Amazon Web Services - API Alexa For Business

POST

/#X-Amz-Target=AlexaForBusiness.ApproveSkill

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.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.ApproveSkill`

Body

Name	Data Type	Description
`ApproveSkillRequest`	object

Properties


                        SkillId

SkillId

The unique identifier of the skill.

SkillId string
Pattern: (^amzn1\.ask\.skill\.[0-9a-f\-]{1,200})|(^amzn1\.echo-sdk-ams\.app\.[0-9a-f\-]{1,200})

Responses

200Success

Body

Name	Data Type	Description
`ApproveSkillResponse`	object

480LimitExceededException

Body

Name	Data Type	Description
`LimitExceededException`

481NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

482ConcurrentModificationException

Body

Name	Data Type	Description
`ConcurrentModificationException`

POST

/#X-Amz-Target=AlexaForBusiness.AssociateContactWithAddressBook

Associates a contact with a given address book.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.AssociateContactWithAddressBook`

Body

Name	Data Type	Description
`AssociateContactWithAddressBookRequest`	object

Properties


                        AddressBookArn

Arn

The ARN of the address book with which to associate the contact.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}


                        ContactArn

Arn

The ARN of the contact to associate with an address book.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Responses

200Success

Body

Name	Data Type	Description
`AssociateContactWithAddressBookResponse`	object

480LimitExceededException

Body

Name	Data Type	Description
`LimitExceededException`

POST

/#X-Amz-Target=AlexaForBusiness.AssociateDeviceWithNetworkProfile

Associates a device with the specified network profile.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.AssociateDeviceWithNetworkProfile`

Body

Name	Data Type	Description
`AssociateDeviceWithNetworkProfileRequest`	object

Properties


                        NetworkProfileArn

Arn

The ARN of the network profile to associate with a device.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}


                        DeviceArn

Arn

The device ARN.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Responses

200Success

Body

Name	Data Type	Description
`AssociateDeviceWithNetworkProfileResponse`	object

480NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

481ConcurrentModificationException

Body

Name	Data Type	Description
`ConcurrentModificationException`

482DeviceNotRegisteredException

Body

Name	Data Type	Description
`DeviceNotRegisteredException`

POST

/#X-Amz-Target=AlexaForBusiness.AssociateDeviceWithRoom

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.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.AssociateDeviceWithRoom`

Body

Name	Data Type	Description
`AssociateDeviceWithRoomRequest`	object

Properties


                        RoomArn

Arn

The ARN of the room with which to associate the device. Required.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}


                        DeviceArn

Arn

The ARN of the device to associate to a room. Required.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Responses

200Success

Body

Name	Data Type	Description
`AssociateDeviceWithRoomResponse`	object

480LimitExceededException

Body

Name	Data Type	Description
`LimitExceededException`

481ConcurrentModificationException

Body

Name	Data Type	Description
`ConcurrentModificationException`

482DeviceNotRegisteredException

Body

Name	Data Type	Description
`DeviceNotRegisteredException`

POST

/#X-Amz-Target=AlexaForBusiness.AssociateSkillGroupWithRoom

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

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.AssociateSkillGroupWithRoom`

Body

Name	Data Type	Description
`AssociateSkillGroupWithRoomRequest`	object

Properties


                        RoomArn

Arn

The ARN of the room with which to associate the skill group. Required.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}


                        SkillGroupArn

Arn

The ARN of the skill group to associate with a room. Required.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Responses

200Success

Body

Name	Data Type	Description
`AssociateSkillGroupWithRoomResponse`	object

480ConcurrentModificationException

Body

Name	Data Type	Description
`ConcurrentModificationException`

POST

/#X-Amz-Target=AlexaForBusiness.AssociateSkillWithSkillGroup

Associates a skill with a skill group.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.AssociateSkillWithSkillGroup`

Body

Name	Data Type	Description
`AssociateSkillWithSkillGroupRequest`	object

Properties


                        SkillId

SkillId

The unique identifier of the skill.

SkillId string
Pattern: (^amzn1\.ask\.skill\.[0-9a-f\-]{1,200})|(^amzn1\.echo-sdk-ams\.app\.[0-9a-f\-]{1,200})


                        SkillGroupArn

Arn

The ARN of the skill group to associate the skill to. Required.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Responses

200Success

Body

Name	Data Type	Description
`AssociateSkillWithSkillGroupResponse`	object

480ConcurrentModificationException

Body

Name	Data Type	Description
`ConcurrentModificationException`

481NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

482SkillNotLinkedException

Body

Name	Data Type	Description
`SkillNotLinkedException`

POST

/#X-Amz-Target=AlexaForBusiness.AssociateSkillWithUsers

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

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.AssociateSkillWithUsers`

Body

Name	Data Type	Description
`AssociateSkillWithUsersRequest`	object

Properties


                        SkillId

SkillId

The private skill ID you want to make available to enrolled users.

SkillId string
Pattern: (^amzn1\.ask\.skill\.[0-9a-f\-]{1,200})|(^amzn1\.echo-sdk-ams\.app\.[0-9a-f\-]{1,200})

Responses

200Success

Body

Name	Data Type	Description
`AssociateSkillWithUsersResponse`	object

480ConcurrentModificationException

Body

Name	Data Type	Description
`ConcurrentModificationException`

481NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

POST

/#X-Amz-Target=AlexaForBusiness.CreateAddressBook

Creates an address book with the specified details.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.CreateAddressBook`

Body

Name	Data Type	Description
`CreateAddressBookRequest`	object

Properties


                        ClientRequestToken

ClientRequestToken

A unique, user-specified identifier for the request that ensures idempotency.


                        ClientRequestToken

string
Pattern: [a-zA-Z0-9][a-zA-Z0-9_-]*
Minimum: 10
Maximum: 150

A unique, user-specified identifier for the request that ensures idempotency.


                        Description

AddressBookDescription

The description of the address book.

AddressBookDescription string
Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
Minimum: 1
Maximum: 200


                        Name

AddressBookName

The name of the address book.

AddressBookName string
Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
Minimum: 1
Maximum: 100

Responses

200Success

Body

Name	Data Type	Description
`CreateAddressBookResponse`	object

Properties


                        AddressBookArn

Arn

The ARN of the newly created address book.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

480AlreadyExistsException

Body

Name	Data Type	Description
`AlreadyExistsException`

481LimitExceededException

Body

Name	Data Type	Description
`LimitExceededException`

POST

/#X-Amz-Target=AlexaForBusiness.CreateBusinessReportSchedule

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

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.CreateBusinessReportSchedule`

Body

Name	Data Type	Description
`CreateBusinessReportScheduleRequest`	object

Properties


                        ClientRequestToken

ClientRequestToken

The client request token.


                        ClientRequestToken

string
Pattern: [a-zA-Z0-9][a-zA-Z0-9_-]*
Minimum: 10
Maximum: 150

A unique, user-specified identifier for the request that ensures idempotency.


                        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.


                        BusinessReportRecurrence

object

The recurrence of the reports.

Properties


                        StartDate

Date

The start date.

Date string
Pattern: ^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$


                        ContentRange

BusinessReportContentRange

The content range of the reports.


                        BusinessReportContentRange

object

The content range of the report.

Properties


                        Interval

BusinessReportInterval

The interval of the content range.

BusinessReportInterval string
Allowed values:
- ONE_DAY
- ONE_WEEK
- THIRTY_DAYS


                        Format

BusinessReportFormat

The format of the generated report (individual CSV files or zipped files of individual files).

BusinessReportFormat string
Allowed values:
- CSV
- CSV_ZIP


                        S3KeyPrefix

S3KeyPrefix

The S3 key where the report is delivered.

S3KeyPrefix string
Pattern: [A-Za-z0-9!_\-\.\*'()/]*
Minimum: 0
Maximum: 100


                        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.

CustomerS3BucketName string
Pattern: [a-z0-9-\.]{3,63}


                        ScheduleName

BusinessReportScheduleName

The name identifier of the schedule.

BusinessReportScheduleName string
Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
Minimum: 0
Maximum: 64

Responses

200Success

Body

Name	Data Type	Description
`CreateBusinessReportScheduleResponse`	object

Properties


                        ScheduleArn

Arn

The ARN of the business report schedule.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

480AlreadyExistsException

Body

Name	Data Type	Description
`AlreadyExistsException`

POST

/#X-Amz-Target=AlexaForBusiness.CreateConferenceProvider

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

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.CreateConferenceProvider`

Body

Name	Data Type	Description
`CreateConferenceProviderRequest`	object

Properties


                        ClientRequestToken

ClientRequestToken

The request token of the client.


                        ClientRequestToken

string
Pattern: [a-zA-Z0-9][a-zA-Z0-9_-]*
Minimum: 10
Maximum: 150

A unique, user-specified identifier for the request that ensures idempotency.


                        MeetingSetting

MeetingSetting

The meeting settings for the conference provider.


                        MeetingSetting

object

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

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

Properties


                        RequirePin

RequirePin

The values that indicate whether the pin is always required.

RequirePin string
Allowed values:
- YES
- NO
- OPTIONAL


                        PSTNDialIn

PSTNDialIn

The information for PSTN conferencing.


                        PSTNDialIn

object

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

Properties


                        OneClickPinDelay

OneClickPinDelay

The delay duration before Alexa enters the conference pin with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.

OneClickPinDelay string
Minimum: 1
Maximum: 2


                        OneClickIdDelay

OneClickIdDelay

The delay duration before Alexa enters the conference ID with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.

OneClickIdDelay string
Minimum: 1
Maximum: 2


                        PhoneNumber

OutboundPhoneNumber

The phone number to call to join the conference.

OutboundPhoneNumber string
Pattern: \d{10}


                        CountryCode

CountryCode

The zip code.

CountryCode string
Pattern: \d{1,3}


                        IPDialIn

IPDialIn

The IP endpoint and protocol for calling.


                        IPDialIn

object

The IP endpoint and protocol for calling.

Properties


                        CommsProtocol

CommsProtocol

The protocol, including SIP, SIPS, and H323.

CommsProtocol string
Allowed values:
- SIP
- SIPS
- H323


                        Endpoint

Endpoint

The IP address.

Endpoint string
Minimum: 1
Maximum: 256


                        ConferenceProviderType

ConferenceProviderType

Represents a type within a list of predefined types.

ConferenceProviderType string
Allowed values:
- CHIME
- BLUEJEANS
- FUZE
- GOOGLE_HANGOUTS
- POLYCOM
- RINGCENTRAL
- SKYPE_FOR_BUSINESS
- WEBEX
- ZOOM
- CUSTOM


                        ConferenceProviderName

ConferenceProviderName

The name of the conference provider.

ConferenceProviderName string
Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
Minimum: 1
Maximum: 50

Responses

200Success

Body

Name	Data Type	Description
`CreateConferenceProviderResponse`	object

Properties


                        ConferenceProviderArn

Arn

The ARN of the newly-created conference provider.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

480AlreadyExistsException

Body

Name	Data Type	Description
`AlreadyExistsException`

POST

/#X-Amz-Target=AlexaForBusiness.CreateContact

Creates a contact with the specified details.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.CreateContact`

Body

Name	Data Type	Description
`CreateContactRequest`	object

Properties


                        ClientRequestToken

ClientRequestToken

A unique, user-specified identifier for this request that ensures idempotency.


                        ClientRequestToken

string
Pattern: [a-zA-Z0-9][a-zA-Z0-9_-]*
Minimum: 10
Maximum: 150

A unique, user-specified identifier for the request that ensures idempotency.


                        SipAddresses

SipAddressList

The list of SIP addresses for the contact.

SipAddressList array [SipAddress]


                        SipAddress

object

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

Properties

`Type`	SipType	The type of the SIP address.
`Uri`	SipUri	The URI for the SIP address.


                        PhoneNumbers

PhoneNumberList

The list of phone numbers for the contact.

PhoneNumberList array [PhoneNumber]


                        PhoneNumber

object

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

Properties

`Type`	PhoneNumberType	The type of the phone number.
`Number`	RawPhoneNumber	The raw value of the phone number.


                        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.

RawPhoneNumber password
Pattern: ^[\+0-9\#\,$][\+0-9\-\.\/\($\,\#\s]+$
Minimum: 0
Maximum: 50


                        LastName

ContactName

The last name of the contact that is used to call the contact on the device.

ContactName string
Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
Minimum: 1
Maximum: 100


                        FirstName

ContactName

The first name of the contact that is used to call the contact on the device.

ContactName string
Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
Minimum: 1
Maximum: 100


                        DisplayName

ContactName

The name of the contact to display on the console.

ContactName string
Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
Minimum: 1
Maximum: 100

Responses

200Success

Body

Name	Data Type	Description
`CreateContactResponse`	object

Properties


                        ContactArn

Arn

The ARN of the newly created address book.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

480AlreadyExistsException

Body

Name	Data Type	Description
`AlreadyExistsException`

481LimitExceededException

Body

Name	Data Type	Description
`LimitExceededException`

POST

/#X-Amz-Target=AlexaForBusiness.CreateGatewayGroup

Creates a gateway group with the specified details.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.CreateGatewayGroup`

Body

Name	Data Type	Description
`CreateGatewayGroupRequest`	object

Properties


                        ClientRequestToken

ClientRequestToken

A unique, user-specified identifier for the request that ensures idempotency.


                        ClientRequestToken

string
Pattern: [a-zA-Z0-9][a-zA-Z0-9_-]*
Minimum: 10
Maximum: 150

A unique, user-specified identifier for the request that ensures idempotency.


                        Description

GatewayGroupDescription

The description of the gateway group.

GatewayGroupDescription string
Minimum: 0
Maximum: 200


                        Name

GatewayGroupName

The name of the gateway group.

GatewayGroupName string
Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
Minimum: 1
Maximum: 100

