aws.codepipeline.get_pipeline

Example SQL Queries

SELECT * FROM
aws.codepipeline.get_pipeline
WHERE
"name" = 'VALUE';

Description

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.

Table Definition

Column Name	Column Data Type
`name` Required Input Column The name of the pipeline for which you want to get information. Pipeline names must be unique in an Amazon Web Services account.	VARCHAR
`version` Input Column The version number of the pipeline. If you do not specify a version, defaults to the current version.	BIGINT
`_aws_profile` Input Column The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.	STRUCT( "type" VARCHAR, "name" VARCHAR, "account_id" VARCHAR, "via_profile_name" VARCHAR, "assumed_role_arn" VARCHAR, "organization" STRUCT( "account_name" VARCHAR, "id" VARCHAR, "tags" STRUCT( "key" VARCHAR, "value" VARCHAR )[], "master_account" STRUCT( "id" VARCHAR, "email" VARCHAR ), "parents" STRUCT( "type" VARCHAR, "id" VARCHAR, "name" VARCHAR, "tags" STRUCT( "key" VARCHAR, "value" VARCHAR )[] )[] ) )
Show child fields `_aws_profile.account_id` The AWS account id `_aws_profile.assumed_role_arn` The ARN of the assumed role `_aws_profile.name` The unique name of the profile. `_aws_profile.organization` Information about this profile's membership in the AWS organization. Show child fields `_aws_profile.organization.account_name` The name of account speciifed by the organization `_aws_profile.organization.id` The organization id `_aws_profile.organization.master_account` Show child fields `_aws_profile.organization.master_account.email` The organization master account email address `_aws_profile.organization.master_account.id` The organization master account id `_aws_profile.organization.parents[]` Show child fields `_aws_profile.organization.parents[].id` The id of the parent `_aws_profile.organization.parents[].name` The name of the parent `_aws_profile.organization.parents[].tags[]` Show child fields `_aws_profile.organization.parents[].tags[].key` `_aws_profile.organization.parents[].tags[].value` `_aws_profile.organization.parents[].type` The type of parent can be an organization unit or a root `_aws_profile.organization.tags[]` Show child fields `_aws_profile.organization.tags[].key` `_aws_profile.organization.tags[].value` `_aws_profile.type` The type of profile, either 'credentials' or 'assumed_role' `_aws_profile.via_profile_name` This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.
`_aws_region` Input Column The AWS region to use.	VARCHAR
`metadata` Represents the pipeline metadata information returned as part of the output of a `GetPipeline` action.	STRUCT( "pipeline_arn" VARCHAR, "created" TIMESTAMP_S, "updated" TIMESTAMP_S, "polling_disabled_at" TIMESTAMP_S )
Show child fields `metadata.created` The date and time the pipeline was created, in timestamp format. `metadata.pipeline_arn` The Amazon Resource Name (ARN) of the pipeline. `metadata.polling_disabled_at` 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. `metadata.updated` The date and time the pipeline was last updated, in timestamp format.
`pipeline` Represents the structure of actions and stages to be performed in the pipeline.	STRUCT( "name" VARCHAR, "role_arn" VARCHAR, "artifact_store" STRUCT( "type" VARCHAR, "location" VARCHAR, "encryption_key" STRUCT( "id" VARCHAR, "type" VARCHAR ) ), "artifact_stores" MAP(VARCHAR, STRUCT( "type" VARCHAR, "location" VARCHAR, "encryption_key" STRUCT( "id" VARCHAR, "type" VARCHAR ) )), "stages" STRUCT( "name" VARCHAR, "blockers" STRUCT( "name" VARCHAR, "type" VARCHAR )[], "actions" STRUCT( "name" VARCHAR, "action_type_id" STRUCT( "category" VARCHAR, "owner" VARCHAR, "provider" VARCHAR, "version" VARCHAR ), "run_order" BIGINT, "configuration" MAP(VARCHAR, VARCHAR), "output_artifacts" STRUCT( "name" VARCHAR )[], "input_artifacts" STRUCT( "name" VARCHAR )[], "role_arn" VARCHAR, "region" VARCHAR, "namespace" VARCHAR, "timeout_in_minutes" BIGINT )[], "on_failure" STRUCT( "result" VARCHAR, "conditions" STRUCT( "result" VARCHAR, "rules" STRUCT( "name" VARCHAR, "rule_type_id" STRUCT( "category" VARCHAR, "owner" VARCHAR, "provider" VARCHAR, "version" VARCHAR ), "configuration" MAP(VARCHAR, VARCHAR), "input_artifacts" STRUCT( "name" VARCHAR )[], "role_arn" VARCHAR, "region" VARCHAR, "timeout_in_minutes" BIGINT )[] )[] ), "on_success" STRUCT( "conditions" STRUCT( "result" VARCHAR, "rules" STRUCT( "name" VARCHAR, "rule_type_id" STRUCT( "category" VARCHAR, "owner" VARCHAR, "provider" VARCHAR, "version" VARCHAR ), "configuration" MAP(VARCHAR, VARCHAR), "input_artifacts" STRUCT( "name" VARCHAR )[], "role_arn" VARCHAR, "region" VARCHAR, "timeout_in_minutes" BIGINT )[] )[] ), "before_entry" STRUCT( "conditions" STRUCT( "result" VARCHAR, "rules" STRUCT( "name" VARCHAR, "rule_type_id" STRUCT( "category" VARCHAR, "owner" VARCHAR, "provider" VARCHAR, "version" VARCHAR ), "configuration" MAP(VARCHAR, VARCHAR), "input_artifacts" STRUCT( "name" VARCHAR )[], "role_arn" VARCHAR, "region" VARCHAR, "timeout_in_minutes" BIGINT )[] )[] ) )[], "version" BIGINT, "execution_mode" VARCHAR, "pipeline_type" VARCHAR, "variables" STRUCT( "name" VARCHAR, "default_value" VARCHAR, "description" VARCHAR )[], "triggers" STRUCT( "provider_type" VARCHAR, "git_configuration" STRUCT( "source_action_name" VARCHAR, "push" STRUCT( "tags" STRUCT( "includes" VARCHAR[], "excludes" VARCHAR[] ), "branches" STRUCT( "includes" VARCHAR[], "excludes" VARCHAR[] ), "file_paths" STRUCT( "includes" VARCHAR[], "excludes" VARCHAR[] ) )[], "pull_request" STRUCT( "events" VARCHAR[], "branches" STRUCT( "includes" VARCHAR[], "excludes" VARCHAR[] ), "file_paths" STRUCT( "includes" VARCHAR[], "excludes" VARCHAR[] ) )[] ) )[] )
Show child fields `pipeline.artifact_store` Represents information about the S3 bucket where artifacts are stored for the pipeline. 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`. Show child fields `pipeline.artifact_store.encryption_key` 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. Show child fields `pipeline.artifact_store.encryption_key.id` 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. 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). `pipeline.artifact_store.encryption_key.type` 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'. `pipeline.artifact_store.location` 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. `pipeline.artifact_store.type` The type of the artifact store, such as S3. `pipeline.artifact_stores` 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. 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`. `pipeline.execution_mode` The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED. `pipeline.name` The name of the pipeline. `pipeline.pipeline_type` 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. 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?. `pipeline.role_arn` 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`. `pipeline.stages[]` Show child fields `pipeline.stages[].actions[]` Show child fields `pipeline.stages[].actions[].action_type_id` Specifies the action type and the provider of the action. Show child fields `pipeline.stages[].actions[].action_type_id.category` 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 `pipeline.stages[].actions[].action_type_id.owner` 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. `pipeline.stages[].actions[].action_type_id.provider` 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. `pipeline.stages[].actions[].action_type_id.version` A string that describes the action version. `pipeline.stages[].actions[].configuration` 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 },` `pipeline.stages[].actions[].input_artifacts[]` Show child fields `pipeline.stages[].actions[].input_artifacts[].name` 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. `pipeline.stages[].actions[].name` The action declaration's name. `pipeline.stages[].actions[].namespace` The variable namespace associated with the action. All variables produced as output by this action fall under this namespace. `pipeline.stages[].actions[].output_artifacts[]` Show child fields `pipeline.stages[].actions[].output_artifacts[].name` 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. `pipeline.stages[].actions[].region` The action declaration's Amazon Web Services Region, such as us-east-1. `pipeline.stages[].actions[].role_arn` The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline. `pipeline.stages[].actions[].run_order` The order in which actions are run. `pipeline.stages[].actions[].timeout_in_minutes` A timeout duration in minutes that can be applied against the ActionType’s default timeout value specified in Quotas for CodePipeline . This attribute is available only to the manual approval ActionType. `pipeline.stages[].before_entry` The method to use when a stage allows entry. For example, configuring this field for conditions will allow entry to the stage when the conditions are met. Show child fields `pipeline.stages[].before_entry.conditions[]` Show child fields `pipeline.stages[].before_entry.conditions[].result` The action to be done when the condition is met. For example, rolling back an execution for a failure condition. `pipeline.stages[].before_entry.conditions[].rules[]` Show child fields `pipeline.stages[].before_entry.conditions[].rules[].configuration` The action configuration fields for the rule. `pipeline.stages[].before_entry.conditions[].rules[].input_artifacts[]` Show child fields `pipeline.stages[].before_entry.conditions[].rules[].input_artifacts[].name` 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. `pipeline.stages[].before_entry.conditions[].rules[].name` The name of the rule that is created for the condition, such as CheckAllResults. `pipeline.stages[].before_entry.conditions[].rules[].region` The Region for the condition associated with the rule. `pipeline.stages[].before_entry.conditions[].rules[].role_arn` The pipeline role ARN associated with the rule. `pipeline.stages[].before_entry.conditions[].rules[].rule_type_id` The ID for the rule type, which is made up of the combined values for category, owner, provider, and version. Show child fields `pipeline.stages[].before_entry.conditions[].rules[].rule_type_id.category` A category defines what kind of rule can be run in the stage, and constrains the provider type for the rule. Valid categories are limited to one of the following values. INVOKE Approval Rule `pipeline.stages[].before_entry.conditions[].rules[].rule_type_id.owner` The creator of the rule being called. The valid value for the `Owner` field in the rule category is `AWS`. `pipeline.stages[].before_entry.conditions[].rules[].rule_type_id.provider` The provider of the service being called by the rule. Valid providers are determined by the rulecategory. For example, a managed rule in the Rule category type has an owner of AWS, which would be specified as `AWS`. `pipeline.stages[].before_entry.conditions[].rules[].rule_type_id.version` A string that describes the rule version. `pipeline.stages[].before_entry.conditions[].rules[].timeout_in_minutes` The action timeout for the rule. `pipeline.stages[].blockers[]` Show child fields `pipeline.stages[].blockers[].name` Reserved for future use. `pipeline.stages[].blockers[].type` Reserved for future use. `pipeline.stages[].name` The name of the stage. `pipeline.stages[].on_failure` The method to use when a stage has not completed successfully. For example, configuring this field for rollback will roll back a failed stage automatically to the last successful pipeline execution in the stage. Show child fields `pipeline.stages[].on_failure.conditions[]` Show child fields `pipeline.stages[].on_failure.conditions[].result` The action to be done when the condition is met. For example, rolling back an execution for a failure condition. `pipeline.stages[].on_failure.conditions[].rules[]` Show child fields `pipeline.stages[].on_failure.conditions[].rules[].configuration` The action configuration fields for the rule. `pipeline.stages[].on_failure.conditions[].rules[].input_artifacts[]` Show child fields `pipeline.stages[].on_failure.conditions[].rules[].input_artifacts[].name` 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. `pipeline.stages[].on_failure.conditions[].rules[].name` The name of the rule that is created for the condition, such as CheckAllResults. `pipeline.stages[].on_failure.conditions[].rules[].region` The Region for the condition associated with the rule. `pipeline.stages[].on_failure.conditions[].rules[].role_arn` The pipeline role ARN associated with the rule. `pipeline.stages[].on_failure.conditions[].rules[].rule_type_id` The ID for the rule type, which is made up of the combined values for category, owner, provider, and version. Show child fields `pipeline.stages[].on_failure.conditions[].rules[].rule_type_id.category` A category defines what kind of rule can be run in the stage, and constrains the provider type for the rule. Valid categories are limited to one of the following values. INVOKE Approval Rule `pipeline.stages[].on_failure.conditions[].rules[].rule_type_id.owner` The creator of the rule being called. The valid value for the `Owner` field in the rule category is `AWS`. `pipeline.stages[].on_failure.conditions[].rules[].rule_type_id.provider` The provider of the service being called by the rule. Valid providers are determined by the rulecategory. For example, a managed rule in the Rule category type has an owner of AWS, which would be specified as `AWS`. `pipeline.stages[].on_failure.conditions[].rules[].rule_type_id.version` A string that describes the rule version. `pipeline.stages[].on_failure.conditions[].rules[].timeout_in_minutes` The action timeout for the rule. `pipeline.stages[].on_failure.result` The specified result for when the failure conditions are met, such as rolling back the stage. `pipeline.stages[].on_success` The method to use when a stage has succeeded. For example, configuring this field for conditions will allow the stage to succeed when the conditions are met. Show child fields `pipeline.stages[].on_success.conditions[]` Show child fields `pipeline.stages[].on_success.conditions[].result` The action to be done when the condition is met. For example, rolling back an execution for a failure condition. `pipeline.stages[].on_success.conditions[].rules[]` Show child fields `pipeline.stages[].on_success.conditions[].rules[].configuration` The action configuration fields for the rule. `pipeline.stages[].on_success.conditions[].rules[].input_artifacts[]` Show child fields `pipeline.stages[].on_success.conditions[].rules[].input_artifacts[].name` 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. `pipeline.stages[].on_success.conditions[].rules[].name` The name of the rule that is created for the condition, such as CheckAllResults. `pipeline.stages[].on_success.conditions[].rules[].region` The Region for the condition associated with the rule. `pipeline.stages[].on_success.conditions[].rules[].role_arn` The pipeline role ARN associated with the rule. `pipeline.stages[].on_success.conditions[].rules[].rule_type_id` The ID for the rule type, which is made up of the combined values for category, owner, provider, and version. Show child fields `pipeline.stages[].on_success.conditions[].rules[].rule_type_id.category` A category defines what kind of rule can be run in the stage, and constrains the provider type for the rule. Valid categories are limited to one of the following values. INVOKE Approval Rule `pipeline.stages[].on_success.conditions[].rules[].rule_type_id.owner` The creator of the rule being called. The valid value for the `Owner` field in the rule category is `AWS`. `pipeline.stages[].on_success.conditions[].rules[].rule_type_id.provider` The provider of the service being called by the rule. Valid providers are determined by the rulecategory. For example, a managed rule in the Rule category type has an owner of AWS, which would be specified as `AWS`. `pipeline.stages[].on_success.conditions[].rules[].rule_type_id.version` A string that describes the rule version. `pipeline.stages[].on_success.conditions[].rules[].timeout_in_minutes` The action timeout for the rule. `pipeline.triggers[]` Show child fields `pipeline.triggers[].git_configuration` Provides the filter criteria and the source stage for the repository event that starts the pipeline, such as Git tags. Show child fields `pipeline.triggers[].git_configuration.pull_request[]` Show child fields `pipeline.triggers[].git_configuration.pull_request[].branches` The field that specifies to filter on branches for the pull request trigger configuration. Show child fields `pipeline.triggers[].git_configuration.pull_request[].branches.excludes[]` `pipeline.triggers[].git_configuration.pull_request[].branches.includes[]` `pipeline.triggers[].git_configuration.pull_request[].events[]` `pipeline.triggers[].git_configuration.pull_request[].file_paths` The field that specifies to filter on file paths for the pull request trigger configuration. Show child fields `pipeline.triggers[].git_configuration.pull_request[].file_paths.excludes[]` `pipeline.triggers[].git_configuration.pull_request[].file_paths.includes[]` `pipeline.triggers[].git_configuration.push[]` Show child fields `pipeline.triggers[].git_configuration.push[].branches` The field that specifies to filter on branches for the push trigger configuration. Show child fields `pipeline.triggers[].git_configuration.push[].branches.excludes[]` `pipeline.triggers[].git_configuration.push[].branches.includes[]` `pipeline.triggers[].git_configuration.push[].file_paths` The field that specifies to filter on file paths for the push trigger configuration. Show child fields `pipeline.triggers[].git_configuration.push[].file_paths.excludes[]` `pipeline.triggers[].git_configuration.push[].file_paths.includes[]` `pipeline.triggers[].git_configuration.push[].tags` The field that contains the details for the Git tags trigger configuration. Show child fields `pipeline.triggers[].git_configuration.push[].tags.excludes[]` `pipeline.triggers[].git_configuration.push[].tags.includes[]` `pipeline.triggers[].git_configuration.source_action_name` 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. You can only specify one trigger configuration per source action. `pipeline.triggers[].provider_type` The source provider for the event, such as connections configured for a repository with Git tags, for the specified trigger configuration. `pipeline.variables[]` Show child fields `pipeline.variables[].default_value` The value of a pipeline-level variable. `pipeline.variables[].description` 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. `pipeline.variables[].name` The name of a pipeline-level variable. `pipeline.version` 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.