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 makes it easy for you to use Alexa in your organization. Alexa for Business gives you the tools you need for managing 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 make also these available as private skills for your organization. Alexa for Business makes it easy to voice-enable your products and services, providing context-aware voice experiences for your customers.

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.



    
        
    

             

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.



    
        
    

             

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.



    
        
    

             

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.

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 AssociateContactWithAddressBook(AssociateContactWithAddressBookRequest)

Associates a contact with a given address book.

Public Method AssociateContactWithAddressBookAsync(AssociateContactWithAddressBookRequest, CancellationToken)

Initiates the asynchronous execution of the AssociateContactWithAddressBook operation.

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)

Initiates the asynchronous execution of the AssociateDeviceWithRoom operation.

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)

Initiates the asynchronous execution of the AssociateSkillGroupWithRoom operation.

Public Method CreateAddressBook(CreateAddressBookRequest)

Creates an address book with the specified details.

Public Method CreateAddressBookAsync(CreateAddressBookRequest, CancellationToken)

Initiates the asynchronous execution of the CreateAddressBook operation.

Public Method CreateContact(CreateContactRequest)

Creates a contact with the specified details.

Public Method CreateContactAsync(CreateContactRequest, CancellationToken)

Initiates the asynchronous execution of the CreateContact operation.

Public Method CreateProfile(CreateProfileRequest)

Creates a new room profile with the specified details.

Public Method CreateProfileAsync(CreateProfileRequest, CancellationToken)

Initiates the asynchronous execution of the CreateProfile operation.

Public Method CreateRoom(CreateRoomRequest)

Creates a room with the specified details.

Public Method CreateRoomAsync(CreateRoomRequest, CancellationToken)

Initiates the asynchronous execution of the CreateRoom operation.

Public Method CreateSkillGroup(CreateSkillGroupRequest)

Creates a skill group with a specified name and description.

Public Method CreateSkillGroupAsync(CreateSkillGroupRequest, CancellationToken)

Initiates the asynchronous execution of the CreateSkillGroup operation.

Public Method CreateUser(CreateUserRequest)

Creates a user.

Public Method CreateUserAsync(CreateUserRequest, CancellationToken)

Initiates the asynchronous execution of the CreateUser operation.

Public Method DeleteAddressBook(DeleteAddressBookRequest)

Deletes an address book by the address book ARN.

