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.

Implementation for accessing AlexaForBusiness

Alexa for Business has been retired and is no longer supported.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.AlexaForBusiness.AmazonAlexaForBusinessClient

Namespace: Amazon.AlexaForBusiness
Assembly: AWSSDK.AlexaForBusiness.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonAlexaForBusinessClient : AmazonServiceClient
         IAmazonAlexaForBusiness, IAmazonService, IDisposable

The AmazonAlexaForBusinessClient type exposes the following members

Constructors

NameDescription
Public Method AmazonAlexaForBusinessClient()

Constructs AmazonAlexaForBusinessClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             

Public Method AmazonAlexaForBusinessClient(RegionEndpoint)

Constructs AmazonAlexaForBusinessClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             

Public Method AmazonAlexaForBusinessClient(AmazonAlexaForBusinessConfig)

Constructs AmazonAlexaForBusinessClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             

Public Method AmazonAlexaForBusinessClient(AWSCredentials)

Constructs AmazonAlexaForBusinessClient with AWS Credentials

Public Method AmazonAlexaForBusinessClient(AWSCredentials, RegionEndpoint)

Constructs AmazonAlexaForBusinessClient with AWS Credentials

Public Method AmazonAlexaForBusinessClient(AWSCredentials, AmazonAlexaForBusinessConfig)

Constructs AmazonAlexaForBusinessClient with AWS Credentials and an AmazonAlexaForBusinessClient Configuration object.

Public Method AmazonAlexaForBusinessClient(string, string)

Constructs AmazonAlexaForBusinessClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAlexaForBusinessClient(string, string, RegionEndpoint)

Constructs AmazonAlexaForBusinessClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAlexaForBusinessClient(string, string, AmazonAlexaForBusinessConfig)

Constructs AmazonAlexaForBusinessClient with AWS Access Key ID, AWS Secret Key and an AmazonAlexaForBusinessClient Configuration object.

Public Method AmazonAlexaForBusinessClient(string, string, string)

Constructs AmazonAlexaForBusinessClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAlexaForBusinessClient(string, string, string, RegionEndpoint)

Constructs AmazonAlexaForBusinessClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAlexaForBusinessClient(string, string, string, AmazonAlexaForBusinessConfig)

Constructs AmazonAlexaForBusinessClient with AWS Access Key ID, AWS Secret Key and an AmazonAlexaForBusinessClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.
Public Property Paginators Amazon.AlexaForBusiness.Model.IAlexaForBusinessPaginatorFactory

Paginators for the service

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method ApproveSkill(ApproveSkillRequest)

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.

Public Method ApproveSkillAsync(ApproveSkillRequest, CancellationToken)

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.

Public Method AssociateContactWithAddressBook(AssociateContactWithAddressBookRequest)

Associates a contact with a given address book.

Public Method AssociateContactWithAddressBookAsync(AssociateContactWithAddressBookRequest, CancellationToken)

Associates a contact with a given address book.

Public Method AssociateDeviceWithNetworkProfile(AssociateDeviceWithNetworkProfileRequest)

Associates a device with the specified network profile.

Public Method AssociateDeviceWithNetworkProfileAsync(AssociateDeviceWithNetworkProfileRequest, CancellationToken)

Associates a device with the specified network profile.

Public Method AssociateDeviceWithRoom(AssociateDeviceWithRoomRequest)

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.

Public Method AssociateDeviceWithRoomAsync(AssociateDeviceWithRoomRequest, CancellationToken)

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.

Public Method AssociateSkillGroupWithRoom(AssociateSkillGroupWithRoomRequest)

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

Public Method AssociateSkillGroupWithRoomAsync(AssociateSkillGroupWithRoomRequest, CancellationToken)

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

Public Method AssociateSkillWithSkillGroup(AssociateSkillWithSkillGroupRequest)

Associates a skill with a skill group.

Public Method AssociateSkillWithSkillGroupAsync(AssociateSkillWithSkillGroupRequest, CancellationToken)

Associates a skill with a skill group.

Public Method AssociateSkillWithUsers(AssociateSkillWithUsersRequest)

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

Public Method AssociateSkillWithUsersAsync(AssociateSkillWithUsersRequest, CancellationToken)

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

Public Method CreateAddressBook(CreateAddressBookRequest)

Creates an address book with the specified details.

Public Method CreateAddressBookAsync(CreateAddressBookRequest, CancellationToken)

Creates an address book with the specified details.

Public Method CreateBusinessReportSchedule(CreateBusinessReportScheduleRequest)

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

