model_card_export_jobs

Creates, updates, deletes, gets or lists a model_card_export_jobs resource.

Overview

Name	model_card_export_jobs
Type	Resource
Id	aws.sagemaker.model_card_export_jobs

Fields

The following fields are returned by SELECT queries:

describe_model_card_export_job

Name	Datatype	Description
created_at	string (date-time)	The date and time that the model export job was created.
export_artifacts	object	The exported model card artifacts.
failure_reason	string	The failure reason if the model export job fails.
last_modified_at	string (date-time)	The date and time that the model export job was last modified.
model_card_export_job_arn	string	The Amazon Resource Name (ARN) of the model card export job. (pattern: <code>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}</code>)
model_card_export_job_name	string	The name of the model card export job to describe. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)
model_card_name	string	The name or Amazon Resource Name (ARN) of the model card that the model export job exports. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)
model_card_version	integer	The version of the model card that the model export job exports.
output_config	object	The export output details for the model card.
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. (InProgress, Completed, Failed)

list_model_card_export_jobs

Name	Datatype	Description
created_at	string (date-time)	The date and time that the model card export job was created.
last_modified_at	string (date-time)	The date and time that the model card export job was last modified..
model_card_export_job_arn	string	The Amazon Resource Name (ARN) of the model card export job. (pattern: <code>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}</code>)
model_card_export_job_name	string	The name of the model card export job. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)
model_card_name	string	The name of the model card that the export job exports. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)
model_card_version	integer	The version of the model card that the export job exports.
status	string	The completion status of the model card export job. (InProgress, Completed, Failed)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_model_card_export_job	select	region		Describes an Amazon SageMaker Model Card export job.
list_model_card_export_jobs	select	region		List the export jobs for the Amazon SageMaker Model Card.
create_model_card_export_job	insert	region, ModelCardName, ModelCardExportJobName, OutputConfig		Creates an Amazon SageMaker Model Card export job.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_model_card_export_job

Describes an Amazon SageMaker Model Card export job.

SELECT
created_at,
export_artifacts,
failure_reason,
last_modified_at,
model_card_export_job_arn,
model_card_export_job_name,
model_card_name,
model_card_version,
output_config,
status
FROM aws.sagemaker.model_card_export_jobs
WHERE region = '{{ region }}' -- required
;

list_model_card_export_jobs

List the export jobs for the Amazon SageMaker Model Card.

SELECT
created_at,
last_modified_at,
model_card_export_job_arn,
model_card_export_job_name,
model_card_name,
model_card_version,
status
FROM aws.sagemaker.model_card_export_jobs
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_model_card_export_job

Creates an Amazon SageMaker Model Card export job.

INSERT INTO aws.sagemaker.model_card_export_jobs (
ModelCardName,
ModelCardVersion,
ModelCardExportJobName,
OutputConfig,
region
)
SELECT 
'{{ ModelCardName }}' /* required */,
{{ ModelCardVersion }},
'{{ ModelCardExportJobName }}' /* required */,
'{{ OutputConfig }}' /* required */,
'{{ region }}'
RETURNING
model_card_export_job_arn
;

Manifest

# Description fields are for documentation purposes
- name: model_card_export_jobs
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the model_card_export_jobs resource.
  - name: ModelCardName
    value: "{{ ModelCardName }}"
    description: |
      The name or Amazon Resource Name (ARN) of the model card to export.
  - name: ModelCardVersion
    value: {{ ModelCardVersion }}
    description: |
      The version of the model card to export. If a version is not provided, then the latest version of the model card is exported.
  - name: ModelCardExportJobName
    value: "{{ ModelCardExportJobName }}"
    description: |
      The name of the model card export job.
  - name: OutputConfig
    description: |
      The model card output configuration that specifies the Amazon S3 path for exporting.
    value:
      S3OutputPath: "{{ S3OutputPath }}"