ListAssociations
Lists the associations in your account and their properties.
Request Syntax
{
"AssociationType": "string",
"CreatedAfter": number,
"CreatedBefore": number,
"DestinationArn": "string",
"DestinationType": "string",
"MaxResults": number,
"NextToken": "string",
"SortBy": "string",
"SortOrder": "string",
"SourceArn": "string",
"SourceType": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- AssociationType
-
A filter that returns only associations of the specified type.
Type: String
Valid Values:
ContributedTo | AssociatedWith | DerivedFrom | Produced | SameAsRequired: No
- CreatedAfter
-
A filter that returns only associations created on or after the specified time.
Type: Timestamp
Required: No
- CreatedBefore
-
A filter that returns only associations created on or before the specified time.
Type: Timestamp
Required: No
- DestinationArn
-
A filter that returns only associations with the specified destination Amazon Resource Name (ARN).
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:(experiment|experiment-trial-component|artifact|action|context)/.*Required: No
- DestinationType
-
A filter that returns only associations with the specified destination type.
Type: String
Length Constraints: Maximum length of 256.
Required: No
- MaxResults
-
The maximum number of associations to return in the response. The default value is 10.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
If the previous call to
ListAssociationsdidn't return the full set of associations, the call returns a token for getting the next set of associations.Type: String
Length Constraints: Maximum length of 8192.
Pattern:
.*Required: No
- SortBy
-
The property used to sort results. The default value is
CreationTime.Type: String
Valid Values:
SourceArn | DestinationArn | SourceType | DestinationType | CreationTimeRequired: No
- SortOrder
-
The sort order. The default value is
Descending.Type: String
Valid Values:
Ascending | DescendingRequired: No
- SourceArn
-
A filter that returns only associations with the specified source ARN.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:(experiment|experiment-trial-component|artifact|action|context)/.*Required: No
- SourceType
-
A filter that returns only associations with the specified source type.
Type: String
Length Constraints: Maximum length of 256.
Required: No
Response Syntax
{
"AssociationSummaries": [
{
"AssociationType": "string",
"CreatedBy": {
"DomainId": "string",
"IamIdentity": {
"Arn": "string",
"PrincipalId": "string",
"SourceIdentity": "string"
},
"UserProfileArn": "string",
"UserProfileName": "string"
},
"CreationTime": number,
"DestinationArn": "string",
"DestinationName": "string",
"DestinationType": "string",
"SourceArn": "string",
"SourceName": "string",
"SourceType": "string"
}
],
"NextToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- AssociationSummaries
-
A list of associations and their properties.
Type: Array of AssociationSummary objects
- NextToken
-
A token for getting the next set of associations, if there are any.
Type: String
Length Constraints: Maximum length of 8192.
Pattern:
.*
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceNotFound
-
Resource being access is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
