:doc:`SageMaker <../../sagemaker>` / Client / list_associations

*****************
list_associations
*****************



.. py:method:: SageMaker.Client.list_associations(**kwargs)

  

  Lists the associations in your account and their properties.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListAssociations>`_  


  **Request Syntax**
  ::

    response = client.list_associations(
        SourceArn='string',
        DestinationArn='string',
        SourceType='string',
        DestinationType='string',
        AssociationType='ContributedTo'|'AssociatedWith'|'DerivedFrom'|'Produced'|'SameAs',
        CreatedAfter=datetime(2015, 1, 1),
        CreatedBefore=datetime(2015, 1, 1),
        SortBy='SourceArn'|'DestinationArn'|'SourceType'|'DestinationType'|'CreationTime',
        SortOrder='Ascending'|'Descending',
        NextToken='string',
        MaxResults=123
    )
    
  :type SourceArn: string
  :param SourceArn: 

    A filter that returns only associations with the specified source ARN.

    

  
  :type DestinationArn: string
  :param DestinationArn: 

    A filter that returns only associations with the specified destination Amazon Resource Name (ARN).

    

  
  :type SourceType: string
  :param SourceType: 

    A filter that returns only associations with the specified source type.

    

  
  :type DestinationType: string
  :param DestinationType: 

    A filter that returns only associations with the specified destination type.

    

  
  :type AssociationType: string
  :param AssociationType: 

    A filter that returns only associations of the specified type.

    

  
  :type CreatedAfter: datetime
  :param CreatedAfter: 

    A filter that returns only associations created on or after the specified time.

    

  
  :type CreatedBefore: datetime
  :param CreatedBefore: 

    A filter that returns only associations created on or before the specified time.

    

  
  :type SortBy: string
  :param SortBy: 

    The property used to sort results. The default value is ``CreationTime``.

    

  
  :type SortOrder: string
  :param SortOrder: 

    The sort order. The default value is ``Descending``.

    

  
  :type NextToken: string
  :param NextToken: 

    If the previous call to ``ListAssociations`` didn't return the full set of associations, the call returns a token for getting the next set of associations.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of associations to return in the response. The default value is 10.

    

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

    
    ::

      {
          'AssociationSummaries': [
              {
                  'SourceArn': 'string',
                  'DestinationArn': 'string',
                  'SourceType': 'string',
                  'DestinationType': 'string',
                  'AssociationType': 'ContributedTo'|'AssociatedWith'|'DerivedFrom'|'Produced'|'SameAs',
                  'SourceName': 'string',
                  'DestinationName': 'string',
                  'CreationTime': datetime(2015, 1, 1),
                  'CreatedBy': {
                      'UserProfileArn': 'string',
                      'UserProfileName': 'string',
                      'DomainId': 'string',
                      'IamIdentity': {
                          'Arn': 'string',
                          'PrincipalId': 'string',
                          'SourceIdentity': 'string'
                      }
                  }
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **AssociationSummaries** *(list) --* 

        A list of associations and their properties.

        
        

        - *(dict) --* 

          Lists a summary of the properties of an association. An association is an entity that links other lineage or experiment entities. An example would be an association between a training job and a model.

          
          

          - **SourceArn** *(string) --* 

            The ARN of the source.

            
          

          - **DestinationArn** *(string) --* 

            The Amazon Resource Name (ARN) of the destination.

            
          

          - **SourceType** *(string) --* 

            The source type.

            
          

          - **DestinationType** *(string) --* 

            The destination type.

            
          

          - **AssociationType** *(string) --* 

            The type of the association.

            
          

          - **SourceName** *(string) --* 

            The name of the source.

            
          

          - **DestinationName** *(string) --* 

            The name of the destination.

            
          

          - **CreationTime** *(datetime) --* 

            When the association was created.

            
          

          - **CreatedBy** *(dict) --* 

            Information about the user who created or modified a SageMaker resource.

            
            

            - **UserProfileArn** *(string) --* 

              The Amazon Resource Name (ARN) of the user's profile.

              
            

            - **UserProfileName** *(string) --* 

              The name of the user's profile.

              
            

            - **DomainId** *(string) --* 

              The domain associated with the user.

              
            

            - **IamIdentity** *(dict) --* 

              The IAM Identity details associated with the user. These details are associated with model package groups, model packages, and project entities only.

              
              

              - **Arn** *(string) --* 

                The Amazon Resource Name (ARN) of the IAM identity.

                
              

              - **PrincipalId** *(string) --* 

                The ID of the principal that assumes the IAM identity.

                
              

              - **SourceIdentity** *(string) --* 

                The person or application which assumes the IAM identity.

                
          
        
      
    
      

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

        A token for getting the next set of associations, if there are any.

        
  
  **Exceptions**
  
  *   :py:class:`SageMaker.Client.exceptions.ResourceNotFound`

  