alexaforbusiness

package module
v1.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 2, 2021 License: Apache-2.0 Imports: 29 Imported by: 13

Documentation

Overview

Package alexaforbusiness provides the API client, operations, and parameter types for Alexa For Business.

Alexa for Business helps you use Alexa in your organization. Alexa for Business provides you with the tools to manage Alexa devices, enroll your users, and assign skills, at scale. You can build your own context-aware voice skills using the Alexa Skills Kit and the Alexa for Business API operations. You can also make these available as private skills for your organization. Alexa for Business makes it efficient to voice-enable your products and services, thus providing context-aware voice experiences for your customers. Device makers building with the Alexa Voice Service (AVS) can create fully integrated solutions, register their products with Alexa for Business, and manage them as shared devices in their organization.

Index

Constants

View Source 
const ServiceAPIVersion = "2017-11-09"
View Source 
const ServiceID = "Alexa For Business"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver 

func WithEndpointResolver(v EndpointResolver) func(*Options)

WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

Types

type ApproveSkillInput 

type ApproveSkillInput struct {

	// The unique identifier of the skill.
	//
	// This member is required.
	SkillId *string
}

type ApproveSkillOutput 

type ApproveSkillOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AssociateContactWithAddressBookInput 

type AssociateContactWithAddressBookInput struct {

	// The ARN of the address book with which to associate the contact.
	//
	// This member is required.
	AddressBookArn *string

	// The ARN of the contact to associate with an address book.
	//
	// This member is required.
	ContactArn *string
}

type AssociateContactWithAddressBookOutput 

type AssociateContactWithAddressBookOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AssociateDeviceWithNetworkProfileInput 

type AssociateDeviceWithNetworkProfileInput struct {

	// The device ARN.
	//
	// This member is required.
	DeviceArn *string

	// The ARN of the network profile to associate with a device.
	//
	// This member is required.
	NetworkProfileArn *string
}

type AssociateDeviceWithNetworkProfileOutput 

type AssociateDeviceWithNetworkProfileOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AssociateDeviceWithRoomInput 

type AssociateDeviceWithRoomInput struct {

	// The ARN of the device to associate to a room. Required.
	DeviceArn *string

	// The ARN of the room with which to associate the device. Required.
	RoomArn *string
}

type AssociateDeviceWithRoomOutput 

type AssociateDeviceWithRoomOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AssociateSkillGroupWithRoomInput 

type AssociateSkillGroupWithRoomInput struct {

	// The ARN of the room with which to associate the skill group. Required.
	RoomArn *string

	// The ARN of the skill group to associate with a room. Required.
	SkillGroupArn *string
}

type AssociateSkillGroupWithRoomOutput 

type AssociateSkillGroupWithRoomOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AssociateSkillWithSkillGroupInput 

type AssociateSkillWithSkillGroupInput struct {

	// The unique identifier of the skill.
	//
	// This member is required.
	SkillId *string

	// The ARN of the skill group to associate the skill to. Required.
	SkillGroupArn *string
}

type AssociateSkillWithSkillGroupOutput 

type AssociateSkillWithSkillGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AssociateSkillWithUsersInput 

type AssociateSkillWithUsersInput struct {

	// The private skill ID you want to make available to enrolled users.
	//
	// This member is required.
	SkillId *string
}

type AssociateSkillWithUsersOutput 

type AssociateSkillWithUsersOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for Alexa For Business.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) ApproveSkill 

func (c *Client) ApproveSkill(ctx context.Context, params *ApproveSkillInput, optFns ...func(*Options)) (*ApproveSkillOutput, error)

Associates a skill with the organization under the customer's AWS account. If a skill is private, the user implicitly accepts access to this skill during enablement.

func (*Client) AssociateContactWithAddressBook 

func (c *Client) AssociateContactWithAddressBook(ctx context.Context, params *AssociateContactWithAddressBookInput, optFns ...func(*Options)) (*AssociateContactWithAddressBookOutput, error)

Associates a contact with a given address book.

func (*Client) AssociateDeviceWithNetworkProfile 

func (c *Client) AssociateDeviceWithNetworkProfile(ctx context.Context, params *AssociateDeviceWithNetworkProfileInput, optFns ...func(*Options)) (*AssociateDeviceWithNetworkProfileOutput, error)

Associates a device with the specified network profile.

func (*Client) AssociateDeviceWithRoom 

func (c *Client) AssociateDeviceWithRoom(ctx context.Context, params *AssociateDeviceWithRoomInput, optFns ...func(*Options)) (*AssociateDeviceWithRoomOutput, error)

Associates a device with a given room. This applies all the settings from the room profile to the device, and all the skills in any skill groups added to that room. This operation requires the device to be online, or else a manual sync is required.

func (*Client) AssociateSkillGroupWithRoom 

func (c *Client) AssociateSkillGroupWithRoom(ctx context.Context, params *AssociateSkillGroupWithRoomInput, optFns ...func(*Options)) (*AssociateSkillGroupWithRoomOutput, error)

Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room.

func (*Client) AssociateSkillWithSkillGroup 

func (c *Client) AssociateSkillWithSkillGroup(ctx context.Context, params *AssociateSkillWithSkillGroupInput, optFns ...func(*Options)) (*AssociateSkillWithSkillGroupOutput, error)

Associates a skill with a skill group.

func (*Client) AssociateSkillWithUsers 

func (c *Client) AssociateSkillWithUsers(ctx context.Context, params *AssociateSkillWithUsersInput, optFns ...func(*Options)) (*AssociateSkillWithUsersOutput, error)

Makes a private skill available for enrolled users to enable on their devices.

func (*Client) CreateAddressBook 

func (c *Client) CreateAddressBook(ctx context.Context, params *CreateAddressBookInput, optFns ...func(*Options)) (*CreateAddressBookOutput, error)

Creates an address book with the specified details.

func (*Client) CreateBusinessReportSchedule 

func (c *Client) CreateBusinessReportSchedule(ctx context.Context, params *CreateBusinessReportScheduleInput, optFns ...func(*Options)) (*CreateBusinessReportScheduleOutput, error)

Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.

func (*Client) CreateConferenceProvider 

func (c *Client) CreateConferenceProvider(ctx context.Context, params *CreateConferenceProviderInput, optFns ...func(*Options)) (*CreateConferenceProviderOutput, error)

Adds a new conference provider under the user's AWS account.

func (*Client) CreateContact 

func (c *Client) CreateContact(ctx context.Context, params *CreateContactInput, optFns ...func(*Options)) (*CreateContactOutput, error)

Creates a contact with the specified details.

func (*Client) CreateGatewayGroup 

func (c *Client) CreateGatewayGroup(ctx context.Context, params *CreateGatewayGroupInput, optFns ...func(*Options)) (*CreateGatewayGroupOutput, error)

Creates a gateway group with the specified details.

func (*Client) CreateNetworkProfile 

func (c *Client) CreateNetworkProfile(ctx context.Context, params *CreateNetworkProfileInput, optFns ...func(*Options)) (*CreateNetworkProfileOutput, error)

Creates a network profile with the specified details.

func (*Client) CreateProfile 

func (c *Client) CreateProfile(ctx context.Context, params *CreateProfileInput, optFns ...func(*Options)) (*CreateProfileOutput, error)

Creates a new room profile with the specified details.

func (*Client) CreateRoom 

func (c *Client) CreateRoom(ctx context.Context, params *CreateRoomInput, optFns ...func(*Options)) (*CreateRoomOutput, error)

Creates a room with the specified details.

func (*Client) CreateSkillGroup 

func (c *Client) CreateSkillGroup(ctx context.Context, params *CreateSkillGroupInput, optFns ...func(*Options)) (*CreateSkillGroupOutput, error)

Creates a skill group with a specified name and description.

func (*Client) CreateUser 

func (c *Client) CreateUser(ctx context.Context, params *CreateUserInput, optFns ...func(*Options)) (*CreateUserOutput, error)

Creates a user.

func (*Client) DeleteAddressBook 

func (c *Client) DeleteAddressBook(ctx context.Context, params *DeleteAddressBookInput, optFns ...func(*Options)) (*DeleteAddressBookOutput, error)

Deletes an address book by the address book ARN.

func (*Client) DeleteBusinessReportSchedule 

func (c *Client) DeleteBusinessReportSchedule(ctx context.Context, params *DeleteBusinessReportScheduleInput, optFns ...func(*Options)) (*DeleteBusinessReportScheduleOutput, error)

Deletes the recurring report delivery schedule with the specified schedule ARN.

func (*Client) DeleteConferenceProvider 

func (c *Client) DeleteConferenceProvider(ctx context.Context, params *DeleteConferenceProviderInput, optFns ...func(*Options)) (*DeleteConferenceProviderOutput, error)

Deletes a conference provider.

func (*Client) DeleteContact 

func (c *Client) DeleteContact(ctx context.Context, params *DeleteContactInput, optFns ...func(*Options)) (*DeleteContactOutput, error)

Deletes a contact by the contact ARN.

func (*Client) DeleteDevice 

func (c *Client) DeleteDevice(ctx context.Context, params *DeleteDeviceInput, optFns ...func(*Options)) (*DeleteDeviceOutput, error)

Removes a device from Alexa For Business.

func (*Client) DeleteDeviceUsageData 

func (c *Client) DeleteDeviceUsageData(ctx context.Context, params *DeleteDeviceUsageDataInput, optFns ...func(*Options)) (*DeleteDeviceUsageDataOutput, error)

When this action is called for a specified shared device, it allows authorized users to delete the device's entire previous history of voice input data and associated response data. This action can be called once every 24 hours for a specific shared device.

func (*Client) DeleteGatewayGroup 

func (c *Client) DeleteGatewayGroup(ctx context.Context, params *DeleteGatewayGroupInput, optFns ...func(*Options)) (*DeleteGatewayGroupOutput, error)

Deletes a gateway group.

func (*Client) DeleteNetworkProfile 

func (c *Client) DeleteNetworkProfile(ctx context.Context, params *DeleteNetworkProfileInput, optFns ...func(*Options)) (*DeleteNetworkProfileOutput, error)

Deletes a network profile by the network profile ARN.

func (*Client) DeleteProfile 

func (c *Client) DeleteProfile(ctx context.Context, params *DeleteProfileInput, optFns ...func(*Options)) (*DeleteProfileOutput, error)

Deletes a room profile by the profile ARN.

func (*Client) DeleteRoom 

func (c *Client) DeleteRoom(ctx context.Context, params *DeleteRoomInput, optFns ...func(*Options)) (*DeleteRoomOutput, error)

Deletes a room by the room ARN.

func (*Client) DeleteRoomSkillParameter 

func (c *Client) DeleteRoomSkillParameter(ctx context.Context, params *DeleteRoomSkillParameterInput, optFns ...func(*Options)) (*DeleteRoomSkillParameterOutput, error)

Deletes room skill parameter details by room, skill, and parameter key ID.

func (*Client) DeleteSkillAuthorization 

func (c *Client) DeleteSkillAuthorization(ctx context.Context, params *DeleteSkillAuthorizationInput, optFns ...func(*Options)) (*DeleteSkillAuthorizationOutput, error)

Unlinks a third-party account from a skill.

func (*Client) DeleteSkillGroup 

func (c *Client) DeleteSkillGroup(ctx context.Context, params *DeleteSkillGroupInput, optFns ...func(*Options)) (*DeleteSkillGroupOutput, error)

Deletes a skill group by skill group ARN.

func (*Client) DeleteUser 

func (c *Client) DeleteUser(ctx context.Context, params *DeleteUserInput, optFns ...func(*Options)) (*DeleteUserOutput, error)

Deletes a specified user by user ARN and enrollment ARN.

func (*Client) DisassociateContactFromAddressBook 

func (c *Client) DisassociateContactFromAddressBook(ctx context.Context, params *DisassociateContactFromAddressBookInput, optFns ...func(*Options)) (*DisassociateContactFromAddressBookOutput, error)

Disassociates a contact from a given address book.

func (*Client) DisassociateDeviceFromRoom 

func (c *Client) DisassociateDeviceFromRoom(ctx context.Context, params *DisassociateDeviceFromRoomInput, optFns ...func(*Options)) (*DisassociateDeviceFromRoomOutput, error)

Disassociates a device from its current room. The device continues to be connected to the Wi-Fi network and is still registered to the account. The device settings and skills are removed from the room.

func (*Client) DisassociateSkillFromSkillGroup 

func (c *Client) DisassociateSkillFromSkillGroup(ctx context.Context, params *DisassociateSkillFromSkillGroupInput, optFns ...func(*Options)) (*DisassociateSkillFromSkillGroupOutput, error)

Disassociates a skill from a skill group.

func (*Client) DisassociateSkillFromUsers 