Public Method DeleteAddressBookAsync(DeleteAddressBookRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteAddressBook operation.

Public Method DeleteContact(DeleteContactRequest)

Deletes a contact by the contact ARN.

Public Method DeleteContactAsync(DeleteContactRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteContact operation.

Public Method DeleteProfile(DeleteProfileRequest)

Deletes a room profile by the profile ARN.

Public Method DeleteProfileAsync(DeleteProfileRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteProfile operation.

Public Method DeleteRoom(DeleteRoomRequest)

Deletes a room by the room ARN.

Public Method DeleteRoomAsync(DeleteRoomRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteRoom operation.

Public Method DeleteRoomSkillParameter(DeleteRoomSkillParameterRequest)

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

Public Method DeleteRoomSkillParameterAsync(DeleteRoomSkillParameterRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteRoomSkillParameter operation.

Public Method DeleteSkillGroup(DeleteSkillGroupRequest)

Deletes a skill group by skill group ARN.

Public Method DeleteSkillGroupAsync(DeleteSkillGroupRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteSkillGroup operation.

Public Method DeleteUser(DeleteUserRequest)

Deletes a specified user by user ARN and enrollment ARN.

Public Method DeleteUserAsync(DeleteUserRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteUser operation.

Public Method DisassociateContactFromAddressBook(DisassociateContactFromAddressBookRequest)

Disassociates a contact from a given address book.

Public Method DisassociateContactFromAddressBookAsync(DisassociateContactFromAddressBookRequest, CancellationToken)

Initiates the asynchronous execution of the DisassociateContactFromAddressBook operation.

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)

Initiates the asynchronous execution of the DisassociateDeviceFromRoom operation.

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)

Initiates the asynchronous execution of the DisassociateSkillGroupFromRoom operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method GetAddressBook(GetAddressBookRequest)

Gets address the book details by the address book ARN.

Public Method GetAddressBookAsync(GetAddressBookRequest, CancellationToken)

Initiates the asynchronous execution of the GetAddressBook operation.

Public Method GetContact(GetContactRequest)

Gets the contact details by the contact ARN.

Public Method GetContactAsync(GetContactRequest, CancellationToken)

Initiates the asynchronous execution of the GetContact operation.

Public Method GetDevice(GetDeviceRequest)

Gets the details of a device by device ARN.

Public Method GetDeviceAsync(GetDeviceRequest, CancellationToken)

Initiates the asynchronous execution of the GetDevice operation.

Public Method GetProfile(GetProfileRequest)

Gets the details of a room profile by profile ARN.

Public Method GetProfileAsync(GetProfileRequest, CancellationToken)

Initiates the asynchronous execution of the GetProfile operation.

Public Method GetRoom(GetRoomRequest)

Gets room details by room ARN.

Public Method GetRoomAsync(GetRoomRequest, CancellationToken)

Initiates the asynchronous execution of the GetRoom operation.

Public Method GetRoomSkillParameter(GetRoomSkillParameterRequest)

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

Public Method GetRoomSkillParameterAsync(GetRoomSkillParameterRequest, CancellationToken)

Initiates the asynchronous execution of the GetRoomSkillParameter operation.

Public Method GetSkillGroup(GetSkillGroupRequest)

Gets skill group details by skill group ARN.

Public Method GetSkillGroupAsync(GetSkillGroupRequest, CancellationToken)

Initiates the asynchronous execution of the GetSkillGroup operation.

Public Method ListDeviceEvents(ListDeviceEventsRequest)

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

Public Method ListDeviceEventsAsync(ListDeviceEventsRequest, CancellationToken)

Initiates the asynchronous execution of the ListDeviceEvents operation.

Public Method ListSkills(ListSkillsRequest)

Lists all enabled skills in a specific skill group.

Public Method ListSkillsAsync(ListSkillsRequest, CancellationToken)

Initiates the asynchronous execution of the ListSkills operation.

Public Method ListTags(ListTagsRequest)

Lists all tags for the specified resource.

Public Method ListTagsAsync(ListTagsRequest, CancellationToken)

Initiates the asynchronous execution of the ListTags operation.

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)

Initiates the asynchronous execution of the PutRoomSkillParameter operation.

Public Method ResolveRoom(ResolveRoomRequest)

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

Public Method ResolveRoomAsync(ResolveRoomRequest, CancellationToken)

Initiates the asynchronous execution of the ResolveRoom operation.

Public Method RevokeInvitation(RevokeInvitationRequest)

Revokes an invitation and invalidates the enrollment URL.

Public Method RevokeInvitationAsync(RevokeInvitationRequest, CancellationToken)

Initiates the asynchronous execution of the RevokeInvitation operation.

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)

Initiates the asynchronous execution of the SearchAddressBooks operation.

Public Method SearchContacts(SearchContactsRequest)

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

Public Method SearchContactsAsync(SearchContactsRequest, CancellationToken)

Initiates the asynchronous execution of the SearchContacts operation.

Public Method SearchDevices(SearchDevicesRequest)

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

Public Method SearchDevicesAsync(SearchDevicesRequest, CancellationToken)

Initiates the asynchronous execution of the SearchDevices operation.

Public Method SearchProfiles(SearchProfilesRequest)

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

Public Method SearchProfilesAsync(SearchProfilesRequest, CancellationToken)

Initiates the asynchronous execution of the SearchProfiles operation.

Public Method SearchRooms(SearchRoomsRequest)

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

Public Method SearchRoomsAsync(SearchRoomsRequest, CancellationToken)

Initiates the asynchronous execution of the SearchRooms operation.

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)

Initiates the asynchronous execution of the SearchSkillGroups operation.

Public Method SearchUsers(SearchUsersRequest)

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

Public Method SearchUsersAsync(SearchUsersRequest, CancellationToken)

Initiates the asynchronous execution of the SearchUsers operation.

Public Method SendInvitation(SendInvitationRequest)

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

Public Method SendInvitationAsync(SendInvitationRequest, CancellationToken)

Initiates the asynchronous execution of the SendInvitation operation.

Public Method StartDeviceSync(StartDeviceSyncRequest)

Resets a device and its account to the known default settings, by clearing all information and settings set by previous users.

Public Method StartDeviceSyncAsync(StartDeviceSyncRequest, CancellationToken)

Initiates the asynchronous execution of the StartDeviceSync operation.

Public Method TagResource(TagResourceRequest)

Adds metadata tags to a specified resource.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

Initiates the asynchronous execution of the TagResource operation.

Public Method UntagResource(UntagResourceRequest)

Removes metadata tags from a specified resource.

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Initiates the asynchronous execution of the UntagResource operation.

Public Method UpdateAddressBook(UpdateAddressBookRequest)

Updates address book details by the address book ARN.

Public Method UpdateAddressBookAsync(UpdateAddressBookRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateAddressBook operation.

Public Method UpdateContact(UpdateContactRequest)

Updates the contact details by the contact ARN.

Public Method UpdateContactAsync(UpdateContactRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateContact operation.

Public Method UpdateDevice(UpdateDeviceRequest)

Updates the device name by device ARN.

Public Method UpdateDeviceAsync(UpdateDeviceRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateDevice operation.

Public Method UpdateProfile(UpdateProfileRequest)

Updates an existing room profile by room profile ARN.

Public Method UpdateProfileAsync(UpdateProfileRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateProfile operation.

Public Method UpdateRoom(UpdateRoomRequest)

Updates room details by room ARN.

Public Method UpdateRoomAsync(UpdateRoomRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateRoom operation.

Public Method UpdateSkillGroup(UpdateSkillGroupRequest)

Updates skill group details by skill group ARN.

Public Method UpdateSkillGroupAsync(UpdateSkillGroupRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateSkillGroup operation.

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 Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms