GetInvitationConﬁguration

Retrieves the conﬁgured values for the user enrollment invitation email template.

Response Syntax

{ "ContactEmail": "string", "OrganizationName": "string", "PrivateSkillIds": [ "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.

ContactEmail (p. 105)

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}) OrganizationName (p. 105)

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]*

PrivateSkillIds (p. 105)

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

Errors

For information about the errors that are common to all actions, see Common Errors (p. 309).

NotFoundException

The resource is not found.

Request Syntax

{ "NetworkProfileArn": "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.

NetworkProﬁleArn (p. 107)

The ARN of the network proﬁle associated with a device.

Type: String

"NetworkProfile": {

"CertificateAuthorityArn": "string", "CurrentPassword": "string",

"Description": "string", "EapMethod": "string",

"NetworkProfileArn": "string", "NetworkProfileName": "string", "NextPassword": "string", "SecurityType": "string", "Ssid": "string",

"TrustAnchors": [ "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.

NetworkProﬁle (p. 107)

The network proﬁle associated with a device.

Errors

Type: NetworkProﬁle (p. 268) object

Errors

For information about the errors that are common to all actions, see Common Errors (p. 309).

InvalidSecretsManagerResourceException

A password in SecretsManager is in an invalid state.

HTTP Status Code: 400 NotFoundException

The resource is not found.

HTTP Status Code: 400

Request Syntax

{ "ProfileArn": "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.

ProﬁleArn (p. 109)

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

Type: String "AddressBookArn": "string", "DataRetentionOptIn": boolean, "DistanceUnit": "string", "IsDefault": boolean, "Locale": "string", "MaxVolumeLimit": number, "MeetingRoomConfiguration": { "EndOfMeetingReminder": {

"RoomUtilizationMetricsEnabled": boolean },

"ProfileArn": "string", "ProfileName": "string",

Response Elements

"PSTNEnabled": boolean, "SetupModeDisabled": boolean, "TemperatureUnit": "string", "Timezone": "string", "WakeWord": "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.

Proﬁle (p. 109)

The details of the room proﬁle requested. Required.

Type: Proﬁle (p. 274) object

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

Request Syntax

{

"RoomArn": "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. 111)

The ARN of the room for which to request details. 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 Syntax

{

"Room": {

"Description": "string", "ProfileArn": "string",

"ProviderCalendarId": "string", "RoomArn": "string",

"RoomName": "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.

Room (p. 111)

The details of the room requested.

Type: Room (p. 282) object

Errors

For information about the errors that are common to all actions, see Common Errors (p. 309).

Request Syntax

{

"ParameterKey": "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.

ParameterKey (p. 113)

The room skill parameter key for which to get details. Required.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes RoomArn (p. 113)

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

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

The ARN of the skill from which to get the room skill parameter details. 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 Syntax

{ "RoomSkillParameter": { "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.

RoomSkillParameter (p. 113)

The details of the room skill parameter requested. Required.

Type: RoomSkillParameter (p. 286) object

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

Request Syntax

{

"SkillGroupArn": "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.

SkillGroupArn (p. 115)

The ARN of the skill group for which to get details. 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 Syntax

{ "SkillGroup": {

"Description": "string", "SkillGroupArn": "string", "SkillGroupName": "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.

SkillGroup (p. 115)

The details of the skill group requested. Required.

Type: SkillGroup (p. 290) object

Errors

For information about the errors that are common to all actions, see Common Errors (p. 309).

Request Syntax

{

"MaxResults": number, "NextToken": "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.

MaxResults (p. 117)

The maximum number of schedules listed in the call.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No NextToken (p. 117)

The token used to list the remaining schedules from the previous API call.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1100.

Required: No

Response Syntax

{ "BusinessReportSchedules": [ {

Response Elements

"NextToken": "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.

BusinessReportSchedules (p. 117) The schedule of the reports.

Type: Array of BusinessReportSchedule (p. 231) objects NextToken (p. 117)

The token used to list the remaining schedules from the previous API call.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1100.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 309).

Request Syntax

{ "MaxResults": number, "NextToken": "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.

MaxResults (p. 119)

The maximum number of conference providers to be returned, per paginated calls.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No NextToken (p. 119)

The tokens used for pagination.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1100.

Required: No

Response Syntax

{ "ConferenceProviders": [ {

Response Elements

"Type": "string"

} ],

"NextToken": "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.

ConferenceProviders (p. 119) The conference providers.

Type: Array of ConferenceProvider (p. 235) objects NextToken (p. 119)

The tokens used for pagination.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1100.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 309).

Request Syntax

{ "DeviceArn": "string", "EventType": "string", "MaxResults": number, "NextToken": "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.

DeviceArn (p. 121) The ARN of a 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: Yes EventType (p. 121)

The event type to ﬁlter device events. If EventType isn't speciﬁed, this returns a list of all device events in reverse chronological order. If EventType is speciﬁed, this returns a list of device events for that EventType in reverse chronological order.

Type: String

Valid Values: CONNECTION_STATUS | DEVICE_STATUS Required: No

MaxResults (p. 121)

The maximum number of results to include in the response. The default value is 50. If more results exist than the speciﬁed 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. 121)

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is speciﬁed, the response only includes results beyond the token, up to the value speciﬁed by MaxResults. When the end of results is reached, the response has a value of null.

Response Syntax

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1100.

Required: No

Response Syntax

{ "DeviceEvents": [ {

"Timestamp": number, "Type": "string", "Value": "string"

} ],

"NextToken": "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.

DeviceEvents (p. 122)

The device events requested for the device ARN.

Type: Array of DeviceEvent (p. 252) objects NextToken (p. 122)

The token returned to indicate that there is more data available.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1100.

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

Request Syntax

{ "MaxResults": number, "NextToken": "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.

MaxResults (p. 124)

The maximum number of gateway group summaries to return. The default is 50.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No NextToken (p. 124)

The token used to paginate though multiple pages of gateway group summaries.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1100.

Required: No

"NextToken": "string"

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

Errors

The following data is returned in JSON format by the service.

GatewayGroups (p. 124)

The gateway groups in the list.

Type: Array of GatewayGroupSummary (p. 261) objects NextToken (p. 124)

The token used to paginate though multiple pages of gateway group summaries.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1100.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 309).

Request Syntax

{

"GatewayGroupArn": "string", "MaxResults": number, "NextToken": "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.

GatewayGroupArn (p. 126)

The gateway group ARN for which to list gateways.

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 MaxResults (p. 126)

The maximum number of gateway summaries to return. The default is 50.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No NextToken (p. 126)

The token used to paginate though multiple pages of gateway summaries.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1100.

Required: No

Response Syntax

{

"Gateways": [ {

Response Elements

"Arn": "string",

"Description": "string", "GatewayGroupArn": "string", "Name": "string",

"SoftwareVersion": "string"

} ],

"NextToken": "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.

Gateways (p. 126)

The gateways in the list.

Type: Array of GatewaySummary (p. 262) objects NextToken (p. 126)

The token used to paginate though multiple pages of gateway summaries.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1100.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 309).

Request Syntax

{ "EnablementType": "string", "MaxResults": number, "NextToken": "string", "SkillGroupArn": "string", "SkillType": "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.

EnablementType (p. 128)

Whether the skill is enabled under the user's account.

Type: String

Valid Values: ENABLED | PENDING Required: No

MaxResults (p. 128)

The maximum number of results to include in the response. If more results exist than the speciﬁed 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 10.

Required: No NextToken (p. 128)

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is speciﬁed, the response includes only results beyond the token, up to the value speciﬁed by MaxResults.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1100.

Required: No SkillGroupArn (p. 128)

The ARN of the skill group for which to list enabled skills.

Type: String

Response Syntax

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 SkillType (p. 128)

Whether the skill is publicly available or is a private skill.

Type: String

Valid Values: PUBLIC | PRIVATE | ALL Required: No

Response Syntax

{ "NextToken": "string", "SkillSummaries": [ {

"EnablementType": "string", "SkillId": "string",

"SkillName": "string", "SkillType": "string", "SupportsLinking": boolean }

]}

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.

NextToken (p. 129)

The token returned to indicate that there is more data available.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1100.

SkillSummaries (p. 129)

The list of enabled skills requested. Required.

Type: Array of SkillSummary (p. 294) objects

Errors

For information about the errors that are common to all actions, see Common Errors (p. 309).

Request Syntax

{ "MaxResults": number, "NextToken": "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.

MaxResults (p. 131)

The maximum number of categories returned, per paginated calls.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No NextToken (p. 131)

The tokens used for pagination.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1100.

Required: No

Response Syntax

{ "CategoryList": [ {

"CategoryId": number, "CategoryName": "string"

} ],

"NextToken": "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.

Errors

CategoryList (p. 131) The list of categories.

Type: Array of Category (p. 233) objects NextToken (p. 131)

The tokens used for pagination.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1100.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 309).

GetInvitationConﬁguration