func (c *Client) DisassociateSkillFromUsers(ctx context.Context, params *DisassociateSkillFromUsersInput, optFns ...func(*Options)) (*DisassociateSkillFromUsersOutput, error)

Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.

func (*Client) DisassociateSkillGroupFromRoom 

func (c *Client) DisassociateSkillGroupFromRoom(ctx context.Context, params *DisassociateSkillGroupFromRoomInput, optFns ...func(*Options)) (*DisassociateSkillGroupFromRoomOutput, error)

Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.

func (*Client) ForgetSmartHomeAppliances 

func (c *Client) ForgetSmartHomeAppliances(ctx context.Context, params *ForgetSmartHomeAppliancesInput, optFns ...func(*Options)) (*ForgetSmartHomeAppliancesOutput, error)

Forgets smart home appliances associated to a room.

func (*Client) GetAddressBook 

func (c *Client) GetAddressBook(ctx context.Context, params *GetAddressBookInput, optFns ...func(*Options)) (*GetAddressBookOutput, error)

Gets address the book details by the address book ARN.

func (*Client) GetConferencePreference 

func (c *Client) GetConferencePreference(ctx context.Context, params *GetConferencePreferenceInput, optFns ...func(*Options)) (*GetConferencePreferenceOutput, error)

Retrieves the existing conference preferences.

func (*Client) GetConferenceProvider 

func (c *Client) GetConferenceProvider(ctx context.Context, params *GetConferenceProviderInput, optFns ...func(*Options)) (*GetConferenceProviderOutput, error)

Gets details about a specific conference provider.

func (*Client) GetContact 

func (c *Client) GetContact(ctx context.Context, params *GetContactInput, optFns ...func(*Options)) (*GetContactOutput, error)

Gets the contact details by the contact ARN.

func (*Client) GetDevice 

func (c *Client) GetDevice(ctx context.Context, params *GetDeviceInput, optFns ...func(*Options)) (*GetDeviceOutput, error)

Gets the details of a device by device ARN.

func (*Client) GetGateway 

func (c *Client) GetGateway(ctx context.Context, params *GetGatewayInput, optFns ...func(*Options)) (*GetGatewayOutput, error)

Retrieves the details of a gateway.

func (*Client) GetGatewayGroup 

func (c *Client) GetGatewayGroup(ctx context.Context, params *GetGatewayGroupInput, optFns ...func(*Options)) (*GetGatewayGroupOutput, error)

Retrieves the details of a gateway group.

func (*Client) GetInvitationConfiguration 

func (c *Client) GetInvitationConfiguration(ctx context.Context, params *GetInvitationConfigurationInput, optFns ...func(*Options)) (*GetInvitationConfigurationOutput, error)

Retrieves the configured values for the user enrollment invitation email template.

func (*Client) GetNetworkProfile 

func (c *Client) GetNetworkProfile(ctx context.Context, params *GetNetworkProfileInput, optFns ...func(*Options)) (*GetNetworkProfileOutput, error)

Gets the network profile details by the network profile ARN.

func (*Client) GetProfile 

func (c *Client) GetProfile(ctx context.Context, params *GetProfileInput, optFns ...func(*Options)) (*GetProfileOutput, error)

Gets the details of a room profile by profile ARN.

func (*Client) GetRoom 

func (c *Client) GetRoom(ctx context.Context, params *GetRoomInput, optFns ...func(*Options)) (*GetRoomOutput, error)

Gets room details by room ARN.

func (*Client) GetRoomSkillParameter 

func (c *Client) GetRoomSkillParameter(ctx context.Context, params *GetRoomSkillParameterInput, optFns ...func(*Options)) (*GetRoomSkillParameterOutput, error)

Gets room skill parameter details by room, skill, and parameter key ARN.

func (*Client) GetSkillGroup 

func (c *Client) GetSkillGroup(ctx context.Context, params *GetSkillGroupInput, optFns ...func(*Options)) (*GetSkillGroupOutput, error)

Gets skill group details by skill group ARN.

func (*Client) ListBusinessReportSchedules 

func (c *Client) ListBusinessReportSchedules(ctx context.Context, params *ListBusinessReportSchedulesInput, optFns ...func(*Options)) (*ListBusinessReportSchedulesOutput, error)

Lists the details of the schedules that a user configured. A download URL of the report associated with each schedule is returned every time this action is called. A new download URL is returned each time, and is valid for 24 hours.

func (*Client) ListConferenceProviders 

func (c *Client) ListConferenceProviders(ctx context.Context, params *ListConferenceProvidersInput, optFns ...func(*Options)) (*ListConferenceProvidersOutput, error)

Lists conference providers under a specific AWS account.

func (*Client) ListDeviceEvents 

func (c *Client) ListDeviceEvents(ctx context.Context, params *ListDeviceEventsInput, optFns ...func(*Options)) (*ListDeviceEventsOutput, error)

Lists the device event history, including device connection status, for up to 30 days.

func (*Client) ListGatewayGroups 

func (c *Client) ListGatewayGroups(ctx context.Context, params *ListGatewayGroupsInput, optFns ...func(*Options)) (*ListGatewayGroupsOutput, error)

Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group.

func (*Client) ListGateways 

func (c *Client) ListGateways(ctx context.Context, params *ListGatewaysInput, optFns ...func(*Options)) (*ListGatewaysOutput, error)

Retrieves a list of gateway summaries. Use GetGateway to retrieve details of a specific gateway. An optional gateway group ARN can be provided to only retrieve gateway summaries of gateways that are associated with that gateway group ARN.

func (*Client) ListSkills 

func (c *Client) ListSkills(ctx context.Context, params *ListSkillsInput, optFns ...func(*Options)) (*ListSkillsOutput, error)

Lists all enabled skills in a specific skill group.

func (*Client) ListSkillsStoreCategories 

func (c *Client) ListSkillsStoreCategories(ctx context.Context, params *ListSkillsStoreCategoriesInput, optFns ...func(*Options)) (*ListSkillsStoreCategoriesOutput, error)

Lists all categories in the Alexa skill store.

func (*Client) ListSkillsStoreSkillsByCategory 

func (c *Client) ListSkillsStoreSkillsByCategory(ctx context.Context, params *ListSkillsStoreSkillsByCategoryInput, optFns ...func(*Options)) (*ListSkillsStoreSkillsByCategoryOutput, error)

Lists all skills in the Alexa skill store by category.

func (*Client) ListSmartHomeAppliances 

func (c *Client) ListSmartHomeAppliances(ctx context.Context, params *ListSmartHomeAppliancesInput, optFns ...func(*Options)) (*ListSmartHomeAppliancesOutput, error)

Lists all of the smart home appliances associated with a room.

func (*Client) ListTags 

func (c *Client) ListTags(ctx context.Context, params *ListTagsInput, optFns ...func(*Options)) (*ListTagsOutput, error)

Lists all tags for the specified resource.

func (*Client) PutConferencePreference 

func (c *Client) PutConferencePreference(ctx context.Context, params *PutConferencePreferenceInput, optFns ...func(*Options)) (*PutConferencePreferenceOutput, error)

Sets the conference preferences on a specific conference provider at the account level.

func (*Client) PutInvitationConfiguration 

func (c *Client) PutInvitationConfiguration(ctx context.Context, params *PutInvitationConfigurationInput, optFns ...func(*Options)) (*PutInvitationConfigurationOutput, error)

Configures the email template for the user enrollment invitation with the specified attributes.

func (*Client) PutRoomSkillParameter 

func (c *Client) PutRoomSkillParameter(ctx context.Context, params *PutRoomSkillParameterInput, optFns ...func(*Options)) (*PutRoomSkillParameterOutput, error)

Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.

func (*Client) PutSkillAuthorization 

func (c *Client) PutSkillAuthorization(ctx context.Context, params *PutSkillAuthorizationInput, optFns ...func(*Options)) (*PutSkillAuthorizationOutput, error)

Links a user's account to a third-party skill provider. If this API operation is called by an assumed IAM role, the skill being linked must be a private skill. Also, the skill must be owned by the AWS account that assumed the IAM role.

func (*Client) RegisterAVSDevice 

func (c *Client) RegisterAVSDevice(ctx context.Context, params *RegisterAVSDeviceInput, optFns ...func(*Options)) (*RegisterAVSDeviceOutput, error)

Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).

func (*Client) RejectSkill 

func (c *Client) RejectSkill(ctx context.Context, params *RejectSkillInput, optFns ...func(*Options)) (*RejectSkillOutput, error)

Disassociates a skill from the organization under a user's AWS account. If the skill is a private skill, it moves to an AcceptStatus of PENDING. Any private or public skill that is rejected can be added later by calling the ApproveSkill API.

func (*Client) ResolveRoom 

func (c *Client) ResolveRoom(ctx context.Context, params *ResolveRoomInput, optFns ...func(*Options)) (*ResolveRoomOutput, error)

Determines the details for the room from which a skill request was invoked. This operation is used by skill developers. To query ResolveRoom from an Alexa skill, the skill ID needs to be authorized. When the skill is using an AWS Lambda function, the skill is automatically authorized when you publish your skill as a private skill to your AWS account. Skills that are hosted using a custom web service must be manually authorized. To get your skill authorized, contact AWS Support with your AWS account ID that queries the ResolveRoom API and skill ID.

func (*Client) RevokeInvitation 

func (c *Client) RevokeInvitation(ctx context.Context, params *RevokeInvitationInput, optFns ...func(*Options)) (*RevokeInvitationOutput, error)

Revokes an invitation and invalidates the enrollment URL.

func (*Client) SearchAddressBooks 

func (c *Client) SearchAddressBooks(ctx context.Context, params *SearchAddressBooksInput, optFns ...func(*Options)) (*SearchAddressBooksOutput, error)

Searches address books and lists the ones that meet a set of filter and sort criteria.

func (*Client) SearchContacts 

func (c *Client) SearchContacts(ctx context.Context, params *SearchContactsInput, optFns ...func(*Options)) (*SearchContactsOutput, error)

Searches contacts and lists the ones that meet a set of filter and sort criteria.

func (*Client) SearchDevices 

func (c *Client) SearchDevices(ctx context.Context, params *SearchDevicesInput, optFns ...func(*Options)) (*SearchDevicesOutput, error)

Searches devices and lists the ones that meet a set of filter criteria.

func (*Client) SearchNetworkProfiles 

func (c *Client) SearchNetworkProfiles(ctx context.Context, params *SearchNetworkProfilesInput, optFns ...func(*Options)) (*SearchNetworkProfilesOutput, error)

Searches network profiles and lists the ones that meet a set of filter and sort criteria.

func (*Client) SearchProfiles 

func (c *Client) SearchProfiles(ctx context.Context, params *SearchProfilesInput, optFns ...func(*Options)) (*SearchProfilesOutput, error)

Searches room profiles and lists the ones that meet a set of filter criteria.

func (*Client) SearchRooms 

func (c *Client) SearchRooms(ctx context.Context, params *SearchRoomsInput, optFns ...func(*Options)) (*SearchRoomsOutput, error)

Searches rooms and lists the ones that meet a set of filter and sort criteria.

func (*Client) SearchSkillGroups 

func (c *Client) SearchSkillGroups(ctx context.Context, params *SearchSkillGroupsInput, optFns ...func(*Options)) (*SearchSkillGroupsOutput, error)

Searches skill groups and lists the ones that meet a set of filter and sort criteria.

func (*Client) SearchUsers 

func (c *Client) SearchUsers(ctx context.Context, params *SearchUsersInput, optFns ...func(*Options)) (*SearchUsersOutput, error)

Searches users and lists the ones that meet a set of filter and sort criteria.

func (*Client) SendAnnouncement 

func (c *Client) SendAnnouncement(ctx context.Context, params *SendAnnouncementInput, optFns ...func(*Options)) (*SendAnnouncementOutput, error)

Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter.

func (*Client) SendInvitation 

func (c *Client) SendInvitation(ctx context.Context, params *SendInvitationInput, optFns ...func(*Options)) (*SendInvitationOutput, error)

Sends an enrollment invitation email with a URL to a user. The URL is valid for 30 days or until you call this operation again, whichever comes first.

func (*Client) StartDeviceSync 

func (c *Client) StartDeviceSync(ctx context.Context, params *StartDeviceSyncInput, optFns ...func(*Options)) (*StartDeviceSyncOutput, error)

Resets a device and its account to the known default settings. This clears all information and settings set by previous users in the following ways:

* Bluetooth - This unpairs all bluetooth devices paired with your echo device.

* Volume - This resets the echo device's volume to the default value.

* Notifications - This clears all notifications from your echo device.

* Lists - This clears all to-do items from your echo device.

* Settings - This internally syncs the room's profile (if the device is assigned to a room), contacts, address books, delegation access for account linking, and communications (if enabled on the room profile).

