associations

Creates, updates, deletes, gets or lists an associations resource.

Overview

Name	associations
Type	Resource
Id	aws.sagemaker.associations

Fields

The following fields are returned by SELECT queries:

list_associations

Name	Datatype	Description
association_type	string	The type of the association. (ContributedTo, AssociatedWith, DerivedFrom, Produced, SameAs)
created_by	object	Information about the user who created or modified a SageMaker resource.
creation_time	string (date-time)	When the association was created.
destination_arn	string	The Amazon Resource Name (ARN) of the destination. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:(experiment|experiment-trial-component|artifact|action|context)/.*</code>)
destination_name	string	The name of the destination. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}</code>)
destination_type	string	The destination type.
source_arn	string	The ARN of the source. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:(experiment|experiment-trial-component|artifact|action|context)/.*</code>)
source_name	string	The name of the source. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}</code>)
source_type	string	The source type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_associations	select	region		Lists the associations in your account and their properties.
add_association	update	region, SourceArn, DestinationArn		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.
delete_association	delete	region		Deletes an association.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

list_associations

Lists the associations in your account and their properties.

SELECT
association_type,
created_by,
creation_time,
destination_arn,
destination_name,
destination_type,
source_arn,
source_name,
source_type
FROM aws.sagemaker.associations
WHERE region = '{{ region }}' -- required
;

UPDATE examples

add_association

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.

UPDATE aws.sagemaker.associations
SET 
SourceArn = '{{ SourceArn }}',
DestinationArn = '{{ DestinationArn }}',
AssociationType = '{{ AssociationType }}'
WHERE 
region = '{{ region }}' --required
AND SourceArn = '{{ SourceArn }}' --required
AND DestinationArn = '{{ DestinationArn }}' --required
RETURNING
destination_arn,
source_arn;

DELETE examples

delete_association

Deletes an association.

DELETE FROM aws.sagemaker.associations
WHERE region = '{{ region }}' --required
;