AWS CodePipeline

Poll for jobs

このページは日本語には対応しておりません。随時翻訳に取り組んでいます。翻訳に関してご質問やご意見ございましたら、お気軽にご連絡ください。

Returns information about any jobs for CodePipeline to act on. PollForJobs is valid only for action types with "Custom" in the owner field. If the action type contains AWS or ThirdParty in the owner field, the PollForJobs action returns an error. When this API is called, 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.

Inputs

Expand All

フィールド

種類

説明

region [required]

enum

default: us-east-1

actionTypeId [required]

object

Represents information about an action type.

category [required]

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 following values. Source Build Test Deploy Invoke Approval

owner [required]

string

The creator of the action being called. There are three valid values for the Owner field in the action category section within your pipeline structure: AWS, ThirdParty, and Custom. For more information, see Valid Action Types and Providers in CodePipeline.

provider [required]

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 CodeDeploy, which would be specified as CodeDeploy. For more information, see Valid Action Types and Providers in CodePipeline.

version [required]

string

A string that describes the action version.

maxBatchSize

number

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

queryParam

object

A map of property names and values. For an action type with no queryable properties, this value must be null or an empty map. For an action type with a queryable property, you must supply that property as a key in the map. Only jobs whose action configuration matches the mapped value are returned.

Outputs

Expand All

フィールド

種類

説明

amzRequestId [required]

string

jobs

[object]

Information about the jobs to take action on.

id

string

The unique system-generated ID of the job.

data

object

Other data about a job.

actionTypeId

object

Represents information about an action type.

category [required]

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 following values. Source Build Test Deploy Invoke Approval

owner [required]

string

The creator of the action being called. There are three valid values for the Owner field in the action category section within your pipeline structure: AWS, ThirdParty, and Custom. For more information, see Valid Action Types and Providers in CodePipeline.

provider [required]

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 CodeDeploy, which would be specified as CodeDeploy. For more information, see Valid Action Types and Providers in CodePipeline.

version [required]

string

A string that describes the action version.

actionConfiguration

object

Represents information about an action configuration.

configuration

object

The configuration data for the action.

pipelineContext

object

Represents information about a pipeline to a job worker. Includes pipelineArn and pipelineExecutionId for custom jobs.

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

object

The stage of the pipeline.

name

string

The name of the stage.

action

object

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

name

string

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

actionExecutionId

string

The system-generated unique ID that corresponds to an action's execution.

pipelineArn

string

The Amazon Resource Name (ARN) of the pipeline.

pipelineExecutionId

string

The execution ID of the pipeline.

inputArtifacts

[object]

The artifact supplied to the job.

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

object

The location of an artifact.

type

string

The type of artifact in the location.

s3Location

object

The S3 bucket that contains the artifact.

bucketName [required]

string

The name of the S3 bucket.

objectKey [required]

string

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

outputArtifacts

[object]

The output of the job.

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

object

The location of an artifact.

type

string

The type of artifact in the location.

s3Location

object

The S3 bucket that contains the artifact.

bucketName [required]

string

The name of the S3 bucket.

objectKey [required]

string

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

artifactCredentials

object

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

accessKeyId [required]

string

The access key for the session.

secretAccessKey [required]

string

The secret access key for the session.

sessionToken [required]

string

The token for the session.

continuationToken

string

A system-generated token, such as a deployment ID, required by a job to continue the job asynchronously.

encryptionKey

object

Represents information about the key used to encrypt data in the artifact store, such as an KMS key.

id [required]

string

The ID used to identify the key. For an Amazon Web Services KMS key, you can use the key ID, the key ARN, or the alias ARN. Aliases are recognized only in the account that created the KMS key. For cross-account actions, you can only use the key ID or key ARN to identify the key. Cross-account actions involve using the role from the other account (AccountB), so specifying the key ID will use the key from the other account (AccountB).

type [required]

string

The type of encryption key, such as an Amazon Web Services KMS key. When creating or updating a pipeline, the value must be set to 'KMS'.

nonce

string

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

accountId

string

The ID of the Amazon Web Services account to use when performing the job.