CodePipeline

Table of Contents

Client

class CodePipeline.Client

A low-level client representing AWS CodePipeline:

client = session.create_client('codepipeline')

These are the available methods:

acknowledge_job(**kwargs)

Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions.

See also: AWS API Documentation

Request Syntax

response = client.acknowledge_job(
    jobId='string',
    nonce='string'
)
Parameters
  • jobId (string) --

    [REQUIRED]

    The unique system-generated ID of the job for which you want to confirm receipt.

  • nonce (string) --

    [REQUIRED]

    A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response of the PollForJobs request that returned this job.

Return type

dict

Returns

Response Syntax

{
    'status': 'Created'|'Queued'|'Dispatched'|'InProgress'|'TimedOut'|'Succeeded'|'Failed'
}

Response Structure

  • (dict) --

    Represents the output of an AcknowledgeJob action.

    • status (string) --

      Whether the job worker has received the specified job.

acknowledge_third_party_job(**kwargs)

Confirms a job worker has received the specified job. Only used for partner actions.

See also: AWS API Documentation

Request Syntax

response = client.acknowledge_third_party_job(
    jobId='string',
    nonce='string',
    clientToken='string'
)
Parameters
  • jobId (string) --

    [REQUIRED]

    The unique system-generated ID of the job.

  • nonce (string) --

    [REQUIRED]

    A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response to a GetThirdPartyJobDetails request.

  • clientToken (string) --

    [REQUIRED]

    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.

Return type

dict

Returns

Response Syntax

{
    'status': 'Created'|'Queued'|'Dispatched'|'InProgress'|'TimedOut'|'Succeeded'|'Failed'
}

Response Structure

  • (dict) --

    Represents the output of an AcknowledgeThirdPartyJob action.

    • status (string) --

      The status information for the third party job, if any.

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_custom_action_type(**kwargs)

Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions.

See also: AWS API Documentation

Request Syntax

response = client.create_custom_action_type(
    category='Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval',
    provider='string',
    version='string',
    settings={
        'thirdPartyConfigurationUrl': 'string',
        'entityUrlTemplate': 'string',
        'executionUrlTemplate': 'string',
        'revisionUrlTemplate': 'string'
    },
    configurationProperties=[
        {
            'name': 'string',
            'required': True|False,
            'key': True|False,
            'secret': True|False,
            'queryable': True|False,
            'description': 'string',
            'type': 'String'|'Number'|'Boolean'
        },
    ],
    inputArtifactDetails={
        'minimumCount': 123,
        'maximumCount': 123
    },
    outputArtifactDetails={
        'minimumCount': 123,
        'maximumCount': 123
    }
)
Parameters
  • category (string) --

    [REQUIRED]

    The category of the custom action, such as a build action or a test action.

    Note

    Although Source and Approval are listed as valid values, they are not currently functional. These values are reserved for future use.

  • provider (string) --

    [REQUIRED]

    The provider of the service used in the custom action, such as AWS CodeDeploy.

  • version (string) --

    [REQUIRED]

    The version identifier of the custom action.

  • settings (dict) --

    Returns information about the settings for an action type.

    • thirdPartyConfigurationUrl (string) --

      The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.

    • entityUrlTemplate (string) --

      The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display within the pipeline.

    • executionUrlTemplate (string) --

      The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action.

    • revisionUrlTemplate (string) --

      The URL returned to the AWS CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.

  • configurationProperties (list) --

    The configuration properties for the custom action.

    Note

    You can refer to a name in the configuration properties of the custom action within the URL templates by following the format of {Config:name}, as long as the configuration property is both required and not secret. For more information, see Create a Custom Action for a Pipeline .

    • (dict) --

      Represents information about an action configuration property.

      • name (string) -- [REQUIRED]

        The name of the action configuration property.

      • required (boolean) -- [REQUIRED]

        Whether the configuration property is a required value.

      • key (boolean) -- [REQUIRED]

        Whether the configuration property is a key.

      • secret (boolean) -- [REQUIRED]

        Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.

        When updating a pipeline, passing * * * * * without changing any other values of the action will preserve the prior value of the secret.

      • queryable (boolean) --

        Indicates that the property will be used in conjunction with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.

        If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to additional restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.

      • description (string) --

        The description of the action configuration property that will be displayed to users.

      • type (string) --

        The type of the configuration property.

  • inputArtifactDetails (dict) --

    [REQUIRED]

    The details of the input artifact for the action, such as its commit ID.

    • minimumCount (integer) -- [REQUIRED]

      The minimum number of artifacts allowed for the action type.

    • maximumCount (integer) -- [REQUIRED]

      The maximum number of artifacts allowed for the action type.

  • outputArtifactDetails (dict) --

    [REQUIRED]

    The details of the output artifact of the action, such as its commit ID.

    • minimumCount (integer) -- [REQUIRED]

      The minimum number of artifacts allowed for the action type.

    • maximumCount (integer) -- [REQUIRED]

      The maximum number of artifacts allowed for the action type.

Return type

dict

Returns

Response Syntax

{
    'actionType': {
        'id': {
            'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval',
            'owner': 'AWS'|'ThirdParty'|'Custom',
            'provider': 'string',
            'version': 'string'
        },
        'settings': {
            'thirdPartyConfigurationUrl': 'string',
            'entityUrlTemplate': 'string',
            'executionUrlTemplate': 'string',
            'revisionUrlTemplate': 'string'
        },
        'actionConfigurationProperties': [
            {
                'name': 'string',
                'required': True|False,
                'key': True|False,
                'secret': True|False,
                'queryable': True|False,
                'description': 'string',
                'type': 'String'|'Number'|'Boolean'
            },
        ],
        'inputArtifactDetails': {
            'minimumCount': 123,
            'maximumCount': 123
        },
        'outputArtifactDetails': {
            'minimumCount': 123,
            'maximumCount': 123
        }
    }
}

Response Structure

  • (dict) --

    Represents the output of a CreateCustomActionType operation.

    • actionType (dict) --

      Returns information about the details of an action type.

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

        • owner (string) --

          The creator of the action being called.

        • 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 AWS CodeDeploy, which would be specified as CodeDeploy.

        • version (string) --

          A string that identifies the action type.

      • settings (dict) --

        The settings for the action type.

        • thirdPartyConfigurationUrl (string) --

          The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.

        • entityUrlTemplate (string) --

          The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display within the pipeline.

        • executionUrlTemplate (string) --

          The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action.

        • revisionUrlTemplate (string) --

          The URL returned to the AWS CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.

      • actionConfigurationProperties (list) --

        The configuration properties for the action type.

        • (dict) --

          Represents information about an action configuration property.

          • name (string) --

            The name of the action configuration property.

          • required (boolean) --

            Whether the configuration property is a required value.

          • key (boolean) --

            Whether the configuration property is a key.

          • secret (boolean) --

            Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.

            When updating a pipeline, passing * * * * * without changing any other values of the action will preserve the prior value of the secret.

          • queryable (boolean) --

            Indicates that the property will be used in conjunction with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.

            If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to additional restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.

          • description (string) --

            The description of the action configuration property that will be displayed to users.

          • type (string) --

            The type of the configuration property.

      • inputArtifactDetails (dict) --

        The details of the input artifact for the action, such as its commit ID.

        • minimumCount (integer) --

          The minimum number of artifacts allowed for the action type.

        • maximumCount (integer) --

          The maximum number of artifacts allowed for the action type.

      • outputArtifactDetails (dict) --

        The details of the output artifact of the action, such as its commit ID.

        • minimumCount (integer) --

          The minimum number of artifacts allowed for the action type.

        • maximumCount (integer) --

          The maximum number of artifacts allowed for the action type.

create_pipeline(**kwargs)

Creates a pipeline.

See also: AWS API Documentation

Request Syntax