Responses

200Success

Body

Name	Data Type	Description
`CreateGatewayGroupResponse`	object

Properties


                        GatewayGroupArn

Arn

The ARN of the created gateway group.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

480AlreadyExistsException

Body

Name	Data Type	Description
`AlreadyExistsException`

481LimitExceededException

Body

Name	Data Type	Description
`LimitExceededException`

POST

/#X-Amz-Target=AlexaForBusiness.CreateNetworkProfile

Creates a network profile with the specified details.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.CreateNetworkProfile`

Body

Name	Data Type	Description
`CreateNetworkProfileRequest`	object

Properties

ClientRequestToken ClientRequestToken


                        ClientRequestToken

string
Pattern: [a-zA-Z0-9][a-zA-Z0-9_-]*
Minimum: 10
Maximum: 150

A unique, user-specified identifier for the request that ensures idempotency.


                        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.

TrustAnchorList array [TrustAnchor]
Pattern: -{5}BEGIN CERTIFICATE-{5}\u000D?\u000A([A-Za-z0-9/+]{64}\u000D?\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\u000D?\u000A-{5}END CERTIFICATE-{5}(\u000D?\u000A)?

TrustAnchor string
Pattern: -{5}BEGIN CERTIFICATE-{5}\u000D?\u000A([A-Za-z0-9/+]{64}\u000D?\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\u000D?\u000A-{5}END CERTIFICATE-{5}(\u000D?\u000A)?


                        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.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}


                        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.

NextWiFiPassword password
Pattern: (^$)|([\x00-\x7F]{5,})
Minimum: 0
Maximum: 128


                        CurrentPassword

CurrentWiFiPassword

The current password of the Wi-Fi network.

CurrentWiFiPassword password
Pattern: [\x00-\x7F]*
Minimum: 5
Maximum: 128


                        EapMethod

NetworkEapMethod

The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.

NetworkEapMethod string
Allowed values:
- EAP_TLS


                        SecurityType

NetworkSecurityType

The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.

NetworkSecurityType string
Allowed values:
- OPEN
- WEP
- WPA_PSK
- WPA2_PSK
- WPA2_ENTERPRISE


                        Ssid

NetworkSsid

The SSID of the Wi-Fi network.

NetworkSsid string
Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
Minimum: 1
Maximum: 32


                        Description

NetworkProfileDescription

Detailed information about a device's network profile.

NetworkProfileDescription string
Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
Minimum: 0
Maximum: 200


                        NetworkProfileName

NetworkProfileName

The name of the network profile associated with a device.

NetworkProfileName string
Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
Minimum: 1
Maximum: 100

Responses

200Success

Body

Name	Data Type	Description
`CreateNetworkProfileResponse`	object

Properties


                        NetworkProfileArn

Arn

The ARN of the network profile associated with a device.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

480AlreadyExistsException

Body

Name	Data Type	Description
`AlreadyExistsException`

481LimitExceededException

Body

Name	Data Type	Description
`LimitExceededException`

482ConcurrentModificationException

Body

Name	Data Type	Description
`ConcurrentModificationException`

483InvalidCertificateAuthorityException

Body

Name	Data Type	Description
`InvalidCertificateAuthorityException`

484InvalidServiceLinkedRoleStateException

Body

Name	Data Type	Description
`InvalidServiceLinkedRoleStateException`

POST

/#X-Amz-Target=AlexaForBusiness.CreateProfile

Creates a new room profile with the specified details.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.CreateProfile`

Body

Name	Data Type	Description
`CreateProfileRequest`	object

Properties


                        MeetingRoomConfiguration

CreateMeetingRoomConfiguration

The meeting room settings of a room profile.


                        CreateMeetingRoomConfiguration

object

Creates meeting room settings of a room profile.

Properties


                        RequireCheckIn

CreateRequireCheckIn

Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it's not checked into to make the room available for others. Users can check in by joining the meeting with Alexa or an AVS device, or by saying “Alexa, check in.”


                        CreateRequireCheckIn

object

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

Properties

`Enabled`	Boolean	Whether require check in is enabled or not.
`ReleaseAfterMinutes`	Minutes	Duration between 5 and 20 minutes to determine when to release the room if it's not checked into.


                        InstantBooking

CreateInstantBooking

Settings to automatically book a room for a configured duration if it's free when joining a meeting with Alexa.


                        CreateInstantBooking

object

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

Properties

`Enabled`	Boolean	Whether instant booking is enabled or not.
`DurationInMinutes`	Minutes	Duration between 15 and 240 minutes at increments of 15 that determines how long to book an available room when a meeting is started with Alexa.

EndOfMeetingReminder CreateEndOfMeetingReminder


                        CreateEndOfMeetingReminder

object

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

Properties

`Enabled`	Boolean	Whether an end of meeting reminder is enabled or not.
`ReminderType`	EndOfMeetingReminderType	The type of sound that users hear during the end of meeting reminder.
`ReminderAtMinutes`	EndOfMeetingReminderMinutesList	A range of 3 to 15 minutes that determines when the reminder begins.


                        RoomUtilizationMetricsEnabled

Boolean

Whether room utilization metrics are enabled or not.

Boolean boolean


                        PSTNEnabled

Boolean

Whether PSTN calling is enabled.

Boolean boolean


                        MaxVolumeLimit

MaxVolumeLimit

The maximum volume limit for a room profile.

MaxVolumeLimit integer


                        SetupModeDisabled

Boolean

Whether room profile setup is enabled.

Boolean boolean


                        ClientRequestToken

ClientRequestToken

The user-specified token that is used during the creation of a profile.


                        ClientRequestToken

string
Pattern: [a-zA-Z0-9][a-zA-Z0-9_-]*
Minimum: 10
Maximum: 150

A unique, user-specified identifier for the request that ensures idempotency.


                        Locale

DeviceLocale

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

DeviceLocale string
Minimum: 1
Maximum: 256


                        WakeWord

WakeWord

A wake word for Alexa, Echo, Amazon, or a computer.

WakeWord string
Allowed values:
- ALEXA
- AMAZON
- ECHO
- COMPUTER


                        TemperatureUnit

TemperatureUnit

The temperature unit to be used by devices in the profile.

TemperatureUnit string
Allowed values:
- FAHRENHEIT
- CELSIUS


                        DistanceUnit

DistanceUnit

The distance unit to be used by devices in the profile.

DistanceUnit string
Allowed values:
- METRIC
- IMPERIAL


                        Address

Address

The valid address for the room.

Address string
Minimum: 1
Maximum: 500


                        Timezone

Timezone

The time zone used by a room profile.

Timezone string
Minimum: 1
Maximum: 100


                        ProfileName

ProfileName

The name of a room profile.

ProfileName string
Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
Minimum: 1
Maximum: 100

Responses

200Success

Body

Name	Data Type	Description
`CreateProfileResponse`	object

Properties


                        ProfileArn

Arn

The ARN of the newly created room profile in the response.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

480LimitExceededException

Body

Name	Data Type	Description
`LimitExceededException`

481AlreadyExistsException

Body

Name	Data Type	Description
`AlreadyExistsException`

482ConcurrentModificationException

Body

Name	Data Type	Description
`ConcurrentModificationException`

POST

/#X-Amz-Target=AlexaForBusiness.CreateRoom

Creates a room with the specified details.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.CreateRoom`

Body

Name	Data Type	Description
`CreateRoomRequest`	object

Properties


                        Tags

TagList

The tags for the room.

TagList array [Tag]

Tag

object

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

Properties

`Value`	TagValue	The value of a tag. Tag values are case sensitive and can be null.
`Key`	TagKey	The key of a tag. Tag keys are case-sensitive.


                        ClientRequestToken

ClientRequestToken

A unique, user-specified identifier for this request that ensures idempotency.


                        ClientRequestToken

string
Pattern: [a-zA-Z0-9][a-zA-Z0-9_-]*
Minimum: 10
Maximum: 150

A unique, user-specified identifier for the request that ensures idempotency.


                        ProviderCalendarId

ProviderCalendarId

The calendar ARN for the room.

ProviderCalendarId string
Minimum: 0
Maximum: 100


                        ProfileArn

Arn

The profile ARN for the room.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}


                        Description

RoomDescription

The description for the room.

RoomDescription string
Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
Minimum: 1
Maximum: 200


                        RoomName

RoomName

The name for the room.

RoomName string
Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
Minimum: 1
Maximum: 100

Responses

200Success

Body

Name	Data Type	Description
`CreateRoomResponse`	object

Properties


                        RoomArn

Arn

The ARN of the newly created room in the response.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

480AlreadyExistsException

Body

Name	Data Type	Description
`AlreadyExistsException`

481LimitExceededException

Body

Name	Data Type	Description
`LimitExceededException`

POST

/#X-Amz-Target=AlexaForBusiness.CreateSkillGroup

Creates a skill group with a specified name and description.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.CreateSkillGroup`

Body

Name	Data Type	Description
`CreateSkillGroupRequest`	object

Properties


                        ClientRequestToken

ClientRequestToken

A unique, user-specified identifier for this request that ensures idempotency.


                        ClientRequestToken

string
Pattern: [a-zA-Z0-9][a-zA-Z0-9_-]*
Minimum: 10
Maximum: 150

A unique, user-specified identifier for the request that ensures idempotency.


                        Description

SkillGroupDescription

The description for the skill group.

SkillGroupDescription string
Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
Minimum: 1
Maximum: 200


                        SkillGroupName

SkillGroupName

The name for the skill group.

SkillGroupName string
Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
Minimum: 1
Maximum: 100

Responses

200Success

Body

Name	Data Type	Description
`CreateSkillGroupResponse`	object

Properties


                        SkillGroupArn

Arn

The ARN of the newly created skill group in the response.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

480AlreadyExistsException

Body

Name	Data Type	Description
`AlreadyExistsException`

481LimitExceededException

Body

Name	Data Type	Description
`LimitExceededException`

482ConcurrentModificationException

Body

Name	Data Type	Description
`ConcurrentModificationException`

POST

/#X-Amz-Target=AlexaForBusiness.CreateUser

Creates a user.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.CreateUser`

Body

Name	Data Type	Description
`CreateUserRequest`	object

Properties


                        Tags

TagList

The tags for the user.

TagList array [Tag]

Tag

object

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

Properties

`Value`	TagValue	The value of a tag. Tag values are case sensitive and can be null.
`Key`	TagKey	The key of a tag. Tag keys are case-sensitive.


                        ClientRequestToken

ClientRequestToken

A unique, user-specified identifier for this request that ensures idempotency.


                        ClientRequestToken

string
Pattern: [a-zA-Z0-9][a-zA-Z0-9_-]*
Minimum: 10
Maximum: 150

A unique, user-specified identifier for the request that ensures idempotency.


                        Email

Email

The email address for the user.

Email string
Pattern: ([0-9a-zA-Z]([+-.\w]*[0-9a-zA-Z])*@([0-9a-zA-Z]([-\w]*[0-9a-zA-Z]+)*\.)+[a-zA-Z]{2,9})
Minimum: 1
Maximum: 128


                        LastName

user_LastName

The last name for the user.

user_LastName string
Pattern: ([A-Za-z\-' 0-9._]|\p{IsLetter})*
Minimum: 0
Maximum: 30


                        FirstName

user_FirstName

The first name for the user.

user_FirstName string
Pattern: ([A-Za-z\-' 0-9._]|\p{IsLetter})*
Minimum: 0
Maximum: 30


                        UserId

user_UserId

The ARN for the user.

user_UserId string
Pattern: [a-zA-Z0-9@_+.-]*
Minimum: 1
Maximum: 128

Responses

200Success

Body

Name	Data Type	Description
`CreateUserResponse`	object

Properties


                        UserArn

Arn

The ARN of the newly created user in the response.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

480ResourceInUseException

Body

Name	Data Type	Description
`ResourceInUseException`

481LimitExceededException

Body

Name	Data Type	Description
`LimitExceededException`

482ConcurrentModificationException

Body

Name	Data Type	Description
`ConcurrentModificationException`

POST

/#X-Amz-Target=AlexaForBusiness.DeleteAddressBook

Deletes an address book by the address book ARN.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.DeleteAddressBook`

Body

Name	Data Type	Description
`DeleteAddressBookRequest`	object

Properties


                        AddressBookArn

Arn

The ARN of the address book to delete.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Responses

200Success

Body

Name	Data Type	Description
`DeleteAddressBookResponse`	object

480NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

481ConcurrentModificationException

Body

Name	Data Type	Description
`ConcurrentModificationException`

POST

/#X-Amz-Target=AlexaForBusiness.DeleteBusinessReportSchedule

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

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.DeleteBusinessReportSchedule`

Body

Name	Data Type	Description
`DeleteBusinessReportScheduleRequest`	object

Properties


                        ScheduleArn

Arn

The ARN of the business report schedule.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Responses

200Success

Body

Name	Data Type	Description
`DeleteBusinessReportScheduleResponse`	object

480NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

481ConcurrentModificationException

Body

Name	Data Type	Description
`ConcurrentModificationException`

POST

/#X-Amz-Target=AlexaForBusiness.DeleteConferenceProvider

Deletes a conference provider.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.DeleteConferenceProvider`

Body

Name	Data Type	Description
`DeleteConferenceProviderRequest`	object

Properties


                        ConferenceProviderArn

Arn

The ARN of the conference provider.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Responses

200Success

Body

Name	Data Type	Description
`DeleteConferenceProviderResponse`	object

480NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

POST

/#X-Amz-Target=AlexaForBusiness.DeleteContact

Deletes a contact by the contact ARN.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.DeleteContact`

Body

Name	Data Type	Description
`DeleteContactRequest`	object

Properties


                        ContactArn

Arn

The ARN of the contact to delete.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Responses

200Success

Body

Name	Data Type	Description
`DeleteContactResponse`	object

480NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

481ConcurrentModificationException

Body

Name	Data Type	Description
`ConcurrentModificationException`

POST

/#X-Amz-Target=AlexaForBusiness.DeleteDevice

Removes a device from Alexa For Business.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.DeleteDevice`

Body

Name	Data Type	Description
`DeleteDeviceRequest`	object

Properties


                        DeviceArn

Arn

The ARN of the device for which to request details.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Responses

200Success

Body

Name	Data Type	Description
`DeleteDeviceResponse`	object

480NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

481ConcurrentModificationException

Body

Name	Data Type	Description
`ConcurrentModificationException`

482InvalidCertificateAuthorityException

Body

Name	Data Type	Description
`InvalidCertificateAuthorityException`

POST

/#X-Amz-Target=AlexaForBusiness.DeleteDeviceUsageData

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.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.DeleteDeviceUsageData`

Body

Name	Data Type	Description
`DeleteDeviceUsageDataRequest`	object

Properties


                        DeviceUsageType

DeviceUsageType

The type of usage data to delete.

DeviceUsageType string
Allowed values:
- VOICE


                        DeviceArn

Arn

The ARN of the device.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Responses

200Success

Body

Name	Data Type	Description
`DeleteDeviceUsageDataResponse`	object

480NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

481DeviceNotRegisteredException

Body

Name	Data Type	Description
`DeviceNotRegisteredException`

482LimitExceededException

Body

Name	Data Type	Description
`LimitExceededException`

POST

/#X-Amz-Target=AlexaForBusiness.DeleteGatewayGroup

Deletes a gateway group.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.DeleteGatewayGroup`

Body

Name	Data Type	Description
`DeleteGatewayGroupRequest`	object

Properties


                        GatewayGroupArn

Arn

The ARN of the gateway group to delete.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Responses

200Success

Body

Name	Data Type	Description
`DeleteGatewayGroupResponse`	object

480ResourceAssociatedException

Body

Name	Data Type	Description
`ResourceAssociatedException`

POST

/#X-Amz-Target=AlexaForBusiness.DeleteNetworkProfile

Deletes a network profile by the network profile ARN.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.DeleteNetworkProfile`

Body

Name	Data Type	Description
`DeleteNetworkProfileRequest`	object

Properties


                        NetworkProfileArn

Arn

The ARN of the network profile associated with a device.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Responses

200Success

Body

Name	Data Type	Description
`DeleteNetworkProfileResponse`	object

480ResourceInUseException

Body

Name	Data Type	Description
`ResourceInUseException`

481ConcurrentModificationException

Body

Name	Data Type	Description
`ConcurrentModificationException`

482NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

POST

/#X-Amz-Target=AlexaForBusiness.DeleteProfile

Deletes a room profile by the profile ARN.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.DeleteProfile`

Body

Name	Data Type	Description
`DeleteProfileRequest`	object

Properties


                        ProfileArn

Arn

The ARN of the room profile to delete. Required.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Responses

200Success

Body

Name	Data Type	Description
`DeleteProfileResponse`	object

480NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

481ConcurrentModificationException

Body

Name	Data Type	Description
`ConcurrentModificationException`

POST

/#X-Amz-Target=AlexaForBusiness.DeleteRoom

Deletes a room by the room ARN.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.DeleteRoom`

Body

Name	Data Type	Description
`DeleteRoomRequest`	object

Properties


                        RoomArn

Arn

The ARN of the room to delete. Required.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Responses

200Success

Body

Name	Data Type	Description
`DeleteRoomResponse`	object

480NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

481ConcurrentModificationException

Body

Name	Data Type	Description
`ConcurrentModificationException`

POST

/#X-Amz-Target=AlexaForBusiness.DeleteRoomSkillParameter

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

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.DeleteRoomSkillParameter`

Body

Name	Data Type	Description
`DeleteRoomSkillParameterRequest`	object

Properties


                        ParameterKey

RoomSkillParameterKey

The room skill parameter key for which to remove details.

RoomSkillParameterKey string
Minimum: 1
Maximum: 256


                        SkillId

SkillId

The ID of the skill from which to remove the room skill parameter details.

SkillId string
Pattern: (^amzn1\.ask\.skill\.[0-9a-f\-]{1,200})|(^amzn1\.echo-sdk-ams\.app\.[0-9a-f\-]{1,200})


                        RoomArn

Arn

The ARN of the room from which to remove the room skill parameter details.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Responses

200Success

Body

Name	Data Type	Description
`DeleteRoomSkillParameterResponse`	object

480ConcurrentModificationException

Body

Name	Data Type	Description
`ConcurrentModificationException`

POST

/#X-Amz-Target=AlexaForBusiness.DeleteSkillAuthorization

Unlinks a third-party account from a skill.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.DeleteSkillAuthorization`

Body

Name	Data Type	Description
`DeleteSkillAuthorizationRequest`	object

Properties


                        RoomArn

Arn

The room that the skill is authorized for.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}


                        SkillId

SkillId

The unique identifier of a skill.

SkillId string
Pattern: (^amzn1\.ask\.skill\.[0-9a-f\-]{1,200})|(^amzn1\.echo-sdk-ams\.app\.[0-9a-f\-]{1,200})

Responses

200Success

Body

Name	Data Type	Description
`DeleteSkillAuthorizationResponse`	object

480NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

481ConcurrentModificationException

Body

Name	Data Type	Description
`ConcurrentModificationException`

POST

/#X-Amz-Target=AlexaForBusiness.DeleteSkillGroup

Deletes a skill group by skill group ARN.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.DeleteSkillGroup`

Body

Name	Data Type	Description
`DeleteSkillGroupRequest`	object

Properties


                        SkillGroupArn

Arn

The ARN of the skill group to delete. Required.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Responses

200Success

Body

Name	Data Type	Description
`DeleteSkillGroupResponse`	object

480NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

481ConcurrentModificationException

Body

Name	Data Type	Description
`ConcurrentModificationException`

POST

/#X-Amz-Target=AlexaForBusiness.DeleteUser

Deletes a specified user by user ARN and enrollment ARN.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.DeleteUser`

Body

Name	Data Type	Description
`DeleteUserRequest`	object

Properties


                        EnrollmentId

EnrollmentId

The ARN of the user's enrollment in the organization. Required.

EnrollmentId string
Minimum: 0
Maximum: 128


                        UserArn

Arn

The ARN of the user to delete in the organization. Required.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Responses

200Success

Body

Name	Data Type	Description
`DeleteUserResponse`	object

480NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

481ConcurrentModificationException

Body

Name	Data Type	Description
`ConcurrentModificationException`

POST

/#X-Amz-Target=AlexaForBusiness.DisassociateContactFromAddressBook

Disassociates a contact from a given address book.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.DisassociateContactFromAddressBook`

Body

Name	Data Type	Description
`DisassociateContactFromAddressBookRequest`	object

Properties


                        AddressBookArn

Arn