Public Method CreateBusinessReportScheduleAsync(CreateBusinessReportScheduleRequest, CancellationToken)

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

Public Method CreateConferenceProvider(CreateConferenceProviderRequest)

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

Public Method CreateConferenceProviderAsync(CreateConferenceProviderRequest, CancellationToken)

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

Public Method CreateContact(CreateContactRequest)

Creates a contact with the specified details.

Public Method CreateContactAsync(CreateContactRequest, CancellationToken)

Creates a contact with the specified details.

Public Method CreateGatewayGroup(CreateGatewayGroupRequest)

Creates a gateway group with the specified details.

Public Method CreateGatewayGroupAsync(CreateGatewayGroupRequest, CancellationToken)

Creates a gateway group with the specified details.

Public Method CreateNetworkProfile(CreateNetworkProfileRequest)

Creates a network profile with the specified details.

Public Method CreateNetworkProfileAsync(CreateNetworkProfileRequest, CancellationToken)

Creates a network profile with the specified details.

Public Method CreateProfile(CreateProfileRequest)

Creates a new room profile with the specified details.

Public Method CreateProfileAsync(CreateProfileRequest, CancellationToken)

Creates a new room profile with the specified details.

Public Method CreateRoom(CreateRoomRequest)

Creates a room with the specified details.

Public Method CreateRoomAsync(CreateRoomRequest, CancellationToken)

Creates a room with the specified details.

Public Method CreateSkillGroup(CreateSkillGroupRequest)

Creates a skill group with a specified name and description.

Public Method CreateSkillGroupAsync(CreateSkillGroupRequest, CancellationToken)

Creates a skill group with a specified name and description.

Public Method CreateUser(CreateUserRequest)

Creates a user.

Public Method CreateUserAsync(CreateUserRequest, CancellationToken)

Creates a user.

Public Method DeleteAddressBook(DeleteAddressBookRequest)

Deletes an address book by the address book ARN.

Public Method DeleteAddressBookAsync(DeleteAddressBookRequest, CancellationToken)

Deletes an address book by the address book ARN.

Public Method DeleteBusinessReportSchedule(DeleteBusinessReportScheduleRequest)

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

Public Method DeleteBusinessReportScheduleAsync(DeleteBusinessReportScheduleRequest, CancellationToken)

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

Public Method DeleteConferenceProvider(DeleteConferenceProviderRequest)

Deletes a conference provider.

Public Method DeleteConferenceProviderAsync(DeleteConferenceProviderRequest, CancellationToken)

Deletes a conference provider.

Public Method DeleteContact(DeleteContactRequest)

Deletes a contact by the contact ARN.

Public Method DeleteContactAsync(DeleteContactRequest, CancellationToken)

Deletes a contact by the contact ARN.

Public Method DeleteDevice(DeleteDeviceRequest)

Removes a device from Alexa For Business.

Public Method DeleteDeviceAsync(DeleteDeviceRequest, CancellationToken)

Removes a device from Alexa For Business.

Public Method DeleteDeviceUsageData(DeleteDeviceUsageDataRequest)

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.

Public Method DeleteDeviceUsageDataAsync(DeleteDeviceUsageDataRequest, CancellationToken)

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.

Public Method DeleteGatewayGroup(DeleteGatewayGroupRequest)

Deletes a gateway group.

Public Method DeleteGatewayGroupAsync(DeleteGatewayGroupRequest, CancellationToken)

Deletes a gateway group.

Public Method DeleteNetworkProfile(DeleteNetworkProfileRequest)

Deletes a network profile by the network profile ARN.

Public Method DeleteNetworkProfileAsync(DeleteNetworkProfileRequest, CancellationToken)

Deletes a network profile by the network profile ARN.

Public Method DeleteProfile(DeleteProfileRequest)

Deletes a room profile by the profile ARN.

Public Method DeleteProfileAsync(DeleteProfileRequest, CancellationToken)

Deletes a room profile by the profile ARN.

Public Method DeleteRoom(DeleteRoomRequest)

Deletes a room by the room ARN.

Public Method DeleteRoomAsync(DeleteRoomRequest, CancellationToken)

Deletes a room by the room ARN.

Public Method DeleteRoomSkillParameter(DeleteRoomSkillParameterRequest)

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

Public Method DeleteRoomSkillParameterAsync(DeleteRoomSkillParameterRequest, CancellationToken)

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

Public Method DeleteSkillAuthorization(DeleteSkillAuthorizationRequest)

Unlinks a third-party account from a skill.

Public Method DeleteSkillAuthorizationAsync(DeleteSkillAuthorizationRequest, CancellationToken)

