Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeModelCardExportJob

Describes an Amazon SageMaker Model Card export job.

Request Syntax


{
   "ModelCardExportJobArn": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ModelCardExportJobArn

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

Type: String

Length Constraints: Maximum length of 256.

Pattern: ^arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:model-card/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}/export-job/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$

Required: Yes

Response Syntax


{
   "CreatedAt": number,
   "ExportArtifacts": { 
      "S3ExportArtifacts": "string"
   },
   "FailureReason": "string",
   "LastModifiedAt": number,
   "ModelCardExportJobArn": "string",
   "ModelCardExportJobName": "string",
   "ModelCardName": "string",
   "ModelCardVersion": number,
   "OutputConfig": { 
      "S3OutputPath": "string"
   },
   "Status": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CreatedAt

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

Type: Timestamp

ExportArtifacts

The exported model card artifacts.

Type: ModelCardExportArtifacts object

FailureReason

The failure reason if the model export job fails.

Type: String

Length Constraints: Maximum length of 1024.

LastModifiedAt

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

Type: Timestamp

ModelCardExportJobArn

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

Type: String

Length Constraints: Maximum length of 256.

Pattern: ^arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:model-card/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}/export-job/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$

ModelCardExportJobName

The name of the model card export job to describe.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$

ModelCardName

The name or Amazon Resource Name (ARN) of the model card that the model export job exports.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$

ModelCardVersion

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

Type: Integer

OutputConfig

The export output details for the model card.

Type: ModelCardExportOutputConfig object

Status

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.

Type: String

Valid Values: InProgress | Completed | Failed

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400