AlexaForBusiness / Paginator / ListSkills

ListSkills

class AlexaForBusiness.Paginator.ListSkills

paginator = client.get_paginator('list_skills')

paginate(**kwargs)

Creates an iterator that will paginate through responses from AlexaForBusiness.Client.list_skills().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    SkillGroupArn='string',
    EnablementType='ENABLED'|'PENDING',
    SkillType='PUBLIC'|'PRIVATE'|'ALL',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• SkillGroupArn (string) – The ARN of the skill group for which to list enabled skills.

• EnablementType (string) – Whether the skill is enabled under the user’s account.

• SkillType (string) – Whether the skill is publicly available or is a private skill.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'SkillSummaries': [
        {
            'SkillId': 'string',
            'SkillName': 'string',
            'SupportsLinking': True|False,
            'EnablementType': 'ENABLED'|'PENDING',
            'SkillType': 'PUBLIC'|'PRIVATE'
        },
    ],

}

Response Structure

• (dict) –

  • SkillSummaries (list) –

    The list of enabled skills requested. Required.

    • (dict) –

      The summary of skills.

      • SkillId (string) –

        The ARN of the skill summary.

      • SkillName (string) –

        The name of the skill.

      • SupportsLinking (boolean) –

        Linking support for a skill.

      • EnablementType (string) –

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

      • SkillType (string) –

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