Poll For Jobs
codepipeline_poll_for_jobs | R Documentation |
Returns information about any jobs for CodePipeline to act on¶
Description¶
Returns information about any jobs for CodePipeline to act on.
poll_for_jobs
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 poll_for_jobs
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.
Usage¶
Arguments¶
actionTypeId
[required] Represents information about an action type.
maxBatchSize
The maximum number of jobs to return in a poll for jobs call.
queryParam
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.
Value¶
A list with the following syntax:
list(
jobs = list(
list(
id = "string",
data = list(
actionTypeId = list(
category = "Source"|"Build"|"Deploy"|"Test"|"Invoke"|"Approval",
owner = "AWS"|"ThirdParty"|"Custom",
provider = "string",
version = "string"
),
actionConfiguration = list(
configuration = list(
"string"
)
),
pipelineContext = list(
pipelineName = "string",
stage = list(
name = "string"
),
action = list(
name = "string",
actionExecutionId = "string"
),
pipelineArn = "string",
pipelineExecutionId = "string"
),
inputArtifacts = list(
list(
name = "string",
revision = "string",
location = list(
type = "S3",
s3Location = list(
bucketName = "string",
objectKey = "string"
)
)
)
),
outputArtifacts = list(
list(
name = "string",
revision = "string",
location = list(
type = "S3",
s3Location = list(
bucketName = "string",
objectKey = "string"
)
)
)
),
artifactCredentials = list(
accessKeyId = "string",
secretAccessKey = "string",
sessionToken = "string"
),
continuationToken = "string",
encryptionKey = list(
id = "string",
type = "KMS"
)
),
nonce = "string",
accountId = "string"
)
)
)