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

PollForThirdPartyJobs

Determines whether there are any third party jobs for a job worker to act on. 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.

Request Syntax

{
   "actionTypeId": { 
      "category": "string",
      "owner": "string",
      "provider": "string",
      "version": "string"
   },
   "maxBatchSize": number
}

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.

actionTypeId

Represents information about an action type.

Type: ActionTypeId object

Required: Yes

maxBatchSize

The maximum number of jobs to return in a poll for jobs call.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

Response Syntax

{
   "jobs": [ 
      { 
         "clientId": "string",
         "jobId": "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.

jobs

Information about the jobs to take action on.

Type: Array of ThirdPartyJob objects

Errors

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

ActionTypeNotFoundException

The specified action type 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: