SageMaker / Client / send_pipeline_execution_step_success

send_pipeline_execution_step_success#

SageMaker.Client.send_pipeline_execution_step_success(**kwargs)#

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

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

  • CallbackToken (string) –

    [REQUIRED]

    The pipeline generated token from the Amazon SQS queue.

  • OutputParameters (list) –

    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.

  • ClientRequestToken (string) –

    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.

Return type:

dict

Returns:

Response Syntax

{
    'PipelineExecutionArn': 'string'
}

Response Structure

  • (dict) –

    • PipelineExecutionArn (string) –

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

Exceptions

  • SageMaker.Client.exceptions.ResourceNotFound

  • SageMaker.Client.exceptions.ResourceLimitExceeded

  • SageMaker.Client.exceptions.ConflictException