Table Of Contents

Feedback

User Guide

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

[ aws . codepipeline ]

poll-for-third-party-jobs

Description

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

See also: AWS API Documentation

Synopsis

  poll-for-third-party-jobs
--action-type-id <value>
[--max-batch-size <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--action-type-id (structure)

Represents information about an action type.

Shorthand Syntax:

category=string,owner=string,provider=string,version=string

JSON Syntax:

{
  "category": "Source"|"Build"|"Deploy"|"Test"|"Invoke"|"Approval",
  "owner": "AWS"|"ThirdParty"|"Custom",
  "provider": "string",
  "version": "string"
}

--max-batch-size (integer)

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

--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.

Output

jobs -> (list)

Information about the jobs to take action on.

(structure)

A response to a poll-for-third-party-jobs request returned by AWS CodePipeline when there is a job to be worked upon by a partner action.

clientId -> (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.

jobId -> (string)

The identifier used to identify the job in AWS CodePipeline.