Menu
Alexa For Business
Alexa for Business API (API Version 2017-11-09)

GetRoomSkillParameter

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

Request Syntax

{
   "ParameterKey": "string",
   "RoomArn": "string",
   "SkillId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ParameterKey

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

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

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

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

The details of the room skill parameter requested. Required.

Type: RoomSkillParameter object

Errors

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

NotFoundException

The resource is not found. HTTP Status Code: 400

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: