ListFacetNames

class CloudDirectory.Paginator.ListFacetNames

paginator = client.get_paginator('list_facet_names')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CloudDirectory.Client.list_facet_names().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    SchemaArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

• SchemaArn (string) --

  [REQUIRED]

  The Amazon Resource Name (ARN) to retrieve facet names from.

• 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

{
    'FacetNames': [
        'string',
    ],

}

Response Structure

• (dict) --

  • FacetNames (list) --

    The names of facets that exist within the schema.

    • (string) --