func (*Client) StartSmartHomeApplianceDiscovery 

func (c *Client) StartSmartHomeApplianceDiscovery(ctx context.Context, params *StartSmartHomeApplianceDiscoveryInput, optFns ...func(*Options)) (*StartSmartHomeApplianceDiscoveryOutput, error)

Initiates the discovery of any smart home appliances associated with the room.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Adds metadata tags to a specified resource.

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes metadata tags from a specified resource.

func (*Client) UpdateAddressBook 

func (c *Client) UpdateAddressBook(ctx context.Context, params *UpdateAddressBookInput, optFns ...func(*Options)) (*UpdateAddressBookOutput, error)

Updates address book details by the address book ARN.

func (*Client) UpdateBusinessReportSchedule 

func (c *Client) UpdateBusinessReportSchedule(ctx context.Context, params *UpdateBusinessReportScheduleInput, optFns ...func(*Options)) (*UpdateBusinessReportScheduleOutput, error)

Updates the configuration of the report delivery schedule with the specified schedule ARN.

func (*Client) UpdateConferenceProvider 

func (c *Client) UpdateConferenceProvider(ctx context.Context, params *UpdateConferenceProviderInput, optFns ...func(*Options)) (*UpdateConferenceProviderOutput, error)

Updates an existing conference provider's settings.

func (*Client) UpdateContact 

func (c *Client) UpdateContact(ctx context.Context, params *UpdateContactInput, optFns ...func(*Options)) (*UpdateContactOutput, error)

Updates the contact details by the contact ARN.

func (*Client) UpdateDevice 

func (c *Client) UpdateDevice(ctx context.Context, params *UpdateDeviceInput, optFns ...func(*Options)) (*UpdateDeviceOutput, error)

Updates the device name by device ARN.

func (*Client) UpdateGateway 

func (c *Client) UpdateGateway(ctx context.Context, params *UpdateGatewayInput, optFns ...func(*Options)) (*UpdateGatewayOutput, error)

Updates the details of a gateway. If any optional field is not provided, the existing corresponding value is left unmodified.

func (*Client) UpdateGatewayGroup 

func (c *Client) UpdateGatewayGroup(ctx context.Context, params *UpdateGatewayGroupInput, optFns ...func(*Options)) (*UpdateGatewayGroupOutput, error)

Updates the details of a gateway group. If any optional field is not provided, the existing corresponding value is left unmodified.

func (*Client) UpdateNetworkProfile 

func (c *Client) UpdateNetworkProfile(ctx context.Context, params *UpdateNetworkProfileInput, optFns ...func(*Options)) (*UpdateNetworkProfileOutput, error)

Updates a network profile by the network profile ARN.

func (*Client) UpdateProfile 

func (c *Client) UpdateProfile(ctx context.Context, params *UpdateProfileInput, optFns ...func(*Options)) (*UpdateProfileOutput, error)

Updates an existing room profile by room profile ARN.

func (*Client) UpdateRoom 

func (c *Client) UpdateRoom(ctx context.Context, params *UpdateRoomInput, optFns ...func(*Options)) (*UpdateRoomOutput, error)

Updates room details by room ARN.

func (*Client) UpdateSkillGroup 

func (c *Client) UpdateSkillGroup(ctx context.Context, params *UpdateSkillGroupInput, optFns ...func(*Options)) (*UpdateSkillGroupOutput, error)

Updates skill group details by skill group ARN.

type CreateAddressBookInput 

type CreateAddressBookInput struct {

	// The name of the address book.
	//
	// This member is required.
	Name *string

	// A unique, user-specified identifier for the request that ensures idempotency.
	ClientRequestToken *string

	// The description of the address book.
	Description *string

	// The tags to be added to the specified resource. Do not provide system tags.
	Tags []types.Tag
}

type CreateAddressBookOutput 

