artifacts

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

Overview

Name	artifacts
Type	Resource
Id	aws.sagemaker.artifacts

Fields

The following fields are returned by SELECT queries:

describe_artifact

Name	Datatype	Description
artifact_arn	string	The Amazon Resource Name (ARN) of the artifact. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:artifact/.*</code>)
artifact_name	string	The name of the artifact. (pattern: <code>(arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:(experiment|experiment-trial|experiment-trial-component|artifact|action|context)/)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,119})</code>)
artifact_type	string	The type of the artifact.
created_by	object	Information about the user who created or modified a SageMaker resource.
creation_time	string (date-time)	When the artifact was created.
last_modified_by	object	Information about the user who created or modified a SageMaker resource.
last_modified_time	string (date-time)	When the artifact was last modified.
lineage_group_arn	string	The Amazon Resource Name (ARN) of the lineage group. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:lineage-group/.*</code>)
metadata_properties	object	Metadata properties of the tracking entity, trial, or trial component.
properties	object	A list of the artifact's properties.
source	object	The source of the artifact.

list_artifacts

Name	Datatype	Description
artifact_arn	string	The Amazon Resource Name (ARN) of the artifact. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:artifact/.*</code>)
artifact_name	string	The name of the artifact. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}</code>)
artifact_type	string	The type of the artifact.
creation_time	string (date-time)	When the artifact was created.
last_modified_time	string (date-time)	When the artifact was last modified.
source	object	The source of the artifact.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_artifact	select	region		Describes an artifact.
list_artifacts	select	region		Lists the artifacts in your account and their properties.
create_artifact	insert	region, ArtifactType		Creates an artifact. An artifact is a lineage tracking entity that represents a URI addressable object or data. Some examples are the S3 URI of a dataset and the ECR registry path of an image. For more information, see Amazon SageMaker ML Lineage Tracking.
update_artifact	update	region, ArtifactArn		Updates an artifact.
delete_artifact	delete	region		Deletes an artifact. Either ArtifactArn or Source must be specified.

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

describe_artifact

Describes an artifact.

SELECT
artifact_arn,
artifact_name,
artifact_type,
created_by,
creation_time,
last_modified_by,
last_modified_time,
lineage_group_arn,
metadata_properties,
properties,
source
FROM aws.sagemaker.artifacts
WHERE region = '{{ region }}' -- required
;

list_artifacts

Lists the artifacts in your account and their properties.

SELECT
artifact_arn,
artifact_name,
artifact_type,
creation_time,
last_modified_time,
source
FROM aws.sagemaker.artifacts
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_artifact

Creates an artifact. An artifact is a lineage tracking entity that represents a URI addressable object or data. Some examples are the S3 URI of a dataset and the ECR registry path of an image. For more information, see Amazon SageMaker ML Lineage Tracking.

INSERT INTO aws.sagemaker.artifacts (
ArtifactName,
Source,
ArtifactType,
Properties,
MetadataProperties,
Tags,
region
)
SELECT 
'{{ ArtifactName }}',
'{{ Source }}',
'{{ ArtifactType }}' /* required */,
'{{ Properties }}',
'{{ MetadataProperties }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
artifact_arn
;

Manifest

# Description fields are for documentation purposes
- name: artifacts
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the artifacts resource.
  - name: ArtifactName
    value: "{{ ArtifactName }}"
    description: |
      The name of the artifact. Must be unique to your account in an Amazon Web Services Region.
  - name: Source
    description: |
      The ID, ID type, and URI of the source.
    value:
      SourceUri: "{{ SourceUri }}"
      SourceTypes:
        - SourceIdType: "{{ SourceIdType }}"
          Value: "{{ Value }}"
  - name: ArtifactType
    value: "{{ ArtifactType }}"
    description: |
      The artifact type.
  - name: Properties
    value: "{{ Properties }}"
    description: |
      A list of properties to add to the artifact.
  - name: MetadataProperties
    description: |
      Metadata properties of the tracking entity, trial, or trial component.
    value:
      CommitId: "{{ CommitId }}"
      Repository: "{{ Repository }}"
      GeneratedBy: "{{ GeneratedBy }}"
      ProjectId: "{{ ProjectId }}"
  - name: Tags
    description: |
      A list of tags to apply to the artifact.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_artifact

Updates an artifact.

UPDATE aws.sagemaker.artifacts
SET 
ArtifactArn = '{{ ArtifactArn }}',
ArtifactName = '{{ ArtifactName }}',
Properties = '{{ Properties }}',
PropertiesToRemove = '{{ PropertiesToRemove }}'
WHERE 
region = '{{ region }}' --required
AND ArtifactArn = '{{ ArtifactArn }}' --required
RETURNING
artifact_arn;

DELETE examples

delete_artifact

Deletes an artifact. Either ArtifactArn or Source must be specified.

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