amazonka-codepipeline-2.0: Amazon CodePipeline SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CodePipeline.GetJobDetails

Description

Returns information about a job. Used for custom actions only.

When this API is called, AWS CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.

Synopsis

Creating a Request

data GetJobDetails Source #

Represents the input of a GetJobDetails action.

See: newGetJobDetails smart constructor.

Constructors

GetJobDetails' 

Fields

  • jobId :: Text

    The unique system-generated ID for the job.

Instances

Instances details
ToJSON GetJobDetails Source # 
Instance details

Defined in Amazonka.CodePipeline.GetJobDetails

ToHeaders GetJobDetails Source # 
Instance details

Defined in Amazonka.CodePipeline.GetJobDetails

ToPath GetJobDetails Source # 
Instance details

Defined in Amazonka.CodePipeline.GetJobDetails

ToQuery GetJobDetails Source # 
Instance details

Defined in Amazonka.CodePipeline.GetJobDetails

AWSRequest GetJobDetails Source # 
Instance details

Defined in Amazonka.CodePipeline.GetJobDetails

Associated Types

type AWSResponse GetJobDetails #

Generic GetJobDetails Source # 
Instance details

Defined in Amazonka.CodePipeline.GetJobDetails

Associated Types

type Rep GetJobDetails :: Type -> Type #

Read GetJobDetails Source # 
Instance details

Defined in Amazonka.CodePipeline.GetJobDetails

Show GetJobDetails Source # 
Instance details

Defined in Amazonka.CodePipeline.GetJobDetails

NFData GetJobDetails Source # 
Instance details

Defined in Amazonka.CodePipeline.GetJobDetails

Methods

rnf :: GetJobDetails -> () #

Eq GetJobDetails Source # 
Instance details

Defined in Amazonka.CodePipeline.GetJobDetails

Hashable GetJobDetails Source # 
Instance details

Defined in Amazonka.CodePipeline.GetJobDetails

type AWSResponse GetJobDetails Source # 
Instance details

Defined in Amazonka.CodePipeline.GetJobDetails

type Rep GetJobDetails Source # 
Instance details

Defined in Amazonka.CodePipeline.GetJobDetails

type Rep GetJobDetails = D1 ('MetaData "GetJobDetails" "Amazonka.CodePipeline.GetJobDetails" "amazonka-codepipeline-2.0-AHHPJTmnvhi1gPjRAFzjQE" 'False) (C1 ('MetaCons "GetJobDetails'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetJobDetails Source #

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

GetJobDetails, getJobDetails_jobId - The unique system-generated ID for the job.

Request Lenses

getJobDetails_jobId :: Lens' GetJobDetails Text Source #

The unique system-generated ID for the job.

Destructuring the Response

data GetJobDetailsResponse Source #

Represents the output of a GetJobDetails action.

See: newGetJobDetailsResponse smart constructor.

Constructors

GetJobDetailsResponse' 

Fields

  • jobDetails :: Maybe JobDetails

    The details of the job.

    If AWSSessionCredentials is used, a long-running job can call GetJobDetails again to obtain new credentials.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic GetJobDetailsResponse Source # 
Instance details

Defined in Amazonka.CodePipeline.GetJobDetails

Associated Types

type Rep GetJobDetailsResponse :: Type -> Type #

Show GetJobDetailsResponse Source # 
Instance details

Defined in Amazonka.CodePipeline.GetJobDetails

NFData GetJobDetailsResponse Source # 
Instance details

Defined in Amazonka.CodePipeline.GetJobDetails

Methods

rnf :: GetJobDetailsResponse -> () #

Eq GetJobDetailsResponse Source # 
Instance details

Defined in Amazonka.CodePipeline.GetJobDetails

type Rep GetJobDetailsResponse Source # 
Instance details

Defined in Amazonka.CodePipeline.GetJobDetails

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

newGetJobDetailsResponse Source #

Create a value of GetJobDetailsResponse 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:jobDetails:GetJobDetailsResponse', getJobDetailsResponse_jobDetails - The details of the job.

If AWSSessionCredentials is used, a long-running job can call GetJobDetails again to obtain new credentials.

$sel:httpStatus:GetJobDetailsResponse', getJobDetailsResponse_httpStatus - The response's http status code.

Response Lenses

getJobDetailsResponse_jobDetails :: Lens' GetJobDetailsResponse (Maybe JobDetails) Source #

The details of the job.

If AWSSessionCredentials is used, a long-running job can call GetJobDetails again to obtain new credentials.