PutInvitationConfiguration
Configures the email template for the user enrollment invitation with the specified attributes.
Request Syntax
{
"ContactEmail": "string", "OrganizationName": "string", "PrivateSkillIds": [ "string" ] }
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 307).
The request accepts the following data in JSON format.
ContactEmail (p. 142)
The email ID of the organization or individual contact that the enrolled user can use.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: ([0-9a-zA-Z]([+-.\w]*[0-9a-zA-Z])*@([0-9a-zA-Z]([-\w]*[0-9a-zA-Z]+)*
\.)+[a-zA-Z]{2,9}) Required: No
OrganizationName (p. 142)
The name of the organization sending the enrollment invite to a user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD
\u10000-\u10FFFF]*
Required: Yes PrivateSkillIds (p. 142)
The list of private skill IDs that you want to recommend to the user to enable in the invitation.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 3 items.
Pattern: (^amzn1\.ask\.skill\.[0-9a-f\-]{1,200})|(^amzn1\.echo-sdk-ams\.app\.
[0-9a-f\-]{1,200}) Required: No
Response Elements
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 309).
ConcurrentModificationException
There is a concurrent modification of resources.
HTTP Status Code: 400 NotFoundException
The resource is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
PutRoomSkillParameter
PutRoomSkillParameter
Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.
Request Syntax
{ "RoomArn": "string", "RoomSkillParameter": { "ParameterKey": "string", "ParameterValue": "string"
},
"SkillId": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 307).
The request accepts the following data in JSON format.
RoomArn (p. 144)
The ARN of the room associated with the room skill parameter. Required.
Type: 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}
Required: No
RoomSkillParameter (p. 144)
The updated room skill parameter. Required.
Type: RoomSkillParameter (p. 286) object Required: Yes
SkillId (p. 144)
The ARN of the skill associated with the room skill parameter. Required.
Type: String
Pattern: (^amzn1\.ask\.skill\.[0-9a-f\-]{1,200})|(^amzn1\.echo-sdk-ams\.app\.
[0-9a-f\-]{1,200}) Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
Errors
For information about the errors that are common to all actions, see Common Errors (p. 309).
ConcurrentModificationException
There is a concurrent modification of resources.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
PutSkillAuthorization
PutSkillAuthorization
Links a user's account to a third-party skill provider. If this API operation is called by an assumed IAM role, the skill being linked must be a private skill. Also, the skill must be owned by the AWS account that assumed the IAM role.
Request Syntax
{ "AuthorizationResult": { "string" : "string"
},
"RoomArn": "string", "SkillId": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 307).
The request accepts the following data in JSON format.
AuthorizationResult (p. 146)
The authorization result specific to OAUTH code grant output. "Code” must be populated in the AuthorizationResult map to establish the authorization.
Type: String to string map
Key Length Constraints: Minimum length of 1.
Value Length Constraints: Minimum length of 1.
Required: Yes RoomArn (p. 146)
The room that the skill is authorized for.
Type: 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}
Required: No SkillId (p. 146)
The unique identifier of a skill.
Type: String
Pattern: (^amzn1\.ask\.skill\.[0-9a-f\-]{1,200})|(^amzn1\.echo-sdk-ams\.app\.
[0-9a-f\-]{1,200}) Required: Yes
Response Elements
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 309).
ConcurrentModificationException
There is a concurrent modification of resources.
HTTP Status Code: 400 UnauthorizedException
The caller has no permissions to operate on the resource involved in the API call.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
RegisterAVSDevice
RegisterAVSDevice
Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).
Request Syntax
{
"AmazonId": "string", "ClientId": "string",
"DeviceSerialNumber": "string", "ProductId": "string",
"RoomArn": "string", "Tags": [
"UserCode": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 307).
The request accepts the following data in JSON format.
AmazonId (p. 148)
The device type ID for your AVS device generated by Amazon when the OEM creates a new product on Amazon's Developer Console.
Type: String
Pattern: [a-zA-Z0-9]{1,18}
Required: Yes ClientId (p. 148)
The client ID of the OEM used for code-based linking authorization on an AVS device.
Type: String
Pattern: ^\S+{1,256}$
Required: Yes
DeviceSerialNumber (p. 148)
The key generated by the OEM that uniquely identifies a specified instance of your AVS device.
Type: String
Pattern: ^[a-zA-Z0-9]{1,50}$
Required: No
Response Syntax
ProductId (p. 148)
The product ID used to identify your AVS device during authorization.
Type: String
Pattern: ^[a-zA-Z0-9_]{1,256}$
Required: Yes RoomArn (p. 148)
The Amazon Resource Name (ARN) of the room with which to associate your AVS device.
Type: 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}
Required: No Tags (p. 148)
The tags to be added to the specified resource. Do not provide system tags.
Type: Array of Tag (p. 299) objects Required: No
UserCode (p. 148)
The code that is obtained after your AVS device has made a POST request to LWA as a part of the Device Authorization Request component of the OAuth code-based linking specification.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes
Response Syntax
{ "DeviceArn": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
DeviceArn (p. 149) The ARN of the device.
Type: 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}
Errors
Errors
For information about the errors that are common to all actions, see Common Errors (p. 309).
ConcurrentModificationException
There is a concurrent modification of resources.
HTTP Status Code: 400 InvalidDeviceException
The device is in an invalid state.
HTTP Status Code: 400 LimitExceededException
You are performing an action that would put you beyond your account's limits.
HTTP Status Code: 400 NotFoundException
The resource is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
RejectSkill
RejectSkill
Disassociates a skill from the organization under a user's AWS account. If the skill is a private skill, it moves to an AcceptStatus of PENDING. Any private or public skill that is rejected can be added later by calling the ApproveSkill API.
Request Syntax
{
"SkillId": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 307).
The request accepts the following data in JSON format.
SkillId (p. 151)
The unique identifier of the skill.
Type: String
Pattern: (^amzn1\.ask\.skill\.[0-9a-f\-]{1,200})|(^amzn1\.echo-sdk-ams\.app\.
[0-9a-f\-]{1,200}) Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 309).
ConcurrentModificationException
There is a concurrent modification of resources.
HTTP Status Code: 400 NotFoundException
The resource is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
See Also
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ResolveRoom
ResolveRoom
Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.
To query ResolveRoom from an Alexa skill, the skill ID needs to be authorized. When the skill is using an AWS Lambda function, the skill is automatically authorized when you publish your skill as a private skill to your AWS account. Skills that are hosted using a custom web service must be manually authorized. To get your skill authorized, contact AWS Support with your AWS account ID that queries the ResolveRoom API and skill ID.
Request Syntax
{ "SkillId": "string", "UserId": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 307).
The request accepts the following data in JSON format.
SkillId (p. 153)
The ARN of the skill that was requested. Required.
Type: String
Pattern: (^amzn1\.ask\.skill\.[0-9a-f\-]{1,200})|(^amzn1\.echo-sdk-ams\.app\.
[0-9a-f\-]{1,200}) Required: Yes
UserId (p. 153)
The ARN of the user. Required.
Type: String
Pattern: amzn1\.[A-Za-z0-9+-\/=.]{1,300}
Required: Yes
Response Syntax
{
"RoomArn": "string", "RoomName": "string", "RoomSkillParameters": [ {
"ParameterKey": "string", "ParameterValue": "string"
}
Response Elements
] }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
RoomArn (p. 153)
The ARN of the room from which the skill request was invoked.
Type: 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}
RoomName (p. 153)
The name of the room from which the skill request was invoked.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD
\u10000-\u10FFFF]*
RoomSkillParameters (p. 153)
Response to get the room profile request. Required.
Type: Array of RoomSkillParameter (p. 286) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 309).
NotFoundException
The resource is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
See Also
• AWS SDK for Python
• AWS SDK for Ruby V3
RevokeInvitation
RevokeInvitation
Revokes an invitation and invalidates the enrollment URL.
Request Syntax
{ "EnrollmentId": "string", "UserArn": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 307).
The request accepts the following data in JSON format.
EnrollmentId (p. 156)
The ARN of the enrollment invitation to revoke. Required.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Required: No UserArn (p. 156)
The ARN of the user for whom to revoke an enrollment invitation. Required.
Type: 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}
Required: No
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 309).
ConcurrentModificationException
There is a concurrent modification of resources.
HTTP Status Code: 400 NotFoundException
The resource is not found.
See Also
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
SearchAddressBooks
SearchAddressBooks
Searches address books and lists the ones that meet a set of filter and sort criteria.
Request Syntax
"MaxResults": number, "NextToken": "string", "SortCriteria": [
For information about the parameters that are common to all actions, see Common Parameters (p. 307).
The request accepts the following data in JSON format.
Filters (p. 158)
The filters to use to list a specified set of address books. The supported filter key is AddressBookName.
Type: Array of Filter (p. 257) objects
Array Members: Maximum number of 25 items.
Required: No MaxResults (p. 158)
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 50.
Required: No NextToken (p. 158)
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.
Type: String
Response Syntax
Length Constraints: Minimum length of 1. Maximum length of 1100.
Required: No SortCriteria (p. 158)
The sort order to use in listing the specified set of address books. The supported sort key is AddressBookName.
Type: Array of Sort (p. 297) objects
Array Members: Maximum number of 25 items.
Required: No
"NextToken": "string", "TotalCount": number }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
AddressBooks (p. 159)
The address books that meet the specified set of filter criteria, in sort order.
Type: Array of AddressBookData (p. 225) objects NextToken (p. 159)
The token returned to indicate that there is more data available.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1100.
TotalCount (p. 159)
The total number of address books returned.
Type: Integer
Errors
For information about the errors that are common to all actions, see Common Errors (p. 309).
See Also
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
SearchContacts
SearchContacts
Searches contacts and lists the ones that meet a set of filter and sort criteria.
Request Syntax
"MaxResults": number, "NextToken": "string", "SortCriteria": [
For information about the parameters that are common to all actions, see Common Parameters (p. 307).
The request accepts the following data in JSON format.
Filters (p. 161)
The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.
Type: Array of Filter (p. 257) objects
Array Members: Maximum number of 25 items.
Required: No MaxResults (p. 161)
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 50.
Required: No NextToken (p. 161)
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.
Type: String
Response Syntax
Length Constraints: Minimum length of 1. Maximum length of 1100.
Required: No SortCriteria (p. 161)
The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.
Type: Array of Sort (p. 297) objects
Array Members: Maximum number of 25 items.
Required: No
"NextToken": "string", "TotalCount": number }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Contacts (p. 162)
The contacts that meet the specified set of filter criteria, in sort order.
Type: Array of ContactData (p. 239) objects NextToken (p. 162)
The token returned to indicate that there is more data available.
Type: String
Errors
Length Constraints: Minimum length of 1. Maximum length of 1100.
TotalCount (p. 162)
The total number of contacts returned.
Type: Integer
Errors
For information about the errors that are common to all actions, see Common Errors (p. 309).
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
SearchDevices
SearchDevices
Searches devices and lists the ones that meet a set of filter criteria.
Request Syntax
"MaxResults": number, "NextToken": "string", "SortCriteria": [
For information about the parameters that are common to all actions, see Common Parameters (p. 307).
The request accepts the following data in JSON format.
Filters (p. 164)
The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, ConnectionStatus (ONLINE and OFFLINE), NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.
Type: Array of Filter (p. 257) objects
Array Members: Maximum number of 25 items.
Required: No MaxResults (p. 164)
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 50.
Required: No NextToken (p. 164)
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
Response Syntax
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1100.
Required: No SortCriteria (p. 164)
The sort order to use in listing the specified set of devices. Supported sort keys are
DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, ConnectionStatus, NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.
Type: Array of Sort (p. 297) objects
Array Members: Maximum number of 25 items.
Required: No
"NextToken": "string", "TotalCount": number }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Devices (p. 165)
The devices that meet the specified set of filter criteria, in sort order.
Errors
Type: Array of DeviceData (p. 249) objects NextToken (p. 165)
The token returned to indicate that there is more data available.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1100.
TotalCount (p. 165)
The total number of devices returned.
Type: Integer
Errors
For information about the errors that are common to all actions, see Common Errors (p. 309).
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3