Menu
AWS CodePipeline
API Reference (API Version 2015-07-09)

GetThirdPartyJobDetails

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

Important

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.

Request Syntax

{
   "clientToken": "string",
   "jobId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

clientToken

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

jobId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Required: Yes

Response Syntax

{
   "jobDetails": { 
      "data": { 
         "actionConfiguration": { 
            "configuration": { 
               "string" : "string" 
            }
         },
         "actionTypeId": { 
            "category": "string",
            "owner": "string",
            "provider": "string",
            "version": "string"
         },
         "artifactCredentials": { 
            "accessKeyId": "string",
            "secretAccessKey": "string",
            "sessionToken": "string"
         },
         "continuationToken": "string",
         "encryptionKey": { 
            "id": "string",
            "type": "string"
         },
         "inputArtifacts": [ 
            { 
               "location": { 
                  "s3Location": { 
                     "bucketName": "string",
                     "objectKey": "string"
                  },
                  "type": "string"
               },
               "name": "string",
               "revision": "string"
            }
         ],
         "outputArtifacts": [ 
            { 
               "location": { 
                  "s3Location": { 
                     "bucketName": "string",
                     "objectKey": "string"
                  },
                  "type": "string"
               },
               "name": "string",
               "revision": "string"
            }
         ],
         "pipelineContext": { 
            "action": { 
               "name": "string"
            },
            "pipelineName": "string",
            "stage": { 
               "name": "string"
            }
         }
      },
      "id": "string",
      "nonce": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

jobDetails

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

Type: ThirdPartyJobDetails object

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidClientTokenException

The client token was specified in an invalid format

HTTP Status Code: 400

InvalidJobException

The specified job was specified in an invalid format or cannot be found.

HTTP Status Code: 400

JobNotFoundException

The specified job was specified in an invalid format or cannot be found.

HTTP Status Code: 400

ValidationException

The validation was specified in an invalid format.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: