search_skill_groups

AlexaForBusiness.Client.search_skill_groups(**kwargs)

Searches skill groups and lists the ones that meet a set of filter and sort criteria.

See also: AWS API Documentation

Request Syntax

response = client.search_skill_groups(
    NextToken='string',
    MaxResults=123,
    Filters=[
        {
            'Key': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    SortCriteria=[
        {
            'Key': 'string',
            'Value': 'ASC'|'DESC'
        },
    ]
)

Parameters

• NextToken (string) -- 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.
• MaxResults (integer) -- 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.
• Filters (list) --

  The filters to use to list a specified set of skill groups. The supported filter key is SkillGroupName.

  • (dict) --

    A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria.

    • Key (string) -- [REQUIRED]

      The key of a filter.

    • Values (list) -- [REQUIRED]

      The values of a filter.

      • (string) --
• SortCriteria (list) --

  The sort order to use in listing the specified set of skill groups. The supported sort key is SkillGroupName.

  • (dict) --

    An object representing a sort criteria.

    • Key (string) -- [REQUIRED]

      The sort key of a sort object.

    • Value (string) -- [REQUIRED]

      The sort value of a sort object.

Return type

dict

Returns

Response Syntax

{
    'SkillGroups': [
        {
            'SkillGroupArn': 'string',
            'SkillGroupName': 'string',
            'Description': 'string'
        },
    ],
    'NextToken': 'string',
    'TotalCount': 123
}

Response Structure

• (dict) --

  • SkillGroups (list) --

    The skill groups that meet the filter criteria, in sort order.

    • (dict) --

      The attributes of a skill group.

      • SkillGroupArn (string) --

        The skill group ARN of a skill group.

      • SkillGroupName (string) --

        The skill group name of a skill group.

      • Description (string) --

        The description of a skill group.

  • NextToken (string) --

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

  • TotalCount (integer) --

    The total number of skill groups returned.