CodePipeline / Client / poll_for_jobs

poll_for_jobs#

CodePipeline.Client.poll_for_jobs(**kwargs)#

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.

Warning

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.

See also: AWS API Documentation

Request Syntax

response = client.poll_for_jobs(
    actionTypeId={
        'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval'|'Compute',
        'owner': 'AWS'|'ThirdParty'|'Custom',
        'provider': 'string',
        'version': 'string'
    },
    maxBatchSize=123,
    queryParam={
        'string': 'string'
    }
)
Parameters:

  • actionTypeId (dict) –

    [REQUIRED]

    Represents information about an action type.

    • category (string) – [REQUIRED]

      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

      • Compute

    • owner (string) – [REQUIRED]

      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 (string) – [REQUIRED]

      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 (string) – [REQUIRED]

      A string that describes the action version.

  • maxBatchSize (integer) – The maximum number of jobs to return in a poll for jobs call.

  • queryParam (dict) –

    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.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'jobs': [
        {
            'id': 'string',
            'data': {
                'actionTypeId': {
                    'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval'|'Compute',
                    'owner': 'AWS'|'ThirdParty'|'Custom',
                    'provider': 'string',
                    'version': 'string'
                },
                'actionConfiguration': {
                    'configuration': {
                        'string': 'string'
                    }
                },
                'pipelineContext': {
                    'pipelineName': 'string',
                    'stage': {
                        'name': 'string'
                    },
                    'action': {
                        'name': 'string',
                        'actionExecutionId': 'string'
                    },
                    'pipelineArn': 'string',
                    'pipelineExecutionId': 'string'
                },
                'inputArtifacts': [
                    {
                        'name': 'string',
                        'revision': 'string',
                        'location': {
                            'type': 'S3',
                            's3Location': {
                                'bucketName': 'string',
                                'objectKey': 'string'
                            }
                        }
                    },
                ],
                'outputArtifacts': [
                    {
                        'name': 'string',
                        'revision': 'string',
                        'location': {
                            'type': 'S3',
                            's3Location': {
                                'bucketName': 'string',
                                'objectKey': 'string'
                            }
                        }
                    },
                ],
                'artifactCredentials': {
                    'accessKeyId': 'string',
                    'secretAccessKey': 'string',
                    'sessionToken': 'string'
                },
                'continuationToken': 'string',
                'encryptionKey': {
                    'id': 'string',
                    'type': 'KMS'
                }
            },
            'nonce': 'string',
            'accountId': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    Represents the output of a PollForJobs action.

    • jobs (list) –

      Information about the jobs to take action on.

      • (dict) –

        Represents information about a job.

        • id (string) –

          The unique system-generated ID of the job.

        • data (dict) –

          Other data about a job.

          • actionTypeId (dict) –

            Represents information about an action type.

            • category (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

              • Compute

            • owner (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 (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 (string) –

              A string that describes the action version.

          • actionConfiguration (dict) –

            Represents information about an action configuration.

            • configuration (dict) –

              The configuration data for the action.

              • (string) –

                • (string) –

          • pipelineContext (dict) –

            Represents information about a pipeline to a job worker.

            Note

            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 (dict) –

              The stage of the pipeline.

              • name (string) –

                The name of the stage.

            • action (dict) –

              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 (list) –

            The artifact supplied to the job.

            • (dict) –

              Artifacts are the files that are worked on by actions in the pipeline. See the action configuration for each action for details about artifact parameters. For example, the S3 source action artifact is a file name (or file path), and the files are generally provided as a ZIP file. Example artifact name: SampleApp_Windows.zip

              • 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 (dict) –

                The location of an artifact.

                • type (string) –

                  The type of artifact in the location.

                • s3Location (dict) –

                  The S3 bucket that contains the artifact.

                  • bucketName (string) –

                    The name of the S3 bucket.

                  • objectKey (string) –

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

          • outputArtifacts (list) –

            The output of the job.

            • (dict) –

              Artifacts are the files that are worked on by actions in the pipeline. See the action configuration for each action for details about artifact parameters. For example, the S3 source action artifact is a file name (or file path), and the files are generally provided as a ZIP file. Example artifact name: SampleApp_Windows.zip

              • 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 (dict) –

                The location of an artifact.

                • type (string) –

                  The type of artifact in the location.

                • s3Location (dict) –

                  The S3 bucket that contains the artifact.

                  • bucketName (string) –

                    The name of the S3 bucket.

                  • objectKey (string) –

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

          • artifactCredentials (dict) –

            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 (string) –

              The access key for the session.

            • secretAccessKey (string) –

              The secret access key for the session.

            • sessionToken (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 (dict) –

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

            • id (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.

              Note

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

Exceptions