send_pipeline_execution_step_failure

SageMaker.Client.send_pipeline_execution_step_failure(**kwargs)

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

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

Parameters

• CallbackToken (string) --

  [REQUIRED]

  The pipeline generated token from the Amazon SQS queue.

• FailureReason (string) -- A message describing why the step failed.
• 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