SageMaker / Client / list_associations

list_associations#

SageMaker.Client.list_associations(**kwargs)#

Lists the associations in your account and their properties.

See also: AWS API Documentation

Request Syntax

response = client.list_associations(
    SourceArn='string',
    DestinationArn='string',
    SourceType='string',
    DestinationType='string',
    AssociationType='ContributedTo'|'AssociatedWith'|'DerivedFrom'|'Produced',
    CreatedAfter=datetime(2015, 1, 1),
    CreatedBefore=datetime(2015, 1, 1),
    SortBy='SourceArn'|'DestinationArn'|'SourceType'|'DestinationType'|'CreationTime',
    SortOrder='Ascending'|'Descending',
    NextToken='string',
    MaxResults=123
)
Parameters:
  • SourceArn (string) – A filter that returns only associations with the specified source ARN.

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

  • SourceType (string) – A filter that returns only associations with the specified source type.

  • DestinationType (string) – A filter that returns only associations with the specified destination type.

  • AssociationType (string) – A filter that returns only associations of the specified type.

  • CreatedAfter (datetime) – A filter that returns only associations created on or after the specified time.

  • CreatedBefore (datetime) – A filter that returns only associations created on or before the specified time.

  • SortBy (string) – The property used to sort results. The default value is CreationTime.

  • SortOrder (string) – The sort order. The default value is Descending.

  • NextToken (string) – 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.

  • MaxResults (integer) – The maximum number of associations to return in the response. The default value is 10.

Return type:

dict

Returns:

Response Syntax

{
    'AssociationSummaries': [
        {
            'SourceArn': 'string',
            'DestinationArn': 'string',
            'SourceType': 'string',
            'DestinationType': 'string',
            'AssociationType': 'ContributedTo'|'AssociatedWith'|'DerivedFrom'|'Produced',
            '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 an experiment, trial, trial component, lineage group, project, or model card.

          • 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

  • SageMaker.Client.exceptions.ResourceNotFound