response = client.create_pipeline(
    pipeline={
        'name': 'string',
        'roleArn': 'string',
        'artifactStore': {
            'type': 'S3',
            'location': 'string',
            'encryptionKey': {
                'id': 'string',
                'type': 'KMS'
            }
        },
        'stages': [
            {
                'name': 'string',
                'blockers': [
                    {
                        'name': 'string',
                        'type': 'Schedule'
                    },
                ],
                'actions': [
                    {
                        'name': 'string',
                        'actionTypeId': {
                            'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval',
                            'owner': 'AWS'|'ThirdParty'|'Custom',
                            'provider': 'string',
                            'version': 'string'
                        },
                        'runOrder': 123,
                        'configuration': {
                            'string': 'string'
                        },
                        'outputArtifacts': [
                            {
                                'name': 'string'
                            },
                        ],
                        'inputArtifacts': [
                            {
                                'name': 'string'
                            },
                        ],
                        'roleArn': 'string'
                    },
                ]
            },
        ],
        'version': 123
    }
)
Parameters
pipeline (dict) --

[REQUIRED]

Represents the structure of actions and stages to be performed in the pipeline.

  • name (string) -- [REQUIRED]

    The name of the action to be performed.

  • roleArn (string) -- [REQUIRED]

    The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.

  • artifactStore (dict) -- [REQUIRED]

    Represents information about the Amazon S3 bucket where artifacts are stored for the pipeline.

    • type (string) -- [REQUIRED]

      The type of the artifact store, such as S3.

    • location (string) -- [REQUIRED]

      The Amazon S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a folder within the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any Amazon S3 bucket in the same AWS Region as the pipeline to store your pipeline artifacts.

    • encryptionKey (dict) --

      The encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service (AWS KMS) key. If this is undefined, the default key for Amazon S3 is used.

      • id (string) -- [REQUIRED]

        The ID used to identify the key. For an AWS KMS key, this is the key ID or key ARN.

      • type (string) -- [REQUIRED]

        The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. When creating or updating a pipeline, the value must be set to 'KMS'.

  • stages (list) -- [REQUIRED]

    The stage in which to perform the action.

    • (dict) --

      Represents information about a stage and its definition.

      • name (string) -- [REQUIRED]

        The name of the stage.

      • blockers (list) --

        Reserved for future use.

        • (dict) --

          Reserved for future use.

          • name (string) -- [REQUIRED]

            Reserved for future use.

          • type (string) -- [REQUIRED]

            Reserved for future use.

      • actions (list) -- [REQUIRED]

        The actions included in a stage.

        • (dict) --

          Represents information about an action declaration.

          • name (string) -- [REQUIRED]

            The action declaration's name.

          • actionTypeId (dict) -- [REQUIRED]

            The configuration information for the 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 values below.

            • owner (string) -- [REQUIRED]

              The creator of the action being called.

            • 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 AWS CodeDeploy, which would be specified as CodeDeploy.

            • version (string) -- [REQUIRED]

              A string that identifies the action type.

          • runOrder (integer) --

            The order in which actions are run.

          • configuration (dict) --

            The action declaration's configuration.

            • (string) --
              • (string) --
          • outputArtifacts (list) --

            The name or ID of the result of the action declaration, such as a test or build artifact.

            • (dict) --

              Represents information about the output of an action.

              • name (string) -- [REQUIRED]

                The name of the output of an artifact, such as "My App".

                The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.

                Output artifact names must be unique within a pipeline.

          • inputArtifacts (list) --

            The name or ID of the artifact consumed by the action, such as a test or build artifact.

            • (dict) --

              Represents information about an artifact to be worked on, such as a test or build artifact.

              • name (string) -- [REQUIRED]

                The name of the artifact to be worked on, for example, "My App".

                The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.

          • roleArn (string) --

            The ARN of the IAM service role that will perform the declared action. This is assumed through the roleArn for the pipeline.

  • version (integer) --

    The version number of the pipeline. A new pipeline always has a version number of 1. This number is automatically incremented when a pipeline is updated.

Return type
dict
Returns
Response Syntax
{
    'pipeline': {
        'name': 'string',
        'roleArn': 'string',
        'artifactStore': {
            'type': 'S3',
            'location': 'string',
            'encryptionKey': {
                'id': 'string',
                'type': 'KMS'
            }
        },
        'stages': [
            {
                'name': 'string',
                'blockers': [
                    {
                        'name': 'string',
                        'type': 'Schedule'
                    },
                ],
                'actions': [
                    {
                        'name': 'string',
                        'actionTypeId': {
                            'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval',
                            'owner': 'AWS'|'ThirdParty'|'Custom',
                            'provider': 'string',
                            'version': 'string'
                        },
                        'runOrder': 123,
                        'configuration': {
                            'string': 'string'
                        },
                        'outputArtifacts': [
                            {
                                'name': 'string'
                            },
                        ],
                        'inputArtifacts': [
                            {
                                'name': 'string'
                            },
                        ],
                        'roleArn': 'string'
                    },
                ]
            },
        ],
        'version': 123
    }
}

Response Structure

  • (dict) --

    Represents the output of a CreatePipeline action.

    • pipeline (dict) --

      Represents the structure of actions and stages to be performed in the pipeline.

      • name (string) --

        The name of the action to be performed.

      • roleArn (string) --

        The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.

      • artifactStore (dict) --

        Represents information about the Amazon S3 bucket where artifacts are stored for the pipeline.

        • type (string) --

          The type of the artifact store, such as S3.

        • location (string) --

          The Amazon S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a folder within the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any Amazon S3 bucket in the same AWS Region as the pipeline to store your pipeline artifacts.

        • encryptionKey (dict) --

          The encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service (AWS KMS) key. If this is undefined, the default key for Amazon S3 is used.

          • id (string) --

            The ID used to identify the key. For an AWS KMS key, this is the key ID or key ARN.

          • type (string) --

            The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. When creating or updating a pipeline, the value must be set to 'KMS'.

      • stages (list) --

        The stage in which to perform the action.

        • (dict) --

          Represents information about a stage and its definition.

          • name (string) --

            The name of the stage.

          • blockers (list) --

            Reserved for future use.

            • (dict) --

              Reserved for future use.

              • name (string) --

                Reserved for future use.

              • type (string) --

                Reserved for future use.

          • actions (list) --

            The actions included in a stage.

            • (dict) --

              Represents information about an action declaration.

              • name (string) --

                The action declaration's name.

              • actionTypeId (dict) --

                The configuration information for the 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 values below.

                • owner (string) --

                  The creator of the action being called.

                • 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 AWS CodeDeploy, which would be specified as CodeDeploy.

                • version (string) --

                  A string that identifies the action type.

              • runOrder (integer) --

                The order in which actions are run.

              • configuration (dict) --

                The action declaration's configuration.

                • (string) --
                  • (string) --
              • outputArtifacts (list) --

                The name or ID of the result of the action declaration, such as a test or build artifact.

                • (dict) --

                  Represents information about the output of an action.

                  • name (string) --

                    The name of the output of an artifact, such as "My App".

                    The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.

                    Output artifact names must be unique within a pipeline.

              • inputArtifacts (list) --

                The name or ID of the artifact consumed by the action, such as a test or build artifact.

                • (dict) --

                  Represents information about an artifact to be worked on, such as a test or build artifact.

                  • name (string) --

                    The name of the artifact to be worked on, for example, "My App".

                    The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.

              • roleArn (string) --

                The ARN of the IAM service role that will perform the declared action. This is assumed through the roleArn for the pipeline.

      • version (integer) --

        The version number of the pipeline. A new pipeline always has a version number of 1. This number is automatically incremented when a pipeline is updated.

delete_custom_action_type(**kwargs)

Marks a custom action as deleted. PollForJobs for the custom action will fail after the action is marked for deletion. Only used for custom actions.

Warning

You cannot recreate a custom action after it has been deleted unless you increase the version number of the action.

See also: AWS API Documentation

Request Syntax

response = client.delete_custom_action_type(
    category='Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval',
    provider='string',
    version='string'
)
Parameters
  • category (string) --

    [REQUIRED]

    The category of the custom action that you want to delete, such as source or deploy.

  • provider (string) --

    [REQUIRED]

    The provider of the service used in the custom action, such as AWS CodeDeploy.

  • version (string) --

    [REQUIRED]

    The version of the custom action to delete.

Returns

None

delete_pipeline(**kwargs)

Deletes the specified pipeline.

See also: AWS API Documentation

Request Syntax

response = client.delete_pipeline(
    name='string'
)
Parameters
name (string) --

[REQUIRED]

The name of the pipeline to be deleted.

Returns
None
disable_stage_transition(**kwargs)

Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.

See also: AWS API Documentation

Request Syntax

response = client.disable_stage_transition(
    pipelineName='string',
    stageName='string',
    transitionType='Inbound'|'Outbound',
    reason='string'
)
Parameters
  • pipelineName (string) --

    [REQUIRED]

    The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.

  • stageName (string) --

    [REQUIRED]

    The name of the stage where you want to disable the inbound or outbound transition of artifacts.

  • transitionType (string) --

    [REQUIRED]

    Specifies whether artifacts will be prevented from transitioning into the stage and being processed by the actions in that stage (inbound), or prevented from transitioning from the stage after they have been processed by the actions in that stage (outbound).

  • reason (string) --

    [REQUIRED]

    The reason given to the user why a stage is disabled, such as waiting for manual approval or manual tests. This message is displayed in the pipeline console UI.

Returns

None

enable_stage_transition(**kwargs)

Enables artifacts in a pipeline to transition to a stage in a pipeline.

See also: AWS API Documentation

Request Syntax

response = client.enable_stage_transition(
    pipelineName='string',
    stageName='string',
    transitionType='Inbound'|'Outbound'
)
Parameters
  • pipelineName (string) --

    [REQUIRED]

    The name of the pipeline in which you want to enable the flow of artifacts from one stage to another.

  • stageName (string) --

    [REQUIRED]

    The name of the stage where you want to enable the transition of artifacts, either into the stage (inbound) or from that stage to the next stage (outbound).

  • transitionType (string) --

    [REQUIRED]

    Specifies whether artifacts will be allowed to enter the stage and be processed by the actions in that stage (inbound) or whether already-processed artifacts will be allowed to transition to the next stage (outbound).

Returns

None

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_job_details(**kwargs)

Returns information about a job. Only used for custom 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. Additionally, this API returns any secret values defined for the action.

See also: AWS API Documentation

Request Syntax

response = client.get_job_details(
    jobId='string'
)
Parameters
jobId (string) --

[REQUIRED]

The unique system-generated ID for the job.

Return type
dict
Returns
Response Syntax
{
    'jobDetails': {
        'id': 'string',
        'data': {
            'actionTypeId': {
                'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval',
                'owner': 'AWS'|'ThirdParty'|'Custom',
                'provider': 'string',
                'version': 'string'
            },
            'actionConfiguration': {
                'configuration': {
                    'string': 'string'
                }
            },
            'pipelineContext': {
                'pipelineName': 'string',
                'stage': {
                    'name': 'string'
                },
                'action': {
                    'name': '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'
            }
        },
        'accountId': 'string'
    }
}

Response Structure

  • (dict) --

    Represents the output of a GetJobDetails action.

    • jobDetails (dict) --

      The details of the job.

      Note

      If AWSSessionCredentials is used, a long-running job can call GetJobDetails again to obtain new credentials.

      • id (string) --

        The unique system-generated ID of the job.

      • data (dict) --

        Represents additional information about a job required for a job worker to complete the 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 values below.

          • owner (string) --

            The creator of the action being called.

          • 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 AWS CodeDeploy, which would be specified as CodeDeploy.

          • version (string) --

            A string that identifies the action type.

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

          • 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 within the stage of a pipeline.

            • name (string) --

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

        • inputArtifacts (list) --

          The artifact supplied to the job.

          • (dict) --

            Represents information about an artifact that will be worked upon by actions in the pipeline.

            • 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 Amazon S3 bucket that contains the artifact.

                • bucketName (string) --

                  The name of the Amazon S3 bucket.

                • objectKey (string) --

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

        • outputArtifacts (list) --

          The output of the job.

          • (dict) --

            Represents information about an artifact that will be worked upon by actions in the pipeline.

            • 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 Amazon S3 bucket that contains the artifact.

                • bucketName (string) --

                  The name of the Amazon S3 bucket.

                • objectKey (string) --

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

        • artifactCredentials (dict) --

          Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS Secure Token Service (STS). They can be used to access input and output artifacts in the Amazon S3 bucket used to store artifact for the pipeline in AWS 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 AWS CodeDeploy deployment ID, that a job requires in order to continue the job asynchronously.

        • encryptionKey (dict) --

          Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS) key.

          • id (string) --

            The ID used to identify the key. For an AWS KMS key, this is the key ID or key ARN.

          • type (string) --

            The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. When creating or updating a pipeline, the value must be set to 'KMS'.

      • accountId (string) --

        The AWS account ID associated with the job.

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_pipeline(**kwargs)

Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with UpdatePipeline .

See also: AWS API Documentation

Request Syntax

response = client.get_pipeline(
    name='string',
    version=123
)
Parameters
  • name (string) --

    [REQUIRED]

    The name of the pipeline for which you want to get information. Pipeline names must be unique under an Amazon Web Services (AWS) user account.

  • version (integer) -- The version number of the pipeline. If you do not specify a version, defaults to the most current version.
Return type

dict

Returns

Response Syntax