Unlinks a third-party account from a skill.

Public Method DeleteSkillGroup(DeleteSkillGroupRequest)

Deletes a skill group by skill group ARN.

Public Method DeleteSkillGroupAsync(DeleteSkillGroupRequest, CancellationToken)

Deletes a skill group by skill group ARN.

Public Method DeleteUser(DeleteUserRequest)

Deletes a specified user by user ARN and enrollment ARN.

Public Method DeleteUserAsync(DeleteUserRequest, CancellationToken)

Deletes a specified user by user ARN and enrollment ARN.

Public Method DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

Public Method DisassociateContactFromAddressBook(DisassociateContactFromAddressBookRequest)

Disassociates a contact from a given address book.

Public Method DisassociateContactFromAddressBookAsync(DisassociateContactFromAddressBookRequest, CancellationToken)

Disassociates a contact from a given address book.

Public Method DisassociateDeviceFromRoom(DisassociateDeviceFromRoomRequest)

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.

Public Method DisassociateDeviceFromRoomAsync(DisassociateDeviceFromRoomRequest, CancellationToken)

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.

Public Method DisassociateSkillFromSkillGroup(DisassociateSkillFromSkillGroupRequest)

Disassociates a skill from a skill group.

Public Method DisassociateSkillFromSkillGroupAsync(DisassociateSkillFromSkillGroupRequest, CancellationToken)

Disassociates a skill from a skill group.

Public Method DisassociateSkillFromUsers(DisassociateSkillFromUsersRequest)

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

Public Method DisassociateSkillFromUsersAsync(DisassociateSkillFromUsersRequest, CancellationToken)

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

Public Method DisassociateSkillGroupFromRoom(DisassociateSkillGroupFromRoomRequest)

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

Public Method DisassociateSkillGroupFromRoomAsync(DisassociateSkillGroupFromRoomRequest, CancellationToken)

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

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method ForgetSmartHomeAppliances(ForgetSmartHomeAppliancesRequest)

Forgets smart home appliances associated to a room.

Public Method ForgetSmartHomeAppliancesAsync(ForgetSmartHomeAppliancesRequest, CancellationToken)

Forgets smart home appliances associated to a room.

Public Method GetAddressBook(GetAddressBookRequest)

Gets address the book details by the address book ARN.

Public Method GetAddressBookAsync(GetAddressBookRequest, CancellationToken)

Gets address the book details by the address book ARN.

Public Method GetConferencePreference(GetConferencePreferenceRequest)

Retrieves the existing conference preferences.

Public Method GetConferencePreferenceAsync(GetConferencePreferenceRequest, CancellationToken)

Retrieves the existing conference preferences.

Public Method GetConferenceProvider(GetConferenceProviderRequest)

Gets details about a specific conference provider.

Public Method GetConferenceProviderAsync(GetConferenceProviderRequest, CancellationToken)

Gets details about a specific conference provider.

Public Method GetContact(GetContactRequest)

Gets the contact details by the contact ARN.

Public Method GetContactAsync(GetContactRequest, CancellationToken)

Gets the contact details by the contact ARN.

Public Method GetDevice(GetDeviceRequest)

Gets the details of a device by device ARN.

Public Method GetDeviceAsync(GetDeviceRequest, CancellationToken)

Gets the details of a device by device ARN.

Public Method GetGateway(GetGatewayRequest)

Retrieves the details of a gateway.

Public Method GetGatewayAsync(GetGatewayRequest, CancellationToken)

Retrieves the details of a gateway.

Public Method GetGatewayGroup(GetGatewayGroupRequest)

Retrieves the details of a gateway group.

Public Method GetGatewayGroupAsync(GetGatewayGroupRequest, CancellationToken)

Retrieves the details of a gateway group.

Public Method GetInvitationConfiguration(GetInvitationConfigurationRequest)

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

Public Method GetInvitationConfigurationAsync(GetInvitationConfigurationRequest, CancellationToken)

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

Public Method GetNetworkProfile(GetNetworkProfileRequest)

Gets the network profile details by the network profile ARN.

Public Method GetNetworkProfileAsync(GetNetworkProfileRequest, CancellationToken)

Gets the network profile details by the network profile ARN.

Public Method GetProfile(GetProfileRequest)

Gets the details of a room profile by profile ARN.

Public Method GetProfileAsync(GetProfileRequest, CancellationToken)

Gets the details of a room profile by profile ARN.

Public Method GetRoom(GetRoomRequest)

Gets room details by room ARN.

Public Method GetRoomAsync(GetRoomRequest, CancellationToken)

