Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . codepipeline ]

get-third-party-job-details

Description

Requests the details of a job for a third party action. Only used for partner actions.

Warning

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-third-party-job-details
--job-id <value>
--client-token <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--job-id (string)

The unique system-generated ID used for identifying the job.

--client-token (string)

The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

jobDetails -> (structure)

The details of the job, including any protected values defined for the job.

id -> (string)

The identifier used to identify the job details in AWS CodePipeline.

data -> (structure)

The data to be returned by the third party job worker.

actionTypeId -> (structure)

Represents information about an action type.

category -> (string)

A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the values below.

owner -> (string)

The creator of the action being called.

provider -> (string)

The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of AWS CodeDeploy, which would be specified as CodeDeploy.

version -> (string)

A string that describes the action version.

actionConfiguration -> (structure)

Represents information about an action configuration.

configuration -> (map)

The configuration data for the action.

key -> (string)

value -> (string)

pipelineContext -> (structure)

Represents information about a pipeline to a job worker.

pipelineName -> (string)

The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names under an Amazon Web Services account.

stage -> (structure)

The stage of the pipeline.

name -> (string)

The name of the stage.

action -> (structure)

The context of an action to a job worker within the stage of a pipeline.

name -> (string)

The name of the action within the context of a job.

inputArtifacts -> (list)

The name of the artifact that will be worked upon by the action, if any. This name might be system-generated, such as "MyApp", or might be defined by the user when the action is created. The input artifact name must match the name of an output artifact generated by an action in an earlier action or stage of the pipeline.

(structure)

Represents information about an artifact that will be worked upon by actions in the pipeline.

name -> (string)

The artifact's name.

revision -> (string)

The artifact's revision ID. Depending on the type of object, this could be a commit ID (GitHub) or a revision ID (Amazon S3).

location -> (structure)

The location of an artifact.

type -> (string)

The type of artifact in the location.

s3Location -> (structure)

The Amazon S3 bucket that contains the artifact.

bucketName -> (string)

The name of the Amazon S3 bucket.

objectKey -> (string)

The key of the object in the Amazon S3 bucket, which uniquely identifies the object in the bucket.

outputArtifacts -> (list)

The name of the artifact that will be the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or might be defined by the user when the action is created.

(structure)

Represents information about an artifact that will be worked upon by actions in the pipeline.

name -> (string)

The artifact's name.

revision -> (string)

The artifact's revision ID. Depending on the type of object, this could be a commit ID (GitHub) or a revision ID (Amazon S3).

location -> (structure)

The location of an artifact.

type -> (string)

The type of artifact in the location.

s3Location -> (structure)

The Amazon S3 bucket that contains the artifact.

bucketName -> (string)

The name of the Amazon S3 bucket.

objectKey -> (string)

The key of the object in the Amazon S3 bucket, which uniquely identifies the object in the bucket.

artifactCredentials -> (structure)

Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS Secure Token Service (STS). They can be used to access input and output artifacts in the Amazon S3 bucket used to store artifact for the pipeline in AWS CodePipeline.

accessKeyId -> (string)

The access key for the session.

secretAccessKey -> (string)

The secret access key for the session.

sessionToken -> (string)

The token for the session.

continuationToken -> (string)

A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires in order to continue the job asynchronously.

encryptionKey -> (structure)

The encryption key used to encrypt and decrypt data in the artifact store for the pipeline, such as an AWS Key Management Service (AWS KMS) key. This is optional and might not be present.

id -> (string)

The ID used to identify the key. For an AWS KMS key, this is the key ID or key ARN.

type -> (string)

The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. When creating or updating a pipeline, the value must be set to 'KMS'.

nonce -> (string)

A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Use this number in an acknowledge-third-party-job request.