AddAssociation
Creates an association between the source and the destination. A source can be associated with multiple destinations, and a destination can be associated with multiple sources. An association is a lineage tracking entity. For more information, see Amazon SageMaker ML Lineage Tracking.
Request Syntax
{
"AssociationType": "string
",
"DestinationArn": "string
",
"SourceArn": "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
-
The type of association. The following are suggested uses for each type. Amazon SageMaker places no restrictions on their use.
-
ContributedTo - The source contributed to the destination or had a part in enabling the destination. For example, the training data contributed to the training job.
-
AssociatedWith - The source is connected to the destination. For example, an approval workflow is associated with a model deployment.
-
DerivedFrom - The destination is a modification of the source. For example, a digest output of a channel input for a processing job is derived from the original inputs.
-
Produced - The source generated the destination. For example, a training job produced a model artifact.
Type: String
Valid Values:
ContributedTo | AssociatedWith | DerivedFrom | Produced | SameAs
Required: No
-
- DestinationArn
-
The Amazon Resource Name (ARN) of the destination.
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: Yes
- SourceArn
-
The ARN of the source.
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: Yes
Response Syntax
{
"DestinationArn": "string",
"SourceArn": "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.
- DestinationArn
-
The Amazon Resource Name (ARN) of the destination.
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)/.*
- SourceArn
-
The ARN of the source.
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)/.*
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceLimitExceeded
-
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
HTTP Status Code: 400
- 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 Amazon SDKs, see the following: