Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

describe_model_card_export_job

describe_model_card_export_job(**kwargs)

Describes an Amazon SageMaker Model Card export job.

See also: AWS API Documentation

Request Syntax

response = client.describe_model_card_export_job(
    ModelCardExportJobArn='string'
)
Parameters
ModelCardExportJobArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the model card export job to describe.

Return type
dict
Returns
Response Syntax
{
    'ModelCardExportJobName': 'string',
    'ModelCardExportJobArn': 'string',
    'Status': 'InProgress'|'Completed'|'Failed',
    'ModelCardName': 'string',
    'ModelCardVersion': 123,
    'OutputConfig': {
        'S3OutputPath': 'string'
    },
    'CreatedAt': datetime(2015, 1, 1),
    'LastModifiedAt': datetime(2015, 1, 1),
    'FailureReason': 'string',
    'ExportArtifacts': {
        'S3ExportArtifacts': 'string'
    }
}

Response Structure

  • (dict) --
    • ModelCardExportJobName (string) --

      The name of the model card export job to describe.

    • ModelCardExportJobArn (string) --

      The Amazon Resource Name (ARN) of the model card export job.

    • Status (string) --

      The completion status of the model card export job.

      • InProgress : The model card export job is in progress.
      • Completed : The model card export job is complete.
      • Failed : The model card export job failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeModelCardExportJob call.
    • ModelCardName (string) --

      The name of the model card that the model export job exports.

    • ModelCardVersion (integer) --

      The version of the model card that the model export job exports.

    • OutputConfig (dict) --

      The export output details for the model card.

      • S3OutputPath (string) --

        The Amazon S3 output path to export your model card PDF.

    • CreatedAt (datetime) --

      The date and time that the model export job was created.

    • LastModifiedAt (datetime) --

      The date and time that the model export job was last modified.

    • FailureReason (string) --

      The failure reason if the model export job fails.

    • ExportArtifacts (dict) --

      The exported model card artifacts.

      • S3ExportArtifacts (string) --

        The Amazon S3 URI of the exported model artifacts.

Exceptions

  • SageMaker.Client.exceptions.ResourceNotFound