CodePipeline / Client / update_pipeline

update_pipeline

CodePipeline.Client.update_pipeline(**kwargs)

Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure and 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'
            }
        },
        'artifactStores': {
            'string': {
                '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',
                        'region': 'string',
                        'namespace': 'string'
                    },
                ]
            },
        ],
        'version': 123
    }
)

Parameters:

pipeline (dict) –

[REQUIRED]

The name of the pipeline to be updated.

• name (string) – [REQUIRED]

  The name of the pipeline.

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

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

  Note

  You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.

  • type (string) – [REQUIRED]

    The type of the artifact store, such as S3.

  • location (string) – [REQUIRED]

    The S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a folder in the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any 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, you can use the key ID, the key ARN, or the alias ARN.

      Note

      Aliases are recognized only in the account that created the customer master key (CMK). For cross-account actions, you can only use the key ID or key ARN to identify the key.

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

• artifactStores (dict) –

  A mapping of artifactStore objects and their corresponding AWS Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.

  Note

  You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.

  • (string) –

    • (dict) –

      The S3 bucket where artifacts for the pipeline are stored.

      Note

      You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.

      • type (string) – [REQUIRED]

        The type of the artifact store, such as S3.

      • location (string) – [REQUIRED]

        The S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a folder in the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any 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, you can use the key ID, the key ARN, or the alias ARN.

          Note

          Aliases are recognized only in the account that created the customer master key (CMK). For cross-account actions, you can only use the key ID or key ARN to identify the key.

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

          Specifies the action type and the provider of the action.

          • category (string) – [REQUIRED]

            A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the following values.

            • Source

            • Build

            • Test

            • Deploy

            • Invoke

            • Approval

          • owner (string) – [REQUIRED]

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

          • provider (string) – [REQUIRED]

            The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of AWS CodeDeploy, which would be specified as CodeDeploy. For more information, see Valid Action Types and Providers in CodePipeline.

          • version (string) – [REQUIRED]

            A string that describes the action version.

        • runOrder (integer) –

          The order in which actions are run.

        • configuration (dict) –

          The action’s configuration. These are key-value pairs that specify input values for an action. For more information, see Action Structure Requirements in CodePipeline. For the list of configuration properties for the AWS CloudFormation action type in CodePipeline, see Configuration Properties Reference in the AWS CloudFormation User Guide. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the AWS CloudFormation User Guide.

          The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows:

          JSON:

          "Configuration" : { Key : Value },

          • (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 performs the declared action. This is assumed through the roleArn for the pipeline.

        • region (string) –

          The action declaration’s AWS Region, such as us-east-1.

        • namespace (string) –

          The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.

• version (integer) –

  The version number of the pipeline. A new pipeline always has a version number of 1. This number is 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'
            }
        },
        'artifactStores': {
            'string': {
                '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',
                        'region': 'string',
                        'namespace': '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 pipeline.

    • 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 S3 bucket where artifacts are stored for the pipeline.

      Note

      You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.

      • type (string) –

        The type of the artifact store, such as S3.

      • location (string) –

        The S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a folder in the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any 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, you can use the key ID, the key ARN, or the alias ARN.

          Note

          Aliases are recognized only in the account that created the customer master key (CMK). For cross-account actions, you can only use the key ID or key ARN to identify the key.

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

    • artifactStores (dict) –

      A mapping of artifactStore objects and their corresponding AWS Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.

      Note

      You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.

      • (string) –

        • (dict) –

          The S3 bucket where artifacts for the pipeline are stored.

          Note

          You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.

          • type (string) –

            The type of the artifact store, such as S3.

          • location (string) –

            The S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a folder in the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any 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, you can use the key ID, the key ARN, or the alias ARN.

              Note

              Aliases are recognized only in the account that created the customer master key (CMK). For cross-account actions, you can only use the key ID or key ARN to identify the key.

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

              Specifies the action type and the provider of the action.

              • category (string) –

                A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the following values.

                • Source

                • Build

                • Test

                • Deploy

                • Invoke

                • Approval

              • owner (string) –

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

              • provider (string) –

                The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of AWS CodeDeploy, which would be specified as CodeDeploy. For more information, see Valid Action Types and Providers in CodePipeline.

              • version (string) –

                A string that describes the action version.

            • runOrder (integer) –

              The order in which actions are run.

            • configuration (dict) –

              The action’s configuration. These are key-value pairs that specify input values for an action. For more information, see Action Structure Requirements in CodePipeline. For the list of configuration properties for the AWS CloudFormation action type in CodePipeline, see Configuration Properties Reference in the AWS CloudFormation User Guide. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the AWS CloudFormation User Guide.

              The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows:

              JSON:

              "Configuration" : { Key : Value },

              • (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 performs the declared action. This is assumed through the roleArn for the pipeline.

            • region (string) –

              The action declaration’s AWS Region, such as us-east-1.

            • namespace (string) –

              The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.

    • version (integer) –

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

Exceptions

• CodePipeline.Client.exceptions.ValidationException

• CodePipeline.Client.exceptions.InvalidStageDeclarationException

• CodePipeline.Client.exceptions.InvalidActionDeclarationException

• CodePipeline.Client.exceptions.InvalidBlockerDeclarationException

• CodePipeline.Client.exceptions.InvalidStructureException

• CodePipeline.Client.exceptions.LimitExceededException