Amazon SageMaker Service

Returns the JSON schema for a specified job category and schema version. Use this schema to validate your JobConfigDocument before calling CreateJob. If you don't specify a schema version, the latest version is returned. The schema defines required fields, allowed values, and constraints for the job configuration.

The following operations are related to DescribeJobSchemaVersion:

• ListJobSchemaVersions

• CreateJob

See also: AWS API Documentation

Request Syntax

client.describe_job_schema_version(
    JobCategory='AgentRFT'|'AgentRFTEvaluation',
    JobConfigSchemaVersion='string'
)

type JobCategory:

string

param JobCategory:

[REQUIRED]

The category of the job schema to describe.

type JobConfigSchemaVersion:

string

param JobConfigSchemaVersion:

The version of the schema to retrieve. If not specified, the latest version is returned.

rtype:

dict

returns:

Response Syntax

{
    'JobCategory': 'AgentRFT'|'AgentRFTEvaluation',
    'JobConfigSchemaVersion': 'string',
    'JobConfigSchema': 'string'
}

Response Structure

• (dict) --

  • JobCategory (string) --

    The category of the job schema.

  • JobConfigSchemaVersion (string) --

    The version of the schema.

  • JobConfigSchema (string) --

    The JSON schema document that defines the structure of the job configuration.

Stops a running job. When you call StopJob, Amazon SageMaker sets the job status to Stopping. After the job stops, the status changes to Stopped. Partial results may be available in the output location if the job was in progress. To delete a stopped job, call DeleteJob.

The following operations are related to StopJob:

• CreateJob

• DescribeJob

• DeleteJob

See also: AWS API Documentation

Request Syntax

client.stop_job(
    JobName='string',
    JobCategory='AgentRFT'|'AgentRFTEvaluation'
)

type JobName:

string

param JobName:

[REQUIRED]

The name of the job to stop.

type JobCategory:

string

param JobCategory:

[REQUIRED]

The category of the job to stop.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Creates a model customization job in Amazon SageMaker. A job runs a workload based on the job category and configuration you provide. You specify the job category, a schema-versioned configuration document, and an IAM role that grants Amazon SageMaker permission to access resources on your behalf.

Use the AgentRFT category to fine-tune a model using multi-turn reinforcement learning with reward signals. Use the AgentRFTEvaluation category to evaluate a fine-tuned or base model by running multi-turn rollouts against a held-out prompt dataset and computing metrics such as pass@k and mean reward.

Before creating a job, call ListJobSchemaVersions and DescribeJobSchemaVersion to retrieve the configuration schema for your job category. The JobConfigDocument must conform to the schema specified by JobConfigSchemaVersion.

The following operations are related to CreateJob:

• DescribeJob

• ListJobs

• StopJob

• DeleteJob

• ListJobSchemaVersions

• DescribeJobSchemaVersion

See also: AWS API Documentation

Request Syntax

client.create_job(
    JobName='string',
    RoleArn='string',
    JobCategory='AgentRFT'|'AgentRFTEvaluation',
    JobConfigSchemaVersion='string',
    JobConfigDocument='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type JobName:

string

param JobName:

[REQUIRED]

The name of the job. The name must be unique within your account and Amazon Web Services Region.

type RoleArn:

string

param RoleArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform the job. The role must have the necessary permissions to access the resources required by the job configuration.

type JobCategory:

string

param JobCategory:

[REQUIRED]

The category of the job. The category determines the type of workload that the job runs.

type JobConfigSchemaVersion:

string

param JobConfigSchemaVersion:

[REQUIRED]

The version of the configuration schema to use for the job configuration document. Use ListJobSchemaVersions to get available schema versions for a job category.

type JobConfigDocument:

string

param JobConfigDocument:

[REQUIRED]

The JSON configuration document for the job. The document must conform to the schema specified by JobConfigSchemaVersion. Use DescribeJobSchemaVersion to retrieve the schema for validation.

type Tags:

list

param Tags:

An array of key-value pairs to apply to the job as tags. For more information, see Tagging Amazon Web Services Resources.

• (dict) --

  A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

  You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.

  For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.

  • Key (string) -- [REQUIRED]

    The tag key. Tag keys must be unique per resource.

  • Value (string) -- [REQUIRED]

    The tag value.

rtype:

dict

returns:

Response Syntax

{
    'JobArn': 'string'
}

Response Structure

• (dict) --

  • JobArn (string) --

    The Amazon Resource Name (ARN) of the job.

Deletes a job. This operation is idempotent. If the job is currently running, you must stop it before deleting it by calling StopJob.

The following operations are related to DeleteJob:

• CreateJob

• StopJob

• DescribeJob

See also: AWS API Documentation

Request Syntax

client.delete_job(
    JobName='string',
    JobCategory='AgentRFT'|'AgentRFTEvaluation'
)

type JobName:

string

param JobName:

[REQUIRED]

The name of the job to delete.

type JobCategory:

string

param JobCategory:

[REQUIRED]

The category of the job to delete.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Lists available configuration schema versions for a specified job category. Use the schema versions with DescribeJobSchemaVersion to retrieve the full schema document.

The following operations are related to ListJobSchemaVersions:

• DescribeJobSchemaVersion

• CreateJob

See also: AWS API Documentation

Request Syntax

client.list_job_schema_versions(
    JobCategory='AgentRFT'|'AgentRFTEvaluation',
    NextToken='string',
    MaxResults=123
)

type JobCategory:

string

param JobCategory:

[REQUIRED]

The category of job schemas to list.

type NextToken:

string

param NextToken:

If the previous response was truncated, this token retrieves the next set of results.

type MaxResults:

integer

param MaxResults:

The maximum number of schema versions to return in the response. The default value is 5.

rtype:

dict

returns:

Response Syntax

{
    'NextToken': 'string',
    'JobConfigSchemas': [
        {
            'JobConfigSchemaVersion': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • NextToken (string) --

    If the response is truncated, this token retrieves the next set of results.

  • JobConfigSchemas (list) --

    An array of JobConfigSchemaVersionSummary objects listing the available schema versions.

    • (dict) --

      Provides summary information about a job configuration schema version.

      • JobConfigSchemaVersion (string) --

        The version of the job configuration schema.

Lists jobs in a specified category. You can filter results by creation time, last modified time, name, and status. Results are sorted by the field you specify in SortBy. Use pagination to retrieve large result sets efficiently.

The following operations are related to ListJobs:

• CreateJob

• DescribeJob

See also: AWS API Documentation

Request Syntax

client.list_jobs(
    JobCategory='AgentRFT'|'AgentRFTEvaluation',
    NextToken='string',
    MaxResults=123,
    CreationTimeAfter=datetime(2015, 1, 1),
    CreationTimeBefore=datetime(2015, 1, 1),
    LastModifiedTimeAfter=datetime(2015, 1, 1),
    LastModifiedTimeBefore=datetime(2015, 1, 1),
    NameContains='string',
    SortBy='Name'|'CreationTime'|'Status',
    SortOrder='Ascending'|'Descending',
    StatusEquals='InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped'|'Deleting'|'DeleteFailed'
)

type JobCategory:

string

param JobCategory:

[REQUIRED]

The category of jobs to list.

type NextToken:

string

param NextToken:

If the previous response was truncated, this token retrieves the next set of results.

type MaxResults:

integer

param MaxResults:

The maximum number of jobs to return in the response. The default value is 50.

type CreationTimeAfter:

datetime

param CreationTimeAfter:

A filter that returns only jobs created after the specified time.

type CreationTimeBefore:

datetime

param CreationTimeBefore:

A filter that returns only jobs created before the specified time.

type LastModifiedTimeAfter:

datetime

param LastModifiedTimeAfter:

A filter that returns only jobs modified after the specified time.

type LastModifiedTimeBefore:

datetime

param LastModifiedTimeBefore:

A filter that returns only jobs modified before the specified time.

type NameContains:

string

param NameContains:

A string in the job name to filter results. Only jobs whose name contains the specified string are returned.

type SortBy:

string

param SortBy:

The field to sort results by.

type SortOrder:

string

param SortOrder:

The sort order for results. Valid values are Ascending and Descending.

type StatusEquals:

string

param StatusEquals:

A filter that returns only jobs with the specified status.

rtype:

dict

returns:

Response Syntax

{
    'NextToken': 'string',
    'JobSummaries': [
        {
            'JobArn': 'string',
            'JobName': 'string',
            'JobCategory': 'AgentRFT'|'AgentRFTEvaluation',
            'JobStatus': 'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped'|'Deleting'|'DeleteFailed',
            'JobSecondaryStatus': 'Starting'|'Downloading'|'Training'|'Uploading'|'Stopping'|'Stopped'|'MaxRuntimeExceeded'|'Interrupted'|'Failed'|'Completed'|'Restarting'|'Pending'|'Evaluating'|'Deleting'|'DeleteFailed',
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

• (dict) --

  • NextToken (string) --

    If the response is truncated, this token retrieves the next set of results.

  • JobSummaries (list) --

    An array of JobSummary objects that provide summary information about the jobs.

    • (dict) --

      Provides summary information about a job, returned by the ListJobs operation. Use DescribeJob to get full details for a specific job.

      • JobArn (string) --

        The Amazon Resource Name (ARN) of the job.

      • JobName (string) --

        The name of the job.

      • JobCategory (string) --

        The category of the job.

      • JobStatus (string) --

        The current status of the job.

      • JobSecondaryStatus (string) --

        The secondary status of the job, providing more granular information about the job's progress. Secondary statuses may change between releases.

      • CreationTime (datetime) --

        The date and time that the job was created.

      • LastModifiedTime (datetime) --

        The date and time that the job was last modified.

      • EndTime (datetime) --

        The date and time that the job ended.

Returns detailed information about a job, including its current status, secondary status, configuration, and timestamps. Use SecondaryStatus for granular progress tracking and SecondaryStatusTransitions to see the full history of status changes with timestamps.

The following operations are related to DescribeJob:

• CreateJob

• ListJobs

• StopJob

• DeleteJob

See also: AWS API Documentation

Request Syntax

client.describe_job(
    JobName='string',
    JobCategory='AgentRFT'|'AgentRFTEvaluation'
)

type JobName:

string

param JobName:

[REQUIRED]

The name of the job to describe.

type JobCategory:

string

param JobCategory:

[REQUIRED]

The category of the job.

rtype:

dict

returns:

Response Syntax

{
    'JobName': 'string',
    'JobArn': 'string',
    'RoleArn': 'string',
    'JobCategory': 'AgentRFT'|'AgentRFTEvaluation',
    'JobConfigSchemaVersion': 'string',
    'JobConfigDocument': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'LastModifiedTime': datetime(2015, 1, 1),
    'EndTime': datetime(2015, 1, 1),
    'JobStatus': 'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped'|'Deleting'|'DeleteFailed',
    'SecondaryStatus': 'Starting'|'Downloading'|'Training'|'Uploading'|'Stopping'|'Stopped'|'MaxRuntimeExceeded'|'Interrupted'|'Failed'|'Completed'|'Restarting'|'Pending'|'Evaluating'|'Deleting'|'DeleteFailed',
    'SecondaryStatusTransitions': [
        {
            'Status': 'Starting'|'Downloading'|'Training'|'Uploading'|'Stopping'|'Stopped'|'MaxRuntimeExceeded'|'Interrupted'|'Failed'|'Completed'|'Restarting'|'Pending'|'Evaluating'|'Deleting'|'DeleteFailed',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'StatusMessage': 'string'
        },
    ],
    'FailureReason': 'string',
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • JobName (string) --

    The name of the job.

  • JobArn (string) --

    The Amazon Resource Name (ARN) of the job.

  • RoleArn (string) --

    The ARN of the IAM role associated with the job.

  • JobCategory (string) --

    The category of the job.

  • JobConfigSchemaVersion (string) --

    The schema version used for the job configuration document.

  • JobConfigDocument (string) --

    The JSON configuration document for the job.

  • CreationTime (datetime) --

    The date and time that the job was created.

  • LastModifiedTime (datetime) --

    The date and time that the job was last modified.

  • EndTime (datetime) --

    The date and time that the job ended.

  • JobStatus (string) --

    The current status of the job.

  • SecondaryStatus (string) --

    The detailed secondary status of the job, providing more granular information about the job's progress. Secondary statuses may change between releases.

  • SecondaryStatusTransitions (list) --

    A list of secondary status transitions for the job, with timestamps and optional status messages.

    • (dict) --

      Represents a secondary status transition for a job. Jobs progress through multiple secondary statuses during execution. Each transition records the status, start time, optional end time, and an optional message with additional details.

      • Status (string) --

        The secondary status of the job at this transition point.

      • StartTime (datetime) --

        The date and time that the status transition started.

      • EndTime (datetime) --

        The date and time that the status transition ended.

      • StatusMessage (string) --

        A detailed message about the status transition.

  • FailureReason (string) --

    If the job failed, the reason it failed.

  • Tags (list) --

    The tags associated with the job.

    • (dict) --

      A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

      You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.

      For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.

      • Key (string) --

        The tag key. Tag keys must be unique per resource.

      • Value (string) --

        The tag value.

{'PipelineExecutionSteps': {'Metadata': {'Job': {'Arn': 'string'}}}}

Gets a list of PipeLineExecutionStep objects.

See also: AWS API Documentation

Request Syntax

client.list_pipeline_execution_steps(
    PipelineExecutionArn='string',
    NextToken='string',
    MaxResults=123,
    SortOrder='Ascending'|'Descending'
)

type PipelineExecutionArn:

string

param PipelineExecutionArn:

The Amazon Resource Name (ARN) of the pipeline execution.

type NextToken:

string

param NextToken:

If the result of the previous ListPipelineExecutionSteps request was truncated, the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.

type MaxResults:

integer

param MaxResults:

The maximum number of pipeline execution steps to return in the response.

type SortOrder:

string

param SortOrder:

The field by which to sort results. The default is CreatedTime.

rtype:

dict

returns:

Response Syntax

{
    'PipelineExecutionSteps': [
        {
            'StepName': 'string',
            'StepDisplayName': 'string',
            'StepDescription': 'string',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'StepStatus': 'Starting'|'Executing'|'Stopping'|'Stopped'|'Failed'|'Succeeded',
            'CacheHitResult': {
                'SourcePipelineExecutionArn': 'string'
            },
            'FailureReason': 'string',
            'Metadata': {
                'TrainingJob': {
                    'Arn': 'string'
                },
                'ProcessingJob': {
                    'Arn': 'string'
                },
                'TransformJob': {
                    'Arn': 'string'
                },
                'TuningJob': {
                    'Arn': 'string'
                },
                'Model': {
                    'Arn': 'string'
                },
                'RegisterModel': {
                    'Arn': 'string'
                },
                'Condition': {
                    'Outcome': 'True'|'False'
                },
                'Callback': {
                    'CallbackToken': 'string',
                    'SqsQueueUrl': 'string',
                    'OutputParameters': [
                        {
                            'Name': 'string',
                            'Value': 'string'
                        },
                    ]
                },
                'Lambda': {
                    'Arn': 'string',
                    'OutputParameters': [
                        {
                            'Name': 'string',
                            'Value': 'string'
                        },
                    ]
                },
                'EMR': {
                    'ClusterId': 'string',
                    'StepId': 'string',
                    'StepName': 'string',
                    'LogFilePath': 'string'
                },
                'QualityCheck': {
                    'CheckType': 'string',
                    'BaselineUsedForDriftCheckStatistics': 'string',
                    'BaselineUsedForDriftCheckConstraints': 'string',
                    'CalculatedBaselineStatistics': 'string',
                    'CalculatedBaselineConstraints': 'string',
                    'ModelPackageGroupName': 'string',
                    'ViolationReport': 'string',
                    'CheckJobArn': 'string',
                    'SkipCheck': True|False,
                    'RegisterNewBaseline': True|False
                },
                'ClarifyCheck': {
                    'CheckType': 'string',
                    'BaselineUsedForDriftCheckConstraints': 'string',
                    'CalculatedBaselineConstraints': 'string',
                    'ModelPackageGroupName': 'string',
                    'ViolationReport': 'string',
                    'CheckJobArn': 'string',
                    'SkipCheck': True|False,
                    'RegisterNewBaseline': True|False
                },
                'Fail': {
                    'ErrorMessage': 'string'
                },
                'AutoMLJob': {
                    'Arn': 'string'
                },
                'Endpoint': {
                    'Arn': 'string'
                },
                'EndpointConfig': {
                    'Arn': 'string'
                },
                'BedrockCustomModel': {
                    'Arn': 'string'
                },
                'BedrockCustomModelDeployment': {
                    'Arn': 'string'
                },
                'BedrockProvisionedModelThroughput': {
                    'Arn': 'string'
                },
                'BedrockModelImport': {
                    'Arn': 'string'
                },
                'InferenceComponent': {
                    'Arn': 'string'
                },
                'Lineage': {
                    'ActionArns': {
                        'string': 'string'
                    },
                    'ArtifactArns': {
                        'string': 'string'
                    },
                    'ContextArns': {
                        'string': 'string'
                    },
                    'Associations': [
                        {
                            'SourceArn': 'string',
                            'DestinationArn': 'string'
                        },
                    ]
                },
                'Job': {
                    'Arn': 'string'
                }
            },
            'AttemptCount': 123,
            'SelectiveExecutionResult': {
                'SourcePipelineExecutionArn': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • PipelineExecutionSteps (list) --

    A list of PipeLineExecutionStep objects. Each PipeLineExecutionStep consists of StepName, StartTime, EndTime, StepStatus, and Metadata. Metadata is an object with properties for each job that contains relevant information about the job created by the step.

    • (dict) --

      An execution of a step in a pipeline.

      • StepName (string) --

        The name of the step that is executed.

      • StepDisplayName (string) --

        The display name of the step.

      • StepDescription (string) --

        The description of the step.

      • StartTime (datetime) --

        The time that the step started executing.

      • EndTime (datetime) --

        The time that the step stopped executing.

      • StepStatus (string) --

        The status of the step execution.

      • CacheHitResult (dict) --

        If this pipeline execution step was cached, details on the cache hit.

        • SourcePipelineExecutionArn (string) --

          The Amazon Resource Name (ARN) of the pipeline execution.

      • FailureReason (string) --

        The reason why the step failed execution. This is only returned if the step failed its execution.

      • Metadata (dict) --

        Metadata to run the pipeline step.

        • TrainingJob (dict) --

          The Amazon Resource Name (ARN) of the training job that was run by this step execution.

          • Arn (string) --

            The Amazon Resource Name (ARN) of the training job that was run by this step execution.

        • ProcessingJob (dict) --

          The Amazon Resource Name (ARN) of the processing job that was run by this step execution.

          • Arn (string) --

            The Amazon Resource Name (ARN) of the processing job.

        • TransformJob (dict) --

          The Amazon Resource Name (ARN) of the transform job that was run by this step execution.

          • Arn (string) --

            The Amazon Resource Name (ARN) of the transform job that was run by this step execution.

        • TuningJob (dict) --

          The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.

          • Arn (string) --

            The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.

        • Model (dict) --

          The Amazon Resource Name (ARN) of the model that was created by this step execution.

          • Arn (string) --

            The Amazon Resource Name (ARN) of the created model.

        • RegisterModel (dict) --

          The Amazon Resource Name (ARN) of the model package that the model was registered to by this step execution.

          • Arn (string) --

            The Amazon Resource Name (ARN) of the model package.

        • Condition (dict) --

          The outcome of the condition evaluation that was run by this step execution.

          • Outcome (string) --

            The outcome of the Condition step evaluation.

        • Callback (dict) --

          The URL of the Amazon SQS queue used by this step execution, the pipeline generated token, and a list of output parameters.

          • CallbackToken (string) --

            The pipeline generated token from the Amazon SQS queue.

          • SqsQueueUrl (string) --

            The URL of the Amazon Simple Queue Service (Amazon SQS) queue used by the callback step.

          • OutputParameters (list) --

            A list of the output parameters of the callback step.

            • (dict) --

              An output parameter of a pipeline step.

              • Name (string) --

                The name of the output parameter.

              • Value (string) --

                The value of the output parameter.

        • Lambda (dict) --

          The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of output parameters.

          • Arn (string) --

            The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution.

          • OutputParameters (list) --

            A list of the output parameters of the Lambda step.

            • (dict) --

              An output parameter of a pipeline step.

              • Name (string) --

                The name of the output parameter.

              • Value (string) --

                The value of the output parameter.

        • EMR (dict) --

          The configurations and outcomes of an Amazon EMR step execution.

          • ClusterId (string) --

            The identifier of the EMR cluster.

          • StepId (string) --

            The identifier of the EMR cluster step.

          • StepName (string) --

            The name of the EMR cluster step.

          • LogFilePath (string) --

            The path to the log file where the cluster step's failure root cause is recorded.

        • QualityCheck (dict) --

          The configurations and outcomes of the check step execution. This includes:

          • The type of the check conducted.

          • The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.

          • The Amazon S3 URIs of newly calculated baseline constraints and statistics.

          • The model package group name provided.

          • The Amazon S3 URI of the violation report if violations detected.

          • The Amazon Resource Name (ARN) of check processing job initiated by the step execution.

          • The Boolean flags indicating if the drift check is skipped.

          • If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.

          • CheckType (string) --

            The type of the Quality check step.

          • BaselineUsedForDriftCheckStatistics (string) --

            The Amazon S3 URI of the baseline statistics file used for the drift check.

          • BaselineUsedForDriftCheckConstraints (string) --

            The Amazon S3 URI of the baseline constraints file used for the drift check.

          • CalculatedBaselineStatistics (string) --

            The Amazon S3 URI of the newly calculated baseline statistics file.

          • CalculatedBaselineConstraints (string) --

            The Amazon S3 URI of the newly calculated baseline constraints file.

          • ModelPackageGroupName (string) --

            The model package group name.

          • ViolationReport (string) --

            The Amazon S3 URI of violation report if violations are detected.

          • CheckJobArn (string) --

            The Amazon Resource Name (ARN) of the Quality check processing job that was run by this step execution.

          • SkipCheck (boolean) --

            This flag indicates if the drift check against the previous baseline will be skipped or not. If it is set to False, the previous baseline of the configured check type must be available.

          • RegisterNewBaseline (boolean) --

            This flag indicates if a newly calculated baseline can be accessed through step properties BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. If it is set to False, the previous baseline of the configured check type must also be available. These can be accessed through the BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics properties.

        • ClarifyCheck (dict) --

          Container for the metadata for a Clarify check step. The configurations and outcomes of the check step execution. This includes:

          • The type of the check conducted,

          • The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.

          • The Amazon S3 URIs of newly calculated baseline constraints and statistics.

          • The model package group name provided.

          • The Amazon S3 URI of the violation report if violations detected.

          • The Amazon Resource Name (ARN) of check processing job initiated by the step execution.

          • The boolean flags indicating if the drift check is skipped.

          • If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.

          • CheckType (string) --

            The type of the Clarify Check step

          • BaselineUsedForDriftCheckConstraints (string) --

            The Amazon S3 URI of baseline constraints file to be used for the drift check.

          • CalculatedBaselineConstraints (string) --

            The Amazon S3 URI of the newly calculated baseline constraints file.

          • ModelPackageGroupName (string) --

            The model package group name.

          • ViolationReport (string) --

            The Amazon S3 URI of the violation report if violations are detected.

          • CheckJobArn (string) --

            The Amazon Resource Name (ARN) of the check processing job that was run by this step's execution.

          • SkipCheck (boolean) --

            This flag indicates if the drift check against the previous baseline will be skipped or not. If it is set to False, the previous baseline of the configured check type must be available.

          • RegisterNewBaseline (boolean) --

            This flag indicates if a newly calculated baseline can be accessed through step properties BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. If it is set to False, the previous baseline of the configured check type must also be available. These can be accessed through the BaselineUsedForDriftCheckConstraints property.

        • Fail (dict) --

          The configurations and outcomes of a Fail step execution.

          • ErrorMessage (string) --

            A message that you define and then is processed and rendered by the Fail step when the error occurs.

        • AutoMLJob (dict) --

          The Amazon Resource Name (ARN) of the AutoML job that was run by this step.

          • Arn (string) --

            The Amazon Resource Name (ARN) of the AutoML job.

        • Endpoint (dict) --

          The endpoint that was invoked during this step execution.

          • Arn (string) --

            The Amazon Resource Name (ARN) of the endpoint in the step.

        • EndpointConfig (dict) --

          The endpoint configuration used to create an endpoint during this step execution.

          • Arn (string) --

            The Amazon Resource Name (ARN) of the endpoint configuration used in the step.

        • BedrockCustomModel (dict) --

          The metadata of the Amazon Bedrock custom model used in the pipeline execution step.

          • Arn (string) --

            The Amazon Resource Name (ARN) of the Amazon Bedrock custom model.

        • BedrockCustomModelDeployment (dict) --

          The metadata of the Amazon Bedrock custom model deployment used in pipeline execution step.

          • Arn (string) --

            The Amazon Resource Name (ARN) for the Amazon Bedrock custom model deployment.

        • BedrockProvisionedModelThroughput (dict) --

          The metadata of the Amazon Bedrock provisioned model throughput used in the pipeline execution step.

          • Arn (string) --

            The Amazon Resource Name (ARN) of the Amazon Bedrock provisioned model throughput.

        • BedrockModelImport (dict) --

          The metadata of Amazon Bedrock model import used in pipeline execution step.

          • Arn (string) --

            The Amazon Resource Name (ARN) of the Amazon Bedrock model import.

        • InferenceComponent (dict) --

          The metadata of the inference component used in pipeline execution step.

          • Arn (string) --

            The Amazon Resource Name (ARN) of the inference component.

        • Lineage (dict) --

          The metadata of the lineage used in pipeline execution step.

          • ActionArns (dict) --

            The Amazon Resource Name (ARN) of the lineage action.

            • (string) --

              • (string) --

          • ArtifactArns (dict) --

            The Amazon Resource Name (ARN) of the lineage artifact.

            • (string) --

              • (string) --

          • ContextArns (dict) --

            The Amazon Resource Name (ARN) of the lineage context.

            • (string) --

              • (string) --

          • Associations (list) --

            The lineage associations.

            • (dict) --

              The data type used to describe the relationship between different sources.

              • SourceArn (string) --

                The Amazon Resource Name (ARN) of the AssociationInfo source.

              • DestinationArn (string) --

                The Amazon Resource Name (ARN) of the AssociationInfo destination.

        • Job (dict) --

          The metadata for a SageMaker job used in a pipeline execution step.

          • Arn (string) --

            The Amazon Resource Name (ARN) of the SageMaker job that was run by this step execution.

      • AttemptCount (integer) --

        The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.

      • SelectiveExecutionResult (dict) --

        The ARN from an execution of the current pipeline from which results are reused for this step.

        • SourcePipelineExecutionArn (string) --

          The ARN from an execution of the current pipeline.

  • NextToken (string) --

    If the result of the previous ListPipelineExecutionSteps request was truncated, the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.