Amazon SageMaker Service

2021/06/07 - Amazon SageMaker Service - 2 new3 updated api methods

Changes  AWS SageMaker - Releasing new APIs related to Callback steps in model building pipelines. Adds experiment integration to model building pipelines.

SendPipelineExecutionStepSuccess (new) Link ¶

Notifies the pipeline that the execution of a callback step succeeded and provides a list of the step's output parameters. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).

See also: AWS API Documentation

Request Syntax

client.send_pipeline_execution_step_success(
    CallbackToken='string',
    OutputParameters=[
        {
            'Name': 'string',
            'Value': 'string'
        },
    ],
    ClientRequestToken='string'
)
type CallbackToken:

string

param CallbackToken:

[REQUIRED]

The pipeline generated token from the Amazon SQS queue.

type OutputParameters:

list

param OutputParameters:

A list of the output parameters of the callback step.

  • (dict) --

    An output parameter of a pipeline step.

    • Name (string) -- [REQUIRED]

      The name of the output parameter.

    • Value (string) -- [REQUIRED]

      The value of the output parameter.

type ClientRequestToken:

string

param ClientRequestToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'PipelineExecutionArn': 'string'
}

Response Structure

  • (dict) --

    • PipelineExecutionArn (string) --

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

SendPipelineExecutionStepFailure (new) Link ¶

Notifies the pipeline that the execution of a callback step failed, along with a message describing why. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).

See also: AWS API Documentation

Request Syntax

client.send_pipeline_execution_step_failure(
    CallbackToken='string',
    FailureReason='string',
    ClientRequestToken='string'
)
type CallbackToken:

string

param CallbackToken:

[REQUIRED]

The pipeline generated token from the Amazon SQS queue.

type FailureReason:

string

param FailureReason:

A message describing why the step failed.

type ClientRequestToken:

string

param ClientRequestToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'PipelineExecutionArn': 'string'
}

Response Structure

  • (dict) --

    • PipelineExecutionArn (string) --

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

DescribePipelineExecution (updated) Link ¶
Changes (response)
{'FailureReason': 'string',
 'PipelineExperimentConfig': {'ExperimentName': 'string',
                              'TrialName': 'string'}}

Describes the details of a pipeline execution.

See also: AWS API Documentation

Request Syntax

client.describe_pipeline_execution(
    PipelineExecutionArn='string'
)
type PipelineExecutionArn:

string

param PipelineExecutionArn:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'PipelineArn': 'string',
    'PipelineExecutionArn': 'string',
    'PipelineExecutionDisplayName': 'string',
    'PipelineExecutionStatus': 'Executing'|'Stopping'|'Stopped'|'Failed'|'Succeeded',
    'PipelineExecutionDescription': 'string',
    'PipelineExperimentConfig': {
        'ExperimentName': 'string',
        'TrialName': 'string'
    },
    'FailureReason': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'LastModifiedTime': datetime(2015, 1, 1),
    'CreatedBy': {
        'UserProfileArn': 'string',
        'UserProfileName': 'string',
        'DomainId': 'string'
    },
    'LastModifiedBy': {
        'UserProfileArn': 'string',
        'UserProfileName': 'string',
        'DomainId': 'string'
    }
}

Response Structure

  • (dict) --

    • PipelineArn (string) --

      The Amazon Resource Name (ARN) of the pipeline.

    • PipelineExecutionArn (string) --

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

    • PipelineExecutionDisplayName (string) --

      The display name of the pipeline execution.

    • PipelineExecutionStatus (string) --

      The status of the pipeline execution.

    • PipelineExecutionDescription (string) --

      The description of the pipeline execution.

    • PipelineExperimentConfig (dict) --

      Specifies the names of the experiment and trial created by a pipeline.

      • ExperimentName (string) --

        The name of the experiment.

      • TrialName (string) --

        The name of the trial.

    • FailureReason (string) --

      If the execution failed, a message describing why.

    • CreationTime (datetime) --

      The time when the pipeline execution was created.

    • LastModifiedTime (datetime) --

      The time when the pipeline execution was modified last.

    • CreatedBy (dict) --

      Information about the user who created or modified an experiment, trial, or trial component.

      • UserProfileArn (string) --

        The Amazon Resource Name (ARN) of the user's profile.

      • UserProfileName (string) --

        The name of the user's profile.

      • DomainId (string) --

        The domain associated with the user.

    • LastModifiedBy (dict) --

      Information about the user who created or modified an experiment, trial, or trial component.

      • UserProfileArn (string) --

        The Amazon Resource Name (ARN) of the user's profile.

      • UserProfileName (string) --

        The name of the user's profile.

      • DomainId (string) --

        The domain associated with the user.

ListPipelineExecutionSteps (updated) Link ¶
Changes (response)
{'PipelineExecutionSteps': {'Metadata': {'Callback': {'CallbackToken': 'string',
                                                      'OutputParameters': [{'Name': 'string',
                                                                            'Value': 'string'}],
                                                      'SqsQueueUrl': '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',
            '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'
                },
                'Model': {
                    'Arn': 'string'
                },
                'RegisterModel': {
                    'Arn': 'string'
                },
                'Condition': {
                    'Outcome': 'True'|'False'
                },
                'Callback': {
                    'CallbackToken': 'string',
                    'SqsQueueUrl': 'string',
                    'OutputParameters': [
                        {
                            'Name': 'string',
                            'Value': '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.

        • 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 for the step execution.

          • 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.

          • Model (dict) --

            Metadata for the Model step.

            • Arn (string) --

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

          • RegisterModel (dict) --

            Metadata for the RegisterModel step.

            • Arn (string) --

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

          • Condition (dict) --

            If this is a Condition step metadata object, details on the condition.

            • Outcome (string) --

              The outcome of the Condition step evaluation.

          • Callback (dict) --

            Metadata about a callback step.

            • 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.

    • 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.