[ aws . sagemaker ]

list-associations

Description

Lists the associations in your account and their properties.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-associations is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: AssociationSummaries

Synopsis

  list-associations
[--source-arn <value>]
[--destination-arn <value>]
[--source-type <value>]
[--destination-type <value>]
[--association-type <value>]
[--created-after <value>]
[--created-before <value>]
[--sort-by <value>]
[--sort-order <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--source-arn (string)

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

--destination-arn (string)

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

--source-type (string)

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

--destination-type (string)

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

--association-type (string)

A filter that returns only associations of the specified type.

Possible values:

• ContributedTo

• AssociatedWith

• DerivedFrom

• Produced

--created-after (timestamp)

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

--created-before (timestamp)

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

--sort-by (string)

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

Possible values:

• SourceArn

• DestinationArn

• SourceType

• DestinationType

• CreationTime

--sort-order (string)

The sort order. The default value is Descending .

Possible values:

• Ascending

• Descending

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

AssociationSummaries -> (list)

A list of associations and their properties.

(structure)

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 -> (timestamp)

When the association was created.

CreatedBy -> (structure)

Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.

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.

NextToken -> (string)

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