The ARN of the address from which to disassociate the contact.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}


                        ContactArn

Arn

The ARN of the contact to disassociate from an address book.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Responses

200Success

Body

Name	Data Type	Description
`DisassociateContactFromAddressBookResponse`	object

POST

/#X-Amz-Target=AlexaForBusiness.DisassociateDeviceFromRoom

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.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.DisassociateDeviceFromRoom`

Body

Name	Data Type	Description
`DisassociateDeviceFromRoomRequest`	object

Properties


                        DeviceArn

Arn

The ARN of the device to disassociate from a room. Required.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Responses

200Success

Body

Name	Data Type	Description
`DisassociateDeviceFromRoomResponse`	object

480ConcurrentModificationException

Body

Name	Data Type	Description
`ConcurrentModificationException`

481DeviceNotRegisteredException

Body

Name	Data Type	Description
`DeviceNotRegisteredException`

POST

/#X-Amz-Target=AlexaForBusiness.DisassociateSkillFromSkillGroup

Disassociates a skill from a skill group.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.DisassociateSkillFromSkillGroup`

Body

Name	Data Type	Description
`DisassociateSkillFromSkillGroupRequest`	object

Properties


                        SkillId

SkillId

The ARN of a skill group to associate to a skill.

SkillId string
Pattern: (^amzn1\.ask\.skill\.[0-9a-f\-]{1,200})|(^amzn1\.echo-sdk-ams\.app\.[0-9a-f\-]{1,200})


                        SkillGroupArn

Arn

The unique identifier of a skill. Required.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Responses

200Success

Body

Name	Data Type	Description
`DisassociateSkillFromSkillGroupResponse`	object

480ConcurrentModificationException

Body

Name	Data Type	Description
`ConcurrentModificationException`

481NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

POST

/#X-Amz-Target=AlexaForBusiness.DisassociateSkillFromUsers

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

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.DisassociateSkillFromUsers`

Body

Name	Data Type	Description
`DisassociateSkillFromUsersRequest`	object

Properties


                        SkillId

SkillId

The private skill ID you want to make unavailable for enrolled users.

SkillId string
Pattern: (^amzn1\.ask\.skill\.[0-9a-f\-]{1,200})|(^amzn1\.echo-sdk-ams\.app\.[0-9a-f\-]{1,200})

Responses

200Success

Body

Name	Data Type	Description
`DisassociateSkillFromUsersResponse`	object

480ConcurrentModificationException

Body

Name	Data Type	Description
`ConcurrentModificationException`

481NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

POST

/#X-Amz-Target=AlexaForBusiness.DisassociateSkillGroupFromRoom

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

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.DisassociateSkillGroupFromRoom`

Body

Name	Data Type	Description
`DisassociateSkillGroupFromRoomRequest`	object

Properties


                        RoomArn

Arn

The ARN of the room from which the skill group is to be disassociated. Required.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}


                        SkillGroupArn

Arn

The ARN of the skill group to disassociate from a room. Required.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Responses

200Success

Body

Name	Data Type	Description
`DisassociateSkillGroupFromRoomResponse`	object

480ConcurrentModificationException

Body

Name	Data Type	Description
`ConcurrentModificationException`

POST

/#X-Amz-Target=AlexaForBusiness.ForgetSmartHomeAppliances

Forgets smart home appliances associated to a room.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.ForgetSmartHomeAppliances`

Body

Name	Data Type	Description
`ForgetSmartHomeAppliancesRequest`	object

Properties


                        RoomArn

Arn

The room that the appliances are associated with.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Responses

200Success

Body

Name	Data Type	Description
`ForgetSmartHomeAppliancesResponse`	object

480NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

POST

/#X-Amz-Target=AlexaForBusiness.GetAddressBook

Gets address the book details by the address book ARN.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.GetAddressBook`

Body

Name	Data Type	Description
`GetAddressBookRequest`	object

Properties


                        AddressBookArn

Arn

The ARN of the address book for which to request details.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Responses

200Success

Body

Name	Data Type	Description
`GetAddressBookResponse`	object

Properties


                        AddressBook

AddressBook

The details of the requested address book.


                        AddressBook

object

An address book with attributes.

Properties


                        Description

AddressBookDescription

The description of the address book.

AddressBookDescription string
Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
Minimum: 1
Maximum: 200


                        Name

AddressBookName

The name of the address book.

AddressBookName string
Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
Minimum: 1
Maximum: 100


                        AddressBookArn

Arn

The ARN of the address book.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

480NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

POST

/#X-Amz-Target=AlexaForBusiness.GetConferencePreference

Retrieves the existing conference preferences.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.GetConferencePreference`

Body

Name	Data Type	Description
`GetConferencePreferenceRequest`	object

Responses

200Success

Body

Name	Data Type	Description
`GetConferencePreferenceResponse`	object

Properties


                        Preference

ConferencePreference

The conference preference.


                        ConferencePreference

object

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

Properties


                        DefaultConferenceProviderArn

Arn

The ARN of the default conference provider.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

480NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

POST

/#X-Amz-Target=AlexaForBusiness.GetConferenceProvider

Gets details about a specific conference provider.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.GetConferenceProvider`

Body

Name	Data Type	Description
`GetConferenceProviderRequest`	object

Properties


                        ConferenceProviderArn

Arn

The ARN of the newly created conference provider.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Responses

200Success

Body

Name	Data Type	Description
`GetConferenceProviderResponse`	object

Properties


                        ConferenceProvider

ConferenceProvider

The conference provider.


                        ConferenceProvider

object

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

Properties


                        MeetingSetting

MeetingSetting

The meeting settings for the conference provider.


                        MeetingSetting

object

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

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

Properties


                        RequirePin

RequirePin

The values that indicate whether the pin is always required.


                        PSTNDialIn

PSTNDialIn

The information for PSTN conferencing.


                        PSTNDialIn

object

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

Properties

`OneClickPinDelay`	OneClickPinDelay	The delay duration before Alexa enters the conference pin with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.
`OneClickIdDelay`	OneClickIdDelay	The delay duration before Alexa enters the conference ID with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.
`PhoneNumber`	OutboundPhoneNumber	The phone number to call to join the conference.
`CountryCode`	CountryCode	The zip code.


                        IPDialIn

IPDialIn

The IP endpoint and protocol for calling.


                        IPDialIn

object

The IP endpoint and protocol for calling.

Properties

`CommsProtocol`	CommsProtocol	The protocol, including SIP, SIPS, and H323.
`Endpoint`	Endpoint	The IP address.


                        Type

ConferenceProviderType

The type of conference providers.

ConferenceProviderType string
Allowed values:
- CHIME
- BLUEJEANS
- FUZE
- GOOGLE_HANGOUTS
- POLYCOM
- RINGCENTRAL
- SKYPE_FOR_BUSINESS
- WEBEX
- ZOOM
- CUSTOM


                        Name

ConferenceProviderName

The name of the conference provider.

ConferenceProviderName string
Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
Minimum: 1
Maximum: 50

