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

ListSkills

Lists all enabled skills in a specific skill group.

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.

The request accepts the following data in JSON format.

EnablementType

Whether the skill is enabled under the user's account, or if it requires linking to be used.

Type: String

Valid Values: ENABLED | PENDING

Required: No

MaxResults

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. Required.

Type: Integer

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

Required: No

NextToken

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. Required.

Type: String

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

Required: No

SkillGroupArn

The ARN of the skill group for which to list enabled skills. 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

SkillType

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

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

Type: String

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

SkillSummaries

The list of enabled skills requested. Required.

Type: Array of SkillSummary objects

Errors

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

See Also

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