AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class AddressBook

An address book with attributes.

Class AddressBookData

Information related to an address book.

Class AlreadyExistsException

The resource being created already exists.

Class ApproveSkillRequest

Container for the parameters to the ApproveSkill operation. 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.

Class ApproveSkillResponse

This is the response object from the ApproveSkill operation.

Class AssociateContactWithAddressBookRequest

Container for the parameters to the AssociateContactWithAddressBook operation. Associates a contact with a given address book.

Class AssociateContactWithAddressBookResponse

This is the response object from the AssociateContactWithAddressBook operation.

Class AssociateDeviceWithNetworkProfileRequest

Container for the parameters to the AssociateDeviceWithNetworkProfile operation. Associates a device with the specified network profile.

Class AssociateDeviceWithNetworkProfileResponse

This is the response object from the AssociateDeviceWithNetworkProfile operation.

Class AssociateDeviceWithRoomRequest

Container for the parameters to the AssociateDeviceWithRoom operation. 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.

Class AssociateDeviceWithRoomResponse

This is the response object from the AssociateDeviceWithRoom operation.

Class AssociateSkillGroupWithRoomRequest

Container for the parameters to the AssociateSkillGroupWithRoom operation. Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room.

Class AssociateSkillGroupWithRoomResponse

This is the response object from the AssociateSkillGroupWithRoom operation.

Class AssociateSkillWithSkillGroupRequest

Container for the parameters to the AssociateSkillWithSkillGroup operation. Associates a skill with a skill group.

Class AssociateSkillWithSkillGroupResponse

This is the response object from the AssociateSkillWithSkillGroup operation.

Class AssociateSkillWithUsersRequest

Container for the parameters to the AssociateSkillWithUsers operation. Makes a private skill available for enrolled users to enable on their devices.

Class AssociateSkillWithUsersResponse

This is the response object from the AssociateSkillWithUsers operation.

Class Audio

The audio message. There is a 1 MB limit on the audio file input and the only supported format is MP3. To convert your MP3 audio files to an Alexa-friendly,

required codec version (MPEG version 2) and bit rate (48 kbps), you might use converter software. One option for this is a command-line tool, FFmpeg. For more information, see FFmpeg. The following command converts the provided to an MP3 file that is played in the announcement:

ffmpeg -i -ac 2 -codec:a libmp3lame -b:a 48k -ar 16000

Class BusinessReport

Usage report with specified parameters.

Class BusinessReportContentRange

The content range of the report.

Class BusinessReportRecurrence

The recurrence of the reports.

Class BusinessReportS3Location

The S3 location of the output reports.

Class BusinessReportSchedule

The schedule of the usage report.

Class Category

The skill store category that is shown. Alexa skills are assigned a specific skill category during creation, such as News, Social, and Sports.

Class ConcurrentModificationException

There is a concurrent modification of resources.

Class ConferencePreference

The default conference provider that is used if no other scheduled meetings are detected.

Class ConferenceProvider

An entity that provides a conferencing solution. Alexa for Business acts as the voice interface and mediator that connects users to their preferred conference provider. Examples of conference providers include Amazon Chime, Zoom, Cisco, and Polycom.

Class Contact

A contact with attributes.

Class ContactData

Information related to a contact.

Class Content

The content definition. This can contain only one text, SSML, or audio list object.

Class CreateAddressBookRequest

Container for the parameters to the CreateAddressBook operation. Creates an address book with the specified details.

Class CreateAddressBookResponse

This is the response object from the CreateAddressBook operation.

Class CreateBusinessReportScheduleRequest

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

Class CreateBusinessReportScheduleResponse

This is the response object from the CreateBusinessReportSchedule operation.

Class CreateConferenceProviderRequest

Container for the parameters to the CreateConferenceProvider operation. Adds a new conference provider under the user's AWS account.

Class CreateConferenceProviderResponse

This is the response object from the CreateConferenceProvider operation.

Class CreateContactRequest

Container for the parameters to the CreateContact operation. Creates a contact with the specified details.

Class CreateContactResponse

This is the response object from the CreateContact operation.

Class CreateEndOfMeetingReminder

Creates settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.

Class CreateGatewayGroupRequest

Container for the parameters to the CreateGatewayGroup operation. Creates a gateway group with the specified details.

Class CreateGatewayGroupResponse

This is the response object from the CreateGatewayGroup operation.

Class CreateInstantBooking

Creates settings for the instant booking feature that are applied to a room profile. When users start their meeting with Alexa, Alexa automatically books the room for the configured duration if the room is available.

