:doc:`CloudDirectory <../../clouddirectory>` / Paginator / ListFacetAttributes

*******************
ListFacetAttributes
*******************



.. py:class:: CloudDirectory.Paginator.ListFacetAttributes

  ::

    
    paginator = client.get_paginator('list_facet_attributes')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`CloudDirectory.Client.list_facet_attributes`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListFacetAttributes>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          SchemaArn='string',
          Name='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type SchemaArn: string
    :param SchemaArn: **[REQUIRED]** 

      The ARN of the schema where the facet resides.

      

    
    :type Name: string
    :param Name: **[REQUIRED]** 

      The name of the facet whose attributes will be retrieved.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'Attributes': [
                {
                    'Name': 'string',
                    'AttributeDefinition': {
                        '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'
                                }
                            }
                        }
                    },
                    'AttributeReference': {
                        'TargetFacetName': 'string',
                        'TargetAttributeName': 'string'
                    },
                    'RequiredBehavior': 'REQUIRED_ALWAYS'|'NOT_REQUIRED'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Attributes** *(list) --* 

          The attributes attached to the facet.

          
          

          - *(dict) --* 

            An attribute that is associated with the  Facet.

            
            

            - **Name** *(string) --* 

              The name of the facet attribute.

              
            

            - **AttributeDefinition** *(dict) --* 

              A facet attribute consists of either a definition or a reference. This structure contains the attribute definition. See `Attribute References <https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html>`__ for more information.

              
              

              - **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 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) --* 
                  
                
                
            
          
          
            

            - **AttributeReference** *(dict) --* 

              An attribute reference that is associated with the attribute. See `Attribute References <https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html>`__ for more information.

              
              

              - **TargetFacetName** *(string) --* 

                The target facet name that is associated with the facet reference. See `Attribute References <https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html>`__ for more information.

                
              

              - **TargetAttributeName** *(string) --* 

                The target attribute name that is associated with the facet reference. See `Attribute References <https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html>`__ for more information.

                
          
            

            - **RequiredBehavior** *(string) --* 

              The required behavior of the ``FacetAttribute``.

              
        
      
    