2024/07/30 - AWS CodePipeline - 3 new 4 updated api methods
Changes AWS CodePipeline V2 type pipelines now support stage level conditions to enable development teams to safely release changes that meet quality and compliance requirements.
Lists the rules for the condition.
See also: AWS API Documentation
Request Syntax
client.list_rule_types(
ruleOwnerFilter='AWS',
regionFilter='string'
)
string
The rule owner to filter on.
string
The rule Region to filter on.
dict
Response Syntax
{
'ruleTypes': [
{
'id': {
'category': 'Rule',
'owner': 'AWS',
'provider': 'string',
'version': 'string'
},
'settings': {
'thirdPartyConfigurationUrl': 'string',
'entityUrlTemplate': 'string',
'executionUrlTemplate': 'string',
'revisionUrlTemplate': 'string'
},
'ruleConfigurationProperties': [
{
'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
}
},
]
}
Response Structure
(dict) --
ruleTypes (list) --
Lists the rules that are configured for the condition.
(dict) --
The rule type, which is made up of the combined values for category, owner, provider, and version.
id (dict) --
Represents information about a rule type.
category (string) --
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
owner (string) --
The creator of the rule being called. The valid value for the Owner field in the rule category is AWS .
provider (string) --
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 .
version (string) --
A string that describes the rule version.
settings (dict) --
Returns information about the settings for a rule 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 CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for a CodeDeploy deployment group. This link is provided as part of the action display in the pipeline.
executionUrlTemplate (string) --
The URL returned to the CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for CodeDeploy. This link is shown on the pipeline view page in the CodePipeline console and provides a link to the execution entity of the external action.
revisionUrlTemplate (string) --
The URL returned to the CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.
ruleConfigurationProperties (list) --
The configuration properties for the rule type.
(dict) --
Represents information about a rule configuration property.
name (string) --
The name of the rule 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.
When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.
queryable (boolean) --
Indicates whether the property can be queried.
If you create a pipeline with a condition and rule, and that rule contains a queryable property, the value for that configuration property is subject to other 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 is displayed to users.
type (string) --
The type of the configuration property.
inputArtifactDetails (dict) --
Returns information about the details of an artifact.
minimumCount (integer) --
The minimum number of artifacts allowed for the action type.
maximumCount (integer) --
The maximum number of artifacts allowed for the action type.
Used to override a stage condition.
See also: AWS API Documentation
Request Syntax
client.override_stage_condition(
pipelineName='string',
stageName='string',
pipelineExecutionId='string',
conditionType='BEFORE_ENTRY'|'ON_SUCCESS'
)
string
[REQUIRED]
The name of the pipeline with the stage that will override the condition.
string
[REQUIRED]
The name of the stage for the override.
string
[REQUIRED]
The ID of the pipeline execution for the override.
string
[REQUIRED]
The type of condition to override for the stage, such as entry conditions, failure conditions, or success conditions.
None
Lists the rule executions that have occurred in a pipeline configured for conditions with rules.
See also: AWS API Documentation
Request Syntax
client.list_rule_executions(
pipelineName='string',
filter={
'pipelineExecutionId': 'string',
'latestInPipelineExecution': {
'pipelineExecutionId': 'string',
'startTimeRange': 'Latest'|'All'
}
},
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The name of the pipeline for which you want to get execution summary information.
dict
Input information used to filter rule execution history.
pipelineExecutionId (string) --
The pipeline execution ID used to filter rule execution history.
latestInPipelineExecution (dict) --
The field that specifies to filter on the latest execution in the pipeline.
Note
Filtering on the latest execution is available for executions run on or after February 08, 2024.
pipelineExecutionId (string) -- [REQUIRED]
The execution ID for the latest execution in the pipeline.
startTimeRange (string) -- [REQUIRED]
The start time to filter on for the latest execution in the pipeline. Valid options:
All
Latest
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. Pipeline history is limited to the most recent 12 months, based on pipeline execution start times. Default value is 100.
string
The token that was returned from the previous ListRuleExecutions call, which can be used to return the next set of rule executions in the list.
dict
Response Syntax
{
'ruleExecutionDetails': [
{
'pipelineExecutionId': 'string',
'ruleExecutionId': 'string',
'pipelineVersion': 123,
'stageName': 'string',
'ruleName': 'string',
'startTime': datetime(2015, 1, 1),
'lastUpdateTime': datetime(2015, 1, 1),
'updatedBy': 'string',
'status': 'InProgress'|'Abandoned'|'Succeeded'|'Failed',
'input': {
'ruleTypeId': {
'category': 'Rule',
'owner': 'AWS',
'provider': 'string',
'version': 'string'
},
'configuration': {
'string': 'string'
},
'resolvedConfiguration': {
'string': 'string'
},
'roleArn': 'string',
'region': 'string',
'inputArtifacts': [
{
'name': 'string',
's3location': {
'bucket': 'string',
'key': 'string'
}
},
]
},
'output': {
'executionResult': {
'externalExecutionId': 'string',
'externalExecutionSummary': 'string',
'externalExecutionUrl': 'string',
'errorDetails': {
'code': 'string',
'message': 'string'
}
}
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
ruleExecutionDetails (list) --
Details about the output for listing rule executions.
(dict) --
The details of the runs for a rule and the results produced on an artifact as it passes through stages in the pipeline.
pipelineExecutionId (string) --
The ID of the pipeline execution in the stage where the rule was run. Use the GetPipelineState action to retrieve the current pipelineExecutionId of the stage.
ruleExecutionId (string) --
The ID of the run for the rule.
pipelineVersion (integer) --
The version number of the pipeline with the stage where the rule was run.
stageName (string) --
The name of the stage where the rule was run.
ruleName (string) --
The name of the rule that was run in the stage.
startTime (datetime) --
The start time of the rule execution.
lastUpdateTime (datetime) --
The date and time of the last change to the rule execution, in timestamp format.
updatedBy (string) --
The ARN of the user who changed the rule execution details.
status (string) --
The status of the rule execution. Status categories are InProgress , Succeeded , and Failed .
input (dict) --
Input details for the rule execution, such as role ARN, Region, and input artifacts.
ruleTypeId (dict) --
The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.
category (string) --
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
owner (string) --
The creator of the rule being called. The valid value for the Owner field in the rule category is AWS .
provider (string) --
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 .
version (string) --
A string that describes the rule version.
configuration (dict) --
Configuration data for a rule execution, such as the resolved values for that run.
(string) --
(string) --
resolvedConfiguration (dict) --
Configuration data for a rule execution with all variable references replaced with their real values for the execution.
(string) --
(string) --
roleArn (string) --
The ARN of the IAM service role that performs the declared rule. This is assumed through the roleArn for the pipeline.
region (string) --
The Amazon Web Services Region for the rule, such as us-east-1.
inputArtifacts (list) --
Details of input artifacts of the rule that correspond to the rule execution.
(dict) --
Artifact details for the action execution, such as the artifact location.
name (string) --
The artifact object name for the action execution.
s3location (dict) --
The Amazon S3 artifact location for the action execution.
bucket (string) --
The Amazon S3 artifact bucket for an action's artifacts.
key (string) --
The artifact name.
output (dict) --
Output details for the rule execution, such as the rule execution result.
executionResult (dict) --
Execution result information listed in the output details for a rule execution.
externalExecutionId (string) --
The external ID for the rule execution.
externalExecutionSummary (string) --
The external provider summary for the rule execution.
externalExecutionUrl (string) --
The deepest external link to the external resource (for example, a repository URL or deployment endpoint) that is used when running the rule.
errorDetails (dict) --
Represents information about an error in CodePipeline.
code (string) --
The system ID or number code of the error.
message (string) --
The text of the error message.
nextToken (string) --
A token that can be used in the next ListRuleExecutions call. To view all items in the list, continue to call this operation with each subsequent token until no more nextToken values are returned.
{'pipeline': {'stages': {'beforeEntry': {'conditions': [{'result': 'ROLLBACK | '
'FAIL',
'rules': [{'configuration': {'string': 'string'},
'inputArtifacts': [{'name': 'string'}],
'name': 'string',
'region': 'string',
'roleArn': 'string',
'ruleTypeId': {'category': 'Rule',
'owner': 'AWS',
'provider': 'string',
'version': 'string'},
'timeoutInMinutes': 'integer'}]}]},
'onFailure': {'conditions': [{'result': 'ROLLBACK | '
'FAIL',
'rules': [{'configuration': {'string': 'string'},
'inputArtifacts': [{'name': 'string'}],
'name': 'string',
'region': 'string',
'roleArn': 'string',
'ruleTypeId': {'category': 'Rule',
'owner': 'AWS',
'provider': 'string',
'version': 'string'},
'timeoutInMinutes': 'integer'}]}],
'result': {'FAIL'}},
'onSuccess': {'conditions': [{'result': 'ROLLBACK | '
'FAIL',
'rules': [{'configuration': {'string': 'string'},
'inputArtifacts': [{'name': 'string'}],
'name': 'string',
'region': 'string',
'roleArn': 'string',
'ruleTypeId': {'category': 'Rule',
'owner': 'AWS',
'provider': 'string',
'version': 'string'},
'timeoutInMinutes': 'integer'}]}]}}}}
Creates a pipeline.
Note
In the pipeline structure, 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 .
See also: AWS API Documentation
Request Syntax
client.create_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',
'timeoutInMinutes': 123
},
],
'onFailure': {
'result': 'ROLLBACK'|'FAIL',
'conditions': [
{
'result': 'ROLLBACK'|'FAIL',
'rules': [
{
'name': 'string',
'ruleTypeId': {
'category': 'Rule',
'owner': 'AWS',
'provider': 'string',
'version': 'string'
},
'configuration': {
'string': 'string'
},
'inputArtifacts': [
{
'name': 'string'
},
],
'roleArn': 'string',
'region': 'string',
'timeoutInMinutes': 123
},
]
},
]
},
'onSuccess': {
'conditions': [
{
'result': 'ROLLBACK'|'FAIL',
'rules': [
{
'name': 'string',
'ruleTypeId': {
'category': 'Rule',
'owner': 'AWS',
'provider': 'string',
'version': 'string'
},
'configuration': {
'string': 'string'
},
'inputArtifacts': [
{
'name': 'string'
},
],
'roleArn': 'string',
'region': 'string',
'timeoutInMinutes': 123
},
]
},
]
},
'beforeEntry': {
'conditions': [
{
'result': 'ROLLBACK'|'FAIL',
'rules': [
{
'name': 'string',
'ruleTypeId': {
'category': 'Rule',
'owner': 'AWS',
'provider': 'string',
'version': 'string'
},
'configuration': {
'string': 'string'
},
'inputArtifacts': [
{
'name': 'string'
},
],
'roleArn': 'string',
'region': 'string',
'timeoutInMinutes': 123
},
]
},
]
}
},
],
'version': 123,
'executionMode': 'QUEUED'|'SUPERSEDED'|'PARALLEL',
'pipelineType': 'V1'|'V2',
'variables': [
{
'name': 'string',
'defaultValue': 'string',
'description': 'string'
},
],
'triggers': [
{
'providerType': 'CodeStarSourceConnection',
'gitConfiguration': {
'sourceActionName': 'string',
'push': [
{
'tags': {
'includes': [
'string',
],
'excludes': [
'string',
]
},
'branches': {
'includes': [
'string',
],
'excludes': [
'string',
]
},
'filePaths': {
'includes': [
'string',
],
'excludes': [
'string',
]
}
},
],
'pullRequest': [
{
'events': [
'OPEN'|'UPDATED'|'CLOSED',
],
'branches': {
'includes': [
'string',
],
'excludes': [
'string',
]
},
'filePaths': {
'includes': [
'string',
],
'excludes': [
'string',
]
}
},
]
}
},
]
},
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
dict
[REQUIRED]
Represents the structure of actions and stages to be performed in the pipeline.
name (string) -- [REQUIRED]
The name of the pipeline.
roleArn (string) -- [REQUIRED]
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) -- [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 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) -- [REQUIRED]
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) -- [REQUIRED]
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) -- [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 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) -- [REQUIRED]
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) -- [REQUIRED]
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) -- [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 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 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) -- [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").
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.
timeoutInMinutes (integer) --
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.
onFailure (dict) --
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.
result (string) --
The specified result for when the failure conditions are met, such as rolling back the stage.
conditions (list) --
The conditions that are configured as failure conditions.
(dict) --
The condition for the stage. A condition is made up of the rules and the result for the condition.
result (string) --
The action to be done when the condition is met. For example, rolling back an execution for a failure condition.
rules (list) --
The rules that make up the condition.
(dict) --
Represents information about the rule to be created for an associated condition. An example would be creating a new rule for an entry condition, such as a rule that checks for a test result before allowing the run to enter the deployment stage.
name (string) -- [REQUIRED]
The name of the rule that is created for the condition, such as CheckAllResults.
ruleTypeId (dict) -- [REQUIRED]
The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.
category (string) -- [REQUIRED]
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
owner (string) --
The creator of the rule being called. The valid value for the Owner field in the rule category is AWS .
provider (string) -- [REQUIRED]
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 .
version (string) --
A string that describes the rule version.
configuration (dict) --
The action configuration fields for the rule.
(string) --
(string) --
inputArtifacts (list) --
The input artifacts fields for the rule, such as specifying an input file for the rule.
(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").
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 pipeline role ARN associated with the rule.
region (string) --
The Region for the condition associated with the rule.
timeoutInMinutes (integer) --
The action timeout for the rule.
onSuccess (dict) --
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.
conditions (list) -- [REQUIRED]
The conditions that are success conditions.
(dict) --
The condition for the stage. A condition is made up of the rules and the result for the condition.
result (string) --
The action to be done when the condition is met. For example, rolling back an execution for a failure condition.
rules (list) --
The rules that make up the condition.
(dict) --
Represents information about the rule to be created for an associated condition. An example would be creating a new rule for an entry condition, such as a rule that checks for a test result before allowing the run to enter the deployment stage.
name (string) -- [REQUIRED]
The name of the rule that is created for the condition, such as CheckAllResults.
ruleTypeId (dict) -- [REQUIRED]
The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.
category (string) -- [REQUIRED]
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
owner (string) --
The creator of the rule being called. The valid value for the Owner field in the rule category is AWS .
provider (string) -- [REQUIRED]
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 .
version (string) --
A string that describes the rule version.
configuration (dict) --
The action configuration fields for the rule.
(string) --
(string) --
inputArtifacts (list) --
The input artifacts fields for the rule, such as specifying an input file for the rule.
(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").
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 pipeline role ARN associated with the rule.
region (string) --
The Region for the condition associated with the rule.
timeoutInMinutes (integer) --
The action timeout for the rule.
beforeEntry (dict) --
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.
conditions (list) -- [REQUIRED]
The conditions that are configured as entry conditions.
(dict) --
The condition for the stage. A condition is made up of the rules and the result for the condition.
result (string) --
The action to be done when the condition is met. For example, rolling back an execution for a failure condition.
rules (list) --
The rules that make up the condition.
(dict) --
Represents information about the rule to be created for an associated condition. An example would be creating a new rule for an entry condition, such as a rule that checks for a test result before allowing the run to enter the deployment stage.
name (string) -- [REQUIRED]
The name of the rule that is created for the condition, such as CheckAllResults.
ruleTypeId (dict) -- [REQUIRED]
The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.
category (string) -- [REQUIRED]
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
owner (string) --
The creator of the rule being called. The valid value for the Owner field in the rule category is AWS .
provider (string) -- [REQUIRED]
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 .
version (string) --
A string that describes the rule version.
configuration (dict) --
The action configuration fields for the rule.
(string) --
(string) --
inputArtifacts (list) --
The input artifacts fields for the rule, such as specifying an input file for the rule.
(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").
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 pipeline role ARN associated with the rule.
region (string) --
The Region for the condition associated with the rule.
timeoutInMinutes (integer) --
The action timeout for the rule.
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.
executionMode (string) --
The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.
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?.
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.
name (string) -- [REQUIRED]
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.
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.
providerType (string) -- [REQUIRED]
The source provider for the event, such as connections configured for a repository with Git tags, for the specified trigger configuration.
gitConfiguration (dict) -- [REQUIRED]
Provides the filter criteria and the source stage for the repository event that starts the pipeline, such as Git tags.
sourceActionName (string) -- [REQUIRED]
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.
(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) --
branches (dict) --
The field that specifies to filter on branches for the push trigger configuration.
includes (list) --
The list of patterns of Git branches that, when a commit is pushed, are to be included as criteria that starts the pipeline.
(string) --
excludes (list) --
The list of patterns of Git branches that, when a commit is pushed, are to be excluded from starting the pipeline.
(string) --
filePaths (dict) --
The field that specifies to filter on file paths for the push trigger configuration.
includes (list) --
The list of patterns of Git repository file paths that, when a commit is pushed, are to be included as criteria that starts the pipeline.
(string) --
excludes (list) --
The list of patterns of Git repository file paths that, when a commit is pushed, are to be excluded from starting the pipeline.
(string) --
pullRequest (list) --
The field where the repository event that will start the pipeline is specified as pull requests.
(dict) --
The event criteria for the pull request trigger configuration, such as the lists of branches or file paths to include and exclude.
events (list) --
The field that specifies which pull request events to filter on (opened, updated, closed) for the trigger configuration.
(string) --
branches (dict) --
The field that specifies to filter on branches for the pull request trigger configuration.
includes (list) --
The list of patterns of Git branches that, when a commit is pushed, are to be included as criteria that starts the pipeline.
(string) --
excludes (list) --
The list of patterns of Git branches that, when a commit is pushed, are to be excluded from starting the pipeline.
(string) --
filePaths (dict) --
The field that specifies to filter on file paths for the pull request trigger configuration.
includes (list) --
The list of patterns of Git repository file paths that, when a commit is pushed, are to be included as criteria that starts the pipeline.
(string) --
excludes (list) --
The list of patterns of Git repository file paths that, when a commit is pushed, are to be excluded from starting the pipeline.
(string) --
list
The tags for the pipeline.
(dict) --
A tag is a key-value pair that is used to manage the resource.
key (string) -- [REQUIRED]
The tag's key.
value (string) -- [REQUIRED]
The tag's value.
dict
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',
'timeoutInMinutes': 123
},
],
'onFailure': {
'result': 'ROLLBACK'|'FAIL',
'conditions': [
{
'result': 'ROLLBACK'|'FAIL',
'rules': [
{
'name': 'string',
'ruleTypeId': {
'category': 'Rule',
'owner': 'AWS',
'provider': 'string',
'version': 'string'
},
'configuration': {
'string': 'string'
},
'inputArtifacts': [
{
'name': 'string'
},
],
'roleArn': 'string',
'region': 'string',
'timeoutInMinutes': 123
},
]
},
]
},
'onSuccess': {
'conditions': [
{
'result': 'ROLLBACK'|'FAIL',
'rules': [
{
'name': 'string',
'ruleTypeId': {
'category': 'Rule',
'owner': 'AWS',
'provider': 'string',
'version': 'string'
},
'configuration': {
'string': 'string'
},
'inputArtifacts': [
{
'name': 'string'
},
],
'roleArn': 'string',
'region': 'string',
'timeoutInMinutes': 123
},
]
},
]
},
'beforeEntry': {
'conditions': [
{
'result': 'ROLLBACK'|'FAIL',
'rules': [
{
'name': 'string',
'ruleTypeId': {
'category': 'Rule',
'owner': 'AWS',
'provider': 'string',
'version': 'string'
},
'configuration': {
'string': 'string'
},
'inputArtifacts': [
{
'name': 'string'
},
],
'roleArn': 'string',
'region': 'string',
'timeoutInMinutes': 123
},
]
},
]
}
},
],
'version': 123,
'executionMode': 'QUEUED'|'SUPERSEDED'|'PARALLEL',
'pipelineType': 'V1'|'V2',
'variables': [
{
'name': 'string',
'defaultValue': 'string',
'description': 'string'
},
],
'triggers': [
{
'providerType': 'CodeStarSourceConnection',
'gitConfiguration': {
'sourceActionName': 'string',
'push': [
{
'tags': {
'includes': [
'string',
],
'excludes': [
'string',
]
},
'branches': {
'includes': [
'string',
],
'excludes': [
'string',
]
},
'filePaths': {
'includes': [
'string',
],
'excludes': [
'string',
]
}
},
],
'pullRequest': [
{
'events': [
'OPEN'|'UPDATED'|'CLOSED',
],
'branches': {
'includes': [
'string',
],
'excludes': [
'string',
]
},
'filePaths': {
'includes': [
'string',
],
'excludes': [
'string',
]
}
},
]
}
},
]
},
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
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 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.
timeoutInMinutes (integer) --
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.
onFailure (dict) --
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.
result (string) --
The specified result for when the failure conditions are met, such as rolling back the stage.
conditions (list) --
The conditions that are configured as failure conditions.
(dict) --
The condition for the stage. A condition is made up of the rules and the result for the condition.
result (string) --
The action to be done when the condition is met. For example, rolling back an execution for a failure condition.
rules (list) --
The rules that make up the condition.
(dict) --
Represents information about the rule to be created for an associated condition. An example would be creating a new rule for an entry condition, such as a rule that checks for a test result before allowing the run to enter the deployment stage.
name (string) --
The name of the rule that is created for the condition, such as CheckAllResults.
ruleTypeId (dict) --
The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.
category (string) --
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
owner (string) --
The creator of the rule being called. The valid value for the Owner field in the rule category is AWS .
provider (string) --
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 .
version (string) --
A string that describes the rule version.
configuration (dict) --
The action configuration fields for the rule.
(string) --
(string) --
inputArtifacts (list) --
The input artifacts fields for the rule, such as specifying an input file for the rule.
(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 pipeline role ARN associated with the rule.
region (string) --
The Region for the condition associated with the rule.
timeoutInMinutes (integer) --
The action timeout for the rule.
onSuccess (dict) --
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.
conditions (list) --
The conditions that are success conditions.
(dict) --
The condition for the stage. A condition is made up of the rules and the result for the condition.
result (string) --
The action to be done when the condition is met. For example, rolling back an execution for a failure condition.
rules (list) --
The rules that make up the condition.
(dict) --
Represents information about the rule to be created for an associated condition. An example would be creating a new rule for an entry condition, such as a rule that checks for a test result before allowing the run to enter the deployment stage.
name (string) --
The name of the rule that is created for the condition, such as CheckAllResults.
ruleTypeId (dict) --
The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.
category (string) --
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
owner (string) --
The creator of the rule being called. The valid value for the Owner field in the rule category is AWS .
provider (string) --
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 .
version (string) --
A string that describes the rule version.
configuration (dict) --
The action configuration fields for the rule.
(string) --
(string) --
inputArtifacts (list) --
The input artifacts fields for the rule, such as specifying an input file for the rule.
(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 pipeline role ARN associated with the rule.
region (string) --
The Region for the condition associated with the rule.
timeoutInMinutes (integer) --
The action timeout for the rule.
beforeEntry (dict) --
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.
conditions (list) --
The conditions that are configured as entry conditions.
(dict) --
The condition for the stage. A condition is made up of the rules and the result for the condition.
result (string) --
The action to be done when the condition is met. For example, rolling back an execution for a failure condition.
rules (list) --
The rules that make up the condition.
(dict) --
Represents information about the rule to be created for an associated condition. An example would be creating a new rule for an entry condition, such as a rule that checks for a test result before allowing the run to enter the deployment stage.
name (string) --
The name of the rule that is created for the condition, such as CheckAllResults.
ruleTypeId (dict) --
The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.
category (string) --
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
owner (string) --
The creator of the rule being called. The valid value for the Owner field in the rule category is AWS .
provider (string) --
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 .
version (string) --
A string that describes the rule version.
configuration (dict) --
The action configuration fields for the rule.
(string) --
(string) --
inputArtifacts (list) --
The input artifacts fields for the rule, such as specifying an input file for the rule.
(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 pipeline role ARN associated with the rule.
region (string) --
The Region for the condition associated with the rule.
timeoutInMinutes (integer) --
The action timeout for the rule.
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.
executionMode (string) --
The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.
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?.
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.
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.
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.
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.
(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) --
branches (dict) --
The field that specifies to filter on branches for the push trigger configuration.
includes (list) --
The list of patterns of Git branches that, when a commit is pushed, are to be included as criteria that starts the pipeline.
(string) --
excludes (list) --
The list of patterns of Git branches that, when a commit is pushed, are to be excluded from starting the pipeline.
(string) --
filePaths (dict) --
The field that specifies to filter on file paths for the push trigger configuration.
includes (list) --
The list of patterns of Git repository file paths that, when a commit is pushed, are to be included as criteria that starts the pipeline.
(string) --
excludes (list) --
The list of patterns of Git repository file paths that, when a commit is pushed, are to be excluded from starting the pipeline.
(string) --
pullRequest (list) --
The field where the repository event that will start the pipeline is specified as pull requests.
(dict) --
The event criteria for the pull request trigger configuration, such as the lists of branches or file paths to include and exclude.
events (list) --
The field that specifies which pull request events to filter on (opened, updated, closed) for the trigger configuration.
(string) --
branches (dict) --
The field that specifies to filter on branches for the pull request trigger configuration.
includes (list) --
The list of patterns of Git branches that, when a commit is pushed, are to be included as criteria that starts the pipeline.
(string) --
excludes (list) --
The list of patterns of Git branches that, when a commit is pushed, are to be excluded from starting the pipeline.
(string) --
filePaths (dict) --
The field that specifies to filter on file paths for the pull request trigger configuration.
includes (list) --
The list of patterns of Git repository file paths that, when a commit is pushed, are to be included as criteria that starts the pipeline.
(string) --
excludes (list) --
The list of patterns of Git repository file paths that, when a commit is pushed, are to be excluded from starting the pipeline.
(string) --
tags (list) --
Specifies the tags applied to the pipeline.
(dict) --
A tag is a key-value pair that is used to manage the resource.
key (string) --
The tag's key.
value (string) --
The tag's value.
{'pipeline': {'stages': {'beforeEntry': {'conditions': [{'result': 'ROLLBACK | '
'FAIL',
'rules': [{'configuration': {'string': 'string'},
'inputArtifacts': [{'name': 'string'}],
'name': 'string',
'region': 'string',
'roleArn': 'string',
'ruleTypeId': {'category': 'Rule',
'owner': 'AWS',
'provider': 'string',
'version': 'string'},
'timeoutInMinutes': 'integer'}]}]},
'onFailure': {'conditions': [{'result': 'ROLLBACK | '
'FAIL',
'rules': [{'configuration': {'string': 'string'},
'inputArtifacts': [{'name': 'string'}],
'name': 'string',
'region': 'string',
'roleArn': 'string',
'ruleTypeId': {'category': 'Rule',
'owner': 'AWS',
'provider': 'string',
'version': 'string'},
'timeoutInMinutes': 'integer'}]}],
'result': {'FAIL'}},
'onSuccess': {'conditions': [{'result': 'ROLLBACK | '
'FAIL',
'rules': [{'configuration': {'string': 'string'},
'inputArtifacts': [{'name': 'string'}],
'name': 'string',
'region': 'string',
'roleArn': 'string',
'ruleTypeId': {'category': 'Rule',
'owner': 'AWS',
'provider': 'string',
'version': 'string'},
'timeoutInMinutes': 'integer'}]}]}}}}
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
client.get_pipeline(
name='string',
version=123
)
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.
integer
The version number of the pipeline. If you do not specify a version, defaults to the current version.
dict
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',
'timeoutInMinutes': 123
},
],
'onFailure': {
'result': 'ROLLBACK'|'FAIL',
'conditions': [
{
'result': 'ROLLBACK'|'FAIL',
'rules': [
{
'name': 'string',
'ruleTypeId': {
'category': 'Rule',
'owner': 'AWS',
'provider': 'string',
'version': 'string'
},
'configuration': {
'string': 'string'
},
'inputArtifacts': [
{
'name': 'string'
},
],
'roleArn': 'string',
'region': 'string',
'timeoutInMinutes': 123
},
]
},
]
},
'onSuccess': {
'conditions': [
{
'result': 'ROLLBACK'|'FAIL',
'rules': [
{
'name': 'string',
'ruleTypeId': {
'category': 'Rule',
'owner': 'AWS',
'provider': 'string',
'version': 'string'
},
'configuration': {
'string': 'string'
},
'inputArtifacts': [
{
'name': 'string'
},
],
'roleArn': 'string',
'region': 'string',
'timeoutInMinutes': 123
},
]
},
]
},
'beforeEntry': {
'conditions': [
{
'result': 'ROLLBACK'|'FAIL',
'rules': [
{
'name': 'string',
'ruleTypeId': {
'category': 'Rule',
'owner': 'AWS',
'provider': 'string',
'version': 'string'
},
'configuration': {
'string': 'string'
},
'inputArtifacts': [
{
'name': 'string'
},
],
'roleArn': 'string',
'region': 'string',
'timeoutInMinutes': 123
},
]
},
]
}
},
],
'version': 123,
'executionMode': 'QUEUED'|'SUPERSEDED'|'PARALLEL',
'pipelineType': 'V1'|'V2',
'variables': [
{
'name': 'string',
'defaultValue': 'string',
'description': 'string'
},
],
'triggers': [
{
'providerType': 'CodeStarSourceConnection',
'gitConfiguration': {
'sourceActionName': 'string',
'push': [
{
'tags': {
'includes': [
'string',
],
'excludes': [
'string',
]
},
'branches': {
'includes': [
'string',
],
'excludes': [
'string',
]
},
'filePaths': {
'includes': [
'string',
],
'excludes': [
'string',
]
}
},
],
'pullRequest': [
{
'events': [
'OPEN'|'UPDATED'|'CLOSED',
],
'branches': {
'includes': [
'string',
],
'excludes': [
'string',
]
},
'filePaths': {
'includes': [
'string',
],
'excludes': [
'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.
timeoutInMinutes (integer) --
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.
onFailure (dict) --
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.
result (string) --
The specified result for when the failure conditions are met, such as rolling back the stage.
conditions (list) --
The conditions that are configured as failure conditions.
(dict) --
The condition for the stage. A condition is made up of the rules and the result for the condition.
result (string) --
The action to be done when the condition is met. For example, rolling back an execution for a failure condition.
rules (list) --
The rules that make up the condition.
(dict) --
Represents information about the rule to be created for an associated condition. An example would be creating a new rule for an entry condition, such as a rule that checks for a test result before allowing the run to enter the deployment stage.
name (string) --
The name of the rule that is created for the condition, such as CheckAllResults.
ruleTypeId (dict) --
The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.
category (string) --
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
owner (string) --
The creator of the rule being called. The valid value for the Owner field in the rule category is AWS .
provider (string) --
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 .
version (string) --
A string that describes the rule version.
configuration (dict) --
The action configuration fields for the rule.
(string) --
(string) --
inputArtifacts (list) --
The input artifacts fields for the rule, such as specifying an input file for the rule.
(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 pipeline role ARN associated with the rule.
region (string) --
The Region for the condition associated with the rule.
timeoutInMinutes (integer) --
The action timeout for the rule.
onSuccess (dict) --
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.
conditions (list) --
The conditions that are success conditions.
(dict) --
The condition for the stage. A condition is made up of the rules and the result for the condition.
result (string) --
The action to be done when the condition is met. For example, rolling back an execution for a failure condition.
rules (list) --
The rules that make up the condition.
(dict) --
Represents information about the rule to be created for an associated condition. An example would be creating a new rule for an entry condition, such as a rule that checks for a test result before allowing the run to enter the deployment stage.
name (string) --
The name of the rule that is created for the condition, such as CheckAllResults.
ruleTypeId (dict) --
The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.
category (string) --
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
owner (string) --
The creator of the rule being called. The valid value for the Owner field in the rule category is AWS .
provider (string) --
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 .
version (string) --
A string that describes the rule version.
configuration (dict) --
The action configuration fields for the rule.
(string) --
(string) --
inputArtifacts (list) --
The input artifacts fields for the rule, such as specifying an input file for the rule.
(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 pipeline role ARN associated with the rule.
region (string) --
The Region for the condition associated with the rule.
timeoutInMinutes (integer) --
The action timeout for the rule.
beforeEntry (dict) --
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.
conditions (list) --
The conditions that are configured as entry conditions.
(dict) --
The condition for the stage. A condition is made up of the rules and the result for the condition.
result (string) --
The action to be done when the condition is met. For example, rolling back an execution for a failure condition.
rules (list) --
The rules that make up the condition.
(dict) --
Represents information about the rule to be created for an associated condition. An example would be creating a new rule for an entry condition, such as a rule that checks for a test result before allowing the run to enter the deployment stage.
name (string) --
The name of the rule that is created for the condition, such as CheckAllResults.
ruleTypeId (dict) --
The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.
category (string) --
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
owner (string) --
The creator of the rule being called. The valid value for the Owner field in the rule category is AWS .
provider (string) --
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 .
version (string) --
A string that describes the rule version.
configuration (dict) --
The action configuration fields for the rule.
(string) --
(string) --
inputArtifacts (list) --
The input artifacts fields for the rule, such as specifying an input file for the rule.
(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 pipeline role ARN associated with the rule.
region (string) --
The Region for the condition associated with the rule.
timeoutInMinutes (integer) --
The action timeout for the rule.
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.
executionMode (string) --
The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.
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?.
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.
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.
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.
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.
(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) --
branches (dict) --
The field that specifies to filter on branches for the push trigger configuration.
includes (list) --
The list of patterns of Git branches that, when a commit is pushed, are to be included as criteria that starts the pipeline.
(string) --
excludes (list) --
The list of patterns of Git branches that, when a commit is pushed, are to be excluded from starting the pipeline.
(string) --
filePaths (dict) --
The field that specifies to filter on file paths for the push trigger configuration.
includes (list) --
The list of patterns of Git repository file paths that, when a commit is pushed, are to be included as criteria that starts the pipeline.
(string) --
excludes (list) --
The list of patterns of Git repository file paths that, when a commit is pushed, are to be excluded from starting the pipeline.
(string) --
pullRequest (list) --
The field where the repository event that will start the pipeline is specified as pull requests.
(dict) --
The event criteria for the pull request trigger configuration, such as the lists of branches or file paths to include and exclude.
events (list) --
The field that specifies which pull request events to filter on (opened, updated, closed) for the trigger configuration.
(string) --
branches (dict) --
The field that specifies to filter on branches for the pull request trigger configuration.
includes (list) --
The list of patterns of Git branches that, when a commit is pushed, are to be included as criteria that starts the pipeline.
(string) --
excludes (list) --
The list of patterns of Git branches that, when a commit is pushed, are to be excluded from starting the pipeline.
(string) --
filePaths (dict) --
The field that specifies to filter on file paths for the pull request trigger configuration.
includes (list) --
The list of patterns of Git repository file paths that, when a commit is pushed, are to be included as criteria that starts the pipeline.
(string) --
excludes (list) --
The list of patterns of Git repository file paths that, when a commit is pushed, are to be excluded from starting the pipeline.
(string) --
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.
{'stageStates': {'beforeEntryConditionState': {'conditionStates': [{'latestExecution': {'lastStatusChange': 'timestamp',
'status': 'InProgress '
'| '
'Failed '
'| '
'Errored '
'| '
'Succeeded '
'| '
'Cancelled '
'| '
'Abandoned '
'| '
'Overridden',
'summary': 'string'},
'ruleStates': [{'currentRevision': {'created': 'timestamp',
'revisionChangeId': 'string',
'revisionId': 'string'},
'entityUrl': 'string',
'latestExecution': {'errorDetails': {'code': 'string',
'message': 'string'},
'externalExecutionId': 'string',
'externalExecutionUrl': 'string',
'lastStatusChange': 'timestamp',
'lastUpdatedBy': 'string',
'ruleExecutionId': 'string',
'status': 'InProgress '
'| '
'Abandoned '
'| '
'Succeeded '
'| '
'Failed',
'summary': 'string',
'token': 'string'},
'revisionUrl': 'string',
'ruleName': 'string'}]}],
'latestExecution': {'status': 'InProgress '
'| '
'Failed '
'| '
'Errored '
'| '
'Succeeded '
'| '
'Cancelled '
'| '
'Abandoned '
'| '
'Overridden',
'summary': 'string'}},
'onFailureConditionState': {'conditionStates': [{'latestExecution': {'lastStatusChange': 'timestamp',
'status': 'InProgress '
'| '
'Failed '
'| '
'Errored '
'| '
'Succeeded '
'| '
'Cancelled '
'| '
'Abandoned '
'| '
'Overridden',
'summary': 'string'},
'ruleStates': [{'currentRevision': {'created': 'timestamp',
'revisionChangeId': 'string',
'revisionId': 'string'},
'entityUrl': 'string',
'latestExecution': {'errorDetails': {'code': 'string',
'message': 'string'},
'externalExecutionId': 'string',
'externalExecutionUrl': 'string',
'lastStatusChange': 'timestamp',
'lastUpdatedBy': 'string',
'ruleExecutionId': 'string',
'status': 'InProgress '
'| '
'Abandoned '
'| '
'Succeeded '
'| '
'Failed',
'summary': 'string',
'token': 'string'},
'revisionUrl': 'string',
'ruleName': 'string'}]}],
'latestExecution': {'status': 'InProgress '
'| '
'Failed '
'| '
'Errored '
'| '
'Succeeded '
'| '
'Cancelled '
'| '
'Abandoned '
'| '
'Overridden',
'summary': 'string'}},
'onSuccessConditionState': {'conditionStates': [{'latestExecution': {'lastStatusChange': 'timestamp',
'status': 'InProgress '
'| '
'Failed '
'| '
'Errored '
'| '
'Succeeded '
'| '
'Cancelled '
'| '
'Abandoned '
'| '
'Overridden',
'summary': 'string'},
'ruleStates': [{'currentRevision': {'created': 'timestamp',
'revisionChangeId': 'string',
'revisionId': 'string'},
'entityUrl': 'string',
'latestExecution': {'errorDetails': {'code': 'string',
'message': 'string'},
'externalExecutionId': 'string',
'externalExecutionUrl': 'string',
'lastStatusChange': 'timestamp',
'lastUpdatedBy': 'string',
'ruleExecutionId': 'string',
'status': 'InProgress '
'| '
'Abandoned '
'| '
'Succeeded '
'| '
'Failed',
'summary': 'string',
'token': 'string'},
'revisionUrl': 'string',
'ruleName': 'string'}]}],
'latestExecution': {'status': 'InProgress '
'| '
'Failed '
'| '
'Errored '
'| '
'Succeeded '
'| '
'Cancelled '
'| '
'Abandoned '
'| '
'Overridden',
'summary': 'string'}}}}
Returns information about the state of a pipeline, including the stages and actions.
Note
Values returned in the revisionId and revisionUrl fields indicate the source revision information, such as the commit ID, for the current state.
See also: AWS API Documentation
Request Syntax
client.get_pipeline_state(
name='string'
)
string
[REQUIRED]
The name of the pipeline about which you want to get information.
dict
Response Syntax
{
'pipelineName': 'string',
'pipelineVersion': 123,
'stageStates': [
{
'stageName': 'string',
'inboundExecution': {
'pipelineExecutionId': 'string',
'status': 'Cancelled'|'InProgress'|'Failed'|'Stopped'|'Stopping'|'Succeeded',
'type': 'STANDARD'|'ROLLBACK'
},
'inboundExecutions': [
{
'pipelineExecutionId': 'string',
'status': 'Cancelled'|'InProgress'|'Failed'|'Stopped'|'Stopping'|'Succeeded',
'type': 'STANDARD'|'ROLLBACK'
},
],
'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': {
'actionExecutionId': 'string',
'status': 'InProgress'|'Abandoned'|'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': 'Cancelled'|'InProgress'|'Failed'|'Stopped'|'Stopping'|'Succeeded',
'type': 'STANDARD'|'ROLLBACK'
},
'beforeEntryConditionState': {
'latestExecution': {
'status': 'InProgress'|'Failed'|'Errored'|'Succeeded'|'Cancelled'|'Abandoned'|'Overridden',
'summary': 'string'
},
'conditionStates': [
{
'latestExecution': {
'status': 'InProgress'|'Failed'|'Errored'|'Succeeded'|'Cancelled'|'Abandoned'|'Overridden',
'summary': 'string',
'lastStatusChange': datetime(2015, 1, 1)
},
'ruleStates': [
{
'ruleName': 'string',
'currentRevision': {
'revisionId': 'string',
'revisionChangeId': 'string',
'created': datetime(2015, 1, 1)
},
'latestExecution': {
'ruleExecutionId': 'string',
'status': 'InProgress'|'Abandoned'|'Succeeded'|'Failed',
'summary': 'string',
'lastStatusChange': datetime(2015, 1, 1),
'token': 'string',
'lastUpdatedBy': 'string',
'externalExecutionId': 'string',
'externalExecutionUrl': 'string',
'errorDetails': {
'code': 'string',
'message': 'string'
}
},
'entityUrl': 'string',
'revisionUrl': 'string'
},
]
},
]
},
'onSuccessConditionState': {
'latestExecution': {
'status': 'InProgress'|'Failed'|'Errored'|'Succeeded'|'Cancelled'|'Abandoned'|'Overridden',
'summary': 'string'
},
'conditionStates': [
{
'latestExecution': {
'status': 'InProgress'|'Failed'|'Errored'|'Succeeded'|'Cancelled'|'Abandoned'|'Overridden',
'summary': 'string',
'lastStatusChange': datetime(2015, 1, 1)
},
'ruleStates': [
{
'ruleName': 'string',
'currentRevision': {
'revisionId': 'string',
'revisionChangeId': 'string',
'created': datetime(2015, 1, 1)
},
'latestExecution': {
'ruleExecutionId': 'string',
'status': 'InProgress'|'Abandoned'|'Succeeded'|'Failed',
'summary': 'string',
'lastStatusChange': datetime(2015, 1, 1),
'token': 'string',
'lastUpdatedBy': 'string',
'externalExecutionId': 'string',
'externalExecutionUrl': 'string',
'errorDetails': {
'code': 'string',
'message': 'string'
}
},
'entityUrl': 'string',
'revisionUrl': 'string'
},
]
},
]
},
'onFailureConditionState': {
'latestExecution': {
'status': 'InProgress'|'Failed'|'Errored'|'Succeeded'|'Cancelled'|'Abandoned'|'Overridden',
'summary': 'string'
},
'conditionStates': [
{
'latestExecution': {
'status': 'InProgress'|'Failed'|'Errored'|'Succeeded'|'Cancelled'|'Abandoned'|'Overridden',
'summary': 'string',
'lastStatusChange': datetime(2015, 1, 1)
},
'ruleStates': [
{
'ruleName': 'string',
'currentRevision': {
'revisionId': 'string',
'revisionChangeId': 'string',
'created': datetime(2015, 1, 1)
},
'latestExecution': {
'ruleExecutionId': 'string',
'status': 'InProgress'|'Abandoned'|'Succeeded'|'Failed',
'summary': 'string',
'lastStatusChange': datetime(2015, 1, 1),
'token': 'string',
'lastUpdatedBy': 'string',
'externalExecutionId': 'string',
'externalExecutionUrl': 'string',
'errorDetails': {
'code': 'string',
'message': 'string'
}
},
'entityUrl': 'string',
'revisionUrl': 'string'
},
]
},
]
}
},
],
'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.
inboundExecution (dict) --
Represents information about the run of a stage.
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.
Note
A status of cancelled means that the pipeline’s definition was updated before the stage execution could be completed.
type (string) --
The type of pipeline execution for the stage, such as a rollback pipeline execution.
inboundExecutions (list) --
The inbound executions for a stage.
(dict) --
Represents information about the run of a stage.
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.
Note
A status of cancelled means that the pipeline’s definition was updated before the stage execution could be completed.
type (string) --
The type of pipeline execution for the stage, such as a rollback pipeline execution.
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.
actionExecutionId (string) --
ID of the workflow action execution in the current stage. Use the GetPipelineState action to retrieve the current action execution details of the current stage.
Note
For older executions, this field might be empty. The action execution ID is available for executions run on or after March 2020.
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. It 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 Amazon Web Services that is 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 Amazon Web Services.
code (string) --
The system ID or 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.
Note
A status of cancelled means that the pipeline’s definition was updated before the stage execution could be completed.
type (string) --
The type of pipeline execution for the stage, such as a rollback pipeline execution.
beforeEntryConditionState (dict) --
The state of the entry conditions for a stage.
latestExecution (dict) --
Represents information about the latest run of a condition for a stage.
status (string) --
The status of a run of a condition for a stage.
summary (string) --
A summary of the run of the condition for a stage.
conditionStates (list) --
The states of the conditions for a run of a condition for a stage.
(dict) --
Information about the state of the condition.
latestExecution (dict) --
The state of the latest run of the rule.
status (string) --
The status of the run for a condition.
summary (string) --
The summary of information about a run for a condition.
lastStatusChange (datetime) --
The last status change of the condition.
ruleStates (list) --
The state of the rules for the condition.
(dict) --
Returns information about the state of a rule.
Note
Values returned in the revisionId field indicate the rule revision information, such as the commit ID, for the current state.
ruleName (string) --
The name of the rule.
currentRevision (dict) --
The ID of the current revision of the artifact successfully worked on by the job.
revisionId (string) --
The system-generated unique ID that identifies the revision number of the rule.
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 rule was created, in timestamp format.
latestExecution (dict) --
Represents information about the latest run of an rule.
ruleExecutionId (string) --
The execution ID for the run of the rule.
status (string) --
The status of the run of the rule, such as FAILED.
summary (string) --
A summary of the run of the rule.
lastStatusChange (datetime) --
The last status change of the rule.
token (string) --
The system-generated token used to identify a unique request.
lastUpdatedBy (string) --
The ARN of the user who last changed the rule.
externalExecutionId (string) --
The external ID of the run of the rule.
externalExecutionUrl (string) --
The URL of a resource external to Amazon Web Services that is used when running the rule (for example, an external repository URL).
errorDetails (dict) --
Represents information about an error in CodePipeline.
code (string) --
The system ID or 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 details page.
revisionUrl (string) --
A URL link for more information about the revision, such as a commit details page.
onSuccessConditionState (dict) --
The state of the success conditions for a stage.
latestExecution (dict) --
Represents information about the latest run of a condition for a stage.
status (string) --
The status of a run of a condition for a stage.
summary (string) --
A summary of the run of the condition for a stage.
conditionStates (list) --
The states of the conditions for a run of a condition for a stage.
(dict) --
Information about the state of the condition.
latestExecution (dict) --
The state of the latest run of the rule.
status (string) --
The status of the run for a condition.
summary (string) --
The summary of information about a run for a condition.
lastStatusChange (datetime) --
The last status change of the condition.
ruleStates (list) --
The state of the rules for the condition.
(dict) --
Returns information about the state of a rule.
Note
Values returned in the revisionId field indicate the rule revision information, such as the commit ID, for the current state.
ruleName (string) --
The name of the rule.
currentRevision (dict) --
The ID of the current revision of the artifact successfully worked on by the job.
revisionId (string) --
The system-generated unique ID that identifies the revision number of the rule.
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 rule was created, in timestamp format.
latestExecution (dict) --
Represents information about the latest run of an rule.
ruleExecutionId (string) --
The execution ID for the run of the rule.
status (string) --
The status of the run of the rule, such as FAILED.
summary (string) --
A summary of the run of the rule.
lastStatusChange (datetime) --
The last status change of the rule.
token (string) --
The system-generated token used to identify a unique request.
lastUpdatedBy (string) --
The ARN of the user who last changed the rule.
externalExecutionId (string) --
The external ID of the run of the rule.
externalExecutionUrl (string) --
The URL of a resource external to Amazon Web Services that is used when running the rule (for example, an external repository URL).
errorDetails (dict) --
Represents information about an error in CodePipeline.
code (string) --
The system ID or 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 details page.
revisionUrl (string) --
A URL link for more information about the revision, such as a commit details page.
onFailureConditionState (dict) --
The state of the failure conditions for a stage.
latestExecution (dict) --
Represents information about the latest run of a condition for a stage.
status (string) --
The status of a run of a condition for a stage.
summary (string) --
A summary of the run of the condition for a stage.
conditionStates (list) --
The states of the conditions for a run of a condition for a stage.
(dict) --
Information about the state of the condition.
latestExecution (dict) --
The state of the latest run of the rule.
status (string) --
The status of the run for a condition.
summary (string) --
The summary of information about a run for a condition.
lastStatusChange (datetime) --
The last status change of the condition.
ruleStates (list) --
The state of the rules for the condition.
(dict) --
Returns information about the state of a rule.
Note
Values returned in the revisionId field indicate the rule revision information, such as the commit ID, for the current state.
ruleName (string) --
The name of the rule.
currentRevision (dict) --
The ID of the current revision of the artifact successfully worked on by the job.
revisionId (string) --
The system-generated unique ID that identifies the revision number of the rule.
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 rule was created, in timestamp format.
latestExecution (dict) --
Represents information about the latest run of an rule.
ruleExecutionId (string) --
The execution ID for the run of the rule.
status (string) --
The status of the run of the rule, such as FAILED.
summary (string) --
A summary of the run of the rule.
lastStatusChange (datetime) --
The last status change of the rule.
token (string) --
The system-generated token used to identify a unique request.
lastUpdatedBy (string) --
The ARN of the user who last changed the rule.
externalExecutionId (string) --
The external ID of the run of the rule.
externalExecutionUrl (string) --
The URL of a resource external to Amazon Web Services that is used when running the rule (for example, an external repository URL).
errorDetails (dict) --
Represents information about an error in CodePipeline.
code (string) --
The system ID or 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 details page.
revisionUrl (string) --
A URL link for more information about the revision, such as a commit details page.
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.
{'pipeline': {'stages': {'beforeEntry': {'conditions': [{'result': 'ROLLBACK | '
'FAIL',
'rules': [{'configuration': {'string': 'string'},
'inputArtifacts': [{'name': 'string'}],
'name': 'string',
'region': 'string',
'roleArn': 'string',
'ruleTypeId': {'category': 'Rule',
'owner': 'AWS',
'provider': 'string',
'version': 'string'},
'timeoutInMinutes': 'integer'}]}]},
'onFailure': {'conditions': [{'result': 'ROLLBACK | '
'FAIL',
'rules': [{'configuration': {'string': 'string'},
'inputArtifacts': [{'name': 'string'}],
'name': 'string',
'region': 'string',
'roleArn': 'string',
'ruleTypeId': {'category': 'Rule',
'owner': 'AWS',
'provider': 'string',
'version': 'string'},
'timeoutInMinutes': 'integer'}]}],
'result': {'FAIL'}},
'onSuccess': {'conditions': [{'result': 'ROLLBACK | '
'FAIL',
'rules': [{'configuration': {'string': 'string'},
'inputArtifacts': [{'name': 'string'}],
'name': 'string',
'region': 'string',
'roleArn': 'string',
'ruleTypeId': {'category': 'Rule',
'owner': 'AWS',
'provider': 'string',
'version': 'string'},
'timeoutInMinutes': 'integer'}]}]}}}}
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
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',
'timeoutInMinutes': 123
},
],
'onFailure': {
'result': 'ROLLBACK'|'FAIL',
'conditions': [
{
'result': 'ROLLBACK'|'FAIL',
'rules': [
{
'name': 'string',
'ruleTypeId': {
'category': 'Rule',
'owner': 'AWS',
'provider': 'string',
'version': 'string'
},
'configuration': {
'string': 'string'
},
'inputArtifacts': [
{
'name': 'string'
},
],
'roleArn': 'string',
'region': 'string',
'timeoutInMinutes': 123
},
]
},
]
},
'onSuccess': {
'conditions': [
{
'result': 'ROLLBACK'|'FAIL',
'rules': [
{
'name': 'string',
'ruleTypeId': {
'category': 'Rule',
'owner': 'AWS',
'provider': 'string',
'version': 'string'
},
'configuration': {
'string': 'string'
},
'inputArtifacts': [
{
'name': 'string'
},
],
'roleArn': 'string',
'region': 'string',
'timeoutInMinutes': 123
},
]
},
]
},
'beforeEntry': {
'conditions': [
{
'result': 'ROLLBACK'|'FAIL',
'rules': [
{
'name': 'string',
'ruleTypeId': {
'category': 'Rule',
'owner': 'AWS',
'provider': 'string',
'version': 'string'
},
'configuration': {
'string': 'string'
},
'inputArtifacts': [
{
'name': 'string'
},
],
'roleArn': 'string',
'region': 'string',
'timeoutInMinutes': 123
},
]
},
]
}
},
],
'version': 123,
'executionMode': 'QUEUED'|'SUPERSEDED'|'PARALLEL',
'pipelineType': 'V1'|'V2',
'variables': [
{
'name': 'string',
'defaultValue': 'string',
'description': 'string'
},
],
'triggers': [
{
'providerType': 'CodeStarSourceConnection',
'gitConfiguration': {
'sourceActionName': 'string',
'push': [
{
'tags': {
'includes': [
'string',
],
'excludes': [
'string',
]
},
'branches': {
'includes': [
'string',
],
'excludes': [
'string',
]
},
'filePaths': {
'includes': [
'string',
],
'excludes': [
'string',
]
}
},
],
'pullRequest': [
{
'events': [
'OPEN'|'UPDATED'|'CLOSED',
],
'branches': {
'includes': [
'string',
],
'excludes': [
'string',
]
},
'filePaths': {
'includes': [
'string',
],
'excludes': [
'string',
]
}
},
]
}
},
]
}
)
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 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 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) -- [REQUIRED]
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) -- [REQUIRED]
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) -- [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 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) -- [REQUIRED]
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) -- [REQUIRED]
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) -- [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 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 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) -- [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").
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.
timeoutInMinutes (integer) --
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.
onFailure (dict) --
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.
result (string) --
The specified result for when the failure conditions are met, such as rolling back the stage.
conditions (list) --
The conditions that are configured as failure conditions.
(dict) --
The condition for the stage. A condition is made up of the rules and the result for the condition.
result (string) --
The action to be done when the condition is met. For example, rolling back an execution for a failure condition.
rules (list) --
The rules that make up the condition.
(dict) --
Represents information about the rule to be created for an associated condition. An example would be creating a new rule for an entry condition, such as a rule that checks for a test result before allowing the run to enter the deployment stage.
name (string) -- [REQUIRED]
The name of the rule that is created for the condition, such as CheckAllResults.
ruleTypeId (dict) -- [REQUIRED]
The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.
category (string) -- [REQUIRED]
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
owner (string) --
The creator of the rule being called. The valid value for the Owner field in the rule category is AWS .
provider (string) -- [REQUIRED]
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 .
version (string) --
A string that describes the rule version.
configuration (dict) --
The action configuration fields for the rule.
(string) --
(string) --
inputArtifacts (list) --
The input artifacts fields for the rule, such as specifying an input file for the rule.
(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").
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 pipeline role ARN associated with the rule.
region (string) --
The Region for the condition associated with the rule.
timeoutInMinutes (integer) --
The action timeout for the rule.
onSuccess (dict) --
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.
conditions (list) -- [REQUIRED]
The conditions that are success conditions.
(dict) --
The condition for the stage. A condition is made up of the rules and the result for the condition.
result (string) --
The action to be done when the condition is met. For example, rolling back an execution for a failure condition.
rules (list) --
The rules that make up the condition.
(dict) --
Represents information about the rule to be created for an associated condition. An example would be creating a new rule for an entry condition, such as a rule that checks for a test result before allowing the run to enter the deployment stage.
name (string) -- [REQUIRED]
The name of the rule that is created for the condition, such as CheckAllResults.
ruleTypeId (dict) -- [REQUIRED]
The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.
category (string) -- [REQUIRED]
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
owner (string) --
The creator of the rule being called. The valid value for the Owner field in the rule category is AWS .
provider (string) -- [REQUIRED]
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 .
version (string) --
A string that describes the rule version.
configuration (dict) --
The action configuration fields for the rule.
(string) --
(string) --
inputArtifacts (list) --
The input artifacts fields for the rule, such as specifying an input file for the rule.
(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").
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 pipeline role ARN associated with the rule.
region (string) --
The Region for the condition associated with the rule.
timeoutInMinutes (integer) --
The action timeout for the rule.
beforeEntry (dict) --
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.
conditions (list) -- [REQUIRED]
The conditions that are configured as entry conditions.
(dict) --
The condition for the stage. A condition is made up of the rules and the result for the condition.
result (string) --
The action to be done when the condition is met. For example, rolling back an execution for a failure condition.
rules (list) --
The rules that make up the condition.
(dict) --
Represents information about the rule to be created for an associated condition. An example would be creating a new rule for an entry condition, such as a rule that checks for a test result before allowing the run to enter the deployment stage.
name (string) -- [REQUIRED]
The name of the rule that is created for the condition, such as CheckAllResults.
ruleTypeId (dict) -- [REQUIRED]
The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.
category (string) -- [REQUIRED]
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
owner (string) --
The creator of the rule being called. The valid value for the Owner field in the rule category is AWS .
provider (string) -- [REQUIRED]
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 .
version (string) --
A string that describes the rule version.
configuration (dict) --
The action configuration fields for the rule.
(string) --
(string) --
inputArtifacts (list) --
The input artifacts fields for the rule, such as specifying an input file for the rule.
(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").
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 pipeline role ARN associated with the rule.
region (string) --
The Region for the condition associated with the rule.
timeoutInMinutes (integer) --
The action timeout for the rule.
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.
executionMode (string) --
The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.
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?.
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.
name (string) -- [REQUIRED]
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.
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.
providerType (string) -- [REQUIRED]
The source provider for the event, such as connections configured for a repository with Git tags, for the specified trigger configuration.
gitConfiguration (dict) -- [REQUIRED]
Provides the filter criteria and the source stage for the repository event that starts the pipeline, such as Git tags.
sourceActionName (string) -- [REQUIRED]
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.
(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) --
branches (dict) --
The field that specifies to filter on branches for the push trigger configuration.
includes (list) --
The list of patterns of Git branches that, when a commit is pushed, are to be included as criteria that starts the pipeline.
(string) --
excludes (list) --
The list of patterns of Git branches that, when a commit is pushed, are to be excluded from starting the pipeline.
(string) --
filePaths (dict) --
The field that specifies to filter on file paths for the push trigger configuration.
includes (list) --
The list of patterns of Git repository file paths that, when a commit is pushed, are to be included as criteria that starts the pipeline.
(string) --
excludes (list) --
The list of patterns of Git repository file paths that, when a commit is pushed, are to be excluded from starting the pipeline.
(string) --
pullRequest (list) --
The field where the repository event that will start the pipeline is specified as pull requests.
(dict) --
The event criteria for the pull request trigger configuration, such as the lists of branches or file paths to include and exclude.
events (list) --
The field that specifies which pull request events to filter on (opened, updated, closed) for the trigger configuration.
(string) --
branches (dict) --
The field that specifies to filter on branches for the pull request trigger configuration.
includes (list) --
The list of patterns of Git branches that, when a commit is pushed, are to be included as criteria that starts the pipeline.
(string) --
excludes (list) --
The list of patterns of Git branches that, when a commit is pushed, are to be excluded from starting the pipeline.
(string) --
filePaths (dict) --
The field that specifies to filter on file paths for the pull request trigger configuration.
includes (list) --
The list of patterns of Git repository file paths that, when a commit is pushed, are to be included as criteria that starts the pipeline.
(string) --
excludes (list) --
The list of patterns of Git repository file paths that, when a commit is pushed, are to be excluded from starting the pipeline.
(string) --
dict
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',
'timeoutInMinutes': 123
},
],
'onFailure': {
'result': 'ROLLBACK'|'FAIL',
'conditions': [
{
'result': 'ROLLBACK'|'FAIL',
'rules': [
{
'name': 'string',
'ruleTypeId': {
'category': 'Rule',
'owner': 'AWS',
'provider': 'string',
'version': 'string'
},
'configuration': {
'string': 'string'
},
'inputArtifacts': [
{
'name': 'string'
},
],
'roleArn': 'string',
'region': 'string',
'timeoutInMinutes': 123
},
]
},
]
},
'onSuccess': {
'conditions': [
{
'result': 'ROLLBACK'|'FAIL',
'rules': [
{
'name': 'string',
'ruleTypeId': {
'category': 'Rule',
'owner': 'AWS',
'provider': 'string',
'version': 'string'
},
'configuration': {
'string': 'string'
},
'inputArtifacts': [
{
'name': 'string'
},
],
'roleArn': 'string',
'region': 'string',
'timeoutInMinutes': 123
},
]
},
]
},
'beforeEntry': {
'conditions': [
{
'result': 'ROLLBACK'|'FAIL',
'rules': [
{
'name': 'string',
'ruleTypeId': {
'category': 'Rule',
'owner': 'AWS',
'provider': 'string',
'version': 'string'
},
'configuration': {
'string': 'string'
},
'inputArtifacts': [
{
'name': 'string'
},
],
'roleArn': 'string',
'region': 'string',
'timeoutInMinutes': 123
},
]
},
]
}
},
],
'version': 123,
'executionMode': 'QUEUED'|'SUPERSEDED'|'PARALLEL',
'pipelineType': 'V1'|'V2',
'variables': [
{
'name': 'string',
'defaultValue': 'string',
'description': 'string'
},
],
'triggers': [
{
'providerType': 'CodeStarSourceConnection',
'gitConfiguration': {
'sourceActionName': 'string',
'push': [
{
'tags': {
'includes': [
'string',
],
'excludes': [
'string',
]
},
'branches': {
'includes': [
'string',
],
'excludes': [
'string',
]
},
'filePaths': {
'includes': [
'string',
],
'excludes': [
'string',
]
}
},
],
'pullRequest': [
{
'events': [
'OPEN'|'UPDATED'|'CLOSED',
],
'branches': {
'includes': [
'string',
],
'excludes': [
'string',
]
},
'filePaths': {
'includes': [
'string',
],
'excludes': [
'string',
]
}
},
]
}
},
]
}
}
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 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.
timeoutInMinutes (integer) --
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.
onFailure (dict) --
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.
result (string) --
The specified result for when the failure conditions are met, such as rolling back the stage.
conditions (list) --
The conditions that are configured as failure conditions.
(dict) --
The condition for the stage. A condition is made up of the rules and the result for the condition.
result (string) --
The action to be done when the condition is met. For example, rolling back an execution for a failure condition.
rules (list) --
The rules that make up the condition.
(dict) --
Represents information about the rule to be created for an associated condition. An example would be creating a new rule for an entry condition, such as a rule that checks for a test result before allowing the run to enter the deployment stage.
name (string) --
The name of the rule that is created for the condition, such as CheckAllResults.
ruleTypeId (dict) --
The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.
category (string) --
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
owner (string) --
The creator of the rule being called. The valid value for the Owner field in the rule category is AWS .
provider (string) --
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 .
version (string) --
A string that describes the rule version.
configuration (dict) --
The action configuration fields for the rule.
(string) --
(string) --
inputArtifacts (list) --
The input artifacts fields for the rule, such as specifying an input file for the rule.
(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 pipeline role ARN associated with the rule.
region (string) --
The Region for the condition associated with the rule.
timeoutInMinutes (integer) --
The action timeout for the rule.
onSuccess (dict) --
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.
conditions (list) --
The conditions that are success conditions.
(dict) --
The condition for the stage. A condition is made up of the rules and the result for the condition.
result (string) --
The action to be done when the condition is met. For example, rolling back an execution for a failure condition.
rules (list) --
The rules that make up the condition.
(dict) --
Represents information about the rule to be created for an associated condition. An example would be creating a new rule for an entry condition, such as a rule that checks for a test result before allowing the run to enter the deployment stage.
name (string) --
The name of the rule that is created for the condition, such as CheckAllResults.
ruleTypeId (dict) --
The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.
category (string) --
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
owner (string) --
The creator of the rule being called. The valid value for the Owner field in the rule category is AWS .
provider (string) --
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 .
version (string) --
A string that describes the rule version.
configuration (dict) --
The action configuration fields for the rule.
(string) --
(string) --
inputArtifacts (list) --
The input artifacts fields for the rule, such as specifying an input file for the rule.
(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 pipeline role ARN associated with the rule.
region (string) --
The Region for the condition associated with the rule.
timeoutInMinutes (integer) --
The action timeout for the rule.
beforeEntry (dict) --
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.
conditions (list) --
The conditions that are configured as entry conditions.
(dict) --
The condition for the stage. A condition is made up of the rules and the result for the condition.
result (string) --
The action to be done when the condition is met. For example, rolling back an execution for a failure condition.
rules (list) --
The rules that make up the condition.
(dict) --
Represents information about the rule to be created for an associated condition. An example would be creating a new rule for an entry condition, such as a rule that checks for a test result before allowing the run to enter the deployment stage.
name (string) --
The name of the rule that is created for the condition, such as CheckAllResults.
ruleTypeId (dict) --
The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.
category (string) --
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
owner (string) --
The creator of the rule being called. The valid value for the Owner field in the rule category is AWS .
provider (string) --
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 .
version (string) --
A string that describes the rule version.
configuration (dict) --
The action configuration fields for the rule.
(string) --
(string) --
inputArtifacts (list) --
The input artifacts fields for the rule, such as specifying an input file for the rule.
(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 pipeline role ARN associated with the rule.
region (string) --
The Region for the condition associated with the rule.
timeoutInMinutes (integer) --
The action timeout for the rule.
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.
executionMode (string) --
The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.
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?.
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.
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.
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.
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.
(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) --
branches (dict) --
The field that specifies to filter on branches for the push trigger configuration.
includes (list) --
The list of patterns of Git branches that, when a commit is pushed, are to be included as criteria that starts the pipeline.
(string) --
excludes (list) --
The list of patterns of Git branches that, when a commit is pushed, are to be excluded from starting the pipeline.
(string) --
filePaths (dict) --
The field that specifies to filter on file paths for the push trigger configuration.
includes (list) --
The list of patterns of Git repository file paths that, when a commit is pushed, are to be included as criteria that starts the pipeline.
(string) --
excludes (list) --
The list of patterns of Git repository file paths that, when a commit is pushed, are to be excluded from starting the pipeline.
(string) --
pullRequest (list) --
The field where the repository event that will start the pipeline is specified as pull requests.
(dict) --
The event criteria for the pull request trigger configuration, such as the lists of branches or file paths to include and exclude.
events (list) --
The field that specifies which pull request events to filter on (opened, updated, closed) for the trigger configuration.
(string) --
branches (dict) --
The field that specifies to filter on branches for the pull request trigger configuration.
includes (list) --
The list of patterns of Git branches that, when a commit is pushed, are to be included as criteria that starts the pipeline.
(string) --
excludes (list) --
The list of patterns of Git branches that, when a commit is pushed, are to be excluded from starting the pipeline.
(string) --
filePaths (dict) --
The field that specifies to filter on file paths for the pull request trigger configuration.
includes (list) --
The list of patterns of Git repository file paths that, when a commit is pushed, are to be included as criteria that starts the pipeline.
(string) --
excludes (list) --
The list of patterns of Git repository file paths that, when a commit is pushed, are to be excluded from starting the pipeline.
(string) --