Class CreateMeetingRoomConfiguration

Creates meeting room settings of a room profile.

Class CreateNetworkProfileRequest

Container for the parameters to the CreateNetworkProfile operation. Creates a network profile with the specified details.

Class CreateNetworkProfileResponse

This is the response object from the CreateNetworkProfile operation.

Class CreateProfileRequest

Container for the parameters to the CreateProfile operation. Creates a new room profile with the specified details.

Class CreateProfileResponse

This is the response object from the CreateProfile operation.

Class CreateRequireCheckIn

Creates settings for the require check in feature that are applied to a room profile. Require check in allows a meeting room’s Alexa or AVS device to prompt the user to check in; otherwise, the room will be released.

Class CreateRoomRequest

Container for the parameters to the CreateRoom operation. Creates a room with the specified details.

Class CreateRoomResponse

This is the response object from the CreateRoom operation.

Class CreateSkillGroupRequest

Container for the parameters to the CreateSkillGroup operation. Creates a skill group with a specified name and description.

Class CreateSkillGroupResponse

This is the response object from the CreateSkillGroup operation.

Class CreateUserRequest

Container for the parameters to the CreateUser operation. Creates a user.

Class CreateUserResponse

This is the response object from the CreateUser operation.

Class DeleteAddressBookRequest

Container for the parameters to the DeleteAddressBook operation. Deletes an address book by the address book ARN.

Class DeleteAddressBookResponse

This is the response object from the DeleteAddressBook operation.

Class DeleteBusinessReportScheduleRequest

Container for the parameters to the DeleteBusinessReportSchedule operation. Deletes the recurring report delivery schedule with the specified schedule ARN.

Class DeleteBusinessReportScheduleResponse

This is the response object from the DeleteBusinessReportSchedule operation.

Class DeleteConferenceProviderRequest

Container for the parameters to the DeleteConferenceProvider operation. Deletes a conference provider.

Class DeleteConferenceProviderResponse

This is the response object from the DeleteConferenceProvider operation.

Class DeleteContactRequest

Container for the parameters to the DeleteContact operation. Deletes a contact by the contact ARN.

Class DeleteContactResponse

This is the response object from the DeleteContact operation.

Class DeleteDeviceRequest

Container for the parameters to the DeleteDevice operation. Removes a device from Alexa For Business.

Class DeleteDeviceResponse

This is the response object from the DeleteDevice operation.

Class DeleteDeviceUsageDataRequest

Container for the parameters to the DeleteDeviceUsageData operation. 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.

Class DeleteDeviceUsageDataResponse

This is the response object from the DeleteDeviceUsageData operation.

Class DeleteGatewayGroupRequest

Container for the parameters to the DeleteGatewayGroup operation. Deletes a gateway group.

Class DeleteGatewayGroupResponse

This is the response object from the DeleteGatewayGroup operation.

Class DeleteNetworkProfileRequest

Container for the parameters to the DeleteNetworkProfile operation. Deletes a network profile by the network profile ARN.

Class DeleteNetworkProfileResponse

This is the response object from the DeleteNetworkProfile operation.

Class DeleteProfileRequest

Container for the parameters to the DeleteProfile operation. Deletes a room profile by the profile ARN.

Class DeleteProfileResponse

This is the response object from the DeleteProfile operation.

Class DeleteRoomRequest

Container for the parameters to the DeleteRoom operation. Deletes a room by the room ARN.

Class DeleteRoomResponse

This is the response object from the DeleteRoom operation.

Class DeleteRoomSkillParameterRequest

Container for the parameters to the DeleteRoomSkillParameter operation. Deletes room skill parameter details by room, skill, and parameter key ID.

Class DeleteRoomSkillParameterResponse

This is the response object from the DeleteRoomSkillParameter operation.

Class DeleteSkillAuthorizationRequest

Container for the parameters to the DeleteSkillAuthorization operation. Unlinks a third-party account from a skill.

Class DeleteSkillAuthorizationResponse

This is the response object from the DeleteSkillAuthorization operation.

Class DeleteSkillGroupRequest

Container for the parameters to the DeleteSkillGroup operation. Deletes a skill group by skill group ARN.

Class DeleteSkillGroupResponse

This is the response object from the DeleteSkillGroup operation.

Class DeleteUserRequest

Container for the parameters to the DeleteUser operation. Deletes a specified user by user ARN and enrollment ARN.

Class DeleteUserResponse

This is the response object from the DeleteUser operation.

Class DeveloperInfo

The details about the developer that published the skill.

Class Device

A device with attributes.

Class DeviceData

Device attributes.

Class DeviceEvent

The list of device events.

Class DeviceNetworkProfileInfo

Detailed information about a device's network profile.

Class DeviceNotRegisteredException

The request failed because this device is no longer registered and therefore no longer managed by this account.

Class DeviceStatusDetail

Details of a device’s status.

Class DeviceStatusInfo

Detailed information about a device's status.

Class DisassociateContactFromAddressBookRequest

Container for the parameters to the DisassociateContactFromAddressBook operation. Disassociates a contact from a given address book.

Class DisassociateContactFromAddressBookResponse

This is the response object from the DisassociateContactFromAddressBook operation.

Class DisassociateDeviceFromRoomRequest

Container for the parameters to the DisassociateDeviceFromRoom operation. 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.

Class DisassociateDeviceFromRoomResponse

This is the response object from the DisassociateDeviceFromRoom operation.

Class DisassociateSkillFromSkillGroupRequest

Container for the parameters to the DisassociateSkillFromSkillGroup operation. Disassociates a skill from a skill group.

Class DisassociateSkillFromSkillGroupResponse

This is the response object from the DisassociateSkillFromSkillGroup operation.

Class DisassociateSkillFromUsersRequest

Container for the parameters to the DisassociateSkillFromUsers operation. Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.

Class DisassociateSkillFromUsersResponse

This is the response object from the DisassociateSkillFromUsers operation.

Class DisassociateSkillGroupFromRoomRequest

Container for the parameters to the DisassociateSkillGroupFromRoom operation. Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.

Class DisassociateSkillGroupFromRoomResponse

This is the response object from the DisassociateSkillGroupFromRoom operation.

Class EndOfMeetingReminder

Settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.

Class Filter

A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria.

Class ForgetSmartHomeAppliancesRequest

Container for the parameters to the ForgetSmartHomeAppliances operation. Forgets smart home appliances associated to a room.

Class ForgetSmartHomeAppliancesResponse

This is the response object from the ForgetSmartHomeAppliances operation.

Class Gateway

The details of the gateway.

Class GatewayGroup

The details of the gateway group.

Class GatewayGroupSummary

The summary of a gateway group.

Class GatewaySummary

The summary of a gateway.

Class GetAddressBookRequest

Container for the parameters to the GetAddressBook operation. Gets address the book details by the address book ARN.

Class GetAddressBookResponse

This is the response object from the GetAddressBook operation.

Class GetConferencePreferenceRequest

Container for the parameters to the GetConferencePreference operation. Retrieves the existing conference preferences.

Class GetConferencePreferenceResponse

This is the response object from the GetConferencePreference operation.

Class GetConferenceProviderRequest

Container for the parameters to the GetConferenceProvider operation. Gets details about a specific conference provider.

Class GetConferenceProviderResponse

This is the response object from the GetConferenceProvider operation.

Class GetContactRequest

Container for the parameters to the GetContact operation. Gets the contact details by the contact ARN.

Class GetContactResponse

This is the response object from the GetContact operation.

Class GetDeviceRequest

Container for the parameters to the GetDevice operation. Gets the details of a device by device ARN.

Class GetDeviceResponse

This is the response object from the GetDevice operation.

Class GetGatewayGroupRequest

Container for the parameters to the GetGatewayGroup operation. Retrieves the details of a gateway group.

Class GetGatewayGroupResponse

This is the response object from the GetGatewayGroup operation.

Class GetGatewayRequest

Container for the parameters to the GetGateway operation. Retrieves the details of a gateway.

Class GetGatewayResponse

This is the response object from the GetGateway operation.

Class GetInvitationConfigurationRequest

Container for the parameters to the GetInvitationConfiguration operation. Retrieves the configured values for the user enrollment invitation email template.

Class GetInvitationConfigurationResponse

This is the response object from the GetInvitationConfiguration operation.

Class GetNetworkProfileRequest

Container for the parameters to the GetNetworkProfile operation. Gets the network profile details by the network profile ARN.

Class GetNetworkProfileResponse

This is the response object from the GetNetworkProfile operation.

Class GetProfileRequest

Container for the parameters to the GetProfile operation. Gets the details of a room profile by profile ARN.

Class GetProfileResponse

This is the response object from the GetProfile operation.

Class GetRoomRequest

Container for the parameters to the GetRoom operation. Gets room details by room ARN.

Class GetRoomResponse

