List Associations

sagemaker_list_associations

R Documentation

Lists the associations in your account and their properties¶

Description¶

Lists the associations in your account and their properties.

Usage¶

sagemaker_list_associations(SourceArn, DestinationArn, SourceType,
  DestinationType, AssociationType, CreatedAfter, CreatedBefore, SortBy,
  SortOrder, NextToken, MaxResults)

Arguments¶

SourceArn

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

DestinationArn

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

SourceType

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

DestinationType

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

AssociationType

A filter that returns only associations of the specified type.

CreatedAfter

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

CreatedBefore

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

SortBy

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

SortOrder

The sort order. The default value is Descending.

NextToken

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

MaxResults

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

Value¶

A list with the following syntax:

list(
  AssociationSummaries = list(
    list(
      SourceArn = "string",
      DestinationArn = "string",
      SourceType = "string",
      DestinationType = "string",
      AssociationType = "ContributedTo"|"AssociatedWith"|"DerivedFrom"|"Produced"|"SameAs",
      SourceName = "string",
      DestinationName = "string",
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      CreatedBy = list(
        UserProfileArn = "string",
        UserProfileName = "string",
        DomainId = "string",
        IamIdentity = list(
          Arn = "string",
          PrincipalId = "string",
          SourceIdentity = "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_associations(
  SourceArn = "string",
  DestinationArn = "string",
  SourceType = "string",
  DestinationType = "string",
  AssociationType = "ContributedTo"|"AssociatedWith"|"DerivedFrom"|"Produced"|"SameAs",
  CreatedAfter = as.POSIXct(
    "2015-01-01"
  ),
  CreatedBefore = as.POSIXct(
    "2015-01-01"
  ),
  SortBy = "SourceArn"|"DestinationArn"|"SourceType"|"DestinationType"|"CreationTime",
  SortOrder = "Ascending"|"Descending",
  NextToken = "string",
  MaxResults = 123
)