CloudDirectory / Paginator / ListTypedLinkFacetAttributes

ListTypedLinkFacetAttributes

class CloudDirectory.Paginator.ListTypedLinkFacetAttributes

paginator = client.get_paginator('list_typed_link_facet_attributes')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• SchemaArn (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

• Name (string) –

  [REQUIRED]

  The unique name of the typed link facet.

• 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

{
    'Attributes': [
        {
            'Name': 'string',
            'Type': 'STRING'|'BINARY'|'BOOLEAN'|'NUMBER'|'DATETIME'|'VARIANT',
            'DefaultValue': {
                'StringValue': 'string',
                'BinaryValue': b'bytes',
                'BooleanValue': True|False,
                'NumberValue': 'string',
                'DatetimeValue': datetime(2015, 1, 1)
            },
            'IsImmutable': True|False,
            'Rules': {
                'string': {
                    'Type': 'BINARY_LENGTH'|'NUMBER_COMPARISON'|'STRING_FROM_SET'|'STRING_LENGTH',
                    'Parameters': {
                        'string': 'string'
                    }
                }
            },
            'RequiredBehavior': 'REQUIRED_ALWAYS'|'NOT_REQUIRED'
        },
    ],

}

Response Structure

• (dict) –

  • Attributes (list) –

    An ordered set of attributes associate with the typed link.

    • (dict) –

      A typed link attribute definition.

      • Name (string) –

        The unique name of the typed link attribute.

      • Type (string) –

        The type of the attribute.

      • DefaultValue (dict) –

        The default value of the attribute (if configured).

        • StringValue (string) –

          A string data value.

        • BinaryValue (bytes) –

          A binary data value.

        • BooleanValue (boolean) –

          A Boolean data value.

        • NumberValue (string) –

          A number data value.

        • DatetimeValue (datetime) –

          A date and time value.

      • IsImmutable (boolean) –

        Whether the attribute is mutable or not.

      • Rules (dict) –

        Validation rules that are attached to the attribute definition.

        • (string) –

          • (dict) –

            Contains an Amazon Resource Name (ARN) and parameters that are associated with the rule.

            • Type (string) –

              The type of attribute validation rule.

            • Parameters (dict) –

              The minimum and maximum parameters that are associated with the rule.

              • (string) –

                • (string) –

      • RequiredBehavior (string) –

        The required behavior of the TypedLinkAttributeDefinition.