This is the response object from the GetRoom operation.

Class GetRoomSkillParameterRequest

Container for the parameters to the GetRoomSkillParameter operation. Gets room skill parameter details by room, skill, and parameter key ARN.

Class GetRoomSkillParameterResponse

This is the response object from the GetRoomSkillParameter operation.

Class GetSkillGroupRequest

Container for the parameters to the GetSkillGroup operation. Gets skill group details by skill group ARN.

Class GetSkillGroupResponse

This is the response object from the GetSkillGroup operation.

Class InstantBooking

Settings for the instant booking feature that are applied to a room profile. When users start their meeting with Alexa, Alexa automatically books the room for the configured duration if the room is available.

Class InvalidCertificateAuthorityException

The Certificate Authority can't issue or revoke a certificate.

Class InvalidDeviceException

The device is in an invalid state.

Class InvalidSecretsManagerResourceException

A password in SecretsManager is in an invalid state.

Class InvalidServiceLinkedRoleStateException

The service linked role is locked for deletion.

Class InvalidUserStatusException

The attempt to update a user is invalid due to the user's current status.

Class IPDialIn

The IP endpoint and protocol for calling.

Class LimitExceededException

You are performing an action that would put you beyond your account's limits.

Class ListBusinessReportSchedulesRequest

Container for the parameters to the ListBusinessReportSchedules operation. 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.

Class ListBusinessReportSchedulesResponse

This is the response object from the ListBusinessReportSchedules operation.

Class ListConferenceProvidersRequest

Container for the parameters to the ListConferenceProviders operation. Lists conference providers under a specific AWS account.

Class ListConferenceProvidersResponse

This is the response object from the ListConferenceProviders operation.

Class ListDeviceEventsRequest

Container for the parameters to the ListDeviceEvents operation. Lists the device event history, including device connection status, for up to 30 days.

Class ListDeviceEventsResponse

This is the response object from the ListDeviceEvents operation.

Class ListGatewayGroupsRequest

Container for the parameters to the ListGatewayGroups operation. Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group.

Class ListGatewayGroupsResponse

This is the response object from the ListGatewayGroups operation.

Class ListGatewaysRequest

Container for the parameters to the ListGateways operation. 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.

Class ListGatewaysResponse

This is the response object from the ListGateways operation.

Class ListSkillsRequest

Container for the parameters to the ListSkills operation. Lists all enabled skills in a specific skill group.

Class ListSkillsResponse

This is the response object from the ListSkills operation.

Class ListSkillsStoreCategoriesRequest

Container for the parameters to the ListSkillsStoreCategories operation. Lists all categories in the Alexa skill store.

Class ListSkillsStoreCategoriesResponse

This is the response object from the ListSkillsStoreCategories operation.

Class ListSkillsStoreSkillsByCategoryRequest

Container for the parameters to the ListSkillsStoreSkillsByCategory operation. Lists all skills in the Alexa skill store by category.

Class ListSkillsStoreSkillsByCategoryResponse

This is the response object from the ListSkillsStoreSkillsByCategory operation.

Class ListSmartHomeAppliancesRequest

Container for the parameters to the ListSmartHomeAppliances operation. Lists all of the smart home appliances associated with a room.

Class ListSmartHomeAppliancesResponse

This is the response object from the ListSmartHomeAppliances operation.

Class ListTagsRequest

Container for the parameters to the ListTags operation. Lists all tags for the specified resource.

Class ListTagsResponse

This is the response object from the ListTags operation.

Class MeetingRoomConfiguration

Meeting room settings of a room profile.

Class MeetingSetting

The values that indicate whether a pin is always required (YES), never required (NO), or OPTIONAL.

  • If YES, Alexa will always ask for a meeting pin.

  • If NO, Alexa will never ask for a meeting pin.

  • If OPTIONAL, Alexa will ask if you have a meeting pin and if the customer responds with yes, it will ask for the meeting pin.

Class NameInUseException

The name sent in the request is already in use.

Class NetworkProfile

The network profile associated with a device.

Class NetworkProfileData

The data associated with a network profile.

Class NotFoundException

The resource is not found.

Class PhoneNumber

The phone number for the contact containing the raw number and phone number type.

Class Profile

A room profile with attributes.

Class ProfileData

The data of a room profile.

Class PSTNDialIn

The information for public switched telephone network (PSTN) conferencing.

Class PutConferencePreferenceRequest

Container for the parameters to the PutConferencePreference operation. Sets the conference preferences on a specific conference provider at the account level.