{
    'pipeline': {
        'name': 'string',
        'roleArn': 'string',
        'artifactStore': {
            'type': 'S3',
            'location': 'string',
            'encryptionKey': {
                'id': 'string',
                'type': 'KMS'
            }
        },
        'stages': [
            {
                'name': 'string',
                'blockers': [
                    {
                        'name': 'string',
                        'type': 'Schedule'
                    },
                ],
                'actions': [
                    {
                        'name': 'string',
                        'actionTypeId': {
                            'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval',
                            'owner': 'AWS'|'ThirdParty'|'Custom',
                            'provider': 'string',
                            'version': 'string'
                        },
                        'runOrder': 123,
                        'configuration': {
                            'string': 'string'
                        },
                        'outputArtifacts': [
                            {
                                'name': 'string'
                            },
                        ],
                        'inputArtifacts': [
                            {
                                'name': 'string'
                            },
                        ],
                        'roleArn': 'string'
                    },
                ]
            },
        ],
        'version': 123
    },
    'metadata': {
        'pipelineArn': 'string',
        'created': datetime(2015, 1, 1),
        'updated': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    Represents the output of a GetPipeline action.

    • pipeline (dict) --

      Represents the structure of actions and stages to be performed in the pipeline.

      • name (string) --

        The name of the action to be performed.

      • roleArn (string) --

        The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.

      • artifactStore (dict) --

        Represents information about the Amazon S3 bucket where artifacts are stored for the pipeline.

        • type (string) --

          The type of the artifact store, such as S3.

        • location (string) --

          The Amazon S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a folder within the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any Amazon S3 bucket in the same AWS Region as the pipeline to store your pipeline artifacts.

        • encryptionKey (dict) --

          The encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service (AWS KMS) key. If this is undefined, the default key for Amazon S3 is used.

          • id (string) --

            The ID used to identify the key. For an AWS KMS key, this is the key ID or key ARN.

          • type (string) --

            The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. When creating or updating a pipeline, the value must be set to 'KMS'.

      • stages (list) --

        The stage in which to perform the action.

        • (dict) --

          Represents information about a stage and its definition.

          • name (string) --

            The name of the stage.

          • blockers (list) --

            Reserved for future use.

            • (dict) --

              Reserved for future use.

              • name (string) --

                Reserved for future use.

              • type (string) --

                Reserved for future use.

          • actions (list) --

            The actions included in a stage.

            • (dict) --

              Represents information about an action declaration.

              • name (string) --

                The action declaration's name.

              • actionTypeId (dict) --

                The configuration information for the 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 values below.

                • owner (string) --

                  The creator of the action being called.

                • 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 AWS CodeDeploy, which would be specified as CodeDeploy.

                • version (string) --

                  A string that identifies the action type.

              • runOrder (integer) --

                The order in which actions are run.

              • configuration (dict) --

                The action declaration's configuration.

                • (string) --
                  • (string) --
              • outputArtifacts (list) --

                The name or ID of the result of the action declaration, such as a test or build artifact.

                • (dict) --

                  Represents information about the output of an action.

                  • name (string) --

                    The name of the output of an artifact, such as "My App".

                    The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.

                    Output artifact names must be unique within a pipeline.

              • inputArtifacts (list) --

                The name or ID of the artifact consumed by the action, such as a test or build artifact.

                • (dict) --

                  Represents information about an artifact to be worked on, such as a test or build artifact.

                  • name (string) --

                    The name of the artifact to be worked on, for example, "My App".

                    The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.

              • roleArn (string) --

                The ARN of the IAM service role that will perform the declared action. This is assumed through the roleArn for the pipeline.

      • version (integer) --

        The version number of the pipeline. A new pipeline always has a version number of 1. This number is automatically incremented when a pipeline is updated.

    • metadata (dict) --

      Represents the pipeline metadata information returned as part of the output of a GetPipeline action.

      • pipelineArn (string) --

        The Amazon Resource Name (ARN) of the pipeline.

      • created (datetime) --

        The date and time the pipeline was created, in timestamp format.

      • updated (datetime) --

        The date and time the pipeline was last updated, in timestamp format.

get_pipeline_execution(**kwargs)

Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline.

See also: AWS API Documentation

Request Syntax

response = client.get_pipeline_execution(
    pipelineName='string',
    pipelineExecutionId='string'
)
Parameters
  • pipelineName (string) --

    [REQUIRED]

    The name of the pipeline about which you want to get execution details.

  • pipelineExecutionId (string) --

    [REQUIRED]

    The ID of the pipeline execution about which you want to get execution details.

Return type

dict

Returns

Response Syntax

{
    'pipelineExecution': {
        'pipelineName': 'string',
        'pipelineVersion': 123,
        'pipelineExecutionId': 'string',
        'status': 'InProgress'|'Succeeded'|'Superseded'|'Failed',
        'artifactRevisions': [
            {
                'name': 'string',
                'revisionId': 'string',
                'revisionChangeIdentifier': 'string',
                'revisionSummary': 'string',
                'created': datetime(2015, 1, 1),
                'revisionUrl': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    Represents the output of a GetPipelineExecution action.

    • pipelineExecution (dict) --

      Represents information about the execution of a pipeline.

      • pipelineName (string) --

        The name of the pipeline that was executed.

      • pipelineVersion (integer) --

        The version number of the pipeline that was executed.

      • pipelineExecutionId (string) --

        The ID of the pipeline execution.

      • status (string) --

        The status of the pipeline execution.

        • InProgress: The pipeline execution is currently running.
        • Succeeded: The pipeline execution was completed successfully.
        • Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead.
        • Failed: The pipeline execution was not completed successfully.
      • artifactRevisions (list) --

        A list of ArtifactRevision objects included in a pipeline execution.

        • (dict) --

          Represents revision details of an artifact.

          • name (string) --

            The name of an artifact. This name might be system-generated, such as "MyApp", or might be defined by the user when an action is created.

          • revisionId (string) --

            The revision ID of the artifact.

          • revisionChangeIdentifier (string) --

            An additional identifier for a revision, such as a commit date or, for artifacts stored in Amazon S3 buckets, the ETag value.

          • revisionSummary (string) --

            Summary information about the most recent revision of the artifact. For GitHub and AWS CodeCommit repositories, the commit message. For Amazon S3 buckets or actions, the user-provided content of a codepipeline-artifact-revision-summary key specified in the object metadata.

          • created (datetime) --

            The date and time when the most recent revision of the artifact was created, in timestamp format.

          • revisionUrl (string) --

            The commit ID for the artifact revision. For artifacts stored in GitHub or AWS CodeCommit repositories, the commit ID is linked to a commit details page.

get_pipeline_state(**kwargs)

Returns information about the state of a pipeline, including the stages and actions.

See also: AWS API Documentation

Request Syntax

response = client.get_pipeline_state(
    name='string'
)
Parameters
name (string) --

[REQUIRED]

The name of the pipeline about which you want to get information.

Return type
dict
Returns
Response Syntax
{
    'pipelineName': 'string',
    'pipelineVersion': 123,
    'stageStates': [
        {
            'stageName': 'string',
            'inboundTransitionState': {
                'enabled': True|False,
                'lastChangedBy': 'string',
                'lastChangedAt': datetime(2015, 1, 1),
                'disabledReason': 'string'
            },
            'actionStates': [
                {
                    'actionName': 'string',
                    'currentRevision': {
                        'revisionId': 'string',
                        'revisionChangeId': 'string',
                        'created': datetime(2015, 1, 1)
                    },
                    'latestExecution': {
                        'status': 'InProgress'|'Succeeded'|'Failed',
                        'summary': 'string',
                        'lastStatusChange': datetime(2015, 1, 1),
                        'token': 'string',
                        'lastUpdatedBy': 'string',
                        'externalExecutionId': 'string',
                        'externalExecutionUrl': 'string',
                        'percentComplete': 123,
                        'errorDetails': {
                            'code': 'string',
                            'message': 'string'
                        }
                    },
                    'entityUrl': 'string',
                    'revisionUrl': 'string'
                },
            ],
            'latestExecution': {
                'pipelineExecutionId': 'string',
                'status': 'InProgress'|'Failed'|'Succeeded'
            }
        },
    ],
    'created': datetime(2015, 1, 1),
    'updated': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    Represents the output of a GetPipelineState action.

    • pipelineName (string) --

      The name of the pipeline for which you want to get the state.

    • pipelineVersion (integer) --

      The version number of the pipeline.

      Note

      A newly-created pipeline is always assigned a version number of 1 .

    • stageStates (list) --

      A list of the pipeline stage output information, including stage name, state, most recent run details, whether the stage is disabled, and other data.

      • (dict) --

        Represents information about the state of the stage.

        • stageName (string) --

          The name of the stage.

        • inboundTransitionState (dict) --

          The state of the inbound transition, which is either enabled or disabled.

          • enabled (boolean) --

            Whether the transition between stages is enabled (true) or disabled (false).

          • lastChangedBy (string) --

            The ID of the user who last changed the transition state.

          • lastChangedAt (datetime) --

            The timestamp when the transition state was last changed.

          • disabledReason (string) --

            The user-specified reason why the transition between two stages of a pipeline was disabled.

        • actionStates (list) --

          The state of the stage.

          • (dict) --

            Represents information about the state of an action.

            • actionName (string) --

              The name of the action.

            • currentRevision (dict) --

              Represents information about the version (or revision) of an action.

              • revisionId (string) --

                The system-generated unique ID that identifies the revision number of the action.

              • revisionChangeId (string) --

                The unique identifier of the change that set the state to this revision, for example a deployment ID or timestamp.

              • created (datetime) --

                The date and time when the most recent version of the action was created, in timestamp format.

            • latestExecution (dict) --

              Represents information about the run of an action.

              • status (string) --

                The status of the action, or for a completed action, the last status of the action.

              • summary (string) --

                A summary of the run of the action.

              • lastStatusChange (datetime) --

                The last status change of the action.

              • token (string) --

                The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the GetPipelineState command and is used to validate that the approval request corresponding to this token is still valid.

              • lastUpdatedBy (string) --

                The ARN of the user who last changed the pipeline.

              • externalExecutionId (string) --

                The external ID of the run of the action.

              • externalExecutionUrl (string) --

                The URL of a resource external to AWS that will be used when running the action, for example an external repository URL.

              • percentComplete (integer) --

                A percentage of completeness of the action as it runs.

              • errorDetails (dict) --

                The details of an error returned by a URL external to AWS.

                • code (string) --

                  The system ID or error number code of the error.

                • message (string) --

                  The text of the error message.

            • entityUrl (string) --

              A URL link for more information about the state of the action, such as a deployment group details page.

            • revisionUrl (string) --

              A URL link for more information about the revision, such as a commit details page.

        • latestExecution (dict) --

          Information about the latest execution in the stage, including its ID and status.

          • pipelineExecutionId (string) --

            The ID of the pipeline execution associated with the stage.

          • status (string) --

            The status of the stage, or for a completed stage, the last status of the stage.

    • created (datetime) --

      The date and time the pipeline was created, in timestamp format.

    • updated (datetime) --

      The date and time the pipeline was last updated, in timestamp format.

get_third_party_job_details(**kwargs)

Requests the details of a job for a third party action. 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. Additionally, this API returns any secret values defined for the action.

See also: AWS API Documentation

Request Syntax

response = client.get_third_party_job_details(
    jobId='string',
    clientToken='string'
)
Parameters
  • jobId (string) --

    [REQUIRED]

    The unique system-generated ID used for identifying the job.

  • clientToken (string) --

    [REQUIRED]

    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.

Return type

dict

Returns

Response Syntax

{
    'jobDetails': {
        'id': 'string',
        'data': {
            'actionTypeId': {
                'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval',
                'owner': 'AWS'|'ThirdParty'|'Custom',
                'provider': 'string',
                'version': 'string'
            },
            'actionConfiguration': {
                'configuration': {
                    'string': 'string'
                }
            },
            'pipelineContext': {
                'pipelineName': 'string',
                'stage': {
                    'name': 'string'
                },
                'action': {
                    'name': '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'
    }
}

Response Structure

  • (dict) --

    Represents the output of a GetThirdPartyJobDetails action.

    • jobDetails (dict) --

      The details of the job, including any protected values defined for the job.

      • id (string) --

        The identifier used to identify the job details in AWS CodePipeline.

      • data (dict) --

        The data to be returned by the third party job worker.

        • 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 values below.

          • owner (string) --

            The creator of the action being called.

          • 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 AWS CodeDeploy, which would be specified as CodeDeploy.

          • version (string) --

            A string that identifies the action type.

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

          • 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 within the stage of a pipeline.

            • name (string) --

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

        • inputArtifacts (list) --

          The name of the artifact that will be worked upon by the action, if any. This name might be system-generated, such as "MyApp", or might be defined by the user when the action is created. The input artifact name must match the name of an output artifact generated by an action in an earlier action or stage of the pipeline.

          • (dict) --

            Represents information about an artifact that will be worked upon by actions in the pipeline.

            • 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 Amazon S3 bucket that contains the artifact.

                • bucketName (string) --

                  The name of the Amazon S3 bucket.

                • objectKey (string) --

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

        • outputArtifacts (list) --

          The name of the artifact that will be the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or might be defined by the user when the action is created.

          • (dict) --

            Represents information about an artifact that will be worked upon by actions in the pipeline.

            • 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 Amazon S3 bucket that contains the artifact.

                • bucketName (string) --

                  The name of the Amazon S3 bucket.

                • objectKey (string) --

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

        • artifactCredentials (dict) --

          Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS Secure Token Service (STS). They can be used to access input and output artifacts in the Amazon S3 bucket used to store artifact for the pipeline in AWS 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 AWS CodeDeploy deployment ID, that a job requires in order to continue the job asynchronously.

        • encryptionKey (dict) --

          The encryption key used to encrypt and decrypt data in the artifact store for the pipeline, such as an AWS Key Management Service (AWS KMS) key. This is optional and might not be present.

          • id (string) --

            The ID used to identify the key. For an AWS KMS key, this is the key ID or key ARN.

          • type (string) --

            The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. When creating or updating a pipeline, the value must be set to 'KMS'.

      • nonce (string) --

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

get_waiter(waiter_name)
list_action_types(**kwargs)

Gets a summary of all AWS CodePipeline action types associated with your account.

See also: AWS API Documentation

Request Syntax

response = client.list_action_types(
    actionOwnerFilter='AWS'|'ThirdParty'|'Custom',
    nextToken='string'
)
Parameters
  • actionOwnerFilter (string) -- Filters the list of action types to those created by a specified entity.
  • nextToken (string) -- An identifier that was returned from the previous list action types call, which can be used to return the next set of action types in the list.
Return type

dict

Returns

Response Syntax

{
    'actionTypes': [
        {
            'id': {
                'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval',
                'owner': 'AWS'|'ThirdParty'|'Custom',
                'provider': 'string',
                'version': 'string'
            },
            'settings': {
                'thirdPartyConfigurationUrl': 'string',
                'entityUrlTemplate': 'string',
                'executionUrlTemplate': 'string',
                'revisionUrlTemplate': 'string'
            },
            'actionConfigurationProperties': [
                {
                    'name': 'string',
                    'required': True|False,
                    'key': True|False,
                    'secret': True|False,
                    'queryable': True|False,
                    'description': 'string',
                    'type': 'String'|'Number'|'Boolean'
                },
            ],
            'inputArtifactDetails': {
                'minimumCount': 123,
                'maximumCount': 123
            },
            'outputArtifactDetails': {
                'minimumCount': 123,
                'maximumCount': 123
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    Represents the output of a ListActionTypes action.

    • actionTypes (list) --

      Provides details of the action types.

      • (dict) --

        Returns information about the details of an action type.

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

          • owner (string) --

            The creator of the action being called.

          • 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 AWS CodeDeploy, which would be specified as CodeDeploy.

          • version (string) --

            A string that identifies the action type.

        • settings (dict) --

          The settings for the action type.

          • thirdPartyConfigurationUrl (string) --

            The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.

          • entityUrlTemplate (string) --

            The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display within the pipeline.

          • executionUrlTemplate (string) --

            The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action.

          • revisionUrlTemplate (string) --

            The URL returned to the AWS CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.

        • actionConfigurationProperties (list) --

          The configuration properties for the action type.

          • (dict) --

            Represents information about an action configuration property.

            • name (string) --

              The name of the action configuration property.

            • required (boolean) --

              Whether the configuration property is a required value.

            • key (boolean) --

              Whether the configuration property is a key.

            • secret (boolean) --

              Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.

              When updating a pipeline, passing * * * * * without changing any other values of the action will preserve the prior value of the secret.

            • queryable (boolean) --

              Indicates that the property will be used in conjunction with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.

              If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to additional restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.

            • description (string) --

              The description of the action configuration property that will be displayed to users.

            • type (string) --

              The type of the configuration property.

        • inputArtifactDetails (dict) --

          The details of the input artifact for the action, such as its commit ID.

          • minimumCount (integer) --

            The minimum number of artifacts allowed for the action type.

          • maximumCount (integer) --

            The maximum number of artifacts allowed for the action type.

        • outputArtifactDetails (dict) --

          The details of the output artifact of the action, such as its commit ID.

          • minimumCount (integer) --

            The minimum number of artifacts allowed for the action type.

          • maximumCount (integer) --

            The maximum number of artifacts allowed for the action type.

    • nextToken (string) --

      If the amount of returned information is significantly large, an identifier is also returned which can be used in a subsequent list action types call to return the next set of action types in the list.

list_pipeline_executions(**kwargs)

Gets a summary of the most recent executions for a pipeline.

See also: AWS API Documentation

Request Syntax

response = client.list_pipeline_executions(
    pipelineName='string',
    maxResults=123,
    nextToken='string'
)
Parameters
  • pipelineName (string) --

    [REQUIRED]

    The name of the pipeline for which you want to get execution summary information.

  • maxResults (integer) -- The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. The available pipeline execution history is limited to the most recent 12 months, based on pipeline execution start times. Default value is 100.
  • nextToken (string) -- The token that was returned from the previous ListPipelineExecutions call, which can be used to return the next set of pipeline executions in the list.
Return type

dict

Returns

Response Syntax

{
    'pipelineExecutionSummaries': [
        {
            'pipelineExecutionId': 'string',
            'status': 'InProgress'|'Succeeded'|'Superseded'|'Failed',
            'startTime': datetime(2015, 1, 1),
            'lastUpdateTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    Represents the output of a ListPipelineExecutions action.

    • pipelineExecutionSummaries (list) --

      A list of executions in the history of a pipeline.

      • (dict) --

        Summary information about a pipeline execution.

        • pipelineExecutionId (string) --

          The ID of the pipeline execution.

        • status (string) --

          The status of the pipeline execution.

          • InProgress: The pipeline execution is currently running.
          • Succeeded: The pipeline execution was completed successfully.
          • Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead.
          • Failed: The pipeline execution was not completed successfully.
        • startTime (datetime) --

          The date and time when the pipeline execution began, in timestamp format.

        • lastUpdateTime (datetime) --

          The date and time of the last change to the pipeline execution, in timestamp format.

    • nextToken (string) --

      A token that can be used in the next ListPipelineExecutions call. To view all items in the list, continue to call this operation with each subsequent token until no more nextToken values are returned.

list_pipelines(**kwargs)

Gets a summary of all of the pipelines associated with your account.

See also: AWS API Documentation

Request Syntax

response = client.list_pipelines(
    nextToken='string'
)
Parameters
nextToken (string) -- An identifier that was returned from the previous list pipelines call, which can be used to return the next set of pipelines in the list.
Return type
dict
Returns
Response Syntax
{
    'pipelines': [
        {
            'name': 'string',
            'version': 123,
            'created': datetime(2015, 1, 1),
            'updated': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    Represents the output of a ListPipelines action.

    • pipelines (list) --

      The list of pipelines.

      • (dict) --

        Returns a summary of a pipeline.

        • name (string) --

          The name of the pipeline.

        • version (integer) --

          The version number of the pipeline.

        • created (datetime) --

          The date and time the pipeline was created, in timestamp format.

        • updated (datetime) --

          The date and time of the last update to the pipeline, in timestamp format.

    • nextToken (string) --

      If the amount of returned information is significantly large, an identifier is also returned which can be used in a subsequent list pipelines call to return the next set of pipelines in the list.

poll_for_jobs(**kwargs)

Returns information about any jobs for AWS CodePipeline to act upon.

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. Additionally, this API 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',
        '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 values below.

    • owner (string) -- [REQUIRED]

      The creator of the action being called.

    • 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 AWS CodeDeploy, which would be specified as CodeDeploy.

    • version (string) -- [REQUIRED]

      A string that identifies the action type.

  • 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 will be returned.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'jobs': [
        {
            'id': 'string',
            'data': {
                'actionTypeId': {
                    'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval',
                    'owner': 'AWS'|'ThirdParty'|'Custom',
                    'provider': 'string',
                    'version': 'string'
                },
                'actionConfiguration': {
                    'configuration': {
                        'string': 'string'
                    }
                },
                'pipelineContext': {
                    'pipelineName': 'string',
                    'stage': {
                        'name': 'string'
                    },
                    'action': {
                        'name': '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) --

          Additional 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 values below.

            • owner (string) --

              The creator of the action being called.

            • 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 AWS CodeDeploy, which would be specified as CodeDeploy.

            • version (string) --

              A string that identifies the action type.

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

            • 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 within the stage of a pipeline.

              • name (string) --

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

          • inputArtifacts (list) --

            The artifact supplied to the job.

            • (dict) --

              Represents information about an artifact that will be worked upon by actions in the pipeline.

              • 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 Amazon S3 bucket that contains the artifact.

                  • bucketName (string) --

                    The name of the Amazon S3 bucket.

                  • objectKey (string) --

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

          • outputArtifacts (list) --

            The output of the job.

            • (dict) --

              Represents information about an artifact that will be worked upon by actions in the pipeline.

              • 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 Amazon S3 bucket that contains the artifact.

                  • bucketName (string) --

                    The name of the Amazon S3 bucket.

                  • objectKey (string) --

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

          • artifactCredentials (dict) --

            Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS Secure Token Service (STS). They can be used to access input and output artifacts in the Amazon S3 bucket used to store artifact for the pipeline in AWS 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 AWS CodeDeploy deployment ID, that a job requires in order to continue the job asynchronously.

          • encryptionKey (dict) --

            Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS) key.

            • id (string) --

              The ID used to identify the key. For an AWS KMS key, this is the key ID or key ARN.

            • type (string) --

              The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. When creating or updating a pipeline, the value must be set to 'KMS'.

        • nonce (string) --

          A system-generated random number that AWS 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 AWS account to use when performing the job.

poll_for_third_party_jobs(**kwargs)

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

Request Syntax

response = client.poll_for_third_party_jobs(
    actionTypeId={
        'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval',
        'owner': 'AWS'|'ThirdParty'|'Custom',
        'provider': 'string',
        'version': 'string'
    },
    maxBatchSize=123
)
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 values below.

    • owner (string) -- [REQUIRED]

      The creator of the action being called.

    • 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 AWS CodeDeploy, which would be specified as CodeDeploy.

    • version (string) -- [REQUIRED]

      A string that identifies the action type.

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

dict

Returns

Response Syntax

{
    'jobs': [
        {
            'clientId': 'string',
            'jobId': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    Represents the output of a PollForThirdPartyJobs action.

    • jobs (list) --

      Information about the jobs to take action on.

      • (dict) --

        A response to a PollForThirdPartyJobs 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.

put_action_revision(**kwargs)

Provides information to AWS CodePipeline about new revisions to a source.

See also: AWS API Documentation

Request Syntax

response = client.put_action_revision(
    pipelineName='string',
    stageName='string',
    actionName='string',
    actionRevision={
        'revisionId': 'string',
        'revisionChangeId': 'string',
        'created': datetime(2015, 1, 1)
    }
)
Parameters
  • pipelineName (string) --

    [REQUIRED]

    The name of the pipeline that will start processing the revision to the source.

  • stageName (string) --

    [REQUIRED]

    The name of the stage that contains the action that will act upon the revision.

  • actionName (string) --

    [REQUIRED]

    The name of the action that will process the revision.

  • actionRevision (dict) --

    [REQUIRED]

    Represents information about the version (or revision) of an action.

    • revisionId (string) -- [REQUIRED]

      The system-generated unique ID that identifies the revision number of the action.

    • revisionChangeId (string) -- [REQUIRED]

      The unique identifier of the change that set the state to this revision, for example a deployment ID or timestamp.

    • created (datetime) -- [REQUIRED]

      The date and time when the most recent version of the action was created, in timestamp format.

Return type

dict

Returns

Response Syntax

{
    'newRevision': True|False,
    'pipelineExecutionId': 'string'
}

Response Structure

  • (dict) --

    Represents the output of a PutActionRevision action.

    • newRevision (boolean) --

      Indicates whether the artifact revision was previously used in an execution of the specified pipeline.

    • pipelineExecutionId (string) --

      The ID of the current workflow state of the pipeline.

put_approval_result(**kwargs)

Provides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and Rejected.

See also: AWS API Documentation

Request Syntax

response = client.put_approval_result(
    pipelineName='string',
    stageName='string',
    actionName='string',
    result={
        'summary': 'string',
        'status': 'Approved'|'Rejected'
    },
    token='string'
)
Parameters
  • pipelineName (string) --

    [REQUIRED]

    The name of the pipeline that contains the action.

  • stageName (string) --

    [REQUIRED]

    The name of the stage that contains the action.

  • actionName (string) --

    [REQUIRED]

    The name of the action for which approval is requested.

  • result (dict) --

    [REQUIRED]

    Represents information about the result of the approval request.

    • summary (string) -- [REQUIRED]

      The summary of the current status of the approval request.

    • status (string) -- [REQUIRED]

      The response submitted by a reviewer assigned to an approval action request.

  • token (string) --

    [REQUIRED]

    The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the GetPipelineState action and is used to validate that the approval request corresponding to this token is still valid.

Return type

dict

Returns

Response Syntax

{
    'approvedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    Represents the output of a PutApprovalResult action.

    • approvedAt (datetime) --

      The timestamp showing when the approval or rejection was submitted.

put_job_failure_result(**kwargs)

Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions.

See also: AWS API Documentation

Request Syntax

response = client.put_job_failure_result(
    jobId='string',
    failureDetails={
        'type': 'JobFailed'|'ConfigurationError'|'PermissionError'|'RevisionOutOfSync'|'RevisionUnavailable'|'SystemUnavailable',
        'message': 'string',
        'externalExecutionId': 'string'
    }
)
Parameters
  • jobId (string) --

    [REQUIRED]

    The unique system-generated ID of the job that failed. This is the same ID returned from PollForJobs.

  • failureDetails (dict) --

    [REQUIRED]

    The details about the failure of a job.

    • type (string) -- [REQUIRED]

      The type of the failure.

    • message (string) -- [REQUIRED]

      The message about the failure.

    • externalExecutionId (string) --

      The external ID of the run of the action that failed.

Returns

None

put_job_success_result(**kwargs)

Represents the success of a job as returned to the pipeline by a job worker. Only used for custom actions.

See also: AWS API Documentation

Request Syntax

response = client.put_job_success_result(
    jobId='string',
    currentRevision={
        'revision': 'string',
        'changeIdentifier': 'string',
        'created': datetime(2015, 1, 1),
        'revisionSummary': 'string'
    },
    continuationToken='string',
    executionDetails={
        'summary': 'string',
        'externalExecutionId': 'string',
        'percentComplete': 123
    }
)
Parameters
  • jobId (string) --

    [REQUIRED]

    The unique system-generated ID of the job that succeeded. This is the same ID returned from PollForJobs.

  • currentRevision (dict) --

    The ID of the current revision of the artifact successfully worked upon by the job.

    • revision (string) -- [REQUIRED]

      The revision ID of the current version of an artifact.

    • changeIdentifier (string) -- [REQUIRED]

      The change identifier for the current revision.

    • created (datetime) --

      The date and time when the most recent revision of the artifact was created, in timestamp format.

    • revisionSummary (string) --

      The summary of the most recent revision of the artifact.

  • continuationToken (string) -- A token generated by a job worker, such as an AWS CodeDeploy deployment ID, that a successful job provides to identify a custom action in progress. Future jobs will use this token in order to identify the running instance of the action. It can be reused to return additional information about the progress of the custom action. When the action is complete, no continuation token should be supplied.
  • executionDetails (dict) --

    The execution details of the successful job, such as the actions taken by the job worker.

    • summary (string) --

      The summary of the current status of the actions.

    • externalExecutionId (string) --

      The system-generated unique ID of this action used to identify this job worker in any external systems, such as AWS CodeDeploy.

    • percentComplete (integer) --

      The percentage of work completed on the action, represented on a scale of zero to one hundred percent.

Returns

None

put_third_party_job_failure_result(**kwargs)

Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions.

See also: AWS API Documentation

Request Syntax

response = client.put_third_party_job_failure_result(
    jobId='string',
    clientToken='string',
    failureDetails={
        'type': 'JobFailed'|'ConfigurationError'|'PermissionError'|'RevisionOutOfSync'|'RevisionUnavailable'|'SystemUnavailable',
        'message': 'string',
        'externalExecutionId': 'string'
    }
)
Parameters
  • jobId (string) --

    [REQUIRED]

    The ID of the job that failed. This is the same ID returned from PollForThirdPartyJobs.

  • clientToken (string) --

    [REQUIRED]

    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.

  • failureDetails (dict) --

    [REQUIRED]

    Represents information about failure details.

    • type (string) -- [REQUIRED]

      The type of the failure.

    • message (string) -- [REQUIRED]

      The message about the failure.

    • externalExecutionId (string) --

      The external ID of the run of the action that failed.

Returns

None

put_third_party_job_success_result(**kwargs)

Represents the success of a third party job as returned to the pipeline by a job worker. Only used for partner actions.

See also: AWS API Documentation

Request Syntax

response = client.put_third_party_job_success_result(
    jobId='string',
    clientToken='string',
    currentRevision={
        'revision': 'string',
        'changeIdentifier': 'string',
        'created': datetime(2015, 1, 1),
        'revisionSummary': 'string'
    },
    continuationToken='string',
    executionDetails={
        'summary': 'string',
        'externalExecutionId': 'string',
        'percentComplete': 123
    }
)
Parameters
  • jobId (string) --

    [REQUIRED]

    The ID of the job that successfully completed. This is the same ID returned from PollForThirdPartyJobs.

  • clientToken (string) --

    [REQUIRED]

    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.

  • currentRevision (dict) --

    Represents information about a current revision.

    • revision (string) -- [REQUIRED]

      The revision ID of the current version of an artifact.

    • changeIdentifier (string) -- [REQUIRED]

      The change identifier for the current revision.

    • created (datetime) --

      The date and time when the most recent revision of the artifact was created, in timestamp format.

    • revisionSummary (string) --

      The summary of the most recent revision of the artifact.

  • continuationToken (string) -- A token generated by a job worker, such as an AWS CodeDeploy deployment ID, that a successful job provides to identify a partner action in progress. Future jobs will use this token in order to identify the running instance of the action. It can be reused to return additional information about the progress of the partner action. When the action is complete, no continuation token should be supplied.
  • executionDetails (dict) --

    The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline.

    • summary (string) --

      The summary of the current status of the actions.

    • externalExecutionId (string) --

      The system-generated unique ID of this action used to identify this job worker in any external systems, such as AWS CodeDeploy.

    • percentComplete (integer) --

      The percentage of work completed on the action, represented on a scale of zero to one hundred percent.

Returns

None

retry_stage_execution(**kwargs)

Resumes the pipeline execution by retrying the last failed actions in a stage.

See also: AWS API Documentation

Request Syntax

response = client.retry_stage_execution(
    pipelineName='string',
    stageName='string',
    pipelineExecutionId='string',
    retryMode='FAILED_ACTIONS'
)
Parameters
  • pipelineName (string) --

    [REQUIRED]

    The name of the pipeline that contains the failed stage.

  • stageName (string) --

    [REQUIRED]

    The name of the failed stage to be retried.

  • pipelineExecutionId (string) --

    [REQUIRED]

    The ID of the pipeline execution in the failed stage to be retried. Use the GetPipelineState action to retrieve the current pipelineExecutionId of the failed stage

  • retryMode (string) --

    [REQUIRED]

    The scope of the retry attempt. Currently, the only supported value is FAILED_ACTIONS.

Return type

dict

Returns

Response Syntax

{
    'pipelineExecutionId': 'string'
}

Response Structure

  • (dict) --

    Represents the output of a RetryStageExecution action.

    • pipelineExecutionId (string) --

      The ID of the current workflow execution in the failed stage.

start_pipeline_execution(**kwargs)

Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.

See also: AWS API Documentation

Request Syntax

response = client.start_pipeline_execution(
    name='string'
)
Parameters
name (string) --

[REQUIRED]

The name of the pipeline to start.

Return type
dict
Returns
Response Syntax
{
    'pipelineExecutionId': 'string'
}

Response Structure

  • (dict) --

    Represents the output of a StartPipelineExecution action.

    • pipelineExecutionId (string) --

      The unique system-generated ID of the pipeline execution that was started.

update_pipeline(**kwargs)

Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure in conjunction with UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1.

See also: AWS API Documentation

Request Syntax

response = client.update_pipeline(
    pipeline={
        'name': 'string',
        'roleArn': 'string',
        'artifactStore': {
            'type': 'S3',
            'location': 'string',
            'encryptionKey': {
                'id': 'string',
                'type': 'KMS'
            }
        },
        'stages': [
            {
                'name': 'string',
                'blockers': [
                    {
                        'name': 'string',
                        'type': 'Schedule'
                    },
                ],
                'actions': [
                    {
                        'name': 'string',
                        'actionTypeId': {
                            'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval',
                            'owner': 'AWS'|'ThirdParty'|'Custom',
                            'provider': 'string',
                            'version': 'string'
                        },
                        'runOrder': 123,
                        'configuration': {
                            'string': 'string'
                        },
                        'outputArtifacts': [
                            {
                                'name': 'string'
                            },
                        ],
                        'inputArtifacts': [
                            {
                                'name': 'string'
                            },
                        ],
                        'roleArn': 'string'
                    },
                ]
            },
        ],
        'version': 123
    }
)
Parameters
pipeline (dict) --

[REQUIRED]

The name of the pipeline to be updated.

  • name (string) -- [REQUIRED]

    The name of the action to be performed.

  • roleArn (string) -- [REQUIRED]

    The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.

  • artifactStore (dict) -- [REQUIRED]

    Represents information about the Amazon S3 bucket where artifacts are stored for the pipeline.

    • type (string) -- [REQUIRED]

      The type of the artifact store, such as S3.

    • location (string) -- [REQUIRED]

      The Amazon S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a folder within the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any Amazon S3 bucket in the same AWS Region as the pipeline to store your pipeline artifacts.

    • encryptionKey (dict) --

      The encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service (AWS KMS) key. If this is undefined, the default key for Amazon S3 is used.

      • id (string) -- [REQUIRED]

        The ID used to identify the key. For an AWS KMS key, this is the key ID or key ARN.

      • type (string) -- [REQUIRED]

        The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. When creating or updating a pipeline, the value must be set to 'KMS'.

  • stages (list) -- [REQUIRED]

    The stage in which to perform the action.

    • (dict) --

      Represents information about a stage and its definition.

      • name (string) -- [REQUIRED]

        The name of the stage.

      • blockers (list) --

        Reserved for future use.

        • (dict) --

          Reserved for future use.

          • name (string) -- [REQUIRED]

            Reserved for future use.

          • type (string) -- [REQUIRED]

            Reserved for future use.

      • actions (list) -- [REQUIRED]

        The actions included in a stage.

        • (dict) --

          Represents information about an action declaration.

          • name (string) -- [REQUIRED]

            The action declaration's name.

          • actionTypeId (dict) -- [REQUIRED]

            The configuration information for the 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 values below.

            • owner (string) -- [REQUIRED]

              The creator of the action being called.

            • 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 AWS CodeDeploy, which would be specified as CodeDeploy.

            • version (string) -- [REQUIRED]

              A string that identifies the action type.

          • runOrder (integer) --

            The order in which actions are run.

          • configuration (dict) --

            The action declaration's configuration.

            • (string) --
              • (string) --
          • outputArtifacts (list) --

            The name or ID of the result of the action declaration, such as a test or build artifact.

            • (dict) --

              Represents information about the output of an action.

              • name (string) -- [REQUIRED]

                The name of the output of an artifact, such as "My App".

                The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.

                Output artifact names must be unique within a pipeline.

          • inputArtifacts (list) --

            The name or ID of the artifact consumed by the action, such as a test or build artifact.

            • (dict) --

              Represents information about an artifact to be worked on, such as a test or build artifact.

              • name (string) -- [REQUIRED]

                The name of the artifact to be worked on, for example, "My App".

                The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.

          • roleArn (string) --

            The ARN of the IAM service role that will perform the declared action. This is assumed through the roleArn for the pipeline.

  • version (integer) --

    The version number of the pipeline. A new pipeline always has a version number of 1. This number is automatically incremented when a pipeline is updated.

Return type
dict
Returns
Response Syntax
{
    'pipeline': {
        'name': 'string',
        'roleArn': 'string',
        'artifactStore': {
            'type': 'S3',
            'location': 'string',
            'encryptionKey': {
                'id': 'string',
                'type': 'KMS'
            }
        },
        'stages': [
            {
                'name': 'string',
                'blockers': [
                    {
                        'name': 'string',
                        'type': 'Schedule'
                    },
                ],
                'actions': [
                    {
                        'name': 'string',
                        'actionTypeId': {
                            'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval',
                            'owner': 'AWS'|'ThirdParty'|'Custom',
                            'provider': 'string',
                            'version': 'string'
                        },
                        'runOrder': 123,
                        'configuration': {
                            'string': 'string'
                        },
                        'outputArtifacts': [
                            {
                                'name': 'string'
                            },
                        ],
                        'inputArtifacts': [
                            {
                                'name': 'string'
                            },
                        ],
                        'roleArn': 'string'
                    },
                ]
            },
        ],
        'version': 123
    }
}

Response Structure

  • (dict) --

    Represents the output of an UpdatePipeline action.

    • pipeline (dict) --

      The structure of the updated pipeline.

      • name (string) --

        The name of the action to be performed.

      • roleArn (string) --

        The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.

      • artifactStore (dict) --

        Represents information about the Amazon S3 bucket where artifacts are stored for the pipeline.

        • type (string) --

          The type of the artifact store, such as S3.

        • location (string) --

          The Amazon S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a folder within the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any Amazon S3 bucket in the same AWS Region as the pipeline to store your pipeline artifacts.

        • encryptionKey (dict) --

          The encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service (AWS KMS) key. If this is undefined, the default key for Amazon S3 is used.

          • id (string) --

            The ID used to identify the key. For an AWS KMS key, this is the key ID or key ARN.

          • type (string) --

            The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. When creating or updating a pipeline, the value must be set to 'KMS'.

      • stages (list) --

        The stage in which to perform the action.

        • (dict) --

          Represents information about a stage and its definition.

          • name (string) --

            The name of the stage.

          • blockers (list) --

            Reserved for future use.

            • (dict) --

              Reserved for future use.

              • name (string) --

                Reserved for future use.

              • type (string) --

                Reserved for future use.

          • actions (list) --

            The actions included in a stage.

            • (dict) --

              Represents information about an action declaration.

              • name (string) --

                The action declaration's name.

              • actionTypeId (dict) --

                The configuration information for the 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 values below.

                • owner (string) --

                  The creator of the action being called.

                • 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 AWS CodeDeploy, which would be specified as CodeDeploy.

                • version (string) --

                  A string that identifies the action type.

              • runOrder (integer) --

                The order in which actions are run.

              • configuration (dict) --

                The action declaration's configuration.

                • (string) --
                  • (string) --
              • outputArtifacts (list) --

                The name or ID of the result of the action declaration, such as a test or build artifact.

                • (dict) --

                  Represents information about the output of an action.

                  • name (string) --

                    The name of the output of an artifact, such as "My App".

                    The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.

                    Output artifact names must be unique within a pipeline.

              • inputArtifacts (list) --

                The name or ID of the artifact consumed by the action, such as a test or build artifact.

                • (dict) --

                  Represents information about an artifact to be worked on, such as a test or build artifact.

                  • name (string) --

                    The name of the artifact to be worked on, for example, "My App".

                    The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.

              • roleArn (string) --

                The ARN of the IAM service role that will perform the declared action. This is assumed through the roleArn for the pipeline.

      • version (integer) --

        The version number of the pipeline. A new pipeline always has a version number of 1. This number is automatically incremented when a pipeline is updated.

Paginators

The available paginators are: