SageMaker / Client / create_artifact

create_artifact#

SageMaker.Client.create_artifact(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.create_artifact(
    ArtifactName='string',
    Source={
        'SourceUri': 'string',
        'SourceTypes': [
            {
                'SourceIdType': 'MD5Hash'|'S3ETag'|'S3Version'|'Custom',
                'Value': 'string'
            },
        ]
    },
    ArtifactType='string',
    Properties={
        'string': 'string'
    },
    MetadataProperties={
        'CommitId': 'string',
        'Repository': 'string',
        'GeneratedBy': 'string',
        'ProjectId': 'string'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • ArtifactName (string) – The name of the artifact. Must be unique to your account in an Amazon Web Services Region.

  • Source (dict) –

    [REQUIRED]

    The ID, ID type, and URI of the source.

    • SourceUri (string) – [REQUIRED]

      The URI of the source.

    • SourceTypes (list) –

      A list of source types.

      • (dict) –

        The ID and ID type of an artifact source.

        • SourceIdType (string) – [REQUIRED]

          The type of ID.

        • Value (string) – [REQUIRED]

          The ID.

  • ArtifactType (string) –

    [REQUIRED]

    The artifact type.

  • Properties (dict) –

    A list of properties to add to the artifact.

    • (string) –

      • (string) –

  • MetadataProperties (dict) –

    Metadata properties of the tracking entity, trial, or trial component.

    • CommitId (string) –

      The commit ID.

    • Repository (string) –

      The repository.

    • GeneratedBy (string) –

      The entity this entity was generated by.

    • ProjectId (string) –

      The project ID.

  • Tags (list) –

    A list of tags to apply to the artifact.

    • (dict) –

      A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

      You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.

      For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.

      • Key (string) – [REQUIRED]

        The tag key. Tag keys must be unique per resource.

      • Value (string) – [REQUIRED]

        The tag value.

Return type:

dict

Returns:

Response Syntax

{
    'ArtifactArn': 'string'
}

Response Structure

  • (dict) –

    • ArtifactArn (string) –

      The Amazon Resource Name (ARN) of the artifact.

Exceptions

  • SageMaker.Client.exceptions.ResourceLimitExceeded