SendPipelineExecutionStepFailure - Amazon SageMaker

SendPipelineExecutionStepFailure

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

Request Syntax

{ "CallbackToken": "string", "ClientRequestToken": "string", "FailureReason": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

CallbackToken

The pipeline generated token from the Amazon SQS queue.

Type: String

Length Constraints: Fixed length of 10.

Pattern: ^[a-zA-Z0-9]+$

Required: Yes

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.

Type: String

Length Constraints: Minimum length of 32. Maximum length of 128.

Required: No

FailureReason

A message describing why the step failed.

Type: String

Length Constraints: Maximum length of 256.

Required: No

Response Syntax

{ "PipelineExecutionArn": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

PipelineExecutionArn

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

Type: String

Length Constraints: Maximum length of 256.

Pattern: ^arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:pipeline\/.*\/execution\/.*$

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceLimitExceeded

You have exceeded an Amazon SageMaker resource limit. For example, you might have too many training jobs created.

HTTP Status Code: 400

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: