2023/10/24 - AWS CodePipeline - 7 updated api methods
Changes Add ability to trigger pipelines from git tags, define variables at pipeline level and new pipeline type V2.
{'pipeline': {'pipelineType': 'V1 | V2',
'triggers': [{'gitConfiguration': {'push': [{'tags': {'excludes': ['string'],
'includes': ['string']}}],
'sourceActionName': 'string'},
'providerType': 'CodeStarSourceConnection'}],
'variables': [{'defaultValue': 'string',
'description': 'string',
'name': 'string'}]}}
Creates a pipeline.
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'
},
]
},
],
'version': 123,
'pipelineType': 'V1'|'V2',
'triggers': [
{
'providerType': 'CodeStarSourceConnection',
'gitConfiguration': {
'sourceActionName': 'string',
'push': [
{
'tags': {
'includes': [
'string',
],
'excludes': [
'string',
]
}
},
]
}
},
],
'variables': [
{
'name': 'string',
'defaultValue': 'string',
'description': '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.
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.
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.
(string) --
(dict) --
The S3 bucket where artifacts for the pipeline are stored.
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.
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.
version (integer) --
The version number of the pipeline. A new pipeline always has a version number of 1. This number is incremented when a pipeline is updated.
pipelineType (string) --
CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.
V1 type pipelines have a JSON structure that contains standard pipeline, stage, and action-level parameters.
V2 type pipelines have the same structure as a V1 type, along with additional parameters for release safety and trigger configuration.
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?.
triggers (list) --
The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.
(dict) --
Represents information about the specified trigger configuration, such as the filter criteria and the source stage for the action that contains the trigger.
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.
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) --
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.
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'
},
]
},
],
'version': 123,
'pipelineType': 'V1'|'V2',
'triggers': [
{
'providerType': 'CodeStarSourceConnection',
'gitConfiguration': {
'sourceActionName': 'string',
'push': [
{
'tags': {
'includes': [
'string',
],
'excludes': [
'string',
]
}
},
]
}
},
],
'variables': [
{
'name': 'string',
'defaultValue': 'string',
'description': '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.
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.
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.
(string) --
(dict) --
The S3 bucket where artifacts for the pipeline are stored.
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.
type (string) --
The type of encryption key, such as an Amazon Web Services KMS key. When creating or updating a pipeline, the value must be set to 'KMS'.
stages (list) --
The stage in which to perform the action.
(dict) --
Represents information about a stage and its definition.
name (string) --
The name of the stage.
blockers (list) --
Reserved for future use.
(dict) --
Reserved for future use.
name (string) --
Reserved for future use.
type (string) --
Reserved for future use.
actions (list) --
The actions included in a stage.
(dict) --
Represents information about an action declaration.
name (string) --
The action declaration's name.
actionTypeId (dict) --
Specifies the action type and the provider of the action.
category (string) --
A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the following values.
Source
Build
Test
Deploy
Invoke
Approval
owner (string) --
The creator of the action being called. There are three valid values for the Owner field in the action category section within your pipeline structure: AWS, ThirdParty, and Custom. For more information, see Valid Action Types and Providers in CodePipeline.
provider (string) --
The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of CodeDeploy, which would be specified as CodeDeploy. For more information, see Valid Action Types and Providers in CodePipeline.
version (string) --
A string that describes the action version.
runOrder (integer) --
The order in which actions are run.
configuration (dict) --
The action's configuration. These are key-value pairs that specify input values for an action. For more information, see Action Structure Requirements in CodePipeline. For the list of configuration properties for the CloudFormation action type in CodePipeline, see Configuration Properties Reference in the CloudFormation User Guide. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the CloudFormation User Guide.
The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows:
JSON:
"Configuration" : { Key : Value },
(string) --
(string) --
outputArtifacts (list) --
The name or ID of the result of the action declaration, such as a test or build artifact.
(dict) --
Represents information about the output of an action.
name (string) --
The name of the output of an artifact, such as "My App".
The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
Output artifact names must be unique within a pipeline.
inputArtifacts (list) --
The name or ID of the artifact consumed by the action, such as a test or build artifact.
(dict) --
Represents information about an artifact to be worked on, such as a test or build artifact.
name (string) --
The name of the artifact to be worked on (for example, "My App").
Artifacts are the files that are worked on by actions in the pipeline. See the action configuration for each action for details about artifact parameters. For example, the S3 source action input artifact is a file name (or file path), and the files are generally provided as a ZIP file. Example artifact name: SampleApp_Windows.zip
The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
roleArn (string) --
The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
region (string) --
The action declaration's Amazon Web Services Region, such as us-east-1.
namespace (string) --
The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
version (integer) --
The version number of the pipeline. A new pipeline always has a version number of 1. This number is incremented when a pipeline is updated.
pipelineType (string) --
CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.
V1 type pipelines have a JSON structure that contains standard pipeline, stage, and action-level parameters.
V2 type pipelines have the same structure as a V1 type, along with additional parameters for release safety and trigger configuration.
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?.
triggers (list) --
The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.
(dict) --
Represents information about the specified trigger configuration, such as the filter criteria and the source stage for the action that contains the trigger.
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.
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) --
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.
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': {'pipelineType': 'V1 | V2',
'triggers': [{'gitConfiguration': {'push': [{'tags': {'excludes': ['string'],
'includes': ['string']}}],
'sourceActionName': 'string'},
'providerType': 'CodeStarSourceConnection'}],
'variables': [{'defaultValue': 'string',
'description': 'string',
'name': 'string'}]}}
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'
},
]
},
],
'version': 123,
'pipelineType': 'V1'|'V2',
'triggers': [
{
'providerType': 'CodeStarSourceConnection',
'gitConfiguration': {
'sourceActionName': 'string',
'push': [
{
'tags': {
'includes': [
'string',
],
'excludes': [
'string',
]
}
},
]
}
},
],
'variables': [
{
'name': 'string',
'defaultValue': 'string',
'description': 'string'
},
]
},
'metadata': {
'pipelineArn': 'string',
'created': datetime(2015, 1, 1),
'updated': datetime(2015, 1, 1),
'pollingDisabledAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Represents the output of a GetPipeline action.
pipeline (dict) --
Represents the structure of actions and stages to be performed in the pipeline.
name (string) --
The name of the pipeline.
roleArn (string) --
The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.
artifactStore (dict) --
Represents information about the S3 bucket where artifacts are stored for the pipeline.
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.
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.
(string) --
(dict) --
The S3 bucket where artifacts for the pipeline are stored.
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.
type (string) --
The type of encryption key, such as an Amazon Web Services KMS key. When creating or updating a pipeline, the value must be set to 'KMS'.
stages (list) --
The stage in which to perform the action.
(dict) --
Represents information about a stage and its definition.
name (string) --
The name of the stage.
blockers (list) --
Reserved for future use.
(dict) --
Reserved for future use.
name (string) --
Reserved for future use.
type (string) --
Reserved for future use.
actions (list) --
The actions included in a stage.
(dict) --
Represents information about an action declaration.
name (string) --
The action declaration's name.
actionTypeId (dict) --
Specifies the action type and the provider of the action.
category (string) --
A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the following values.
Source
Build
Test
Deploy
Invoke
Approval
owner (string) --
The creator of the action being called. There are three valid values for the Owner field in the action category section within your pipeline structure: AWS, ThirdParty, and Custom. For more information, see Valid Action Types and Providers in CodePipeline.
provider (string) --
The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of CodeDeploy, which would be specified as CodeDeploy. For more information, see Valid Action Types and Providers in CodePipeline.
version (string) --
A string that describes the action version.
runOrder (integer) --
The order in which actions are run.
configuration (dict) --
The action's configuration. These are key-value pairs that specify input values for an action. For more information, see Action Structure Requirements in CodePipeline. For the list of configuration properties for the CloudFormation action type in CodePipeline, see Configuration Properties Reference in the CloudFormation User Guide. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the CloudFormation User Guide.
The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows:
JSON:
"Configuration" : { Key : Value },
(string) --
(string) --
outputArtifacts (list) --
The name or ID of the result of the action declaration, such as a test or build artifact.
(dict) --
Represents information about the output of an action.
name (string) --
The name of the output of an artifact, such as "My App".
The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
Output artifact names must be unique within a pipeline.
inputArtifacts (list) --
The name or ID of the artifact consumed by the action, such as a test or build artifact.
(dict) --
Represents information about an artifact to be worked on, such as a test or build artifact.
name (string) --
The name of the artifact to be worked on (for example, "My App").
Artifacts are the files that are worked on by actions in the pipeline. See the action configuration for each action for details about artifact parameters. For example, the S3 source action input artifact is a file name (or file path), and the files are generally provided as a ZIP file. Example artifact name: SampleApp_Windows.zip
The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
roleArn (string) --
The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
region (string) --
The action declaration's Amazon Web Services Region, such as us-east-1.
namespace (string) --
The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
version (integer) --
The version number of the pipeline. A new pipeline always has a version number of 1. This number is incremented when a pipeline is updated.
pipelineType (string) --
CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.
V1 type pipelines have a JSON structure that contains standard pipeline, stage, and action-level parameters.
V2 type pipelines have the same structure as a V1 type, along with additional parameters for release safety and trigger configuration.
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?.
triggers (list) --
The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.
(dict) --
Represents information about the specified trigger configuration, such as the filter criteria and the source stage for the action that contains the trigger.
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.
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) --
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.
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.
{'pipelineExecution': {'trigger': {'triggerDetail': 'string',
'triggerType': 'CreatePipeline | '
'StartPipelineExecution | '
'PollForSourceChanges | '
'Webhook | CloudWatchEvent | '
'PutActionRevision | '
'WebhookV2'},
'variables': [{'name': 'string',
'resolvedValue': 'string'}]}}
Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline.
See also: AWS API Documentation
Request Syntax
client.get_pipeline_execution(
pipelineName='string',
pipelineExecutionId='string'
)
string
[REQUIRED]
The name of the pipeline about which you want to get execution details.
string
[REQUIRED]
The ID of the pipeline execution about which you want to get execution details.
dict
Response Syntax
{
'pipelineExecution': {
'pipelineName': 'string',
'pipelineVersion': 123,
'pipelineExecutionId': 'string',
'status': 'Cancelled'|'InProgress'|'Stopped'|'Stopping'|'Succeeded'|'Superseded'|'Failed',
'statusSummary': 'string',
'artifactRevisions': [
{
'name': 'string',
'revisionId': 'string',
'revisionChangeIdentifier': 'string',
'revisionSummary': 'string',
'created': datetime(2015, 1, 1),
'revisionUrl': 'string'
},
],
'trigger': {
'triggerType': 'CreatePipeline'|'StartPipelineExecution'|'PollForSourceChanges'|'Webhook'|'CloudWatchEvent'|'PutActionRevision'|'WebhookV2',
'triggerDetail': 'string'
},
'variables': [
{
'name': 'string',
'resolvedValue': 'string'
},
]
}
}
Response Structure
(dict) --
Represents the output of a GetPipelineExecution action.
pipelineExecution (dict) --
Represents information about the execution of a pipeline.
pipelineName (string) --
The name of the pipeline with the specified pipeline execution.
pipelineVersion (integer) --
The version number of the pipeline with the specified pipeline execution.
pipelineExecutionId (string) --
The ID of the pipeline execution.
status (string) --
The status of the pipeline execution.
Cancelled: The pipeline’s definition was updated before the pipeline execution could be completed.
InProgress: The pipeline execution is currently running.
Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.
Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.
Succeeded: The pipeline execution was completed successfully.
Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions.
Failed: The pipeline execution was not completed successfully.
statusSummary (string) --
A summary that contains a description of the pipeline execution status.
artifactRevisions (list) --
A list of ArtifactRevision objects included in a pipeline execution.
(dict) --
Represents revision details of an artifact.
name (string) --
The name of an artifact. This name might be system-generated, such as "MyApp", or defined by the user when an action is created.
revisionId (string) --
The revision ID of the artifact.
revisionChangeIdentifier (string) --
An additional identifier for a revision, such as a commit date or, for artifacts stored in Amazon S3 buckets, the ETag value.
revisionSummary (string) --
Summary information about the most recent revision of the artifact. For GitHub and CodeCommit repositories, the commit message. For Amazon S3 buckets or actions, the user-provided content of a codepipeline-artifact-revision-summary key specified in the object metadata.
created (datetime) --
The date and time when the most recent revision of the artifact was created, in timestamp format.
revisionUrl (string) --
The commit ID for the artifact revision. For artifacts stored in GitHub or CodeCommit repositories, the commit ID is linked to a commit details page.
trigger (dict) --
The interaction or event that started a pipeline execution.
triggerType (string) --
The type of change-detection method, command, or user interaction that started a pipeline execution.
triggerDetail (string) --
Detail related to the event that started a pipeline execution, such as the webhook ARN of the webhook that triggered the pipeline execution or the user ARN for a user-initiated start-pipeline-execution CLI command.
variables (list) --
A list of pipeline variables used for the pipeline execution.
(dict) --
A pipeline-level variable used for a pipeline execution.
name (string) --
The name of a pipeline-level variable.
resolvedValue (string) --
The resolved value of a pipeline-level variable.
{'pipelineExecutionSummaries': {'trigger': {'triggerType': {'WebhookV2'}}}}
Gets a summary of the most recent executions for a pipeline.
See also: AWS API Documentation
Request Syntax
client.list_pipeline_executions(
pipelineName='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The name of the pipeline for which you want to get execution summary information.
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 ListPipelineExecutions call, which can be used to return the next set of pipeline executions in the list.
dict
Response Syntax
{
'pipelineExecutionSummaries': [
{
'pipelineExecutionId': 'string',
'status': 'Cancelled'|'InProgress'|'Stopped'|'Stopping'|'Succeeded'|'Superseded'|'Failed',
'startTime': datetime(2015, 1, 1),
'lastUpdateTime': datetime(2015, 1, 1),
'sourceRevisions': [
{
'actionName': 'string',
'revisionId': 'string',
'revisionSummary': 'string',
'revisionUrl': 'string'
},
],
'trigger': {
'triggerType': 'CreatePipeline'|'StartPipelineExecution'|'PollForSourceChanges'|'Webhook'|'CloudWatchEvent'|'PutActionRevision'|'WebhookV2',
'triggerDetail': 'string'
},
'stopTrigger': {
'reason': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Represents the output of a ListPipelineExecutions action.
pipelineExecutionSummaries (list) --
A list of executions in the history of a pipeline.
(dict) --
Summary information about a pipeline execution.
pipelineExecutionId (string) --
The ID of the pipeline execution.
status (string) --
The status of the pipeline execution.
InProgress: The pipeline execution is currently running.
Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.
Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.
Succeeded: The pipeline execution was completed successfully.
Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions.
Failed: The pipeline execution was not completed successfully.
startTime (datetime) --
The date and time when the pipeline execution began, in timestamp format.
lastUpdateTime (datetime) --
The date and time of the last change to the pipeline execution, in timestamp format.
sourceRevisions (list) --
A list of the source artifact revisions that initiated a pipeline execution.
(dict) --
Information about the version (or revision) of a source artifact that initiated a pipeline execution.
actionName (string) --
The name of the action that processed the revision to the source artifact.
revisionId (string) --
The system-generated unique ID that identifies the revision number of the artifact.
revisionSummary (string) --
Summary information about the most recent revision of the artifact. For GitHub and CodeCommit repositories, the commit message. For Amazon S3 buckets or actions, the user-provided content of a codepipeline-artifact-revision-summary key specified in the object metadata.
revisionUrl (string) --
The commit ID for the artifact revision. For artifacts stored in GitHub or CodeCommit repositories, the commit ID is linked to a commit details page.
trigger (dict) --
The interaction or event that started a pipeline execution, such as automated change detection or a StartPipelineExecution API call.
triggerType (string) --
The type of change-detection method, command, or user interaction that started a pipeline execution.
triggerDetail (string) --
Detail related to the event that started a pipeline execution, such as the webhook ARN of the webhook that triggered the pipeline execution or the user ARN for a user-initiated start-pipeline-execution CLI command.
stopTrigger (dict) --
The interaction that stopped a pipeline execution.
reason (string) --
The user-specified reason the pipeline was stopped.
nextToken (string) --
A token that can be used in the next ListPipelineExecutions call. To view all items in the list, continue to call this operation with each subsequent token until no more nextToken values are returned.
{'pipelines': {'pipelineType': 'V1 | V2'}}
Gets a summary of all of the pipelines associated with your account.
See also: AWS API Documentation
Request Syntax
client.list_pipelines(
nextToken='string',
maxResults=123
)
string
An identifier that was returned from the previous list pipelines call. It can be used to return the next set of pipelines in the list.
integer
The maximum number of pipelines to return in a single call. To retrieve the remaining pipelines, make another call with the returned nextToken value. The minimum value you can specify is 1. The maximum accepted value is 1000.
dict
Response Syntax
{
'pipelines': [
{
'name': 'string',
'version': 123,
'pipelineType': 'V1'|'V2',
'created': datetime(2015, 1, 1),
'updated': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Represents the output of a ListPipelines action.
pipelines (list) --
The list of pipelines.
(dict) --
Returns a summary of a pipeline.
name (string) --
The name of the pipeline.
version (integer) --
The version number of the pipeline.
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.
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?.
created (datetime) --
The date and time the pipeline was created, in timestamp format.
updated (datetime) --
The date and time of the last update to the pipeline, in timestamp format.
nextToken (string) --
If the amount of returned information is significantly large, an identifier is also returned. It can be used in a subsequent list pipelines call to return the next set of pipelines in the list.
{'variables': [{'name': 'string', 'value': 'string'}]}
Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.
See also: AWS API Documentation
Request Syntax
client.start_pipeline_execution(
name='string',
variables=[
{
'name': 'string',
'value': 'string'
},
],
clientRequestToken='string'
)
string
[REQUIRED]
The name of the pipeline to start.
list
A list that overrides pipeline variables for a pipeline execution that's being started. Variable names must match [A-Za-z0-9@\-_]+, and the values can be anything except an empty string.
(dict) --
A pipeline-level variable used for a pipeline execution.
name (string) -- [REQUIRED]
The name of a pipeline-level variable.
value (string) -- [REQUIRED]
The value of a pipeline-level variable.
string
The system-generated unique ID used to identify a unique execution request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'pipelineExecutionId': 'string'
}
Response Structure
(dict) --
Represents the output of a StartPipelineExecution action.
pipelineExecutionId (string) --
The unique system-generated ID of the pipeline execution that was started.
{'pipeline': {'pipelineType': 'V1 | V2',
'triggers': [{'gitConfiguration': {'push': [{'tags': {'excludes': ['string'],
'includes': ['string']}}],
'sourceActionName': 'string'},
'providerType': 'CodeStarSourceConnection'}],
'variables': [{'defaultValue': 'string',
'description': 'string',
'name': 'string'}]}}
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'
},
]
},
],
'version': 123,
'pipelineType': 'V1'|'V2',
'triggers': [
{
'providerType': 'CodeStarSourceConnection',
'gitConfiguration': {
'sourceActionName': 'string',
'push': [
{
'tags': {
'includes': [
'string',
],
'excludes': [
'string',
]
}
},
]
}
},
],
'variables': [
{
'name': 'string',
'defaultValue': 'string',
'description': '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.
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.
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.
(string) --
(dict) --
The S3 bucket where artifacts for the pipeline are stored.
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.
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.
version (integer) --
The version number of the pipeline. A new pipeline always has a version number of 1. This number is incremented when a pipeline is updated.
pipelineType (string) --
CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.
V1 type pipelines have a JSON structure that contains standard pipeline, stage, and action-level parameters.
V2 type pipelines have the same structure as a V1 type, along with additional parameters for release safety and trigger configuration.
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?.
triggers (list) --
The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.
(dict) --
Represents information about the specified trigger configuration, such as the filter criteria and the source stage for the action that contains the trigger.
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.
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) --
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.
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'
},
]
},
],
'version': 123,
'pipelineType': 'V1'|'V2',
'triggers': [
{
'providerType': 'CodeStarSourceConnection',
'gitConfiguration': {
'sourceActionName': 'string',
'push': [
{
'tags': {
'includes': [
'string',
],
'excludes': [
'string',
]
}
},
]
}
},
],
'variables': [
{
'name': 'string',
'defaultValue': 'string',
'description': '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.
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.
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.
(string) --
(dict) --
The S3 bucket where artifacts for the pipeline are stored.
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.
type (string) --
The type of encryption key, such as an Amazon Web Services KMS key. When creating or updating a pipeline, the value must be set to 'KMS'.
stages (list) --
The stage in which to perform the action.
(dict) --
Represents information about a stage and its definition.
name (string) --
The name of the stage.
blockers (list) --
Reserved for future use.
(dict) --
Reserved for future use.
name (string) --
Reserved for future use.
type (string) --
Reserved for future use.
actions (list) --
The actions included in a stage.
(dict) --
Represents information about an action declaration.
name (string) --
The action declaration's name.
actionTypeId (dict) --
Specifies the action type and the provider of the action.
category (string) --
A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the following values.
Source
Build
Test
Deploy
Invoke
Approval
owner (string) --
The creator of the action being called. There are three valid values for the Owner field in the action category section within your pipeline structure: AWS, ThirdParty, and Custom. For more information, see Valid Action Types and Providers in CodePipeline.
provider (string) --
The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of CodeDeploy, which would be specified as CodeDeploy. For more information, see Valid Action Types and Providers in CodePipeline.
version (string) --
A string that describes the action version.
runOrder (integer) --
The order in which actions are run.
configuration (dict) --
The action's configuration. These are key-value pairs that specify input values for an action. For more information, see Action Structure Requirements in CodePipeline. For the list of configuration properties for the CloudFormation action type in CodePipeline, see Configuration Properties Reference in the CloudFormation User Guide. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the CloudFormation User Guide.
The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows:
JSON:
"Configuration" : { Key : Value },
(string) --
(string) --
outputArtifacts (list) --
The name or ID of the result of the action declaration, such as a test or build artifact.
(dict) --
Represents information about the output of an action.
name (string) --
The name of the output of an artifact, such as "My App".
The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
Output artifact names must be unique within a pipeline.
inputArtifacts (list) --
The name or ID of the artifact consumed by the action, such as a test or build artifact.
(dict) --
Represents information about an artifact to be worked on, such as a test or build artifact.
name (string) --
The name of the artifact to be worked on (for example, "My App").
Artifacts are the files that are worked on by actions in the pipeline. See the action configuration for each action for details about artifact parameters. For example, the S3 source action input artifact is a file name (or file path), and the files are generally provided as a ZIP file. Example artifact name: SampleApp_Windows.zip
The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
roleArn (string) --
The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
region (string) --
The action declaration's Amazon Web Services Region, such as us-east-1.
namespace (string) --
The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
version (integer) --
The version number of the pipeline. A new pipeline always has a version number of 1. This number is incremented when a pipeline is updated.
pipelineType (string) --
CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.
V1 type pipelines have a JSON structure that contains standard pipeline, stage, and action-level parameters.
V2 type pipelines have the same structure as a V1 type, along with additional parameters for release safety and trigger configuration.
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?.
triggers (list) --
The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.
(dict) --
Represents information about the specified trigger configuration, such as the filter criteria and the source stage for the action that contains the trigger.
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.
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) --
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.