Amazonka.DataPipeline.DeactivatePipeline

Deactivates the specified running pipeline. The pipeline is set to the DEACTIVATING state until the deactivation process completes.

To resume a deactivated pipeline, use ActivatePipeline. By default, the pipeline resumes from the last completed execution. Optionally, you can specify the date and time to resume the pipeline.

Creating a Request

data DeactivatePipeline

Contains the parameters for DeactivatePipeline.

See: newDeactivatePipeline smart constructor.

Constructors

DeactivatePipeline'

Fields

• cancelActive :: Maybe Bool

  Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to CANCELED. If this value is false, the pipeline is deactivated after all running objects finish.

• pipelineId :: Text

  The ID of the pipeline.

Instances

ToJSON DeactivatePipeline

Defined in Amazonka.DataPipeline.DeactivatePipeline

Methods

toJSON :: DeactivatePipeline -> Value

toEncoding :: DeactivatePipeline -> Encoding

toJSONList :: [DeactivatePipeline] -> Value

toEncodingList :: [DeactivatePipeline] -> Encoding

ToHeaders DeactivatePipeline

Defined in Amazonka.DataPipeline.DeactivatePipeline

Methods

toHeaders :: DeactivatePipeline -> [Header]

ToPath DeactivatePipeline

Defined in Amazonka.DataPipeline.DeactivatePipeline

Methods

toPath :: DeactivatePipeline -> ByteString

ToQuery DeactivatePipeline

Defined in Amazonka.DataPipeline.DeactivatePipeline

Methods

toQuery :: DeactivatePipeline -> QueryString

AWSRequest DeactivatePipeline

Defined in Amazonka.DataPipeline.DeactivatePipeline

Associated Types

type AWSResponse DeactivatePipeline

Methods

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

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

Generic DeactivatePipeline

Defined in Amazonka.DataPipeline.DeactivatePipeline

Associated Types

type Rep DeactivatePipeline :: Type -> Type

Methods

from :: DeactivatePipeline -> Rep DeactivatePipeline x

to :: Rep DeactivatePipeline x -> DeactivatePipeline

Read DeactivatePipeline

Defined in Amazonka.DataPipeline.DeactivatePipeline

Methods

readsPrec :: Int -> ReadS DeactivatePipeline

readList :: ReadS [DeactivatePipeline]

readPrec :: ReadPrec DeactivatePipeline

readListPrec :: ReadPrec [DeactivatePipeline]

Show DeactivatePipeline

Defined in Amazonka.DataPipeline.DeactivatePipeline

Methods

showsPrec :: Int -> DeactivatePipeline -> ShowS

show :: DeactivatePipeline -> String

showList :: [DeactivatePipeline] -> ShowS

NFData DeactivatePipeline

Defined in Amazonka.DataPipeline.DeactivatePipeline

Methods

rnf :: DeactivatePipeline -> ()

Eq DeactivatePipeline

Defined in Amazonka.DataPipeline.DeactivatePipeline

Methods

(==) :: DeactivatePipeline -> DeactivatePipeline -> Bool

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

Hashable DeactivatePipeline

Defined in Amazonka.DataPipeline.DeactivatePipeline

Methods

hashWithSalt :: Int -> DeactivatePipeline -> Int

hash :: DeactivatePipeline -> Int

type AWSResponse DeactivatePipeline

Defined in Amazonka.DataPipeline.DeactivatePipeline

type AWSResponse DeactivatePipeline = DeactivatePipelineResponse

type Rep DeactivatePipeline

Defined in Amazonka.DataPipeline.DeactivatePipeline

type Rep DeactivatePipeline = D1 ('MetaData "DeactivatePipeline" "Amazonka.DataPipeline.DeactivatePipeline" "amazonka-datapipeline-2.0-1cySuAk2jmdDRpZSxMUuos" 'False) (C1 ('MetaCons "DeactivatePipeline'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cancelActive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "pipelineId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeactivatePipeline

Arguments

:: Text

DeactivatePipeline

-> DeactivatePipeline

Create a value of DeactivatePipeline 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:

$sel:cancelActive:DeactivatePipeline', deactivatePipeline_cancelActive - Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to CANCELED. If this value is false, the pipeline is deactivated after all running objects finish.

DeactivatePipeline, deactivatePipeline_pipelineId - The ID of the pipeline.

Request Lenses

deactivatePipeline_cancelActive :: Lens' DeactivatePipeline (Maybe Bool)

Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to CANCELED. If this value is false, the pipeline is deactivated after all running objects finish.

deactivatePipeline_pipelineId :: Lens' DeactivatePipeline Text

The ID of the pipeline.

Destructuring the Response

data DeactivatePipelineResponse

Contains the output of DeactivatePipeline.

See: newDeactivatePipelineResponse smart constructor.

Constructors

DeactivatePipelineResponse'

Fields

• httpStatus :: Int

  The response's http status code.

Instances

Generic DeactivatePipelineResponse

Defined in Amazonka.DataPipeline.DeactivatePipeline

Associated Types

type Rep DeactivatePipelineResponse :: Type -> Type

Methods

from :: DeactivatePipelineResponse -> Rep DeactivatePipelineResponse x

to :: Rep DeactivatePipelineResponse x -> DeactivatePipelineResponse

Read DeactivatePipelineResponse

Defined in Amazonka.DataPipeline.DeactivatePipeline

Methods

readsPrec :: Int -> ReadS DeactivatePipelineResponse

readList :: ReadS [DeactivatePipelineResponse]

readPrec :: ReadPrec DeactivatePipelineResponse

readListPrec :: ReadPrec [DeactivatePipelineResponse]

Show DeactivatePipelineResponse

Defined in Amazonka.DataPipeline.DeactivatePipeline

Methods

showsPrec :: Int -> DeactivatePipelineResponse -> ShowS

show :: DeactivatePipelineResponse -> String

showList :: [DeactivatePipelineResponse] -> ShowS

NFData DeactivatePipelineResponse

Defined in Amazonka.DataPipeline.DeactivatePipeline

Methods

rnf :: DeactivatePipelineResponse -> ()

Eq DeactivatePipelineResponse

Defined in Amazonka.DataPipeline.DeactivatePipeline

Methods

(==) :: DeactivatePipelineResponse -> DeactivatePipelineResponse -> Bool

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

type Rep DeactivatePipelineResponse

Defined in Amazonka.DataPipeline.DeactivatePipeline

type Rep DeactivatePipelineResponse = D1 ('MetaData "DeactivatePipelineResponse" "Amazonka.DataPipeline.DeactivatePipeline" "amazonka-datapipeline-2.0-1cySuAk2jmdDRpZSxMUuos" 'False) (C1 ('MetaCons "DeactivatePipelineResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeactivatePipelineResponse

Arguments

:: Int

$sel:httpStatus:DeactivatePipelineResponse'

-> DeactivatePipelineResponse

Create a value of DeactivatePipelineResponse 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:

$sel:httpStatus:DeactivatePipelineResponse', deactivatePipelineResponse_httpStatus - The response's http status code.

Response Lenses

deactivatePipelineResponse_httpStatus :: Lens' DeactivatePipelineResponse Int

The response's http status code.