SageMaker / Client / list_artifacts

list_artifacts#

SageMaker.Client.list_artifacts(**kwargs)#

Lists the artifacts in your account and their properties.

See also: AWS API Documentation

Request Syntax

response = client.list_artifacts(
    SourceUri='string',
    ArtifactType='string',
    CreatedAfter=datetime(2015, 1, 1),
    CreatedBefore=datetime(2015, 1, 1),
    SortBy='CreationTime',
    SortOrder='Ascending'|'Descending',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • SourceUri (string) – A filter that returns only artifacts with the specified source URI.

  • ArtifactType (string) – A filter that returns only artifacts of the specified type.

  • CreatedAfter (datetime) – A filter that returns only artifacts created on or after the specified time.

  • CreatedBefore (datetime) – A filter that returns only artifacts created on or before the specified time.

  • SortBy (string) – The property used to sort results. The default value is CreationTime.

  • SortOrder (string) – The sort order. The default value is Descending.

  • NextToken (string) – If the previous call to ListArtifacts didn’t return the full set of artifacts, the call returns a token for getting the next set of artifacts.

  • MaxResults (integer) – The maximum number of artifacts to return in the response. The default value is 10.

Return type:

dict

Returns:

Response Syntax

{
    'ArtifactSummaries': [
        {
            'ArtifactArn': 'string',
            'ArtifactName': 'string',
            'Source': {
                'SourceUri': 'string',
                'SourceTypes': [
                    {
                        'SourceIdType': 'MD5Hash'|'S3ETag'|'S3Version'|'Custom',
                        'Value': 'string'
                    },
                ]
            },
            'ArtifactType': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ArtifactSummaries (list) –

      A list of artifacts and their properties.

      • (dict) –

        Lists a summary of the properties of an artifact. An artifact represents a URI addressable object or data. Some examples are a dataset and a model.

        • ArtifactArn (string) –

          The Amazon Resource Name (ARN) of the artifact.

        • ArtifactName (string) –

          The name of the artifact.

        • Source (dict) –

          The source of the artifact.

          • SourceUri (string) –

            The URI of the source.

          • SourceTypes (list) –

            A list of source types.

            • (dict) –

              The ID and ID type of an artifact source.

              • SourceIdType (string) –

                The type of ID.

              • Value (string) –

                The ID.

        • ArtifactType (string) –

          The type of the artifact.

        • CreationTime (datetime) –

          When the artifact was created.

        • LastModifiedTime (datetime) –

          When the artifact was last modified.

    • NextToken (string) –

      A token for getting the next set of artifacts, if there are any.

Exceptions

  • SageMaker.Client.exceptions.ResourceNotFound