Amazonka.CodePipeline.StartPipelineExecution

Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.

Creating a Request

data StartPipelineExecution

Represents the input of a StartPipelineExecution action.

See: newStartPipelineExecution smart constructor.

Constructors

StartPipelineExecution'

Fields

• clientRequestToken :: Maybe Text

  The system-generated unique ID used to identify a unique execution request.

• name :: Text

  The name of the pipeline to start.

Instances

ToJSON StartPipelineExecution

Defined in Amazonka.CodePipeline.StartPipelineExecution

Methods

toJSON :: StartPipelineExecution -> Value

toEncoding :: StartPipelineExecution -> Encoding

toJSONList :: [StartPipelineExecution] -> Value

toEncodingList :: [StartPipelineExecution] -> Encoding

ToHeaders StartPipelineExecution

Defined in Amazonka.CodePipeline.StartPipelineExecution

Methods

toHeaders :: StartPipelineExecution -> [Header]

ToPath StartPipelineExecution

Defined in Amazonka.CodePipeline.StartPipelineExecution

Methods

toPath :: StartPipelineExecution -> ByteString

ToQuery StartPipelineExecution

Defined in Amazonka.CodePipeline.StartPipelineExecution

Methods

toQuery :: StartPipelineExecution -> QueryString

AWSRequest StartPipelineExecution

Defined in Amazonka.CodePipeline.StartPipelineExecution

Associated Types

type AWSResponse StartPipelineExecution

Methods

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

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

Generic StartPipelineExecution

Defined in Amazonka.CodePipeline.StartPipelineExecution

Associated Types

type Rep StartPipelineExecution :: Type -> Type

Methods

from :: StartPipelineExecution -> Rep StartPipelineExecution x

to :: Rep StartPipelineExecution x -> StartPipelineExecution

Read StartPipelineExecution

Defined in Amazonka.CodePipeline.StartPipelineExecution

Methods

readsPrec :: Int -> ReadS StartPipelineExecution

readList :: ReadS [StartPipelineExecution]

readPrec :: ReadPrec StartPipelineExecution

readListPrec :: ReadPrec [StartPipelineExecution]

Show StartPipelineExecution

Defined in Amazonka.CodePipeline.StartPipelineExecution

Methods

showsPrec :: Int -> StartPipelineExecution -> ShowS

show :: StartPipelineExecution -> String

showList :: [StartPipelineExecution] -> ShowS

NFData StartPipelineExecution

Defined in Amazonka.CodePipeline.StartPipelineExecution

Methods

rnf :: StartPipelineExecution -> ()

Eq StartPipelineExecution

Defined in Amazonka.CodePipeline.StartPipelineExecution

Methods

(==) :: StartPipelineExecution -> StartPipelineExecution -> Bool

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

Hashable StartPipelineExecution

Defined in Amazonka.CodePipeline.StartPipelineExecution

Methods

hashWithSalt :: Int -> StartPipelineExecution -> Int

hash :: StartPipelineExecution -> Int

type AWSResponse StartPipelineExecution

Defined in Amazonka.CodePipeline.StartPipelineExecution

type AWSResponse StartPipelineExecution = StartPipelineExecutionResponse

type Rep StartPipelineExecution

Defined in Amazonka.CodePipeline.StartPipelineExecution

type Rep StartPipelineExecution = D1 ('MetaData "StartPipelineExecution" "Amazonka.CodePipeline.StartPipelineExecution" "amazonka-codepipeline-2.0-AHHPJTmnvhi1gPjRAFzjQE" 'False) (C1 ('MetaCons "StartPipelineExecution'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newStartPipelineExecution

Arguments

:: Text

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:clientRequestToken:StartPipelineExecution', startPipelineExecution_clientRequestToken - The system-generated unique ID used to identify a unique execution request.

StartPipelineExecution, startPipelineExecution_name - The name of the pipeline to start.

Request Lenses

startPipelineExecution_clientRequestToken :: Lens' StartPipelineExecution (Maybe Text)

The system-generated unique ID used to identify a unique execution request.

startPipelineExecution_name :: Lens' StartPipelineExecution Text

The name of the pipeline to start.

Destructuring the Response

data StartPipelineExecutionResponse

Represents the output of a StartPipelineExecution action.

See: newStartPipelineExecutionResponse smart constructor.

Constructors

StartPipelineExecutionResponse'

Fields

• pipelineExecutionId :: Maybe Text

  The unique system-generated ID of the pipeline execution that was started.

• httpStatus :: Int

  The response's http status code.

Instances

Generic StartPipelineExecutionResponse

Defined in Amazonka.CodePipeline.StartPipelineExecution

Associated Types

type Rep StartPipelineExecutionResponse :: Type -> Type

Methods

from :: StartPipelineExecutionResponse -> Rep StartPipelineExecutionResponse x

to :: Rep StartPipelineExecutionResponse x -> StartPipelineExecutionResponse

Read StartPipelineExecutionResponse

Defined in Amazonka.CodePipeline.StartPipelineExecution

Methods

readsPrec :: Int -> ReadS StartPipelineExecutionResponse

readList :: ReadS [StartPipelineExecutionResponse]

readPrec :: ReadPrec StartPipelineExecutionResponse

readListPrec :: ReadPrec [StartPipelineExecutionResponse]

Show StartPipelineExecutionResponse

Defined in Amazonka.CodePipeline.StartPipelineExecution

Methods

showsPrec :: Int -> StartPipelineExecutionResponse -> ShowS

show :: StartPipelineExecutionResponse -> String

showList :: [StartPipelineExecutionResponse] -> ShowS

NFData StartPipelineExecutionResponse

Defined in Amazonka.CodePipeline.StartPipelineExecution

Methods

rnf :: StartPipelineExecutionResponse -> ()

Eq StartPipelineExecutionResponse

Defined in Amazonka.CodePipeline.StartPipelineExecution

Methods

(==) :: StartPipelineExecutionResponse -> StartPipelineExecutionResponse -> Bool

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

type Rep StartPipelineExecutionResponse

Defined in Amazonka.CodePipeline.StartPipelineExecution

type Rep StartPipelineExecutionResponse = D1 ('MetaData "StartPipelineExecutionResponse" "Amazonka.CodePipeline.StartPipelineExecution" "amazonka-codepipeline-2.0-AHHPJTmnvhi1gPjRAFzjQE" 'False) (C1 ('MetaCons "StartPipelineExecutionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pipelineExecutionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartPipelineExecutionResponse

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:

StartPipelineExecutionResponse, startPipelineExecutionResponse_pipelineExecutionId - The unique system-generated ID of the pipeline execution that was started.

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

Response Lenses

startPipelineExecutionResponse_pipelineExecutionId :: Lens' StartPipelineExecutionResponse (Maybe Text)

The unique system-generated ID of the pipeline execution that was started.

startPipelineExecutionResponse_httpStatus :: Lens' StartPipelineExecutionResponse Int

The response's http status code.