Gets room details by room ARN.

Public Method GetRoomSkillParameter(GetRoomSkillParameterRequest)

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

Public Method GetRoomSkillParameterAsync(GetRoomSkillParameterRequest, CancellationToken)

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

Public Method GetSkillGroup(GetSkillGroupRequest)

Gets skill group details by skill group ARN.

Public Method GetSkillGroupAsync(GetSkillGroupRequest, CancellationToken)

Gets skill group details by skill group ARN.

Public Method ListBusinessReportSchedules(ListBusinessReportSchedulesRequest)

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.

Public Method ListBusinessReportSchedulesAsync(ListBusinessReportSchedulesRequest, CancellationToken)

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.

Public Method ListConferenceProviders(ListConferenceProvidersRequest)

Lists conference providers under a specific AWS account.

Public Method ListConferenceProvidersAsync(ListConferenceProvidersRequest, CancellationToken)

Lists conference providers under a specific AWS account.

Public Method ListDeviceEvents(ListDeviceEventsRequest)

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

Public Method ListDeviceEventsAsync(ListDeviceEventsRequest, CancellationToken)

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

Public Method ListGatewayGroups(ListGatewayGroupsRequest)

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

Public Method ListGatewayGroupsAsync(ListGatewayGroupsRequest, CancellationToken)

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

Public Method ListGateways(ListGatewaysRequest)

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.

Public Method ListGatewaysAsync(ListGatewaysRequest, CancellationToken)

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.

Public Method ListSkills(ListSkillsRequest)

Lists all enabled skills in a specific skill group.

Public Method ListSkillsAsync(ListSkillsRequest, CancellationToken)

Lists all enabled skills in a specific skill group.

Public Method ListSkillsStoreCategories(ListSkillsStoreCategoriesRequest)

Lists all categories in the Alexa skill store.

Public Method ListSkillsStoreCategoriesAsync(ListSkillsStoreCategoriesRequest, CancellationToken)

Lists all categories in the Alexa skill store.

Public Method ListSkillsStoreSkillsByCategory(ListSkillsStoreSkillsByCategoryRequest)

Lists all skills in the Alexa skill store by category.

Public Method ListSkillsStoreSkillsByCategoryAsync(ListSkillsStoreSkillsByCategoryRequest, CancellationToken)

Lists all skills in the Alexa skill store by category.

Public Method ListSmartHomeAppliances(ListSmartHomeAppliancesRequest)

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

Public Method ListSmartHomeAppliancesAsync(ListSmartHomeAppliancesRequest, CancellationToken)

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

Public Method ListTags(ListTagsRequest)

Lists all tags for the specified resource.

Public Method ListTagsAsync(ListTagsRequest, CancellationToken)

Lists all tags for the specified resource.

Public Method PutConferencePreference(PutConferencePreferenceRequest)

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

Public Method PutConferencePreferenceAsync(PutConferencePreferenceRequest, CancellationToken)

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

Public Method PutInvitationConfiguration(PutInvitationConfigurationRequest)

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

Public Method PutInvitationConfigurationAsync(PutInvitationConfigurationRequest, CancellationToken)

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

Public Method PutRoomSkillParameter(PutRoomSkillParameterRequest)

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

Public Method PutRoomSkillParameterAsync(PutRoomSkillParameterRequest, CancellationToken)

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

Public Method PutSkillAuthorization(PutSkillAuthorizationRequest)

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.

Public Method PutSkillAuthorizationAsync(PutSkillAuthorizationRequest, CancellationToken)

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.

Public Method RegisterAVSDevice(RegisterAVSDeviceRequest)

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

Public Method RegisterAVSDeviceAsync(RegisterAVSDeviceRequest, CancellationToken)

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

Public Method RejectSkill(RejectSkillRequest)

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.

Public Method RejectSkillAsync(RejectSkillRequest, CancellationToken)

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.

Public Method ResolveRoom(ResolveRoomRequest)

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.

Public Method ResolveRoomAsync(ResolveRoomRequest, CancellationToken)

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.

Public Method RevokeInvitation(RevokeInvitationRequest)

Revokes an invitation and invalidates the enrollment URL.

Public Method RevokeInvitationAsync(RevokeInvitationRequest, CancellationToken)

Revokes an invitation and invalidates the enrollment URL.

Public Method SearchAddressBooks(SearchAddressBooksRequest)

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

Public Method SearchAddressBooksAsync(SearchAddressBooksRequest, CancellationToken)

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

Public Method SearchContacts(SearchContactsRequest)

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

Public Method SearchContactsAsync(SearchContactsRequest, CancellationToken)

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

Public Method SearchDevices(SearchDevicesRequest)

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

Public Method SearchDevicesAsync(SearchDevicesRequest, CancellationToken)

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

Public Method SearchNetworkProfiles(SearchNetworkProfilesRequest)

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

Public Method SearchNetworkProfilesAsync(SearchNetworkProfilesRequest, CancellationToken)

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

Public Method SearchProfiles(SearchProfilesRequest)

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

Public Method SearchProfilesAsync(SearchProfilesRequest, CancellationToken)

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

Public Method SearchRooms(SearchRoomsRequest)

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

Public Method SearchRoomsAsync(SearchRoomsRequest, CancellationToken)

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

Public Method SearchSkillGroups(SearchSkillGroupsRequest)

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

Public Method SearchSkillGroupsAsync(SearchSkillGroupsRequest, CancellationToken)

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

Public Method SearchUsers(SearchUsersRequest)

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

Public Method SearchUsersAsync(SearchUsersRequest, CancellationToken)

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

Public Method SendAnnouncement(SendAnnouncementRequest)

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

Public Method SendAnnouncementAsync(SendAnnouncementRequest, CancellationToken)

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

Public Method SendInvitation(SendInvitationRequest)

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.

Public Method SendInvitationAsync(SendInvitationRequest, CancellationToken)

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.

Public Method StartDeviceSync(StartDeviceSyncRequest)

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).

Public Method StartDeviceSyncAsync(StartDeviceSyncRequest, CancellationToken)

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).

Public Method StartSmartHomeApplianceDiscovery(StartSmartHomeApplianceDiscoveryRequest)

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

Public Method StartSmartHomeApplianceDiscoveryAsync(StartSmartHomeApplianceDiscoveryRequest, CancellationToken)

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

Public Method TagResource(TagResourceRequest)

Adds metadata tags to a specified resource.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

Adds metadata tags to a specified resource.

Public Method UntagResource(UntagResourceRequest)

Removes metadata tags from a specified resource.

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Removes metadata tags from a specified resource.

Public Method UpdateAddressBook(UpdateAddressBookRequest)

Updates address book details by the address book ARN.

Public Method UpdateAddressBookAsync(UpdateAddressBookRequest, CancellationToken)

Updates address book details by the address book ARN.

Public Method UpdateBusinessReportSchedule(UpdateBusinessReportScheduleRequest)

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

Public Method UpdateBusinessReportScheduleAsync(UpdateBusinessReportScheduleRequest, CancellationToken)

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

Public Method UpdateConferenceProvider(UpdateConferenceProviderRequest)

Updates an existing conference provider's settings.

Public Method UpdateConferenceProviderAsync(UpdateConferenceProviderRequest, CancellationToken)

Updates an existing conference provider's settings.

Public Method UpdateContact(UpdateContactRequest)

Updates the contact details by the contact ARN.

Public Method UpdateContactAsync(UpdateContactRequest, CancellationToken)

Updates the contact details by the contact ARN.

Public Method UpdateDevice(UpdateDeviceRequest)

Updates the device name by device ARN.

Public Method UpdateDeviceAsync(UpdateDeviceRequest, CancellationToken)

Updates the device name by device ARN.

Public Method UpdateGateway(UpdateGatewayRequest)

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

Public Method UpdateGatewayAsync(UpdateGatewayRequest, CancellationToken)

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

Public Method UpdateGatewayGroup(UpdateGatewayGroupRequest)

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

Public Method UpdateGatewayGroupAsync(UpdateGatewayGroupRequest, CancellationToken)

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

Public Method UpdateNetworkProfile(UpdateNetworkProfileRequest)

Updates a network profile by the network profile ARN.

Public Method UpdateNetworkProfileAsync(UpdateNetworkProfileRequest, CancellationToken)

Updates a network profile by the network profile ARN.

Public Method UpdateProfile(UpdateProfileRequest)

Updates an existing room profile by room profile ARN.

Public Method UpdateProfileAsync(UpdateProfileRequest, CancellationToken)

Updates an existing room profile by room profile ARN.

Public Method UpdateRoom(UpdateRoomRequest)

Updates room details by room ARN.

Public Method UpdateRoomAsync(UpdateRoomRequest, CancellationToken)

Updates room details by room ARN.

Public Method UpdateSkillGroup(UpdateSkillGroupRequest)

Updates skill group details by skill group ARN.

Public Method UpdateSkillGroupAsync(UpdateSkillGroupRequest, CancellationToken)

Updates skill group details by skill group ARN.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5