Class PutConferencePreferenceResponse

This is the response object from the PutConferencePreference operation.

Class PutInvitationConfigurationRequest

Container for the parameters to the PutInvitationConfiguration operation. Configures the email template for the user enrollment invitation with the specified attributes.

Class PutInvitationConfigurationResponse

This is the response object from the PutInvitationConfiguration operation.

Class PutRoomSkillParameterRequest

Container for the parameters to the PutRoomSkillParameter operation. Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.

Class PutRoomSkillParameterResponse

This is the response object from the PutRoomSkillParameter operation.

Class PutSkillAuthorizationRequest

Container for the parameters to the PutSkillAuthorization operation. 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.

Class PutSkillAuthorizationResponse

This is the response object from the PutSkillAuthorization operation.

Class RegisterAVSDeviceRequest

Container for the parameters to the RegisterAVSDevice operation. Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).

Class RegisterAVSDeviceResponse

This is the response object from the RegisterAVSDevice operation.

Class RejectSkillRequest

Container for the parameters to the RejectSkill operation. 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.

Class RejectSkillResponse

This is the response object from the RejectSkill operation.

Class RequireCheckIn

Settings for the require check in feature that are applied to a room profile. Require check in allows a meeting room’s Alexa or AVS device to prompt the user to check in; otherwise, the room will be released.

Class ResolveRoomRequest

Container for the parameters to the ResolveRoom operation. Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.

Class ResolveRoomResponse

This is the response object from the ResolveRoom operation.

Class ResourceAssociatedException

Another resource is associated with the resource in the request.

Class ResourceInUseException

The resource in the request is already in use.

Class RevokeInvitationRequest

Container for the parameters to the RevokeInvitation operation. Revokes an invitation and invalidates the enrollment URL.

Class RevokeInvitationResponse

This is the response object from the RevokeInvitation operation.

Class Room

A room with attributes.

Class RoomData

The data of a room.

Class RoomSkillParameter

A skill parameter associated with a room.

Class SearchAddressBooksRequest

Container for the parameters to the SearchAddressBooks operation. Searches address books and lists the ones that meet a set of filter and sort criteria.

Class SearchAddressBooksResponse

This is the response object from the SearchAddressBooks operation.

Class SearchContactsRequest

Container for the parameters to the SearchContacts operation. Searches contacts and lists the ones that meet a set of filter and sort criteria.

Class SearchContactsResponse

This is the response object from the SearchContacts operation.

Class SearchDevicesRequest

Container for the parameters to the SearchDevices operation. Searches devices and lists the ones that meet a set of filter criteria.

Class SearchDevicesResponse

This is the response object from the SearchDevices operation.

Class SearchNetworkProfilesRequest

Container for the parameters to the SearchNetworkProfiles operation. Searches network profiles and lists the ones that meet a set of filter and sort criteria.

Class SearchNetworkProfilesResponse

This is the response object from the SearchNetworkProfiles operation.

Class SearchProfilesRequest

Container for the parameters to the SearchProfiles operation. Searches room profiles and lists the ones that meet a set of filter criteria.

Class SearchProfilesResponse

This is the response object from the SearchProfiles operation.

Class SearchRoomsRequest

Container for the parameters to the SearchRooms operation. Searches rooms and lists the ones that meet a set of filter and sort criteria.

Class SearchRoomsResponse

This is the response object from the SearchRooms operation.

Class SearchSkillGroupsRequest

Container for the parameters to the SearchSkillGroups operation. Searches skill groups and lists the ones that meet a set of filter and sort criteria.

Class SearchSkillGroupsResponse

This is the response object from the SearchSkillGroups operation.

Class SearchUsersRequest

Container for the parameters to the SearchUsers operation. Searches users and lists the ones that meet a set of filter and sort criteria.

Class SearchUsersResponse

This is the response object from the SearchUsers operation.

Class SendAnnouncementRequest

Container for the parameters to the SendAnnouncement operation. Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter.

Class SendAnnouncementResponse

This is the response object from the SendAnnouncement operation.

Class SendInvitationRequest

Container for the parameters to the SendInvitation operation. 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.

Class SendInvitationResponse

This is the response object from the SendInvitation operation.

Class SipAddress

The SIP address for the contact containing the URI and SIP address type.

Class SkillDetails

Granular information about the skill.

Class SkillGroup

A skill group with attributes.

Class SkillGroupData

The attributes of a skill group.

Class SkillNotLinkedException

The skill must be linked to a third-party account.

Class SkillsStoreSkill

The detailed information about an Alexa skill.

Class SkillSummary

The summary of skills.

Class SmartHomeAppliance

A smart home appliance that can connect to a central system. Any domestic device can be a smart appliance.

Class Sort

An object representing a sort criteria.

Class Ssml

The SSML message. For more information, see SSML Reference.

Class StartDeviceSyncRequest

Container for the parameters to the StartDeviceSync operation. 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).

Class StartDeviceSyncResponse

This is the response object from the StartDeviceSync operation.

Class StartSmartHomeApplianceDiscoveryRequest

Container for the parameters to the StartSmartHomeApplianceDiscovery operation. Initiates the discovery of any smart home appliances associated with the room.

Class StartSmartHomeApplianceDiscoveryResponse

This is the response object from the StartSmartHomeApplianceDiscovery operation.

Class Tag

A key-value pair that can be associated with a resource.

Class TagResourceRequest

Container for the parameters to the TagResource operation. Adds metadata tags to a specified resource.

Class TagResourceResponse

This is the response object from the TagResource operation.

Class Text

The text message.

Class UnauthorizedException

The caller has no permissions to operate on the resource involved in the API call.

Class UntagResourceRequest

Container for the parameters to the UntagResource operation. Removes metadata tags from a specified resource.

Class UntagResourceResponse

This is the response object from the UntagResource operation.

Class UpdateAddressBookRequest

Container for the parameters to the UpdateAddressBook operation. Updates address book details by the address book ARN.

Class UpdateAddressBookResponse

This is the response object from the UpdateAddressBook operation.

Class UpdateBusinessReportScheduleRequest

Container for the parameters to the UpdateBusinessReportSchedule operation. Updates the configuration of the report delivery schedule with the specified schedule ARN.

Class UpdateBusinessReportScheduleResponse

This is the response object from the UpdateBusinessReportSchedule operation.

Class UpdateConferenceProviderRequest

Container for the parameters to the UpdateConferenceProvider operation. Updates an existing conference provider's settings.

Class UpdateConferenceProviderResponse

This is the response object from the UpdateConferenceProvider operation.

Class UpdateContactRequest

Container for the parameters to the UpdateContact operation. Updates the contact details by the contact ARN.

Class UpdateContactResponse

This is the response object from the UpdateContact operation.

Class UpdateDeviceRequest

Container for the parameters to the UpdateDevice operation. Updates the device name by device ARN.

Class UpdateDeviceResponse

This is the response object from the UpdateDevice operation.

Class UpdateEndOfMeetingReminder

Settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.

Class UpdateGatewayGroupRequest

Container for the parameters to the UpdateGatewayGroup operation. Updates the details of a gateway group. If any optional field is not provided, the existing corresponding value is left unmodified.

Class UpdateGatewayGroupResponse

This is the response object from the UpdateGatewayGroup operation.

Class UpdateGatewayRequest

Container for the parameters to the UpdateGateway operation. Updates the details of a gateway. If any optional field is not provided, the existing corresponding value is left unmodified.

Class UpdateGatewayResponse

This is the response object from the UpdateGateway operation.

Class UpdateInstantBooking

Updates settings for the instant booking feature that are applied to a room profile. If instant booking is enabled, Alexa automatically reserves a room if it is free when a user joins a meeting with Alexa.

Class UpdateMeetingRoomConfiguration

Updates meeting room settings of a room profile.

Class UpdateNetworkProfileRequest

Container for the parameters to the UpdateNetworkProfile operation. Updates a network profile by the network profile ARN.

Class UpdateNetworkProfileResponse

This is the response object from the UpdateNetworkProfile operation.

Class UpdateProfileRequest

Container for the parameters to the UpdateProfile operation. Updates an existing room profile by room profile ARN.

Class UpdateProfileResponse

This is the response object from the UpdateProfile operation.

Class UpdateRequireCheckIn

Updates settings for the require check in feature that are applied to a room profile. Require check in allows a meeting room’s Alexa or AVS device to prompt the user to check in; otherwise, the room will be released.

Class UpdateRoomRequest

Container for the parameters to the UpdateRoom operation. Updates room details by room ARN.

Class UpdateRoomResponse

This is the response object from the UpdateRoom operation.

Class UpdateSkillGroupRequest

Container for the parameters to the UpdateSkillGroup operation. Updates skill group details by skill group ARN.

Class UpdateSkillGroupResponse

This is the response object from the UpdateSkillGroup operation.

Class UserData

Information related to a user.