Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateModelCardExportJob

Creates an Amazon SageMaker Model Card export job.

Request Syntax


{
   "ModelCardExportJobName": "string",
   "ModelCardName": "string",
   "ModelCardVersion": number,
   "OutputConfig": { 
      "S3OutputPath": "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.

ModelCardExportJobName

The name of the model card export job.

Type: String

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

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

Required: Yes

ModelCardName

The name or Amazon Resource Name (ARN) of the model card to export.

Type: String

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

Pattern: (arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:model-card/.*)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})

Required: Yes

ModelCardVersion

The version of the model card to export. If a version is not provided, then the latest version of the model card is exported.

Type: Integer

Required: No

OutputConfig

The model card output configuration that specifies the Amazon S3 path for exporting.

Type: ModelCardExportOutputConfig object

Required: Yes

Response Syntax


{
   "ModelCardExportJobArn": "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.

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}$

Errors

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

ConflictException

There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.

HTTP Status Code: 400

ResourceLimitExceeded

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

HTTP Status Code: 400

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400