:doc:`CloudDirectory <../../clouddirectory>` / Client / list_typed_link_facet_attributes

********************************
list_typed_link_facet_attributes
********************************



.. py:method:: CloudDirectory.Client.list_typed_link_facet_attributes(**kwargs)

  

  Returns a paginated list of all attribute definitions for a particular  TypedLinkFacet. For more information, see `Typed Links <https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink>`__.

  

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


  **Request Syntax**
  ::

    response = client.list_typed_link_facet_attributes(
        SchemaArn='string',
        Name='string',
        NextToken='string',
        MaxResults=123
    )
    
  :type SchemaArn: string
  :param SchemaArn: **[REQUIRED]** 

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

    

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

    The unique name of the typed link facet.

    

  
  :type NextToken: string
  :param NextToken: 

    The pagination token.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to retrieve.

    

  
  
  :rtype: 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'
              },
          ],
          'NextToken': 'string'
      }
      
    **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``.

            
      
    
      

      - **NextToken** *(string) --* 

        The pagination token.

        
  
  **Exceptions**
  
  *   :py:class:`CloudDirectory.Client.exceptions.InternalServiceException`

  
  *   :py:class:`CloudDirectory.Client.exceptions.InvalidArnException`

  
  *   :py:class:`CloudDirectory.Client.exceptions.RetryableConflictException`

  
  *   :py:class:`CloudDirectory.Client.exceptions.ValidationException`

  
  *   :py:class:`CloudDirectory.Client.exceptions.LimitExceededException`

  
  *   :py:class:`CloudDirectory.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`CloudDirectory.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`CloudDirectory.Client.exceptions.FacetNotFoundException`

  
  *   :py:class:`CloudDirectory.Client.exceptions.InvalidNextTokenException`

  