Arn

Arn

The ARN of the newly created conference provider.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

480NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

POST

/#X-Amz-Target=AlexaForBusiness.GetContact

Gets the contact details by the contact ARN.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.GetContact`

Body

Name	Data Type	Description
`GetContactRequest`	object

Properties


                        ContactArn

Arn

The ARN of the contact for which to request details.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Responses

200Success

Body

Name	Data Type	Description
`GetContactResponse`	object

Properties


                        Contact

Contact

The details of the requested contact.


                        Contact

object

A contact with attributes.

Properties


                        SipAddresses

SipAddressList

The list of SIP addresses for the contact.

SipAddressList array [SipAddress]


                        PhoneNumbers

PhoneNumberList

The list of phone numbers for the contact.

PhoneNumberList array [PhoneNumber]


                        PhoneNumber

RawPhoneNumber

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

RawPhoneNumber password
Pattern: ^[\+0-9\#\,$][\+0-9\-\.\/\($\,\#\s]+$
Minimum: 0
Maximum: 50


                        LastName

ContactName

The last name of the contact, used to call the contact on the device.

ContactName string
Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
Minimum: 1
Maximum: 100


                        FirstName

ContactName

The first name of the contact, used to call the contact on the device.

ContactName string
Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
Minimum: 1
Maximum: 100


                        DisplayName

ContactName

The name of the contact to display on the console.

ContactName string
Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
Minimum: 1
Maximum: 100


                        ContactArn

Arn

The ARN of the contact.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

480NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

POST

/#X-Amz-Target=AlexaForBusiness.GetDevice

Gets the details of a device by device ARN.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.GetDevice`

Body

Name	Data Type	Description
`GetDeviceRequest`	object

Properties


                        DeviceArn

Arn

The ARN of the device for which to request details. Required.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Responses

200Success

Body

Name	Data Type	Description
`GetDeviceResponse`	object

Properties


                        Device

Device

The details of the device requested. Required.


                        Device

object

A device with attributes.

Properties


                        NetworkProfileInfo

DeviceNetworkProfileInfo

Detailed information about a device's network profile.


                        DeviceNetworkProfileInfo

object

Detailed information about a device's network profile.

Properties

`CertificateExpirationTime`	CertificateTime	The time (in epoch) when the certificate expires.
`CertificateArn`	Arn	The ARN of the certificate associated with a device.
`NetworkProfileArn`	Arn	The ARN of the network profile associated with a device.


                        DeviceStatusInfo

DeviceStatusInfo

Detailed information about a device's status.


                        DeviceStatusInfo

object

Detailed information about a device's status.

Properties

`ConnectionStatusUpdatedTime`	ConnectionStatusUpdatedTime	The time (in epoch) when the device connection status changed.
`ConnectionStatus`	ConnectionStatus	The latest available information about the connection status of a device.
`DeviceStatusDetails`	DeviceStatusDetails	One or more device status detail descriptions.


                        DeviceStatus

DeviceStatus

The status of a device. If the status is not READY, check the DeviceStatusInfo value for details.

DeviceStatus string
Allowed values:
- READY
- PENDING
- WAS_OFFLINE
- DEREGISTERED
- FAILED


                        RoomArn

Arn

The room ARN of a device.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}


                        MacAddress

MacAddress

The MAC address of a device.

MacAddress string


                        SoftwareVersion

SoftwareVersion

The software version of a device.

SoftwareVersion string


                        DeviceName

DeviceName

The name of a device.

DeviceName string
Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
Minimum: 2
Maximum: 100


                        DeviceType

DeviceType

The type of a device.

DeviceType string
Pattern: [a-zA-Z0-9]{1,200}


                        DeviceSerialNumber

DeviceSerialNumber

The serial number of a device.

DeviceSerialNumber string
Pattern: [a-zA-Z0-9]{1,200}


                        DeviceArn

Arn

The ARN of a device.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

480NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

POST

/#X-Amz-Target=AlexaForBusiness.GetGatewayGroup

Retrieves the details of a gateway group.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.GetGatewayGroup`

Body

Name	Data Type	Description
`GetGatewayGroupRequest`	object

Properties


                        GatewayGroupArn

Arn

The ARN of the gateway group to get.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Responses

200Success

Body

Name	Data Type	Description
`GetGatewayGroupResponse`	object

Properties

GatewayGroup GatewayGroup


                        GatewayGroup

object

The details of the gateway group.

Properties


                        Description

GatewayGroupDescription

The description of the gateway group.

GatewayGroupDescription string
Minimum: 0
Maximum: 200


                        Name

GatewayGroupName

The name of the gateway group.

GatewayGroupName string
Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
Minimum: 1
Maximum: 100

Arn

Arn

The ARN of the gateway group.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

480NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

POST

/#X-Amz-Target=AlexaForBusiness.GetGateway

Retrieves the details of a gateway.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.GetGateway`

Body

Name	Data Type	Description
`GetGatewayRequest`	object

Properties


                        GatewayArn

Arn

The ARN of the gateway to get.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Responses

200Success

Body

Name	Data Type	Description
`GetGatewayResponse`	object

Properties


                        Gateway

Gateway

The details of the gateway.


                        Gateway

object

The details of the gateway.

Properties


                        SoftwareVersion

GatewayVersion

The software version of the gateway. The gateway automatically updates its software version during normal operation.

GatewayVersion string
Minimum: 1
Maximum: 50


                        GatewayGroupArn

Arn

The ARN of the gateway group that the gateway is associated to.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}


                        Description

GatewayDescription

The description of the gateway.

GatewayDescription string
Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
Minimum: 0
Maximum: 200


                        Name

GatewayName

The name of the gateway.

GatewayName string
Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
Minimum: 1
Maximum: 253

Arn

Arn

The ARN of the gateway.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

480NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

POST

/#X-Amz-Target=AlexaForBusiness.GetInvitationConfiguration

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

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.GetInvitationConfiguration`

Body

Name	Data Type	Description
`GetInvitationConfigurationRequest`	object

Responses

200Success

Body

Name	Data Type	Description
`GetInvitationConfigurationResponse`	object

Properties


                        PrivateSkillIds

ShortSkillIdList

The list of private skill IDs that you want to recommend to the user to enable in the invitation.

ShortSkillIdList array [SkillId]
Pattern: (^amzn1\.ask\.skill\.[0-9a-f\-]{1,200})|(^amzn1\.echo-sdk-ams\.app\.[0-9a-f\-]{1,200})

SkillId string
Pattern: (^amzn1\.ask\.skill\.[0-9a-f\-]{1,200})|(^amzn1\.echo-sdk-ams\.app\.[0-9a-f\-]{1,200})


                        ContactEmail

Email

The email ID of the organization or individual contact that the enrolled user can use.

Email string
Pattern: ([0-9a-zA-Z]([+-.\w]*[0-9a-zA-Z])*@([0-9a-zA-Z]([-\w]*[0-9a-zA-Z]+)*\.)+[a-zA-Z]{2,9})
Minimum: 1
Maximum: 128


                        OrganizationName

OrganizationName

The name of the organization sending the enrollment invite to a user.

OrganizationName string
Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
Minimum: 1
Maximum: 100

480NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

POST

/#X-Amz-Target=AlexaForBusiness.GetNetworkProfile

Gets the network profile details by the network profile ARN.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.GetNetworkProfile`