type CreateAddressBookOutput struct {

	// The ARN of the newly created address book.
	AddressBookArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateBusinessReportScheduleInput 

type CreateBusinessReportScheduleInput struct {

	// The content range of the reports.
	//
	// This member is required.
	ContentRange *types.BusinessReportContentRange

	// The format of the generated report (individual CSV files or zipped files of
	// individual files).
	//
	// This member is required.
	Format types.BusinessReportFormat

	// The client request token.
	ClientRequestToken *string

	// The recurrence of the reports. If this isn't specified, the report will only be
	// delivered one time when the API is called.
	Recurrence *types.BusinessReportRecurrence

	// The S3 bucket name of the output reports. If this isn't specified, the report
	// can be retrieved from a download link by calling ListBusinessReportSchedule.
	S3BucketName *string

	// The S3 key where the report is delivered.
	S3KeyPrefix *string

	// The name identifier of the schedule.
	ScheduleName *string

	// The tags for the business report schedule.
	Tags []types.Tag
}

type CreateBusinessReportScheduleOutput 

type CreateBusinessReportScheduleOutput struct {

	// The ARN of the business report schedule.
	ScheduleArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateConferenceProviderInput 

type CreateConferenceProviderInput struct {

	// The name of the conference provider.
	//
	// This member is required.
	ConferenceProviderName *string

	// Represents a type within a list of predefined types.
	//
	// This member is required.
	ConferenceProviderType types.ConferenceProviderType

	// The meeting settings for the conference provider.
	//
	// This member is required.
	MeetingSetting *types.MeetingSetting

	// The request token of the client.
	ClientRequestToken *string

	// The IP endpoint and protocol for calling.
	IPDialIn *types.IPDialIn

	// The information for PSTN conferencing.
	PSTNDialIn *types.PSTNDialIn

	// The tags to be added to the specified resource. Do not provide system tags.
	Tags []types.Tag
}

type CreateConferenceProviderOutput 

type CreateConferenceProviderOutput struct {

	// The ARN of the newly-created conference provider.
	ConferenceProviderArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateContactInput 

type CreateContactInput struct {

	// The first name of the contact that is used to call the contact on the device.
	//
	// This member is required.
	FirstName *string

	// A unique, user-specified identifier for this request that ensures idempotency.
	ClientRequestToken *string

	// The name of the contact to display on the console.
	DisplayName *string

	// The last name of the contact that is used to call the contact on the device.
	LastName *string

	// The phone number of the contact in E.164 format. The phone number type defaults
	// to WORK. You can specify PhoneNumber or PhoneNumbers. We recommend that you use
	// PhoneNumbers, which lets you specify the phone number type and multiple numbers.
	PhoneNumber *string

	// The list of phone numbers for the contact.
	PhoneNumbers []types.PhoneNumber

	// The list of SIP addresses for the contact.
	SipAddresses []types.SipAddress

	// The tags to be added to the specified resource. Do not provide system tags.
	Tags []types.Tag
}

type CreateContactOutput 

type CreateContactOutput struct {

	// The ARN of the newly created address book.
	ContactArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateGatewayGroupInput 

type CreateGatewayGroupInput struct {

	// A unique, user-specified identifier for the request that ensures idempotency.
	//
	// This member is required.
	ClientRequestToken *string

	// The name of the gateway group.
	//
	// This member is required.
	Name *string

	// The description of the gateway group.
	Description *string

	// The tags to be added to the specified resource. Do not provide system tags.
	Tags []types.Tag
}

type CreateGatewayGroupOutput 

type CreateGatewayGroupOutput struct {

	// The ARN of the created gateway group.
	GatewayGroupArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateNetworkProfileInput 

type CreateNetworkProfileInput struct {

	// A unique, user-specified identifier for the request that ensures idempotency.
	//
	// This member is required.
	ClientRequestToken *string

	// The name of the network profile associated with a device.
	//
	// This member is required.
	NetworkProfileName *string

	// The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK,
	// WPA_PSK, WEP, or OPEN.
	//
	// This member is required.
	SecurityType types.NetworkSecurityType

	// The SSID of the Wi-Fi network.
	//
	// This member is required.
	Ssid *string

	// The ARN of the Private Certificate Authority (PCA) created in AWS Certificate
	// Manager (ACM). This is used to issue certificates to the devices.
	CertificateAuthorityArn *string

	// The current password of the Wi-Fi network.
	CurrentPassword *string

	// Detailed information about a device's network profile.
	Description *string

	// The authentication standard that is used in the EAP framework. Currently,
	// EAP_TLS is supported.
	EapMethod types.NetworkEapMethod

	// The next, or subsequent, password of the Wi-Fi network. This password is
	// asynchronously transmitted to the device and is used when the password of the
	// network changes to NextPassword.
	NextPassword *string

	// The tags to be added to the specified resource. Do not provide system tags.
	Tags []types.Tag

	// The root certificates of your authentication server that is installed on your
	// devices and used to trust your authentication server during EAP negotiation.
	TrustAnchors []string
}

type CreateNetworkProfileOutput 

type CreateNetworkProfileOutput struct {

	// The ARN of the network profile associated with a device.
	NetworkProfileArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateProfileInput 

type CreateProfileInput struct {

	// The valid address for the room.
	//
	// This member is required.
	Address *string

	// The distance unit to be used by devices in the profile.
	//
	// This member is required.
	DistanceUnit types.DistanceUnit

	// The name of a room profile.
	//
	// This member is required.
	ProfileName *string

	// The temperature unit to be used by devices in the profile.
	//
	// This member is required.
	TemperatureUnit types.TemperatureUnit

	// The time zone used by a room profile.
	//
	// This member is required.
	Timezone *string

	// A wake word for Alexa, Echo, Amazon, or a computer.
	//
	// This member is required.
	WakeWord types.WakeWord

	// The user-specified token that is used during the creation of a profile.
	ClientRequestToken *string

	// Whether data retention of the profile is enabled.
	DataRetentionOptIn *bool

	// The locale of the room profile. (This is currently only available to a limited
	// preview audience.)
	Locale *string

	// The maximum volume limit for a room profile.
	MaxVolumeLimit *int32

	// The meeting room settings of a room profile.
	MeetingRoomConfiguration *types.CreateMeetingRoomConfiguration

	// Whether PSTN calling is enabled.
	PSTNEnabled *bool

	// Whether room profile setup is enabled.
	SetupModeDisabled *bool

	// The tags for the profile.
	Tags []types.Tag
}

type CreateProfileOutput 

type CreateProfileOutput struct {

	// The ARN of the newly created room profile in the response.
	ProfileArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateRoomInput 

type CreateRoomInput struct {

	// The name for the room.
	//
	// This member is required.
	RoomName *string

	// A unique, user-specified identifier for this request that ensures idempotency.
	ClientRequestToken *string

	// The description for the room.
	Description *string

	// The profile ARN for the room. This is required.
	ProfileArn *string

	// The calendar ARN for the room.
	ProviderCalendarId *string

	// The tags for the room.
	Tags []types.Tag
}

type CreateRoomOutput 

type CreateRoomOutput struct {

	// The ARN of the newly created room in the response.
	RoomArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateSkillGroupInput 

type CreateSkillGroupInput struct {

	// The name for the skill group.
	//
	// This member is required.
	SkillGroupName *string

	// A unique, user-specified identifier for this request that ensures idempotency.
	ClientRequestToken *string

	// The description for the skill group.
	Description *string

	// The tags for the skill group.
	Tags []types.Tag
}

type CreateSkillGroupOutput 

type CreateSkillGroupOutput struct {

	// The ARN of the newly created skill group in the response.
	SkillGroupArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateUserInput 

type CreateUserInput struct {

	// The ARN for the user.
	//
	// This member is required.
	UserId *string

	// A unique, user-specified identifier for this request that ensures idempotency.
	ClientRequestToken *string

	// The email address for the user.
	Email *string

	// The first name for the user.
	FirstName *string

	// The last name for the user.
	LastName *string

	// The tags for the user.
	Tags []types.Tag
}

type CreateUserOutput 

type CreateUserOutput struct {

	// The ARN of the newly created user in the response.
	UserArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteAddressBookInput 

type DeleteAddressBookInput struct {

	// The ARN of the address book to delete.
	//
	// This member is required.
	AddressBookArn *string
}

type DeleteAddressBookOutput 

type DeleteAddressBookOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteBusinessReportScheduleInput 

type DeleteBusinessReportScheduleInput struct {

	// The ARN of the business report schedule.
	//
	// This member is required.
	ScheduleArn *string
}

type DeleteBusinessReportScheduleOutput 

type DeleteBusinessReportScheduleOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteConferenceProviderInput 

type DeleteConferenceProviderInput struct {

	// The ARN of the conference provider.
	//
	// This member is required.
	ConferenceProviderArn *string
}

type DeleteConferenceProviderOutput 

type DeleteConferenceProviderOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteContactInput 

type DeleteContactInput struct {

	// The ARN of the contact to delete.
	//
	// This member is required.
	ContactArn *string
}

type DeleteContactOutput 

type DeleteContactOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteDeviceInput 

type DeleteDeviceInput struct {

	// The ARN of the device for which to request details.
	//
	// This member is required.
	DeviceArn *string
}

type DeleteDeviceOutput 

type DeleteDeviceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteDeviceUsageDataInput 

type DeleteDeviceUsageDataInput struct {

	// The ARN of the device.
	//
	// This member is required.
	DeviceArn *string

	// The type of usage data to delete.
	//
	// This member is required.
	DeviceUsageType types.DeviceUsageType
}

type DeleteDeviceUsageDataOutput 

type DeleteDeviceUsageDataOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteGatewayGroupInput 

type DeleteGatewayGroupInput struct {

	// The ARN of the gateway group to delete.
	//
	// This member is required.
	GatewayGroupArn *string
}

type DeleteGatewayGroupOutput 

type DeleteGatewayGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteNetworkProfileInput 

type DeleteNetworkProfileInput struct {

	// The ARN of the network profile associated with a device.
	//
	// This member is required.
	NetworkProfileArn *string
}

type DeleteNetworkProfileOutput 

type DeleteNetworkProfileOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteProfileInput 

type DeleteProfileInput struct {

	// The ARN of the room profile to delete. Required.
	ProfileArn *string
}

type DeleteProfileOutput 

type DeleteProfileOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteRoomInput 

type DeleteRoomInput struct {

	// The ARN of the room to delete. Required.
	RoomArn *string
}

type DeleteRoomOutput 

type DeleteRoomOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteRoomSkillParameterInput 

type DeleteRoomSkillParameterInput struct {

	// The room skill parameter key for which to remove details.
	//
	// This member is required.
	ParameterKey *string

	// The ID of the skill from which to remove the room skill parameter details.
	//
	// This member is required.
	SkillId *string

	// The ARN of the room from which to remove the room skill parameter details.
	RoomArn *string
}

type DeleteRoomSkillParameterOutput 

type DeleteRoomSkillParameterOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteSkillAuthorizationInput 

type DeleteSkillAuthorizationInput struct {

	// The unique identifier of a skill.
	//
	// This member is required.
	SkillId *string

	// The room that the skill is authorized for.
	RoomArn *string
}

type DeleteSkillAuthorizationOutput 

type DeleteSkillAuthorizationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteSkillGroupInput 

type DeleteSkillGroupInput struct {

	// The ARN of the skill group to delete. Required.
	SkillGroupArn *string
}

type DeleteSkillGroupOutput 

type DeleteSkillGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteUserInput 

type DeleteUserInput struct {

	// The ARN of the user's enrollment in the organization. Required.
	//
	// This member is required.
	EnrollmentId *string

	// The ARN of the user to delete in the organization. Required.
	UserArn *string
}

type DeleteUserOutput 

type DeleteUserOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DisassociateContactFromAddressBookInput 

type DisassociateContactFromAddressBookInput struct {

	// The ARN of the address from which to disassociate the contact.
	//
	// This member is required.
	AddressBookArn *string

	// The ARN of the contact to disassociate from an address book.
	//
	// This member is required.
	ContactArn *string
}

type DisassociateContactFromAddressBookOutput 

type DisassociateContactFromAddressBookOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DisassociateDeviceFromRoomInput 

type DisassociateDeviceFromRoomInput struct {

	// The ARN of the device to disassociate from a room. Required.
	DeviceArn *string
}

type DisassociateDeviceFromRoomOutput 

type DisassociateDeviceFromRoomOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DisassociateSkillFromSkillGroupInput 

type DisassociateSkillFromSkillGroupInput struct {

	// The ARN of a skill group to associate to a skill.
	//
	// This member is required.
	SkillId *string

	// The unique identifier of a skill. Required.
	SkillGroupArn *string
}

type DisassociateSkillFromSkillGroupOutput 

type DisassociateSkillFromSkillGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DisassociateSkillFromUsersInput 

type DisassociateSkillFromUsersInput struct {

	// The private skill ID you want to make unavailable for enrolled users.
	//
	// This member is required.
	SkillId *string
}

type DisassociateSkillFromUsersOutput 

type DisassociateSkillFromUsersOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DisassociateSkillGroupFromRoomInput 

type DisassociateSkillGroupFromRoomInput struct {

	// The ARN of the room from which the skill group is to be disassociated. Required.
	RoomArn *string

	// The ARN of the skill group to disassociate from a room. Required.
	SkillGroupArn *string
}

type DisassociateSkillGroupFromRoomOutput 

type DisassociateSkillGroupFromRoomOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions added in v0.29.0 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type ForgetSmartHomeAppliancesInput 

type ForgetSmartHomeAppliancesInput struct {

	// The room that the appliances are associated with.
	//
	// This member is required.
	RoomArn *string
}

type ForgetSmartHomeAppliancesOutput 

type ForgetSmartHomeAppliancesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetAddressBookInput 

type GetAddressBookInput struct {

	// The ARN of the address book for which to request details.
	//
	// This member is required.
	AddressBookArn *string
}

type GetAddressBookOutput 

type GetAddressBookOutput struct {

	// The details of the requested address book.
	AddressBook *types.AddressBook

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetConferencePreferenceInput 

type GetConferencePreferenceInput struct {
}

type GetConferencePreferenceOutput 

type GetConferencePreferenceOutput struct {

	// The conference preference.
	Preference *types.ConferencePreference

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetConferenceProviderInput 

type GetConferenceProviderInput struct {

	// The ARN of the newly created conference provider.
	//
	// This member is required.
	ConferenceProviderArn *string
}

type GetConferenceProviderOutput 

type GetConferenceProviderOutput struct {

	// The conference provider.
	ConferenceProvider *types.ConferenceProvider

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetContactInput 

type GetContactInput struct {

	// The ARN of the contact for which to request details.
	//
	// This member is required.
	ContactArn *string
}

type GetContactOutput 

type GetContactOutput struct {

	// The details of the requested contact.
	Contact *types.Contact

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetDeviceInput 

type GetDeviceInput struct {

	// The ARN of the device for which to request details. Required.
	DeviceArn *string
}

type GetDeviceOutput 

type GetDeviceOutput struct {

	// The details of the device requested. Required.
	Device *types.Device

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetGatewayGroupInput 

type GetGatewayGroupInput struct {

	// The ARN of the gateway group to get.
	//
	// This member is required.
	GatewayGroupArn *string
}

type GetGatewayGroupOutput 

type GetGatewayGroupOutput struct {

	// The details of the gateway group.
	GatewayGroup *types.GatewayGroup

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetGatewayInput 

type GetGatewayInput struct {

	// The ARN of the gateway to get.
	//
	// This member is required.
	GatewayArn *string
}

type GetGatewayOutput 

type GetGatewayOutput struct {

	// The details of the gateway.
	Gateway *types.Gateway

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetInvitationConfigurationInput 

type GetInvitationConfigurationInput struct {
}

type GetInvitationConfigurationOutput 

type GetInvitationConfigurationOutput struct {

	// The email ID of the organization or individual contact that the enrolled user
	// can use.
	ContactEmail *string

	// The name of the organization sending the enrollment invite to a user.
	OrganizationName *string

	// The list of private skill IDs that you want to recommend to the user to enable
	// in the invitation.
	PrivateSkillIds []string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetNetworkProfileInput 

type GetNetworkProfileInput struct {

	// The ARN of the network profile associated with a device.
	//
	// This member is required.
	NetworkProfileArn *string
}

type GetNetworkProfileOutput 

type GetNetworkProfileOutput struct {

	// The network profile associated with a device.
	NetworkProfile *types.NetworkProfile

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetProfileInput 

type GetProfileInput struct {

	// The ARN of the room profile for which to request details. Required.
	ProfileArn *string
}

type GetProfileOutput 

type GetProfileOutput struct {

	// The details of the room profile requested. Required.
	Profile *types.Profile

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetRoomInput 

type GetRoomInput struct {

	// The ARN of the room for which to request details. Required.
	RoomArn *string
}

type GetRoomOutput 

type GetRoomOutput struct {

	// The details of the room requested.
	Room *types.Room

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetRoomSkillParameterInput 

type GetRoomSkillParameterInput struct {

	// The room skill parameter key for which to get details. Required.
	//
	// This member is required.
	ParameterKey *string

	// The ARN of the skill from which to get the room skill parameter details.
	// Required.
	//
	// This member is required.
	SkillId *string

	// The ARN of the room from which to get the room skill parameter details.
	RoomArn *string
}

type GetRoomSkillParameterOutput 

type GetRoomSkillParameterOutput struct {

	// The details of the room skill parameter requested. Required.
	RoomSkillParameter *types.RoomSkillParameter

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetSkillGroupInput 

type GetSkillGroupInput struct {

	// The ARN of the skill group for which to get details. Required.
	SkillGroupArn *string
}

type GetSkillGroupOutput 

type GetSkillGroupOutput struct {

	// The details of the skill group requested. Required.
	SkillGroup *types.SkillGroup

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider 

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListBusinessReportSchedulesAPIClient added in v0.30.0 

type ListBusinessReportSchedulesAPIClient interface {
	ListBusinessReportSchedules(context.Context, *ListBusinessReportSchedulesInput, ...func(*Options)) (*ListBusinessReportSchedulesOutput, error)
}

ListBusinessReportSchedulesAPIClient is a client that implements the ListBusinessReportSchedules operation.

type ListBusinessReportSchedulesInput 

type ListBusinessReportSchedulesInput struct {

	// The maximum number of schedules listed in the call.
	MaxResults *int32

	// The token used to list the remaining schedules from the previous API call.
	NextToken *string
}

type ListBusinessReportSchedulesOutput 

type ListBusinessReportSchedulesOutput struct {

	// The schedule of the reports.
	BusinessReportSchedules []types.BusinessReportSchedule

	// The token used to list the remaining schedules from the previous API call.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListBusinessReportSchedulesPaginator added in v0.30.0 

type ListBusinessReportSchedulesPaginator struct {
	// contains filtered or unexported fields
}

ListBusinessReportSchedulesPaginator is a paginator for ListBusinessReportSchedules

func NewListBusinessReportSchedulesPaginator added in v0.30.0 

func NewListBusinessReportSchedulesPaginator(client ListBusinessReportSchedulesAPIClient, params *ListBusinessReportSchedulesInput, optFns ...func(*ListBusinessReportSchedulesPaginatorOptions)) *ListBusinessReportSchedulesPaginator

NewListBusinessReportSchedulesPaginator returns a new ListBusinessReportSchedulesPaginator

func (*ListBusinessReportSchedulesPaginator) HasMorePages added in v0.30.0 

func (p *ListBusinessReportSchedulesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListBusinessReportSchedulesPaginator) NextPage added in v0.30.0 

func (p *ListBusinessReportSchedulesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListBusinessReportSchedulesOutput, error)

NextPage retrieves the next ListBusinessReportSchedules page.

type ListBusinessReportSchedulesPaginatorOptions added in v0.30.0 

type ListBusinessReportSchedulesPaginatorOptions struct {
	// The maximum number of schedules listed in the call.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListBusinessReportSchedulesPaginatorOptions is the paginator options for ListBusinessReportSchedules

type ListConferenceProvidersAPIClient added in v0.30.0 

type ListConferenceProvidersAPIClient interface {
	ListConferenceProviders(context.Context, *ListConferenceProvidersInput, ...func(*Options)) (*ListConferenceProvidersOutput, error)
}

ListConferenceProvidersAPIClient is a client that implements the ListConferenceProviders operation.

type ListConferenceProvidersInput 

type ListConferenceProvidersInput struct {

	// The maximum number of conference providers to be returned, per paginated calls.
	MaxResults *int32

	// The tokens used for pagination.
	NextToken *string
}

type ListConferenceProvidersOutput 

type ListConferenceProvidersOutput struct {

	// The conference providers.
	ConferenceProviders []types.ConferenceProvider

	// The tokens used for pagination.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListConferenceProvidersPaginator added in v0.30.0 

type ListConferenceProvidersPaginator struct {
	// contains filtered or unexported fields
}

ListConferenceProvidersPaginator is a paginator for ListConferenceProviders

func NewListConferenceProvidersPaginator added in v0.30.0 

func NewListConferenceProvidersPaginator(client ListConferenceProvidersAPIClient, params *ListConferenceProvidersInput, optFns ...func(*ListConferenceProvidersPaginatorOptions)) *ListConferenceProvidersPaginator

NewListConferenceProvidersPaginator returns a new ListConferenceProvidersPaginator

func (*ListConferenceProvidersPaginator) HasMorePages added in v0.30.0 

func (p *ListConferenceProvidersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListConferenceProvidersPaginator) NextPage added in v0.30.0 

func (p *ListConferenceProvidersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListConferenceProvidersOutput, error)

NextPage retrieves the next ListConferenceProviders page.

type ListConferenceProvidersPaginatorOptions added in v0.30.0 

type ListConferenceProvidersPaginatorOptions struct {
	// The maximum number of conference providers to be returned, per paginated calls.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListConferenceProvidersPaginatorOptions is the paginator options for ListConferenceProviders

type ListDeviceEventsAPIClient added in v0.30.0 

type ListDeviceEventsAPIClient interface {
	ListDeviceEvents(context.Context, *ListDeviceEventsInput, ...func(*Options)) (*ListDeviceEventsOutput, error)
}

ListDeviceEventsAPIClient is a client that implements the ListDeviceEvents operation.

type ListDeviceEventsInput 

type ListDeviceEventsInput struct {

	// The ARN of a device.
	//
	// This member is required.
	DeviceArn *string

	// The event type to filter device events. If EventType isn't specified, this
	// returns a list of all device events in reverse chronological order. If EventType
	// is specified, this returns a list of device events for that EventType in reverse
	// chronological order.
	EventType types.DeviceEventType

	// The maximum number of results to include in the response. The default value is
	// 50. If more results exist than the specified MaxResults value, a token is
	// included in the response so that the remaining results can be retrieved.
	MaxResults *int32

	// An optional token returned from a prior request. Use this token for pagination
	// of results from this action. If this parameter is specified, the response only
	// includes results beyond the token, up to the value specified by MaxResults. When
	// the end of results is reached, the response has a value of null.
	NextToken *string
}

type ListDeviceEventsOutput 

type ListDeviceEventsOutput struct {

	// The device events requested for the device ARN.
	DeviceEvents []types.DeviceEvent

	// The token returned to indicate that there is more data available.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListDeviceEventsPaginator added in v0.30.0 

type ListDeviceEventsPaginator struct {
	// contains filtered or unexported fields
}

ListDeviceEventsPaginator is a paginator for ListDeviceEvents

func NewListDeviceEventsPaginator added in v0.30.0 

func NewListDeviceEventsPaginator(client ListDeviceEventsAPIClient, params *ListDeviceEventsInput, optFns ...func(*ListDeviceEventsPaginatorOptions)) *ListDeviceEventsPaginator

NewListDeviceEventsPaginator returns a new ListDeviceEventsPaginator

func (*ListDeviceEventsPaginator) HasMorePages added in v0.30.0 

func (p *ListDeviceEventsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDeviceEventsPaginator) NextPage added in v0.30.0 

func (p *ListDeviceEventsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDeviceEventsOutput, error)

NextPage retrieves the next ListDeviceEvents page.

type ListDeviceEventsPaginatorOptions added in v0.30.0 

type ListDeviceEventsPaginatorOptions struct {
	// The maximum number of results to include in the response. The default value is
	// 50. If more results exist than the specified MaxResults value, a token is
	// included in the response so that the remaining results can be retrieved.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDeviceEventsPaginatorOptions is the paginator options for ListDeviceEvents

type ListGatewayGroupsAPIClient added in v0.30.0 

type ListGatewayGroupsAPIClient interface {
	ListGatewayGroups(context.Context, *ListGatewayGroupsInput, ...func(*Options)) (*ListGatewayGroupsOutput, error)
}

ListGatewayGroupsAPIClient is a client that implements the ListGatewayGroups operation.

type ListGatewayGroupsInput 

type ListGatewayGroupsInput struct {

	// The maximum number of gateway group summaries to return. The default is 50.
	MaxResults *int32

	// The token used to paginate though multiple pages of gateway group summaries.
	NextToken *string
}

type ListGatewayGroupsOutput 

type ListGatewayGroupsOutput struct {

	// The gateway groups in the list.
	GatewayGroups []types.GatewayGroupSummary

	// The token used to paginate though multiple pages of gateway group summaries.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListGatewayGroupsPaginator added in v0.30.0 

type ListGatewayGroupsPaginator struct {
	// contains filtered or unexported fields
}

ListGatewayGroupsPaginator is a paginator for ListGatewayGroups

func NewListGatewayGroupsPaginator added in v0.30.0 

func NewListGatewayGroupsPaginator(client ListGatewayGroupsAPIClient, params *ListGatewayGroupsInput, optFns ...func(*ListGatewayGroupsPaginatorOptions)) *ListGatewayGroupsPaginator

NewListGatewayGroupsPaginator returns a new ListGatewayGroupsPaginator

func (*ListGatewayGroupsPaginator) HasMorePages added in v0.30.0 

func (p *ListGatewayGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListGatewayGroupsPaginator) NextPage added in v0.30.0 

func (p *ListGatewayGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListGatewayGroupsOutput, error)

NextPage retrieves the next ListGatewayGroups page.

type ListGatewayGroupsPaginatorOptions added in v0.30.0 

type ListGatewayGroupsPaginatorOptions struct {
	// The maximum number of gateway group summaries to return. The default is 50.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListGatewayGroupsPaginatorOptions is the paginator options for ListGatewayGroups

type ListGatewaysAPIClient added in v0.30.0 

type ListGatewaysAPIClient interface {
	ListGateways(context.Context, *ListGatewaysInput, ...func(*Options)) (*ListGatewaysOutput, error)
}

ListGatewaysAPIClient is a client that implements the ListGateways operation.

type ListGatewaysInput 

type ListGatewaysInput struct {

	// The gateway group ARN for which to list gateways.
	GatewayGroupArn *string

	// The maximum number of gateway summaries to return. The default is 50.
	MaxResults *int32

	// The token used to paginate though multiple pages of gateway summaries.
	NextToken *string
}

type ListGatewaysOutput 

type ListGatewaysOutput struct {

	// The gateways in the list.
	Gateways []types.GatewaySummary

	// The token used to paginate though multiple pages of gateway summaries.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListGatewaysPaginator added in v0.30.0 

type ListGatewaysPaginator struct {
	// contains filtered or unexported fields
}

ListGatewaysPaginator is a paginator for ListGateways

func NewListGatewaysPaginator added in v0.30.0 

func NewListGatewaysPaginator(client ListGatewaysAPIClient, params *ListGatewaysInput, optFns ...func(*ListGatewaysPaginatorOptions)) *ListGatewaysPaginator

NewListGatewaysPaginator returns a new ListGatewaysPaginator

func (*ListGatewaysPaginator) HasMorePages added in v0.30.0 

func (p *ListGatewaysPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListGatewaysPaginator) NextPage added in v0.30.0 

func (p *ListGatewaysPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListGatewaysOutput, error)

NextPage retrieves the next ListGateways page.

type ListGatewaysPaginatorOptions added in v0.30.0 

type ListGatewaysPaginatorOptions struct {
	// The maximum number of gateway summaries to return. The default is 50.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListGatewaysPaginatorOptions is the paginator options for ListGateways

type ListSkillsAPIClient added in v0.30.0 

type ListSkillsAPIClient interface {
	ListSkills(context.Context, *ListSkillsInput, ...func(*Options)) (*ListSkillsOutput, error)
}

ListSkillsAPIClient is a client that implements the ListSkills operation.

type ListSkillsInput 

type ListSkillsInput struct {

	// Whether the skill is enabled under the user's account.
	EnablementType types.EnablementTypeFilter

	// The maximum number of results to include in the response. If more results exist
	// than the specified MaxResults value, a token is included in the response so that
	// the remaining results can be retrieved.
	MaxResults *int32

	// An optional token returned from a prior request. Use this token for pagination
	// of results from this action. If this parameter is specified, the response
	// includes only results beyond the token, up to the value specified by MaxResults.
	NextToken *string

	// The ARN of the skill group for which to list enabled skills.
	SkillGroupArn *string

	// Whether the skill is publicly available or is a private skill.
	SkillType types.SkillTypeFilter
}

type ListSkillsOutput 

type ListSkillsOutput struct {

	// The token returned to indicate that there is more data available.
	NextToken *string

	// The list of enabled skills requested. Required.
	SkillSummaries []types.SkillSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListSkillsPaginator added in v0.30.0 

type ListSkillsPaginator struct {
	// contains filtered or unexported fields
}

ListSkillsPaginator is a paginator for ListSkills

func NewListSkillsPaginator added in v0.30.0 

func NewListSkillsPaginator(client ListSkillsAPIClient, params *ListSkillsInput, optFns ...func(*ListSkillsPaginatorOptions)) *ListSkillsPaginator

NewListSkillsPaginator returns a new ListSkillsPaginator

func (*ListSkillsPaginator) HasMorePages added in v0.30.0 

func (p *ListSkillsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSkillsPaginator) NextPage added in v0.30.0 

func (p *ListSkillsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSkillsOutput, error)

NextPage retrieves the next ListSkills page.

type ListSkillsPaginatorOptions added in v0.30.0 

type ListSkillsPaginatorOptions struct {
	// The maximum number of results to include in the response. If more results exist
	// than the specified MaxResults value, a token is included in the response so that
	// the remaining results can be retrieved.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSkillsPaginatorOptions is the paginator options for ListSkills

type ListSkillsStoreCategoriesAPIClient added in v0.30.0 

type ListSkillsStoreCategoriesAPIClient interface {
	ListSkillsStoreCategories(context.Context, *ListSkillsStoreCategoriesInput, ...func(*Options)) (*ListSkillsStoreCategoriesOutput, error)
}

ListSkillsStoreCategoriesAPIClient is a client that implements the ListSkillsStoreCategories operation.

type ListSkillsStoreCategoriesInput 

type ListSkillsStoreCategoriesInput struct {

	// The maximum number of categories returned, per paginated calls.
	MaxResults *int32

	// The tokens used for pagination.
	NextToken *string
}

type ListSkillsStoreCategoriesOutput 

type ListSkillsStoreCategoriesOutput struct {

	// The list of categories.
	CategoryList []types.Category

	// The tokens used for pagination.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListSkillsStoreCategoriesPaginator added in v0.30.0 

type ListSkillsStoreCategoriesPaginator struct {
	// contains filtered or unexported fields
}

ListSkillsStoreCategoriesPaginator is a paginator for ListSkillsStoreCategories

func NewListSkillsStoreCategoriesPaginator added in v0.30.0 

func NewListSkillsStoreCategoriesPaginator(client ListSkillsStoreCategoriesAPIClient, params *ListSkillsStoreCategoriesInput, optFns ...func(*ListSkillsStoreCategoriesPaginatorOptions)) *ListSkillsStoreCategoriesPaginator

NewListSkillsStoreCategoriesPaginator returns a new ListSkillsStoreCategoriesPaginator

func (*ListSkillsStoreCategoriesPaginator) HasMorePages added in v0.30.0 

func (p *ListSkillsStoreCategoriesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSkillsStoreCategoriesPaginator) NextPage added in v0.30.0 

func (p *ListSkillsStoreCategoriesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSkillsStoreCategoriesOutput, error)

NextPage retrieves the next ListSkillsStoreCategories page.

type ListSkillsStoreCategoriesPaginatorOptions added in v0.30.0 

type ListSkillsStoreCategoriesPaginatorOptions struct {
	// The maximum number of categories returned, per paginated calls.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSkillsStoreCategoriesPaginatorOptions is the paginator options for ListSkillsStoreCategories

type ListSkillsStoreSkillsByCategoryAPIClient added in v0.30.0 

type ListSkillsStoreSkillsByCategoryAPIClient interface {
	ListSkillsStoreSkillsByCategory(context.Context, *ListSkillsStoreSkillsByCategoryInput, ...func(*Options)) (*ListSkillsStoreSkillsByCategoryOutput, error)
}

ListSkillsStoreSkillsByCategoryAPIClient is a client that implements the ListSkillsStoreSkillsByCategory operation.

type ListSkillsStoreSkillsByCategoryInput 

type ListSkillsStoreSkillsByCategoryInput struct {

	// The category ID for which the skills are being retrieved from the skill store.
	//
	// This member is required.
	CategoryId *int64

	// The maximum number of skills returned per paginated calls.
	MaxResults *int32

	// The tokens used for pagination.
	NextToken *string
}

type ListSkillsStoreSkillsByCategoryOutput 

type ListSkillsStoreSkillsByCategoryOutput struct {

	// The tokens used for pagination.
	NextToken *string

	// The skill store skills.
	SkillsStoreSkills []types.SkillsStoreSkill

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListSkillsStoreSkillsByCategoryPaginator added in v0.30.0 

type ListSkillsStoreSkillsByCategoryPaginator struct {
	// contains filtered or unexported fields
}

ListSkillsStoreSkillsByCategoryPaginator is a paginator for ListSkillsStoreSkillsByCategory

func NewListSkillsStoreSkillsByCategoryPaginator added in v0.30.0 

func NewListSkillsStoreSkillsByCategoryPaginator(client ListSkillsStoreSkillsByCategoryAPIClient, params *ListSkillsStoreSkillsByCategoryInput, optFns ...func(*ListSkillsStoreSkillsByCategoryPaginatorOptions)) *ListSkillsStoreSkillsByCategoryPaginator

NewListSkillsStoreSkillsByCategoryPaginator returns a new ListSkillsStoreSkillsByCategoryPaginator

func (*ListSkillsStoreSkillsByCategoryPaginator) HasMorePages added in v0.30.0 

func (p *ListSkillsStoreSkillsByCategoryPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSkillsStoreSkillsByCategoryPaginator) NextPage added in v0.30.0 

func (p *ListSkillsStoreSkillsByCategoryPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSkillsStoreSkillsByCategoryOutput, error)

NextPage retrieves the next ListSkillsStoreSkillsByCategory page.

type ListSkillsStoreSkillsByCategoryPaginatorOptions added in v0.30.0 

type ListSkillsStoreSkillsByCategoryPaginatorOptions struct {
	// The maximum number of skills returned per paginated calls.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSkillsStoreSkillsByCategoryPaginatorOptions is the paginator options for ListSkillsStoreSkillsByCategory

type ListSmartHomeAppliancesAPIClient added in v0.30.0 

type ListSmartHomeAppliancesAPIClient interface {
	ListSmartHomeAppliances(context.Context, *ListSmartHomeAppliancesInput, ...func(*Options)) (*ListSmartHomeAppliancesOutput, error)
}

ListSmartHomeAppliancesAPIClient is a client that implements the ListSmartHomeAppliances operation.

type ListSmartHomeAppliancesInput 

type ListSmartHomeAppliancesInput struct {

	// The room that the appliances are associated with.
	//
	// This member is required.
	RoomArn *string

	// The maximum number of appliances to be returned, per paginated calls.
	MaxResults *int32

	// The tokens used for pagination.
	NextToken *string
}

type ListSmartHomeAppliancesOutput 

type ListSmartHomeAppliancesOutput struct {

	// The tokens used for pagination.
	NextToken *string

	// The smart home appliances.
	SmartHomeAppliances []types.SmartHomeAppliance

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListSmartHomeAppliancesPaginator added in v0.30.0 

type ListSmartHomeAppliancesPaginator struct {
	// contains filtered or unexported fields
}

ListSmartHomeAppliancesPaginator is a paginator for ListSmartHomeAppliances

func NewListSmartHomeAppliancesPaginator added in v0.30.0 

func NewListSmartHomeAppliancesPaginator(client ListSmartHomeAppliancesAPIClient, params *ListSmartHomeAppliancesInput, optFns ...func(*ListSmartHomeAppliancesPaginatorOptions)) *ListSmartHomeAppliancesPaginator

NewListSmartHomeAppliancesPaginator returns a new ListSmartHomeAppliancesPaginator

func (*ListSmartHomeAppliancesPaginator) HasMorePages added in v0.30.0 

func (p *ListSmartHomeAppliancesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSmartHomeAppliancesPaginator) NextPage added in v0.30.0 

func (p *ListSmartHomeAppliancesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSmartHomeAppliancesOutput, error)

NextPage retrieves the next ListSmartHomeAppliances page.

type ListSmartHomeAppliancesPaginatorOptions added in v0.30.0 

type ListSmartHomeAppliancesPaginatorOptions struct {
	// The maximum number of appliances to be returned, per paginated calls.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSmartHomeAppliancesPaginatorOptions is the paginator options for ListSmartHomeAppliances

type ListTagsAPIClient added in v0.30.0 

type ListTagsAPIClient interface {
	ListTags(context.Context, *ListTagsInput, ...func(*Options)) (*ListTagsOutput, error)
}

ListTagsAPIClient is a client that implements the ListTags operation.

type ListTagsInput 

type ListTagsInput struct {

	// The ARN of the specified resource for which to list tags.
	//
	// This member is required.
	Arn *string

	// The maximum number of results to include in the response. If more results exist
	// than the specified MaxResults value, a token is included in the response so that
	// the remaining results can be retrieved.
	MaxResults *int32

	// An optional token returned from a prior request. Use this token for pagination
	// of results from this action. If this parameter is specified, the response
	// includes only results beyond the token, up to the value specified by MaxResults.
	NextToken *string
}

type ListTagsOutput 

type ListTagsOutput struct {

	// The token returned to indicate that there is more data available.
	NextToken *string

	// The tags requested for the specified resource.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListTagsPaginator added in v0.30.0 

type ListTagsPaginator struct {
	// contains filtered or unexported fields
}

ListTagsPaginator is a paginator for ListTags

func NewListTagsPaginator added in v0.30.0 

func NewListTagsPaginator(client ListTagsAPIClient, params *ListTagsInput, optFns ...func(*ListTagsPaginatorOptions)) *ListTagsPaginator

NewListTagsPaginator returns a new ListTagsPaginator

func (*ListTagsPaginator) HasMorePages added in v0.30.0 

func (p *ListTagsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTagsPaginator) NextPage added in v0.30.0 

func (p *ListTagsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTagsOutput, error)

NextPage retrieves the next ListTags page.

type ListTagsPaginatorOptions added in v0.30.0 

type ListTagsPaginatorOptions struct {
	// The maximum number of results to include in the response. If more results exist
	// than the specified MaxResults value, a token is included in the response so that
	// the remaining results can be retrieved.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTagsPaginatorOptions is the paginator options for ListTags

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer aws.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

type PutConferencePreferenceInput 

type PutConferencePreferenceInput struct {

	// The conference preference of a specific conference provider.
	//
	// This member is required.
	ConferencePreference *types.ConferencePreference
}

type PutConferencePreferenceOutput 

type PutConferencePreferenceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type PutInvitationConfigurationInput 

type PutInvitationConfigurationInput struct {

	// The name of the organization sending the enrollment invite to a user.
	//
	// This member is required.
	OrganizationName *string

	// The email ID of the organization or individual contact that the enrolled user
	// can use.
	ContactEmail *string

	// The list of private skill IDs that you want to recommend to the user to enable
	// in the invitation.
	PrivateSkillIds []string
}

type PutInvitationConfigurationOutput 

type PutInvitationConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type PutRoomSkillParameterInput 

type PutRoomSkillParameterInput struct {

	// The updated room skill parameter. Required.
	//
	// This member is required.
	RoomSkillParameter *types.RoomSkillParameter

	// The ARN of the skill associated with the room skill parameter. Required.
	//
	// This member is required.
	SkillId *string

	// The ARN of the room associated with the room skill parameter. Required.
	RoomArn *string
}

type PutRoomSkillParameterOutput 

type PutRoomSkillParameterOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type PutSkillAuthorizationInput 

type PutSkillAuthorizationInput struct {

	// The authorization result specific to OAUTH code grant output. "Code” must be
	// populated in the AuthorizationResult map to establish the authorization.
	//
	// This member is required.
	AuthorizationResult map[string]string

	// The unique identifier of a skill.
	//
	// This member is required.
	SkillId *string

	// The room that the skill is authorized for.
	RoomArn *string
}

type PutSkillAuthorizationOutput 

type PutSkillAuthorizationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type RegisterAVSDeviceInput 

type RegisterAVSDeviceInput struct {

	// The device type ID for your AVS device generated by Amazon when the OEM creates
	// a new product on Amazon's Developer Console.
	//
	// This member is required.
	AmazonId *string

	// The client ID of the OEM used for code-based linking authorization on an AVS
	// device.
	//
	// This member is required.
	ClientId *string

	// The product ID used to identify your AVS device during authorization.
	//
	// This member is required.
	ProductId *string

	// The code that is obtained after your AVS device has made a POST request to LWA
	// as a part of the Device Authorization Request component of the OAuth code-based
	// linking specification.
	//
	// This member is required.
	UserCode *string

	// The key generated by the OEM that uniquely identifies a specified instance of
	// your AVS device.
	DeviceSerialNumber *string

	// The Amazon Resource Name (ARN) of the room with which to associate your AVS
	// device.
	RoomArn *string

	// The tags to be added to the specified resource. Do not provide system tags.
	Tags []types.Tag
}

type RegisterAVSDeviceOutput 

type RegisterAVSDeviceOutput struct {

	// The ARN of the device.
	DeviceArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type RejectSkillInput 

type RejectSkillInput struct {

	// The unique identifier of the skill.
	//
	// This member is required.
	SkillId *string
}

type RejectSkillOutput 

type RejectSkillOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type ResolveRoomInput 

type ResolveRoomInput struct {

	// The ARN of the skill that was requested. Required.
	//
	// This member is required.
	SkillId *string

	// The ARN of the user. Required.
	//
	// This member is required.
	UserId *string
}

type ResolveRoomOutput 

type ResolveRoomOutput struct {

	// The ARN of the room from which the skill request was invoked.
	RoomArn *string

	// The name of the room from which the skill request was invoked.
	RoomName *string

	// Response to get the room profile request. Required.
	RoomSkillParameters []types.RoomSkillParameter

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type RevokeInvitationInput 

type RevokeInvitationInput struct {

	// The ARN of the enrollment invitation to revoke. Required.
	EnrollmentId *string

	// The ARN of the user for whom to revoke an enrollment invitation. Required.
	UserArn *string
}

type RevokeInvitationOutput 

type RevokeInvitationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type SearchAddressBooksAPIClient added in v0.30.0 

type SearchAddressBooksAPIClient interface {
	SearchAddressBooks(context.Context, *SearchAddressBooksInput, ...func(*Options)) (*SearchAddressBooksOutput, error)
}

SearchAddressBooksAPIClient is a client that implements the SearchAddressBooks operation.

type SearchAddressBooksInput 

type SearchAddressBooksInput struct {

	// The filters to use to list a specified set of address books. The supported
	// filter key is AddressBookName.
	Filters []types.Filter

	// The maximum number of results to include in the response. If more results exist
	// than the specified MaxResults value, a token is included in the response so that
	// the remaining results can be retrieved.
	MaxResults *int32

	// An optional token returned from a prior request. Use this token for pagination
	// of results from this action. If this parameter is specified, the response only
	// includes results beyond the token, up to the value specified by MaxResults.
	NextToken *string

	// The sort order to use in listing the specified set of address books. The
	// supported sort key is AddressBookName.
	SortCriteria []types.Sort
}

type SearchAddressBooksOutput 

type SearchAddressBooksOutput struct {

	// The address books that meet the specified set of filter criteria, in sort order.
	AddressBooks []types.AddressBookData

	// The token returned to indicate that there is more data available.
	NextToken *string

	// The total number of address books returned.
	TotalCount *int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type SearchAddressBooksPaginator added in v0.30.0 

type SearchAddressBooksPaginator struct {
	// contains filtered or unexported fields
}

SearchAddressBooksPaginator is a paginator for SearchAddressBooks

func NewSearchAddressBooksPaginator added in v0.30.0 

func NewSearchAddressBooksPaginator(client SearchAddressBooksAPIClient, params *SearchAddressBooksInput, optFns ...func(*SearchAddressBooksPaginatorOptions)) *SearchAddressBooksPaginator

NewSearchAddressBooksPaginator returns a new SearchAddressBooksPaginator

func (*SearchAddressBooksPaginator) HasMorePages added in v0.30.0 

func (p *SearchAddressBooksPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchAddressBooksPaginator) NextPage added in v0.30.0 

func (p *SearchAddressBooksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchAddressBooksOutput, error)

NextPage retrieves the next SearchAddressBooks page.

type SearchAddressBooksPaginatorOptions added in v0.30.0 

type SearchAddressBooksPaginatorOptions struct {
	// The maximum number of results to include in the response. If more results exist
	// than the specified MaxResults value, a token is included in the response so that
	// the remaining results can be retrieved.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

SearchAddressBooksPaginatorOptions is the paginator options for SearchAddressBooks

type SearchContactsAPIClient added in v0.30.0 

type SearchContactsAPIClient interface {
	SearchContacts(context.Context, *SearchContactsInput, ...func(*Options)) (*SearchContactsOutput, error)
}

SearchContactsAPIClient is a client that implements the SearchContacts operation.

type SearchContactsInput 

type SearchContactsInput struct {

	// The filters to use to list a specified set of address books. The supported
	// filter keys are DisplayName, FirstName, LastName, and AddressBookArns.
	Filters []types.Filter

	// The maximum number of results to include in the response. If more results exist
	// than the specified MaxResults value, a token is included in the response so that
	// the remaining results can be retrieved.
	MaxResults *int32

	// An optional token returned from a prior request. Use this token for pagination
	// of results from this action. If this parameter is specified, the response only
	// includes results beyond the token, up to the value specified by MaxResults.
	NextToken *string

	// The sort order to use in listing the specified set of contacts. The supported
	// sort keys are DisplayName, FirstName, and LastName.
	SortCriteria []types.Sort
}

type SearchContactsOutput 

type SearchContactsOutput struct {

	// The contacts that meet the specified set of filter criteria, in sort order.
	Contacts []types.ContactData

	// The token returned to indicate that there is more data available.
	NextToken *string

	// The total number of contacts returned.
	TotalCount *int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type SearchContactsPaginator added in v0.30.0 

type SearchContactsPaginator struct {
	// contains filtered or unexported fields
}

SearchContactsPaginator is a paginator for SearchContacts

func NewSearchContactsPaginator added in v0.30.0 

func NewSearchContactsPaginator(client SearchContactsAPIClient, params *SearchContactsInput, optFns ...func(*SearchContactsPaginatorOptions)) *SearchContactsPaginator

NewSearchContactsPaginator returns a new SearchContactsPaginator

func (*SearchContactsPaginator) HasMorePages added in v0.30.0 

func (p *SearchContactsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchContactsPaginator) NextPage added in v0.30.0 

func (p *SearchContactsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchContactsOutput, error)

NextPage retrieves the next SearchContacts page.

type SearchContactsPaginatorOptions added in v0.30.0 

type SearchContactsPaginatorOptions struct {
	// The maximum number of results to include in the response. If more results exist
	// than the specified MaxResults value, a token is included in the response so that
	// the remaining results can be retrieved.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

SearchContactsPaginatorOptions is the paginator options for SearchContacts

type SearchDevicesAPIClient added in v0.30.0 

type SearchDevicesAPIClient interface {
	SearchDevices(context.Context, *SearchDevicesInput, ...func(*Options)) (*SearchDevicesOutput, error)
}

SearchDevicesAPIClient is a client that implements the SearchDevices operation.

type SearchDevicesInput 

type SearchDevicesInput struct {

	// The filters to use to list a specified set of devices. Supported filter keys are
	// DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType,
	// DeviceSerialNumber, UnassociatedOnly, ConnectionStatus (ONLINE and OFFLINE),
	// NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.
	Filters []types.Filter

	// The maximum number of results to include in the response. If more results exist
	// than the specified MaxResults value, a token is included in the response so that
	// the remaining results can be retrieved.
	MaxResults *int32

	// An optional token returned from a prior request. Use this token for pagination
	// of results from this action. If this parameter is specified, the response
	// includes only results beyond the token, up to the value specified by MaxResults.
	NextToken *string

	// The sort order to use in listing the specified set of devices. Supported sort
	// keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber,
	// ConnectionStatus, NetworkProfileName, NetworkProfileArn, Feature, and
	// FailureCode.
	SortCriteria []types.Sort
}

type SearchDevicesOutput 

type SearchDevicesOutput struct {

	// The devices that meet the specified set of filter criteria, in sort order.
	Devices []types.DeviceData

	// The token returned to indicate that there is more data available.
	NextToken *string

	// The total number of devices returned.
	TotalCount *int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type SearchDevicesPaginator added in v0.30.0 

type SearchDevicesPaginator struct {
	// contains filtered or unexported fields
}

SearchDevicesPaginator is a paginator for SearchDevices

func NewSearchDevicesPaginator added in v0.30.0 

func NewSearchDevicesPaginator(client SearchDevicesAPIClient, params *SearchDevicesInput, optFns ...func(*SearchDevicesPaginatorOptions)) *SearchDevicesPaginator

NewSearchDevicesPaginator returns a new SearchDevicesPaginator

func (*SearchDevicesPaginator) HasMorePages added in v0.30.0 

func (p *SearchDevicesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchDevicesPaginator) NextPage added in v0.30.0 

func (p *SearchDevicesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchDevicesOutput, error)

NextPage retrieves the next SearchDevices page.

type SearchDevicesPaginatorOptions added in v0.30.0 

type SearchDevicesPaginatorOptions struct {
	// The maximum number of results to include in the response. If more results exist
	// than the specified MaxResults value, a token is included in the response so that
	// the remaining results can be retrieved.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

SearchDevicesPaginatorOptions is the paginator options for SearchDevices

type SearchNetworkProfilesAPIClient added in v0.30.0 

type SearchNetworkProfilesAPIClient interface {
	SearchNetworkProfiles(context.Context, *SearchNetworkProfilesInput, ...func(*Options)) (*SearchNetworkProfilesOutput, error)
}

SearchNetworkProfilesAPIClient is a client that implements the SearchNetworkProfiles operation.

type SearchNetworkProfilesInput 

type SearchNetworkProfilesInput struct {

	// The filters to use to list a specified set of network profiles. Valid filters
	// are NetworkProfileName, Ssid, and SecurityType.
	Filters []types.Filter

	// The maximum number of results to include in the response. If more results exist
	// than the specified MaxResults value, a token is included in the response so that
	// the remaining results can be retrieved.
	MaxResults *int32

	// An optional token returned from a prior request. Use this token for pagination
	// of results from this action. If this parameter is specified, the response
	// includes only results beyond the token, up to the value specified by MaxResults.
	NextToken *string

	// The sort order to use to list the specified set of network profiles. Valid sort
	// criteria includes NetworkProfileName, Ssid, and SecurityType.
	SortCriteria []types.Sort
}

type SearchNetworkProfilesOutput 

type SearchNetworkProfilesOutput struct {

	// The network profiles that meet the specified set of filter criteria, in sort
	// order. It is a list of NetworkProfileData objects.
	NetworkProfiles []types.NetworkProfileData

	// An optional token returned from a prior request. Use this token for pagination
	// of results from this action. If this parameter is specified, the response
	// includes only results beyond the token, up to the value specified by MaxResults.
	NextToken *string

	// The total number of network profiles returned.
	TotalCount *int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type SearchNetworkProfilesPaginator added in v0.30.0 

type SearchNetworkProfilesPaginator struct {
	// contains filtered or unexported fields
}

SearchNetworkProfilesPaginator is a paginator for SearchNetworkProfiles

func NewSearchNetworkProfilesPaginator added in v0.30.0 

func NewSearchNetworkProfilesPaginator(client SearchNetworkProfilesAPIClient, params *SearchNetworkProfilesInput, optFns ...func(*SearchNetworkProfilesPaginatorOptions)) *SearchNetworkProfilesPaginator

NewSearchNetworkProfilesPaginator returns a new SearchNetworkProfilesPaginator

func (*SearchNetworkProfilesPaginator) HasMorePages added in v0.30.0 

func (p *SearchNetworkProfilesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchNetworkProfilesPaginator) NextPage added in v0.30.0 

func (p *SearchNetworkProfilesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchNetworkProfilesOutput, error)

NextPage retrieves the next SearchNetworkProfiles page.

type SearchNetworkProfilesPaginatorOptions added in v0.30.0 

type SearchNetworkProfilesPaginatorOptions struct {
	// The maximum number of results to include in the response. If more results exist
	// than the specified MaxResults value, a token is included in the response so that
	// the remaining results can be retrieved.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

SearchNetworkProfilesPaginatorOptions is the paginator options for SearchNetworkProfiles

type SearchProfilesAPIClient added in v0.30.0 

type SearchProfilesAPIClient interface {
	SearchProfiles(context.Context, *SearchProfilesInput, ...func(*Options)) (*SearchProfilesOutput, error)
}

SearchProfilesAPIClient is a client that implements the SearchProfiles operation.

type SearchProfilesInput 

type SearchProfilesInput struct {

	// The filters to use to list a specified set of room profiles. Supported filter
	// keys are ProfileName and Address. Required.
	Filters []types.Filter

	// The maximum number of results to include in the response. If more results exist
	// than the specified MaxResults value, a token is included in the response so that
	// the remaining results can be retrieved.
	MaxResults *int32

	// An optional token returned from a prior request. Use this token for pagination
	// of results from this action. If this parameter is specified, the response
	// includes only results beyond the token, up to the value specified by MaxResults.
	NextToken *string

	// The sort order to use in listing the specified set of room profiles. Supported
	// sort keys are ProfileName and Address.
	SortCriteria []types.Sort
}

type SearchProfilesOutput 

type SearchProfilesOutput struct {

	// The token returned to indicate that there is more data available.
	NextToken *string

	// The profiles that meet the specified set of filter criteria, in sort order.
	Profiles []types.ProfileData

	// The total number of room profiles returned.
	TotalCount *int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type SearchProfilesPaginator added in v0.30.0 

type SearchProfilesPaginator struct {
	// contains filtered or unexported fields
}

SearchProfilesPaginator is a paginator for SearchProfiles

func NewSearchProfilesPaginator added in v0.30.0 

func NewSearchProfilesPaginator(client SearchProfilesAPIClient, params *SearchProfilesInput, optFns ...func(*SearchProfilesPaginatorOptions)) *SearchProfilesPaginator

NewSearchProfilesPaginator returns a new SearchProfilesPaginator

func (*SearchProfilesPaginator) HasMorePages added in v0.30.0 

func (p *SearchProfilesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchProfilesPaginator) NextPage added in v0.30.0 

func (p *SearchProfilesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchProfilesOutput, error)

NextPage retrieves the next SearchProfiles page.

type SearchProfilesPaginatorOptions added in v0.30.0 

type SearchProfilesPaginatorOptions struct {
	// The maximum number of results to include in the response. If more results exist
	// than the specified MaxResults value, a token is included in the response so that
	// the remaining results can be retrieved.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

SearchProfilesPaginatorOptions is the paginator options for SearchProfiles

type SearchRoomsAPIClient added in v0.30.0 

type SearchRoomsAPIClient interface {
	SearchRooms(context.Context, *SearchRoomsInput, ...func(*Options)) (*SearchRoomsOutput, error)
}

SearchRoomsAPIClient is a client that implements the SearchRooms operation.

type SearchRoomsInput 

type SearchRoomsInput struct {

	// The filters to use to list a specified set of rooms. The supported filter keys
	// are RoomName and ProfileName.
	Filters []types.Filter

	// The maximum number of results to include in the response. If more results exist
	// than the specified MaxResults value, a token is included in the response so that
	// the remaining results can be retrieved.
	MaxResults *int32

	// An optional token returned from a prior request. Use this token for pagination
	// of results from this action. If this parameter is specified, the response
	// includes only results beyond the token, up to the value specified by MaxResults.
	NextToken *string

	// The sort order to use in listing the specified set of rooms. The supported sort
	// keys are RoomName and ProfileName.
	SortCriteria []types.Sort
}

type SearchRoomsOutput 

type SearchRoomsOutput struct {

	// The token returned to indicate that there is more data available.
	NextToken *string

	// The rooms that meet the specified set of filter criteria, in sort order.
	Rooms []types.RoomData

	// The total number of rooms returned.
	TotalCount *int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type SearchRoomsPaginator added in v0.30.0 

type SearchRoomsPaginator struct {
	// contains filtered or unexported fields
}

SearchRoomsPaginator is a paginator for SearchRooms

func NewSearchRoomsPaginator added in v0.30.0 

func NewSearchRoomsPaginator(client SearchRoomsAPIClient, params *SearchRoomsInput, optFns ...func(*SearchRoomsPaginatorOptions)) *SearchRoomsPaginator

NewSearchRoomsPaginator returns a new SearchRoomsPaginator

func (*SearchRoomsPaginator) HasMorePages added in v0.30.0 

func (p *SearchRoomsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchRoomsPaginator) NextPage added in v0.30.0 

func (p *SearchRoomsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchRoomsOutput, error)

NextPage retrieves the next SearchRooms page.

type SearchRoomsPaginatorOptions added in v0.30.0 

type SearchRoomsPaginatorOptions struct {
	// The maximum number of results to include in the response. If more results exist
	// than the specified MaxResults value, a token is included in the response so that
	// the remaining results can be retrieved.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

SearchRoomsPaginatorOptions is the paginator options for SearchRooms

type SearchSkillGroupsAPIClient added in v0.30.0 

type SearchSkillGroupsAPIClient interface {
	SearchSkillGroups(context.Context, *SearchSkillGroupsInput, ...func(*Options)) (*SearchSkillGroupsOutput, error)
}

SearchSkillGroupsAPIClient is a client that implements the SearchSkillGroups operation.

type SearchSkillGroupsInput 

type SearchSkillGroupsInput struct {

	// The filters to use to list a specified set of skill groups. The supported filter
	// key is SkillGroupName.
	Filters []types.Filter

	// The maximum number of results to include in the response. If more results exist
	// than the specified MaxResults value, a token is included in the response so that
	// the remaining results can be retrieved.
	MaxResults *int32

	// An optional token returned from a prior request. Use this token for pagination
	// of results from this action. If this parameter is specified, the response
	// includes only results beyond the token, up to the value specified by MaxResults.
	// Required.
	NextToken *string

	// The sort order to use in listing the specified set of skill groups. The
	// supported sort key is SkillGroupName.
	SortCriteria []types.Sort
}

type SearchSkillGroupsOutput 

type SearchSkillGroupsOutput struct {

	// The token returned to indicate that there is more data available.
	NextToken *string

	// The skill groups that meet the filter criteria, in sort order.
	SkillGroups []types.SkillGroupData

	// The total number of skill groups returned.
	TotalCount *int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type SearchSkillGroupsPaginator added in v0.30.0 

type SearchSkillGroupsPaginator struct {
	// contains filtered or unexported fields
}

SearchSkillGroupsPaginator is a paginator for SearchSkillGroups

func NewSearchSkillGroupsPaginator added in v0.30.0 

func NewSearchSkillGroupsPaginator(client SearchSkillGroupsAPIClient, params *SearchSkillGroupsInput, optFns ...func(*SearchSkillGroupsPaginatorOptions)) *SearchSkillGroupsPaginator

NewSearchSkillGroupsPaginator returns a new SearchSkillGroupsPaginator

func (*SearchSkillGroupsPaginator) HasMorePages added in v0.30.0 

func (p *SearchSkillGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchSkillGroupsPaginator) NextPage added in v0.30.0 

func (p *SearchSkillGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchSkillGroupsOutput, error)

NextPage retrieves the next SearchSkillGroups page.

type SearchSkillGroupsPaginatorOptions added in v0.30.0 

type SearchSkillGroupsPaginatorOptions struct {
	// The maximum number of results to include in the response. If more results exist
	// than the specified MaxResults value, a token is included in the response so that
	// the remaining results can be retrieved.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

SearchSkillGroupsPaginatorOptions is the paginator options for SearchSkillGroups

type SearchUsersAPIClient added in v0.30.0 

type SearchUsersAPIClient interface {
	SearchUsers(context.Context, *SearchUsersInput, ...func(*Options)) (*SearchUsersOutput, error)
}

SearchUsersAPIClient is a client that implements the SearchUsers operation.

type SearchUsersInput 

type SearchUsersInput struct {

	// The filters to use for listing a specific set of users. Required. Supported
	// filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
	Filters []types.Filter

	// The maximum number of results to include in the response. If more results exist
	// than the specified MaxResults value, a token is included in the response so that
	// the remaining results can be retrieved. Required.
	MaxResults *int32

	// An optional token returned from a prior request. Use this token for pagination
	// of results from this action. If this parameter is specified, the response
	// includes only results beyond the token, up to the value specified by MaxResults.
	// Required.
	NextToken *string

	// The sort order to use in listing the filtered set of users. Required. Supported
	// sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
	SortCriteria []types.Sort
}

type SearchUsersOutput 

type SearchUsersOutput struct {

	// The token returned to indicate that there is more data available.
	NextToken *string

	// The total number of users returned.
	TotalCount *int32

	// The users that meet the specified set of filter criteria, in sort order.
	Users []types.UserData

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type SearchUsersPaginator added in v0.30.0 

type SearchUsersPaginator struct {
	// contains filtered or unexported fields
}

SearchUsersPaginator is a paginator for SearchUsers

func NewSearchUsersPaginator added in v0.30.0 

func NewSearchUsersPaginator(client SearchUsersAPIClient, params *SearchUsersInput, optFns ...func(*SearchUsersPaginatorOptions)) *SearchUsersPaginator

NewSearchUsersPaginator returns a new SearchUsersPaginator

func (*SearchUsersPaginator) HasMorePages added in v0.30.0 

func (p *SearchUsersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchUsersPaginator) NextPage added in v0.30.0 

func (p *SearchUsersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchUsersOutput, error)

NextPage retrieves the next SearchUsers page.

type SearchUsersPaginatorOptions added in v0.30.0 

type SearchUsersPaginatorOptions struct {
	// The maximum number of results to include in the response. If more results exist
	// than the specified MaxResults value, a token is included in the response so that
	// the remaining results can be retrieved. Required.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

SearchUsersPaginatorOptions is the paginator options for SearchUsers

type SendAnnouncementInput 

type SendAnnouncementInput struct {

	// The unique, user-specified identifier for the request that ensures idempotency.
	//
	// This member is required.
	ClientRequestToken *string

	// The announcement content. This can contain only one of the three possible
	// announcement types (text, SSML or audio).
	//
	// This member is required.
	Content *types.Content

	// The filters to use to send an announcement to a specified list of rooms. The
	// supported filter keys are RoomName, ProfileName, RoomArn, and ProfileArn. To
	// send to all rooms, specify an empty RoomFilters list.
	//
	// This member is required.
	RoomFilters []types.Filter

	// The time to live for an announcement. Default is 300. If delivery doesn't occur
	// within this time, the announcement is not delivered.
	TimeToLiveInSeconds *int32
}

type SendAnnouncementOutput 

type SendAnnouncementOutput struct {

	// The identifier of the announcement.
	AnnouncementArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type SendInvitationInput 

type SendInvitationInput struct {

	// The ARN of the user to whom to send an invitation. Required.
	UserArn *string
}

type SendInvitationOutput 

type SendInvitationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type StartDeviceSyncInput 

type StartDeviceSyncInput struct {

	// Request structure to start the device sync. Required.
	//
	// This member is required.
	Features []types.Feature

	// The ARN of the device to sync. Required.
	DeviceArn *string

	// The ARN of the room with which the device to sync is associated. Required.
	RoomArn *string
}

type StartDeviceSyncOutput 

type StartDeviceSyncOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type StartSmartHomeApplianceDiscoveryInput 

type StartSmartHomeApplianceDiscoveryInput struct {

	// The room where smart home appliance discovery was initiated.
	//
	// This member is required.
	RoomArn *string
}

type StartSmartHomeApplianceDiscoveryOutput 

type StartSmartHomeApplianceDiscoveryOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type TagResourceInput 

type TagResourceInput struct {

	// The ARN of the resource to which to add metadata tags. Required.
	//
	// This member is required.
	Arn *string

	// The tags to be added to the specified resource. Do not provide system tags.
	// Required.
	//
	// This member is required.
	Tags []types.Tag
}

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UntagResourceInput 

type UntagResourceInput struct {

	// The ARN of the resource from which to remove metadata tags. Required.
	//
	// This member is required.
	Arn *string

	// The tags to be removed from the specified resource. Do not provide system tags.
	// Required.
	//
	// This member is required.
	TagKeys []string
}

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateAddressBookInput 

type UpdateAddressBookInput struct {

	// The ARN of the room to update.
	//
	// This member is required.
	AddressBookArn *string

	// The updated description of the room.
	Description *string

	// The updated name of the room.
	Name *string
}

type UpdateAddressBookOutput 

type UpdateAddressBookOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateBusinessReportScheduleInput 

type UpdateBusinessReportScheduleInput struct {

	// The ARN of the business report schedule.
	//
	// This member is required.
	ScheduleArn *string

	// The format of the generated report (individual CSV files or zipped files of
	// individual files).
	Format types.BusinessReportFormat

	// The recurrence of the reports.
	Recurrence *types.BusinessReportRecurrence

	// The S3 location of the output reports.
	S3BucketName *string

	// The S3 key where the report is delivered.
	S3KeyPrefix *string

	// The name identifier of the schedule.
	ScheduleName *string
}

type UpdateBusinessReportScheduleOutput 

type UpdateBusinessReportScheduleOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateConferenceProviderInput 

type UpdateConferenceProviderInput struct {

	// The ARN of the conference provider.
	//
	// This member is required.
	ConferenceProviderArn *string

	// The type of the conference provider.
	//
	// This member is required.
	ConferenceProviderType types.ConferenceProviderType

	// The meeting settings for the conference provider.
	//
	// This member is required.
	MeetingSetting *types.MeetingSetting

	// The IP endpoint and protocol for calling.
	IPDialIn *types.IPDialIn

	// The information for PSTN conferencing.
	PSTNDialIn *types.PSTNDialIn
}

type UpdateConferenceProviderOutput 

type UpdateConferenceProviderOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateContactInput 

type UpdateContactInput struct {

	// The ARN of the contact to update.
	//
	// This member is required.
	ContactArn *string

	// The updated display name of the contact.
	DisplayName *string

	// The updated first name of the contact.
	FirstName *string

	// The updated last name of the contact.
	LastName *string

	// The updated phone number of the contact. The phone number type defaults to WORK.
	// You can either specify PhoneNumber or PhoneNumbers. We recommend that you use
	// PhoneNumbers, which lets you specify the phone number type and multiple numbers.
	PhoneNumber *string

	// The list of phone numbers for the contact.
	PhoneNumbers []types.PhoneNumber

	// The list of SIP addresses for the contact.
	SipAddresses []types.SipAddress
}

type UpdateContactOutput 

type UpdateContactOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateDeviceInput 

type UpdateDeviceInput struct {

	// The ARN of the device to update. Required.
	DeviceArn *string

	// The updated device name. Required.
	DeviceName *string
}

type UpdateDeviceOutput 

type UpdateDeviceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateGatewayGroupInput 

type UpdateGatewayGroupInput struct {

	// The ARN of the gateway group to update.
	//
	// This member is required.
	GatewayGroupArn *string

	// The updated description of the gateway group.
	Description *string

	// The updated name of the gateway group.
	Name *string
}

type UpdateGatewayGroupOutput 

type UpdateGatewayGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateGatewayInput 

type UpdateGatewayInput struct {

	// The ARN of the gateway to update.
	//
	// This member is required.
	GatewayArn *string

	// The updated description of the gateway.
	Description *string

	// The updated name of the gateway.
	Name *string

	// The updated software version of the gateway. The gateway automatically updates
	// its software version during normal operation.
	SoftwareVersion *string
}

type UpdateGatewayOutput 

type UpdateGatewayOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateNetworkProfileInput 

type UpdateNetworkProfileInput struct {

	// The ARN of the network profile associated with a device.
	//
	// This member is required.
	NetworkProfileArn *string

	// The ARN of the Private Certificate Authority (PCA) created in AWS Certificate
	// Manager (ACM). This is used to issue certificates to the devices.
	CertificateAuthorityArn *string

	// The current password of the Wi-Fi network.
	CurrentPassword *string

	// Detailed information about a device's network profile.
	Description *string

	// The name of the network profile associated with a device.
	NetworkProfileName *string

	// The next, or subsequent, password of the Wi-Fi network. This password is
	// asynchronously transmitted to the device and is used when the password of the
	// network changes to NextPassword.
	NextPassword *string

	// The root certificate(s) of your authentication server that will be installed on
	// your devices and used to trust your authentication server during EAP
	// negotiation.
	TrustAnchors []string
}

type UpdateNetworkProfileOutput 

type UpdateNetworkProfileOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateProfileInput 

type UpdateProfileInput struct {

	// The updated address for the room profile.
	Address *string

	// Whether data retention of the profile is enabled.
	DataRetentionOptIn *bool

	// The updated distance unit for the room profile.
	DistanceUnit types.DistanceUnit

	// Sets the profile as default if selected. If this is missing, no update is done
	// to the default status.
	IsDefault *bool

	// The updated locale for the room profile. (This is currently only available to a
	// limited preview audience.)
	Locale *string

	// The updated maximum volume limit for the room profile.
	MaxVolumeLimit *int32

	// The updated meeting room settings of a room profile.
	MeetingRoomConfiguration *types.UpdateMeetingRoomConfiguration

	// Whether the PSTN setting of the room profile is enabled.
	PSTNEnabled *bool

	// The ARN of the room profile to update. Required.
	ProfileArn *string

	// The updated name for the room profile.
	ProfileName *string

	// Whether the setup mode of the profile is enabled.
	SetupModeDisabled *bool

	// The updated temperature unit for the room profile.
	TemperatureUnit types.TemperatureUnit

	// The updated timezone for the room profile.
	Timezone *string

	// The updated wake word for the room profile.
	WakeWord types.WakeWord
}

type UpdateProfileOutput 

type UpdateProfileOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateRoomInput 

type UpdateRoomInput struct {

	// The updated description for the room.
	Description *string

	// The updated profile ARN for the room.
	ProfileArn *string

	// The updated provider calendar ARN for the room.
	ProviderCalendarId *string

	// The ARN of the room to update.
	RoomArn *string

	// The updated name for the room.
	RoomName *string
}

type UpdateRoomOutput 

type UpdateRoomOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateSkillGroupInput 

type UpdateSkillGroupInput struct {

	// The updated description for the skill group.
	Description *string

	// The ARN of the skill group to update.
	SkillGroupArn *string

	// The updated name for the skill group.
	SkillGroupName *string
}

type UpdateSkillGroupOutput 

type UpdateSkillGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.