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.
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.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.ApproveSkill |
Name | Data Type | Description |
---|---|---|
ApproveSkillRequest
|
object |
SkillId
|
SkillId |
The unique identifier of the skill. |
||||
|
Name | Data Type | Description |
---|---|---|
ApproveSkillResponse
|
object |
Name | Data Type | Description |
---|---|---|
LimitExceededException
|
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Name | Data Type | Description |
---|---|---|
ConcurrentModificationException
|
Associates a contact with a given address book.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.AssociateContactWithAddressBook |
Name | Data Type | Description |
---|---|---|
AssociateContactWithAddressBookRequest
|
object |
AddressBookArn
|
Arn |
The ARN of the address book with which to associate the contact. |
||||
|
||||||
ContactArn
|
Arn |
The ARN of the contact to associate with an address book. |
||||
|
Name | Data Type | Description |
---|---|---|
AssociateContactWithAddressBookResponse
|
object |
Name | Data Type | Description |
---|---|---|
LimitExceededException
|
Associates a device with the specified network profile.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.AssociateDeviceWithNetworkProfile |
Name | Data Type | Description |
---|---|---|
AssociateDeviceWithNetworkProfileRequest
|
object |
NetworkProfileArn
|
Arn |
The ARN of the network profile to associate with a device. |
||||
|
||||||
DeviceArn
|
Arn |
The device ARN. |
||||
|
Name | Data Type | Description |
---|---|---|
AssociateDeviceWithNetworkProfileResponse
|
object |
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Name | Data Type | Description |
---|---|---|
ConcurrentModificationException
|
Name | Data Type | Description |
---|---|---|
DeviceNotRegisteredException
|
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.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.AssociateDeviceWithRoom |
Name | Data Type | Description |
---|---|---|
AssociateDeviceWithRoomRequest
|
object |
RoomArn
|
Arn |
The ARN of the room with which to associate the device. Required. |
||||
|
||||||
DeviceArn
|
Arn |
The ARN of the device to associate to a room. Required. |
||||
|
Name | Data Type | Description |
---|---|---|
AssociateDeviceWithRoomResponse
|
object |
Name | Data Type | Description |
---|---|---|
LimitExceededException
|
Name | Data Type | Description |
---|---|---|
ConcurrentModificationException
|
Name | Data Type | Description |
---|---|---|
DeviceNotRegisteredException
|
Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.AssociateSkillGroupWithRoom |
Name | Data Type | Description |
---|---|---|
AssociateSkillGroupWithRoomRequest
|
object |
RoomArn
|
Arn |
The ARN of the room with which to associate the skill group. Required. |
||||
|
||||||
SkillGroupArn
|
Arn |
The ARN of the skill group to associate with a room. Required. |
||||
|
Name | Data Type | Description |
---|---|---|
AssociateSkillGroupWithRoomResponse
|
object |
Name | Data Type | Description |
---|---|---|
ConcurrentModificationException
|
Associates a skill with a skill group.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.AssociateSkillWithSkillGroup |
Name | Data Type | Description |
---|---|---|
AssociateSkillWithSkillGroupRequest
|
object |
SkillId
|
SkillId |
The unique identifier of the skill. |
||||
|
||||||
SkillGroupArn
|
Arn |
The ARN of the skill group to associate the skill to. Required. |
||||
|
Name | Data Type | Description |
---|---|---|
AssociateSkillWithSkillGroupResponse
|
object |
Name | Data Type | Description |
---|---|---|
ConcurrentModificationException
|
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Name | Data Type | Description |
---|---|---|
SkillNotLinkedException
|
Makes a private skill available for enrolled users to enable on their devices.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.AssociateSkillWithUsers |
Name | Data Type | Description |
---|---|---|
AssociateSkillWithUsersRequest
|
object |
SkillId
|
SkillId |
The private skill ID you want to make available to enrolled users. |
||||
|
Name | Data Type | Description |
---|---|---|
AssociateSkillWithUsersResponse
|
object |
Name | Data Type | Description |
---|---|---|
ConcurrentModificationException
|
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Creates an address book with the specified details.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.CreateAddressBook |
Name | Data Type | Description |
---|---|---|
CreateAddressBookRequest
|
object |
ClientRequestToken
|
ClientRequestToken |
A unique, user-specified identifier for the request that ensures idempotency. |
||||
|
||||||
Description
|
AddressBookDescription |
The description of the address book. |
||||
|
||||||
Name
|
AddressBookName |
The name of the address book. |
||||
|
Name | Data Type | Description |
---|---|---|
CreateAddressBookResponse
|
object |
AddressBookArn
|
Arn |
The ARN of the newly created address book. |
||||
|
Name | Data Type | Description |
---|---|---|
AlreadyExistsException
|
Name | Data Type | Description |
---|---|---|
LimitExceededException
|
Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.CreateBusinessReportSchedule |
Name | Data Type | Description |
---|---|---|
CreateBusinessReportScheduleRequest
|
object |
ClientRequestToken
|
ClientRequestToken |
The client request token. |
||||||||||||||
|
||||||||||||||||
Recurrence
|
BusinessReportRecurrence |
The recurrence of the reports. If this isn't specified, the report will only be delivered one time when the API is called. |
||||||||||||||
Properties
|
||||||||||||||||
ContentRange
|
BusinessReportContentRange |
The content range of the reports. |
||||||||||||||
Properties
|
||||||||||||||||
Format
|
BusinessReportFormat |
The format of the generated report (individual CSV files or zipped files of individual files). |
||||||||||||||
|
||||||||||||||||
S3KeyPrefix
|
S3KeyPrefix |
The S3 key where the report is delivered. |
||||||||||||||
|
||||||||||||||||
S3BucketName
|
CustomerS3BucketName |
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. |
||||||||||||||
|
||||||||||||||||
ScheduleName
|
BusinessReportScheduleName |
The name identifier of the schedule. |
||||||||||||||
|
Name | Data Type | Description |
---|---|---|
CreateBusinessReportScheduleResponse
|
object |
ScheduleArn
|
Arn |
The ARN of the business report schedule. |
||||
|
Name | Data Type | Description |
---|---|---|
AlreadyExistsException
|
Adds a new conference provider under the user's AWS account.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.CreateConferenceProvider |
Name | Data Type | Description |
---|---|---|
CreateConferenceProviderRequest
|
object |
ClientRequestToken
|
ClientRequestToken |
The request token of the client. |
||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||
MeetingSetting
|
MeetingSetting |
The meeting settings for the conference provider. |
||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||
PSTNDialIn
|
PSTNDialIn |
The information for PSTN conferencing. |
||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||
IPDialIn
|
IPDialIn |
The IP endpoint and protocol for calling. |
||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||
ConferenceProviderType
|
ConferenceProviderType |
Represents a type within a list of predefined types. |
||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||
ConferenceProviderName
|
ConferenceProviderName |
The name of the conference provider. |
||||||||||||||||||||||||||||||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
CreateConferenceProviderResponse
|
object |
ConferenceProviderArn
|
Arn |
The ARN of the newly-created conference provider. |
||||
|
Name | Data Type | Description |
---|---|---|
AlreadyExistsException
|
Creates a contact with the specified details.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.CreateContact |
Name | Data Type | Description |
---|---|---|
CreateContactRequest
|
object |
ClientRequestToken
|
ClientRequestToken |
A unique, user-specified identifier for this request that ensures idempotency. |
|||||||||||||||||
|
|||||||||||||||||||
SipAddresses
|
SipAddressList |
The list of SIP addresses for the contact. |
|||||||||||||||||
|
|||||||||||||||||||
PhoneNumbers
|
PhoneNumberList |
The list of phone numbers for the contact. |
|||||||||||||||||
|
|||||||||||||||||||
PhoneNumber
|
RawPhoneNumber |
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. |
|||||||||||||||||
|
|||||||||||||||||||
LastName
|
ContactName |
The last name of the contact that is used to call the contact on the device. |
|||||||||||||||||
|
|||||||||||||||||||
FirstName
|
ContactName |
The first name of the contact that is used to call the contact on the device. |
|||||||||||||||||
|
|||||||||||||||||||
DisplayName
|
ContactName |
The name of the contact to display on the console. |
|||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
CreateContactResponse
|
object |
ContactArn
|
Arn |
The ARN of the newly created address book. |
||||
|
Name | Data Type | Description |
---|---|---|
AlreadyExistsException
|
Name | Data Type | Description |
---|---|---|
LimitExceededException
|
Creates a gateway group with the specified details.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.CreateGatewayGroup |
Name | Data Type | Description |
---|---|---|
CreateGatewayGroupRequest
|
object |
ClientRequestToken
|
ClientRequestToken |
A unique, user-specified identifier for the request that ensures idempotency. |
||||
|
||||||
Description
|
GatewayGroupDescription |
The description of the gateway group. |
||||
|
||||||
Name
|
GatewayGroupName |
The name of the gateway group. |
||||
|
Name | Data Type | Description |
---|---|---|
CreateGatewayGroupResponse
|
object |
GatewayGroupArn
|
Arn |
The ARN of the created gateway group. |
||||
|
Name | Data Type | Description |
---|---|---|
AlreadyExistsException
|
Name | Data Type | Description |
---|---|---|
LimitExceededException
|
Creates a network profile with the specified details.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.CreateNetworkProfile |
Name | Data Type | Description |
---|---|---|
CreateNetworkProfileRequest
|
object |
ClientRequestToken
|
ClientRequestToken | ||||||||||||
|
|||||||||||||
TrustAnchors
|
TrustAnchorList |
The root certificates of your authentication server that is installed on your devices and used to trust your authentication server during EAP negotiation. |
|||||||||||
|
|||||||||||||
CertificateAuthorityArn
|
Arn |
The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices. |
|||||||||||
|
|||||||||||||
NextPassword
|
NextWiFiPassword |
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. |
|||||||||||
|
|||||||||||||
CurrentPassword
|
CurrentWiFiPassword |
The current password of the Wi-Fi network. |
|||||||||||
|
|||||||||||||
EapMethod
|
NetworkEapMethod |
The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported. |
|||||||||||
|
|||||||||||||
SecurityType
|
NetworkSecurityType |
The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN. |
|||||||||||
|
|||||||||||||
Ssid
|
NetworkSsid |
The SSID of the Wi-Fi network. |
|||||||||||
|
|||||||||||||
Description
|
NetworkProfileDescription |
Detailed information about a device's network profile. |
|||||||||||
|
|||||||||||||
NetworkProfileName
|
NetworkProfileName |
The name of the network profile associated with a device. |
|||||||||||
|
Name | Data Type | Description |
---|---|---|
CreateNetworkProfileResponse
|
object |
NetworkProfileArn
|
Arn |
The ARN of the network profile associated with a device. |
||||
|
Name | Data Type | Description |
---|---|---|
AlreadyExistsException
|
Name | Data Type | Description |
---|---|---|
LimitExceededException
|
Name | Data Type | Description |
---|---|---|
ConcurrentModificationException
|
Name | Data Type | Description |
---|---|---|
InvalidCertificateAuthorityException
|
Name | Data Type | Description |
---|---|---|
InvalidServiceLinkedRoleStateException
|
Creates a new room profile with the specified details.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.CreateProfile |
Name | Data Type | Description |
---|---|---|
CreateProfileRequest
|
object |
MeetingRoomConfiguration
|
CreateMeetingRoomConfiguration |
The meeting room settings of a room profile. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PSTNEnabled
|
Boolean |
Whether PSTN calling is enabled. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaxVolumeLimit
|
MaxVolumeLimit |
The maximum volume limit for a room profile. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SetupModeDisabled
|
Boolean |
Whether room profile setup is enabled. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ClientRequestToken
|
ClientRequestToken |
The user-specified token that is used during the creation of a profile. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Locale
|
DeviceLocale |
The locale of the room profile. (This is currently only available to a limited preview audience.) |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
WakeWord
|
WakeWord |
A wake word for Alexa, Echo, Amazon, or a computer. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TemperatureUnit
|
TemperatureUnit |
The temperature unit to be used by devices in the profile. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DistanceUnit
|
DistanceUnit |
The distance unit to be used by devices in the profile. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Address
|
Address |
The valid address for the room. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Timezone
|
Timezone |
The time zone used by a room profile. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProfileName
|
ProfileName |
The name of a room profile. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
CreateProfileResponse
|
object |
ProfileArn
|
Arn |
The ARN of the newly created room profile in the response. |
||||
|
Name | Data Type | Description |
---|---|---|
LimitExceededException
|
Name | Data Type | Description |
---|---|---|
AlreadyExistsException
|
Name | Data Type | Description |
---|---|---|
ConcurrentModificationException
|
Creates a room with the specified details.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.CreateRoom |
Name | Data Type | Description |
---|---|---|
CreateRoomRequest
|
object |
Tags
|
TagList |
The tags for the room. |
|||||||||||||||||
|
|||||||||||||||||||
ClientRequestToken
|
ClientRequestToken |
A unique, user-specified identifier for this request that ensures idempotency. |
|||||||||||||||||
|
|||||||||||||||||||
ProviderCalendarId
|
ProviderCalendarId |
The calendar ARN for the room. |
|||||||||||||||||
|
|||||||||||||||||||
ProfileArn
|
Arn |
The profile ARN for the room. |
|||||||||||||||||
|
|||||||||||||||||||
Description
|
RoomDescription |
The description for the room. |
|||||||||||||||||
|
|||||||||||||||||||
RoomName
|
RoomName |
The name for the room. |
|||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
CreateRoomResponse
|
object |
RoomArn
|
Arn |
The ARN of the newly created room in the response. |
||||
|
Name | Data Type | Description |
---|---|---|
AlreadyExistsException
|
Name | Data Type | Description |
---|---|---|
LimitExceededException
|
Creates a skill group with a specified name and description.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.CreateSkillGroup |
Name | Data Type | Description |
---|---|---|
CreateSkillGroupRequest
|
object |
ClientRequestToken
|
ClientRequestToken |
A unique, user-specified identifier for this request that ensures idempotency. |
||||
|
||||||
Description
|
SkillGroupDescription |
The description for the skill group. |
||||
|
||||||
SkillGroupName
|
SkillGroupName |
The name for the skill group. |
||||
|
Name | Data Type | Description |
---|---|---|
CreateSkillGroupResponse
|
object |
SkillGroupArn
|
Arn |
The ARN of the newly created skill group in the response. |
||||
|
Name | Data Type | Description |
---|---|---|
AlreadyExistsException
|
Name | Data Type | Description |
---|---|---|
LimitExceededException
|
Name | Data Type | Description |
---|---|---|
ConcurrentModificationException
|
Creates a user.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.CreateUser |
Name | Data Type | Description |
---|---|---|
CreateUserRequest
|
object |
Tags
|
TagList |
The tags for the user. |
|||||||||||||||||
|
|||||||||||||||||||
ClientRequestToken
|
ClientRequestToken |
A unique, user-specified identifier for this request that ensures idempotency. |
|||||||||||||||||
|
|||||||||||||||||||
Email
|
The email address for the user. |
||||||||||||||||||
|
|||||||||||||||||||
LastName
|
user_LastName |
The last name for the user. |
|||||||||||||||||
|
|||||||||||||||||||
FirstName
|
user_FirstName |
The first name for the user. |
|||||||||||||||||
|
|||||||||||||||||||
UserId
|
user_UserId |
The ARN for the user. |
|||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
CreateUserResponse
|
object |
UserArn
|
Arn |
The ARN of the newly created user in the response. |
||||
|
Name | Data Type | Description |
---|---|---|
ResourceInUseException
|
Name | Data Type | Description |
---|---|---|
LimitExceededException
|
Name | Data Type | Description |
---|---|---|
ConcurrentModificationException
|
Deletes an address book by the address book ARN.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.DeleteAddressBook |
Name | Data Type | Description |
---|---|---|
DeleteAddressBookRequest
|
object |
AddressBookArn
|
Arn |
The ARN of the address book to delete. |
||||
|
Name | Data Type | Description |
---|---|---|
DeleteAddressBookResponse
|
object |
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Name | Data Type | Description |
---|---|---|
ConcurrentModificationException
|
Deletes the recurring report delivery schedule with the specified schedule ARN.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.DeleteBusinessReportSchedule |
Name | Data Type | Description |
---|---|---|
DeleteBusinessReportScheduleRequest
|
object |
ScheduleArn
|
Arn |
The ARN of the business report schedule. |
||||
|
Name | Data Type | Description |
---|---|---|
DeleteBusinessReportScheduleResponse
|
object |
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Name | Data Type | Description |
---|---|---|
ConcurrentModificationException
|
Deletes a conference provider.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.DeleteConferenceProvider |
Name | Data Type | Description |
---|---|---|
DeleteConferenceProviderRequest
|
object |
ConferenceProviderArn
|
Arn |
The ARN of the conference provider. |
||||
|
Name | Data Type | Description |
---|---|---|
DeleteConferenceProviderResponse
|
object |
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Deletes a contact by the contact ARN.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.DeleteContact |
Name | Data Type | Description |
---|---|---|
DeleteContactRequest
|
object |
ContactArn
|
Arn |
The ARN of the contact to delete. |
||||
|
Name | Data Type | Description |
---|---|---|
DeleteContactResponse
|
object |
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Name | Data Type | Description |
---|---|---|
ConcurrentModificationException
|
Removes a device from Alexa For Business.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.DeleteDevice |
Name | Data Type | Description |
---|---|---|
DeleteDeviceRequest
|
object |
DeviceArn
|
Arn |
The ARN of the device for which to request details. |
||||
|
Name | Data Type | Description |
---|---|---|
DeleteDeviceResponse
|
object |
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Name | Data Type | Description |
---|---|---|
ConcurrentModificationException
|
Name | Data Type | Description |
---|---|---|
InvalidCertificateAuthorityException
|
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.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.DeleteDeviceUsageData |
Name | Data Type | Description |
---|---|---|
DeleteDeviceUsageDataRequest
|
object |
DeviceUsageType
|
DeviceUsageType |
The type of usage data to delete. |
||||
|
||||||
DeviceArn
|
Arn |
The ARN of the device. |
||||
|
Name | Data Type | Description |
---|---|---|
DeleteDeviceUsageDataResponse
|
object |
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Name | Data Type | Description |
---|---|---|
DeviceNotRegisteredException
|
Name | Data Type | Description |
---|---|---|
LimitExceededException
|
Deletes a gateway group.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.DeleteGatewayGroup |
Name | Data Type | Description |
---|---|---|
DeleteGatewayGroupRequest
|
object |
GatewayGroupArn
|
Arn |
The ARN of the gateway group to delete. |
||||
|
Name | Data Type | Description |
---|---|---|
DeleteGatewayGroupResponse
|
object |
Name | Data Type | Description |
---|---|---|
ResourceAssociatedException
|
Deletes a network profile by the network profile ARN.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.DeleteNetworkProfile |
Name | Data Type | Description |
---|---|---|
DeleteNetworkProfileRequest
|
object |
NetworkProfileArn
|
Arn |
The ARN of the network profile associated with a device. |
||||
|
Name | Data Type | Description |
---|---|---|
DeleteNetworkProfileResponse
|
object |
Name | Data Type | Description |
---|---|---|
ResourceInUseException
|
Name | Data Type | Description |
---|---|---|
ConcurrentModificationException
|
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Deletes a room profile by the profile ARN.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.DeleteProfile |
Name | Data Type | Description |
---|---|---|
DeleteProfileRequest
|
object |
ProfileArn
|
Arn |
The ARN of the room profile to delete. Required. |
||||
|
Name | Data Type | Description |
---|---|---|
DeleteProfileResponse
|
object |
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Name | Data Type | Description |
---|---|---|
ConcurrentModificationException
|
Deletes a room by the room ARN.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.DeleteRoom |
Name | Data Type | Description |
---|---|---|
DeleteRoomRequest
|
object |
RoomArn
|
Arn |
The ARN of the room to delete. Required. |
||||
|
Name | Data Type | Description |
---|---|---|
DeleteRoomResponse
|
object |
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Name | Data Type | Description |
---|---|---|
ConcurrentModificationException
|
Deletes room skill parameter details by room, skill, and parameter key ID.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.DeleteRoomSkillParameter |
Name | Data Type | Description |
---|---|---|
DeleteRoomSkillParameterRequest
|
object |
ParameterKey
|
RoomSkillParameterKey |
The room skill parameter key for which to remove details. |
||||
|
||||||
SkillId
|
SkillId |
The ID of the skill from which to remove the room skill parameter details. |
||||
|
||||||
RoomArn
|
Arn |
The ARN of the room from which to remove the room skill parameter details. |
||||
|
Name | Data Type | Description |
---|---|---|
DeleteRoomSkillParameterResponse
|
object |
Name | Data Type | Description |
---|---|---|
ConcurrentModificationException
|
Unlinks a third-party account from a skill.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.DeleteSkillAuthorization |
Name | Data Type | Description |
---|---|---|
DeleteSkillAuthorizationRequest
|
object |
RoomArn
|
Arn |
The room that the skill is authorized for. |
||||
|
||||||
SkillId
|
SkillId |
The unique identifier of a skill. |
||||
|
Name | Data Type | Description |
---|---|---|
DeleteSkillAuthorizationResponse
|
object |
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Name | Data Type | Description |
---|---|---|
ConcurrentModificationException
|
Deletes a skill group by skill group ARN.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.DeleteSkillGroup |
Name | Data Type | Description |
---|---|---|
DeleteSkillGroupRequest
|
object |
SkillGroupArn
|
Arn |
The ARN of the skill group to delete. Required. |
||||
|
Name | Data Type | Description |
---|---|---|
DeleteSkillGroupResponse
|
object |
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Name | Data Type | Description |
---|---|---|
ConcurrentModificationException
|
Deletes a specified user by user ARN and enrollment ARN.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.DeleteUser |
Name | Data Type | Description |
---|---|---|
DeleteUserRequest
|
object |
EnrollmentId
|
EnrollmentId |
The ARN of the user's enrollment in the organization. Required. |
||||
|
||||||
UserArn
|
Arn |
The ARN of the user to delete in the organization. Required. |
||||
|
Name | Data Type | Description |
---|---|---|
DeleteUserResponse
|
object |
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Name | Data Type | Description |
---|---|---|
ConcurrentModificationException
|
Disassociates a contact from a given address book.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.DisassociateContactFromAddressBook |
Name | Data Type | Description |
---|---|---|
DisassociateContactFromAddressBookRequest
|
object |
AddressBookArn
|
Arn |
The ARN of the address from which to disassociate the contact. |
||||
|
||||||
ContactArn
|
Arn |
The ARN of the contact to disassociate from an address book. |
||||
|
Name | Data Type | Description |
---|---|---|
DisassociateContactFromAddressBookResponse
|
object |
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.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.DisassociateDeviceFromRoom |
Name | Data Type | Description |
---|---|---|
DisassociateDeviceFromRoomRequest
|
object |
DeviceArn
|
Arn |
The ARN of the device to disassociate from a room. Required. |
||||
|
Name | Data Type | Description |
---|---|---|
DisassociateDeviceFromRoomResponse
|
object |
Name | Data Type | Description |
---|---|---|
ConcurrentModificationException
|
Name | Data Type | Description |
---|---|---|
DeviceNotRegisteredException
|
Disassociates a skill from a skill group.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.DisassociateSkillFromSkillGroup |
Name | Data Type | Description |
---|---|---|
DisassociateSkillFromSkillGroupRequest
|
object |
SkillId
|
SkillId |
The ARN of a skill group to associate to a skill. |
||||
|
||||||
SkillGroupArn
|
Arn |
The unique identifier of a skill. Required. |
||||
|
Name | Data Type | Description |
---|---|---|
DisassociateSkillFromSkillGroupResponse
|
object |
Name | Data Type | Description |
---|---|---|
ConcurrentModificationException
|
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.DisassociateSkillFromUsers |
Name | Data Type | Description |
---|---|---|
DisassociateSkillFromUsersRequest
|
object |
SkillId
|
SkillId |
The private skill ID you want to make unavailable for enrolled users. |
||||
|
Name | Data Type | Description |
---|---|---|
DisassociateSkillFromUsersResponse
|
object |
Name | Data Type | Description |
---|---|---|
ConcurrentModificationException
|
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.DisassociateSkillGroupFromRoom |
Name | Data Type | Description |
---|---|---|
DisassociateSkillGroupFromRoomRequest
|
object |
RoomArn
|
Arn |
The ARN of the room from which the skill group is to be disassociated. Required. |
||||
|
||||||
SkillGroupArn
|
Arn |
The ARN of the skill group to disassociate from a room. Required. |
||||
|
Name | Data Type | Description |
---|---|---|
DisassociateSkillGroupFromRoomResponse
|
object |
Name | Data Type | Description |
---|---|---|
ConcurrentModificationException
|
Forgets smart home appliances associated to a room.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.ForgetSmartHomeAppliances |
Name | Data Type | Description |
---|---|---|
ForgetSmartHomeAppliancesRequest
|
object |
RoomArn
|
Arn |
The room that the appliances are associated with. |
||||
|
Name | Data Type | Description |
---|---|---|
ForgetSmartHomeAppliancesResponse
|
object |
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Gets address the book details by the address book ARN.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.GetAddressBook |
Name | Data Type | Description |
---|---|---|
GetAddressBookRequest
|
object |
AddressBookArn
|
Arn |
The ARN of the address book for which to request details. |
||||
|
Name | Data Type | Description |
---|---|---|
GetAddressBookResponse
|
object |
AddressBook
|
AddressBook |
The details of the requested address book. |
||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Retrieves the existing conference preferences.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.GetConferencePreference |
Name | Data Type | Description |
---|---|---|
GetConferencePreferenceRequest
|
object |
Name | Data Type | Description |
---|---|---|
GetConferencePreferenceResponse
|
object |
Preference
|
ConferencePreference |
The conference preference. |
||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Gets details about a specific conference provider.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.GetConferenceProvider |
Name | Data Type | Description |
---|---|---|
GetConferenceProviderRequest
|
object |
ConferenceProviderArn
|
Arn |
The ARN of the newly created conference provider. |
||||
|
Name | Data Type | Description |
---|---|---|
GetConferenceProviderResponse
|
object |
ConferenceProvider
|
ConferenceProvider |
The conference provider. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Gets the contact details by the contact ARN.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.GetContact |
Name | Data Type | Description |
---|---|---|
GetContactRequest
|
object |
ContactArn
|
Arn |
The ARN of the contact for which to request details. |
||||
|
Name | Data Type | Description |
---|---|---|
GetContactResponse
|
object |
Contact
|
Contact |
The details of the requested contact. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Gets the details of a device by device ARN.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.GetDevice |
Name | Data Type | Description |
---|---|---|
GetDeviceRequest
|
object |
DeviceArn
|
Arn |
The ARN of the device for which to request details. Required. |
||||
|
Name | Data Type | Description |
---|---|---|
GetDeviceResponse
|
object |
Device
|
Device |
The details of the device requested. Required. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Retrieves the details of a gateway group.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.GetGatewayGroup |
Name | Data Type | Description |
---|---|---|
GetGatewayGroupRequest
|
object |
GatewayGroupArn
|
Arn |
The ARN of the gateway group to get. |
||||
|
Name | Data Type | Description |
---|---|---|
GetGatewayGroupResponse
|
object |
GatewayGroup
|
GatewayGroup | |||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Retrieves the details of a gateway.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.GetGateway |
Name | Data Type | Description |
---|---|---|
GetGatewayRequest
|
object |
GatewayArn
|
Arn |
The ARN of the gateway to get. |
||||
|
Name | Data Type | Description |
---|---|---|
GetGatewayResponse
|
object |
Gateway
|
Gateway |
The details of the gateway. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Retrieves the configured values for the user enrollment invitation email template.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.GetInvitationConfiguration |
Name | Data Type | Description |
---|---|---|
GetInvitationConfigurationRequest
|
object |
Name | Data Type | Description |
---|---|---|
GetInvitationConfigurationResponse
|
object |
PrivateSkillIds
|
ShortSkillIdList |
The list of private skill IDs that you want to recommend to the user to enable in the invitation. |
|||||||||||
|
|||||||||||||
ContactEmail
|
The email ID of the organization or individual contact that the enrolled user can use. |
||||||||||||
|
|||||||||||||
OrganizationName
|
OrganizationName |
The name of the organization sending the enrollment invite to a user. |
|||||||||||
|
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Gets the network profile details by the network profile ARN.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.GetNetworkProfile |
Name | Data Type | Description |
---|---|---|
GetNetworkProfileRequest
|
object |
NetworkProfileArn
|
Arn |
The ARN of the network profile associated with a device. |
||||
|
Name | Data Type | Description |
---|---|---|
GetNetworkProfileResponse
|
object |
NetworkProfile
|
NetworkProfile |
The network profile associated with a device. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Name | Data Type | Description |
---|---|---|
InvalidSecretsManagerResourceException
|
Gets the details of a room profile by profile ARN.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.GetProfile |
Name | Data Type | Description |
---|---|---|
GetProfileRequest
|
object |
ProfileArn
|
Arn |
The ARN of the room profile for which to request details. Required. |
||||
|
Name | Data Type | Description |
---|---|---|
GetProfileResponse
|
object |
Profile
|
Profile |
The details of the room profile requested. Required. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Gets room details by room ARN.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AlexaForBusiness.GetRoom |
Name | Data Type | Description |
---|---|---|
GetRoomRequest
|
object |
RoomArn
|
Arn |
The ARN of the room for which to request details. Required. |
||||
|
Name | Data Type | Description |
---|---|---|
GetRoomResponse
|
object |
Room
|
Room |
The details of the room requested. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
NotFoundException
|