Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SageMaker.StartPipelineExecution

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts a pipeline execution.

Synopsis

data StartPipelineExecution = StartPipelineExecution' {
- pipelineParameters :: Maybe [Parameter]
- pipelineExecutionDisplayName :: Maybe Text
- pipelineExecutionDescription :: Maybe Text
- pipelineName :: Text
- clientRequestToken :: Text
}
newStartPipelineExecution :: Text -> Text -> StartPipelineExecution
startPipelineExecution_pipelineParameters :: Lens' StartPipelineExecution (Maybe [Parameter])
startPipelineExecution_pipelineExecutionDisplayName :: Lens' StartPipelineExecution (Maybe Text)
startPipelineExecution_pipelineExecutionDescription :: Lens' StartPipelineExecution (Maybe Text)
startPipelineExecution_pipelineName :: Lens' StartPipelineExecution Text
startPipelineExecution_clientRequestToken :: Lens' StartPipelineExecution Text
data StartPipelineExecutionResponse = StartPipelineExecutionResponse' {
- pipelineExecutionArn :: Maybe Text
- httpStatus :: Int
}
newStartPipelineExecutionResponse :: Int -> StartPipelineExecutionResponse
startPipelineExecutionResponse_pipelineExecutionArn :: Lens' StartPipelineExecutionResponse (Maybe Text)
startPipelineExecutionResponse_httpStatus :: Lens' StartPipelineExecutionResponse Int

Creating a Request

data StartPipelineExecution Source #

See: newStartPipelineExecution smart constructor.

Constructors

StartPipelineExecution'

Fields

pipelineParameters :: Maybe [Parameter]
Contains a list of pipeline parameters. This list can be empty.
pipelineExecutionDisplayName :: Maybe Text
The display name of the pipeline execution.
pipelineExecutionDescription :: Maybe Text
The description of the pipeline execution.
pipelineName :: Text
The name of the pipeline.
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

Instances details

