Amazonka.SageMaker.StopPipelineExecution

Stops a pipeline execution.

Callback Step

A pipeline execution won't stop while a callback step is running. When you call StopPipelineExecution on a pipeline execution with a running callback step, SageMaker Pipelines sends an additional Amazon SQS message to the specified SQS queue. The body of the SQS message contains a "Status" field which is set to "Stopping".

You should add logic to your Amazon SQS message consumer to take any needed action (for example, resource cleanup) upon receipt of the message followed by a call to SendPipelineExecutionStepSuccess or SendPipelineExecutionStepFailure.

Only when SageMaker Pipelines receives one of these calls will it stop the pipeline execution.

Lambda Step

A pipeline execution can't be stopped while a lambda step is running because the Lambda function invoked by the lambda step can't be stopped. If you attempt to stop the execution while the Lambda function is running, the pipeline waits for the Lambda function to finish or until the timeout is hit, whichever occurs first, and then stops. If the Lambda function finishes, the pipeline execution status is Stopped. If the timeout is hit the pipeline execution status is Failed.

Creating a Request

data StopPipelineExecution

See: newStopPipelineExecution smart constructor.

Constructors

StopPipelineExecution'

Fields

• pipelineExecutionArn :: Text

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

• clientRequestToken :: Text

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

Instances

ToJSON StopPipelineExecution

Defined in Amazonka.SageMaker.StopPipelineExecution

Methods

toJSON :: StopPipelineExecution -> Value

toEncoding :: StopPipelineExecution -> Encoding

toJSONList :: [StopPipelineExecution] -> Value

toEncodingList :: [StopPipelineExecution] -> Encoding

ToHeaders StopPipelineExecution

Defined in Amazonka.SageMaker.StopPipelineExecution

Methods

toHeaders :: StopPipelineExecution -> [Header]

ToPath StopPipelineExecution

Defined in Amazonka.SageMaker.StopPipelineExecution

Methods

toPath :: StopPipelineExecution -> ByteString

ToQuery StopPipelineExecution

Defined in Amazonka.SageMaker.StopPipelineExecution

Methods

toQuery :: StopPipelineExecution -> QueryString

AWSRequest StopPipelineExecution

Defined in Amazonka.SageMaker.StopPipelineExecution

Associated Types

type AWSResponse StopPipelineExecution

Methods

request :: (Service -> Service) -> StopPipelineExecution -> Request StopPipelineExecution

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StopPipelineExecution -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StopPipelineExecution)))

Generic StopPipelineExecution

Defined in Amazonka.SageMaker.StopPipelineExecution

Associated Types

type Rep StopPipelineExecution :: Type -> Type

Methods

from :: StopPipelineExecution -> Rep StopPipelineExecution x

to :: Rep StopPipelineExecution x -> StopPipelineExecution

Read StopPipelineExecution

Defined in Amazonka.SageMaker.StopPipelineExecution

Methods

readsPrec :: Int -> ReadS StopPipelineExecution

readList :: ReadS [StopPipelineExecution]

readPrec :: ReadPrec StopPipelineExecution

readListPrec :: ReadPrec [StopPipelineExecution]

Show StopPipelineExecution

Defined in Amazonka.SageMaker.StopPipelineExecution

Methods

showsPrec :: Int -> StopPipelineExecution -> ShowS

show :: StopPipelineExecution -> String

showList :: [StopPipelineExecution] -> ShowS

NFData StopPipelineExecution

Defined in Amazonka.SageMaker.StopPipelineExecution

Methods

rnf :: StopPipelineExecution -> ()

Eq StopPipelineExecution

Defined in Amazonka.SageMaker.StopPipelineExecution

Methods

(==) :: StopPipelineExecution -> StopPipelineExecution -> Bool

(/=) :: StopPipelineExecution -> StopPipelineExecution -> Bool

Hashable StopPipelineExecution

Defined in Amazonka.SageMaker.StopPipelineExecution

Methods

hashWithSalt :: Int -> StopPipelineExecution -> Int

hash :: StopPipelineExecution -> Int

type AWSResponse StopPipelineExecution

Defined in Amazonka.SageMaker.StopPipelineExecution

type AWSResponse StopPipelineExecution = StopPipelineExecutionResponse

type Rep StopPipelineExecution

Defined in Amazonka.SageMaker.StopPipelineExecution

type Rep StopPipelineExecution = D1 ('MetaData "StopPipelineExecution" "Amazonka.SageMaker.StopPipelineExecution" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "StopPipelineExecution'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pipelineExecutionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newStopPipelineExecution

Arguments

:: Text

StopPipelineExecution

-> Text

$sel:clientRequestToken:StopPipelineExecution'

-> StopPipelineExecution

Create a value of StopPipelineExecution with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

StopPipelineExecution, stopPipelineExecution_pipelineExecutionArn - The Amazon Resource Name (ARN) of the pipeline execution.

$sel:clientRequestToken:StopPipelineExecution', stopPipelineExecution_clientRequestToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.

Request Lenses

stopPipelineExecution_pipelineExecutionArn :: Lens' StopPipelineExecution Text

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

stopPipelineExecution_clientRequestToken :: Lens' StopPipelineExecution Text

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

Destructuring the Response

data StopPipelineExecutionResponse

See: newStopPipelineExecutionResponse smart constructor.

Constructors

StopPipelineExecutionResponse'

Fields

• pipelineExecutionArn :: Maybe Text

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic StopPipelineExecutionResponse

Defined in Amazonka.SageMaker.StopPipelineExecution

Associated Types

type Rep StopPipelineExecutionResponse :: Type -> Type

Methods

from :: StopPipelineExecutionResponse -> Rep StopPipelineExecutionResponse x

to :: Rep StopPipelineExecutionResponse x -> StopPipelineExecutionResponse

Read StopPipelineExecutionResponse

Defined in Amazonka.SageMaker.StopPipelineExecution

Methods

readsPrec :: Int -> ReadS StopPipelineExecutionResponse

readList :: ReadS [StopPipelineExecutionResponse]

readPrec :: ReadPrec StopPipelineExecutionResponse

readListPrec :: ReadPrec [StopPipelineExecutionResponse]

Show StopPipelineExecutionResponse

Defined in Amazonka.SageMaker.StopPipelineExecution

Methods

showsPrec :: Int -> StopPipelineExecutionResponse -> ShowS

show :: StopPipelineExecutionResponse -> String

showList :: [StopPipelineExecutionResponse] -> ShowS

NFData StopPipelineExecutionResponse

Defined in Amazonka.SageMaker.StopPipelineExecution

Methods

rnf :: StopPipelineExecutionResponse -> ()

Eq StopPipelineExecutionResponse

Defined in Amazonka.SageMaker.StopPipelineExecution

Methods

(==) :: StopPipelineExecutionResponse -> StopPipelineExecutionResponse -> Bool

(/=) :: StopPipelineExecutionResponse -> StopPipelineExecutionResponse -> Bool

type Rep StopPipelineExecutionResponse

Defined in Amazonka.SageMaker.StopPipelineExecution

type Rep StopPipelineExecutionResponse = D1 ('MetaData "StopPipelineExecutionResponse" "Amazonka.SageMaker.StopPipelineExecution" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "StopPipelineExecutionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pipelineExecutionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStopPipelineExecutionResponse

Arguments

:: Int

$sel:httpStatus:StopPipelineExecutionResponse'

-> StopPipelineExecutionResponse

Create a value of StopPipelineExecutionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

StopPipelineExecution, stopPipelineExecutionResponse_pipelineExecutionArn - The Amazon Resource Name (ARN) of the pipeline execution.

$sel:httpStatus:StopPipelineExecutionResponse', stopPipelineExecutionResponse_httpStatus - The response's http status code.

Response Lenses

stopPipelineExecutionResponse_pipelineExecutionArn :: Lens' StopPipelineExecutionResponse (Maybe Text)

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

stopPipelineExecutionResponse_httpStatus :: Lens' StopPipelineExecutionResponse Int

The response's http status code.