Body

Name	Data Type	Description
`GetNetworkProfileRequest`	object

Properties


                        NetworkProfileArn

Arn

The ARN of the network profile associated with a device.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Responses

200Success

Body

Name	Data Type	Description
`GetNetworkProfileResponse`	object

Properties


                        NetworkProfile

NetworkProfile

The network profile associated with a device.


                        NetworkProfile

object

The network profile associated with a device.

Properties


                        TrustAnchors

TrustAnchorList

The root certificates of your authentication server, which is installed on your devices and used to trust your authentication server during EAP negotiation.

TrustAnchorList array [TrustAnchor]
Pattern: -{5}BEGIN CERTIFICATE-{5}\u000D?\u000A([A-Za-z0-9/+]{64}\u000D?\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\u000D?\u000A-{5}END CERTIFICATE-{5}(\u000D?\u000A)?


                        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.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}


                        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.

NextWiFiPassword password
Pattern: (^$)|([\x00-\x7F]{5,})
Minimum: 0
Maximum: 128


                        CurrentPassword

CurrentWiFiPassword

The current password of the Wi-Fi network.

CurrentWiFiPassword password
Pattern: [\x00-\x7F]*
Minimum: 5
Maximum: 128


                        EapMethod

NetworkEapMethod

The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.

NetworkEapMethod string
Allowed values:
- EAP_TLS


                        SecurityType

NetworkSecurityType

The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.

NetworkSecurityType string
Allowed values:
- OPEN
- WEP
- WPA_PSK
- WPA2_PSK
- WPA2_ENTERPRISE


                        Ssid

NetworkSsid

The SSID of the Wi-Fi network.

NetworkSsid string
Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
Minimum: 1
Maximum: 32


                        Description

NetworkProfileDescription

Detailed information about a device's network profile.

NetworkProfileDescription string
Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
Minimum: 0
Maximum: 200


                        NetworkProfileName

NetworkProfileName

The name of the network profile associated with a device.

NetworkProfileName string
Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
Minimum: 1
Maximum: 100


                        NetworkProfileArn

Arn

The ARN of the network profile associated with a device.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

480NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

481InvalidSecretsManagerResourceException

Body

Name	Data Type	Description
`InvalidSecretsManagerResourceException`

POST

/#X-Amz-Target=AlexaForBusiness.GetProfile

Gets the details of a room profile by profile ARN.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.GetProfile`

Body

Name	Data Type	Description
`GetProfileRequest`	object

Properties


                        ProfileArn

Arn

The ARN of the room profile for which to request details. Required.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Responses

200Success

Body

Name	Data Type	Description
`GetProfileResponse`	object

Properties


                        Profile

Profile

The details of the room profile requested. Required.


                        Profile

object

A room profile with attributes.

Properties


                        MeetingRoomConfiguration

MeetingRoomConfiguration

Meeting room settings of a room profile.


                        MeetingRoomConfiguration

object

Meeting room settings of a room profile.

Properties

`RequireCheckIn`	RequireCheckIn	Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it's not checked into. This makes the room available for others. Users can check in by joining the meeting with Alexa or an AVS device, or by saying “Alexa, check in.”
`InstantBooking`	InstantBooking	Settings to automatically book the room if available for a configured duration when joining a meeting with Alexa.
`EndOfMeetingReminder`	EndOfMeetingReminder	Settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.
`RoomUtilizationMetricsEnabled`	Boolean	Whether room utilization metrics are enabled or not.


                        AddressBookArn

Arn

The ARN of the address book.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}


                        PSTNEnabled

Boolean

The PSTN setting of a room profile.

Boolean boolean


                        MaxVolumeLimit

MaxVolumeLimit

The max volume limit of a room profile.

MaxVolumeLimit integer


                        SetupModeDisabled

Boolean

The setup mode of a room profile.

Boolean boolean


                        Locale

DeviceLocale

The locale of a room profile. (This is currently available only to a limited preview audience.)

DeviceLocale string
Minimum: 1
Maximum: 256


                        WakeWord

WakeWord

The wake word of a room profile.

WakeWord string
Allowed values:
- ALEXA
- AMAZON
- ECHO
- COMPUTER


                        TemperatureUnit

TemperatureUnit

The temperature unit of a room profile.

TemperatureUnit string
Allowed values:
- FAHRENHEIT
- CELSIUS


                        DistanceUnit

DistanceUnit

The distance unit of a room profile.

DistanceUnit string
Allowed values:
- METRIC
- IMPERIAL


                        Timezone

Timezone

The time zone of a room profile.

Timezone string
Minimum: 1
Maximum: 100


                        Address

Address

The address of a room profile.

Address string
Minimum: 1
Maximum: 500


                        IsDefault

Boolean

Retrieves if the profile is default or not.

Boolean boolean


                        ProfileName

ProfileName

The name of a room profile.

ProfileName string
Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
Minimum: 1
Maximum: 100


                        ProfileArn

Arn

The ARN of a room profile.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

480NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

POST

/#X-Amz-Target=AlexaForBusiness.GetRoom

Gets room details by room ARN.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AlexaForBusiness.GetRoom`

Body

Name	Data Type	Description
`GetRoomRequest`	object

Properties


                        RoomArn

Arn

The ARN of the room for which to request details. Required.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Responses

200Success

Body

Name	Data Type	Description
`GetRoomResponse`	object

Properties


                        Room

Room

The details of the room requested.


                        Room

object

A room with attributes.

Properties


                        ProfileArn

Arn

The profile ARN of a room.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}


                        ProviderCalendarId

ProviderCalendarId

The provider calendar ARN of a room.

ProviderCalendarId string
Minimum: 0
Maximum: 100


                        Description

RoomDescription

The description of a room.

RoomDescription string
Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
Minimum: 1
Maximum: 200


                        RoomName

RoomName

The name of a room.

RoomName string
Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
Minimum: 1
Maximum: 100


                        RoomArn

Arn

The ARN of a room.

Arn string
Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

480NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

POST

Alexa For Business

Resources

Request

Header

Body

Properties

Responses

Body

Body

Body

Body

Request

Header

Body

Properties

Responses

Body

Body

Request

Header

Body

Properties

Responses

Body

Body

Body

Body

Request

Header

Body

Properties

Responses

Body

Body

Body

Body

Request

Header

Body

Properties

Responses

Body

Body

Request

Header

Body

Properties

Responses

Body

Body

Body

Body

Request

Header

Body

Properties

Responses

Body

Body

Body

Request

Header

Body

Properties

Responses

Body

Properties

Body

Body

Request

Header

Body

Properties

Properties

Properties

Responses

Body

Properties

Body

Request