CodePipeline / Client / get_pipeline

get_pipeline

CodePipeline.Client.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 in an Amazon Web Services account.

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

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,
        'pipelineType': 'V1'|'V2',
        'triggers': [
            {
                'providerType': 'CodeStarSourceConnection',
                'gitConfiguration': {
                    'sourceActionName': 'string',
                    'push': [
                        {
                            'tags': {
                                'includes': [
                                    'string',
                                ],
                                'excludes': [
                                    'string',
                                ]
                            }
                        },
                    ]
                }
            },
        ],
        'variables': [
            {
                'name': 'string',
                'defaultValue': 'string',
                'description': 'string'
            },
        ]
    },
    'metadata': {
        'pipelineArn': 'string',
        'created': datetime(2015, 1, 1),
        'updated': datetime(2015, 1, 1),
        'pollingDisabledAt': 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 pipeline.

    • roleArn (string) –

      The Amazon Resource Name (ARN) for 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 Amazon Web Services 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 Amazon Web Services Key Management Service key. If this is undefined, the default key for Amazon S3 is used.

        • id (string) –

          The ID used to identify the key. For an Amazon Web Services KMS key, you can use the key ID, the key ARN, or the alias ARN.

          Note

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

        • type (string) –

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

    • artifactStores (dict) –

      A mapping of artifactStore objects and their corresponding Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services Key Management Service key. If this is undefined, the default key for Amazon S3 is used.

            • id (string) –

              The ID used to identify the key. For an Amazon Web Services KMS key, you can use the key ID, the key ARN, or the alias ARN.

              Note

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

            • type (string) –

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

    • 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 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 CloudFormation action type in CodePipeline, see Configuration Properties Reference in the CloudFormation User Guide. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the 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”).

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

                  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 Amazon Web Services 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.

    • pipelineType (string) –

      CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.

      • V1 type pipelines have a JSON structure that contains standard pipeline, stage, and action-level parameters.

      • V2 type pipelines have the same structure as a V1 type, along with additional parameters for release safety and trigger configuration.

      Warning

      Including V2 parameters, such as triggers on Git tags, in the pipeline JSON when creating or updating a pipeline will result in the pipeline having the V2 type of pipeline and the associated costs.

      For information about pricing for CodePipeline, see Pricing.

      For information about which type of pipeline to choose, see What type of pipeline is right for me?.

      Note

      V2 type pipelines, along with triggers on Git tags and pipeline-level variables, are not currently supported for CloudFormation and CDK resources in CodePipeline. For more information about V2 type pipelines, see Pipeline types in the CodePipeline User Guide.

    • triggers (list) –

      The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.

      Note

      When a trigger configuration is specified, default change detection for repository and branch commits is disabled.

      • (dict) –

        Represents information about the specified trigger configuration, such as the filter criteria and the source stage for the action that contains the trigger.

        Note

        This is only supported for the CodeStarSourceConnection action type.

        Note

        When a trigger configuration is specified, default change detection for repository and branch commits is disabled.

        Note

        V2 type pipelines, along with triggers on Git tags and pipeline-level variables, are not currently supported for CloudFormation and CDK resources in CodePipeline. For more information about V2 type pipelines, see Pipeline types in the CodePipeline User Guide.

        • providerType (string) –

          The source provider for the event, such as connections configured for a repository with Git tags, for the specified trigger configuration.

        • gitConfiguration (dict) –

          Provides the filter criteria and the source stage for the repository event that starts the pipeline, such as Git tags.

          • sourceActionName (string) –

            The name of the pipeline source action where the trigger configuration, such as Git tags, is specified. The trigger configuration will start the pipeline upon the specified change only.

            Note

            You can only specify one trigger configuration per source action.

          • push (list) –

            The field where the repository event that will start the pipeline, such as pushing Git tags, is specified with details.

            Note

            Git tags is the only supported event type.

            • (dict) –

              The event criteria that specify when a specified repository event will start the pipeline for the specified trigger configuration, such as the lists of Git tags to include and exclude.

              • tags (dict) –

                The field that contains the details for the Git tags trigger configuration.

                • includes (list) –

                  The list of patterns of Git tags that, when pushed, are to be included as criteria that starts the pipeline.

                  • (string) –

                • excludes (list) –

                  The list of patterns of Git tags that, when pushed, are to be excluded from starting the pipeline.

                  • (string) –

    • variables (list) –

      A list that defines the pipeline variables for a pipeline resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9@\-_]+.

      • (dict) –

        A variable declared at the pipeline level.

        Note

        V2 type pipelines, along with triggers on Git tags and pipeline-level variables, are not currently supported for CloudFormation and CDK resources in CodePipeline. For more information about V2 type pipelines, see Pipeline types in the CodePipeline User Guide.

        • name (string) –

          The name of a pipeline-level variable.

        • defaultValue (string) –

          The value of a pipeline-level variable.

        • description (string) –

          The description of a pipeline-level variable. It’s used to add additional context about the variable, and not being used at time when pipeline executes.

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

    • pollingDisabledAt (datetime) –

      The date and time that polling for source changes (periodic checks) was stopped for the pipeline, in timestamp format. You can migrate (update) a polling pipeline to use event-based change detection. For example, for a pipeline with a CodeCommit source, we recommend you migrate (update) your pipeline to use CloudWatch Events. To learn more, see Migrate polling pipelines to use event-based change detection in the CodePipeline User Guide.

Exceptions

• CodePipeline.Client.exceptions.ValidationException

• CodePipeline.Client.exceptions.PipelineNotFoundException

• CodePipeline.Client.exceptions.PipelineVersionNotFoundException