Eq StartPipelineExecution Source #
Instance details Defined in Amazonka.SageMaker.StartPipelineExecution Methods (==) :: StartPipelineExecution -> StartPipelineExecution -> Bool # (/=) :: StartPipelineExecution -> StartPipelineExecution -> Bool #
Read StartPipelineExecution Source #
Instance details Defined in Amazonka.SageMaker.StartPipelineExecution Methods readsPrec :: Int -> ReadS StartPipelineExecution # readList :: ReadS [StartPipelineExecution] # readPrec :: ReadPrec StartPipelineExecution # readListPrec :: ReadPrec [StartPipelineExecution] #
Show StartPipelineExecution Source #
Instance details Defined in Amazonka.SageMaker.StartPipelineExecution Methods showsPrec :: Int -> StartPipelineExecution -> ShowS # show :: StartPipelineExecution -> String # showList :: [StartPipelineExecution] -> ShowS #
Generic StartPipelineExecution Source #
Instance details Defined in Amazonka.SageMaker.StartPipelineExecution Associated Types type Rep StartPipelineExecution :: Type -> Type # Methods from :: StartPipelineExecution -> Rep StartPipelineExecution x # to :: Rep StartPipelineExecution x -> StartPipelineExecution #
NFData StartPipelineExecution Source #
Instance details Defined in Amazonka.SageMaker.StartPipelineExecution Methods rnf :: StartPipelineExecution -> () #
Hashable StartPipelineExecution Source #
Instance details Defined in Amazonka.SageMaker.StartPipelineExecution Methods hashWithSalt :: Int -> StartPipelineExecution -> Int # hash :: StartPipelineExecution -> Int #
ToJSON StartPipelineExecution Source #
Instance details Defined in Amazonka.SageMaker.StartPipelineExecution Methods toJSON :: StartPipelineExecution -> Value # toEncoding :: StartPipelineExecution -> Encoding # toJSONList :: [StartPipelineExecution] -> Value # toEncodingList :: [StartPipelineExecution] -> Encoding #
AWSRequest StartPipelineExecution Source #
Instance details Defined in Amazonka.SageMaker.StartPipelineExecution Associated Types type AWSResponse StartPipelineExecution # Methods request :: StartPipelineExecution -> Request StartPipelineExecution # response :: MonadResource m => Logger -> Service -> Proxy StartPipelineExecution -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartPipelineExecution))) #
ToHeaders StartPipelineExecution Source #
Instance details Defined in Amazonka.SageMaker.StartPipelineExecution Methods toHeaders :: StartPipelineExecution -> [Header] #
ToPath StartPipelineExecution Source #
Instance details Defined in Amazonka.SageMaker.StartPipelineExecution Methods toPath :: StartPipelineExecution -> ByteString #
ToQuery StartPipelineExecution Source #
Instance details Defined in Amazonka.SageMaker.StartPipelineExecution Methods toQuery :: StartPipelineExecution -> QueryString #
type Rep StartPipelineExecution Source #
Instance details Defined in Amazonka.SageMaker.StartPipelineExecution type Rep StartPipelineExecution = D1 ('MetaData "StartPipelineExecution" "Amazonka.SageMaker.StartPipelineExecution" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "StartPipelineExecution'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "pipelineParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Parameter])) :: S1 ('MetaSel ('Just "pipelineExecutionDisplayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "pipelineExecutionDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "pipelineName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse StartPipelineExecution Source #
Instance details Defined in Amazonka.SageMaker.StartPipelineExecution type AWSResponse StartPipelineExecution = StartPipelineExecutionResponse

newStartPipelineExecution Source #

Arguments

:: Text	`$sel:pipelineName:StartPipelineExecution'`
-> Text	`$sel:clientRequestToken:StartPipelineExecution'`
-> StartPipelineExecution

Create a value of StartPipelineExecution 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:pipelineParameters:StartPipelineExecution', startPipelineExecution_pipelineParameters - Contains a list of pipeline parameters. This list can be empty.

$sel:pipelineExecutionDisplayName:StartPipelineExecution', startPipelineExecution_pipelineExecutionDisplayName - The display name of the pipeline execution.

$sel:pipelineExecutionDescription:StartPipelineExecution', startPipelineExecution_pipelineExecutionDescription - The description of the pipeline execution.

$sel:pipelineName:StartPipelineExecution', startPipelineExecution_pipelineName - The name of the pipeline.

$sel:clientRequestToken:StartPipelineExecution', startPipelineExecution_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

startPipelineExecution_pipelineParameters :: Lens' StartPipelineExecution (Maybe [Parameter]) Source #

Contains a list of pipeline parameters. This list can be empty.

startPipelineExecution_pipelineExecutionDisplayName :: Lens' StartPipelineExecution (Maybe Text) Source #

The display name of the pipeline execution.

startPipelineExecution_pipelineExecutionDescription :: Lens' StartPipelineExecution (Maybe Text) Source #

The description of the pipeline execution.

startPipelineExecution_pipelineName :: Lens' StartPipelineExecution Text Source #

The name of the pipeline.

startPipelineExecution_clientRequestToken :: Lens' StartPipelineExecution Text Source #

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 StartPipelineExecutionResponse Source #

See: newStartPipelineExecutionResponse smart constructor.

Constructors

StartPipelineExecutionResponse'
Fields pipelineExecutionArn :: Maybe Text The Amazon Resource Name (ARN) of the pipeline execution. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq StartPipelineExecutionResponse Source #
Instance details Defined in Amazonka.SageMaker.StartPipelineExecution Methods (==) :: StartPipelineExecutionResponse -> StartPipelineExecutionResponse -> Bool # (/=) :: StartPipelineExecutionResponse -> StartPipelineExecutionResponse -> Bool #
Read StartPipelineExecutionResponse Source #
Instance details Defined in Amazonka.SageMaker.StartPipelineExecution Methods readsPrec :: Int -> ReadS StartPipelineExecutionResponse # readList :: ReadS [StartPipelineExecutionResponse] # readPrec :: ReadPrec StartPipelineExecutionResponse # readListPrec :: ReadPrec [StartPipelineExecutionResponse] #
Show StartPipelineExecutionResponse Source #
Instance details Defined in Amazonka.SageMaker.StartPipelineExecution Methods showsPrec :: Int -> StartPipelineExecutionResponse -> ShowS # show :: StartPipelineExecutionResponse -> String # showList :: [StartPipelineExecutionResponse] -> ShowS #
Generic StartPipelineExecutionResponse Source #
Instance details Defined in Amazonka.SageMaker.StartPipelineExecution Associated Types type Rep StartPipelineExecutionResponse :: Type -> Type # Methods from :: StartPipelineExecutionResponse -> Rep StartPipelineExecutionResponse x # to :: Rep StartPipelineExecutionResponse x -> StartPipelineExecutionResponse #
NFData StartPipelineExecutionResponse Source #
Instance details Defined in Amazonka.SageMaker.StartPipelineExecution Methods rnf :: StartPipelineExecutionResponse -> () #
type Rep StartPipelineExecutionResponse Source #
Instance details Defined in Amazonka.SageMaker.StartPipelineExecution type Rep StartPipelineExecutionResponse = D1 ('MetaData "StartPipelineExecutionResponse" "Amazonka.SageMaker.StartPipelineExecution" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "StartPipelineExecutionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pipelineExecutionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartPipelineExecutionResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartPipelineExecutionResponse'`
-> StartPipelineExecutionResponse

Create a value of StartPipelineExecutionResponse 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:pipelineExecutionArn:StartPipelineExecutionResponse', startPipelineExecutionResponse_pipelineExecutionArn - The Amazon Resource Name (ARN) of the pipeline execution.

$sel:httpStatus:StartPipelineExecutionResponse', startPipelineExecutionResponse_httpStatus - The response's http status code.

Response Lenses

startPipelineExecutionResponse_pipelineExecutionArn :: Lens' StartPipelineExecutionResponse (Maybe Text) Source #

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

startPipelineExecutionResponse_httpStatus :: Lens' StartPipelineExecutionResponse Int Source #

The response's http status code.