2024/10/09 - AWS CodePipeline - 13 updated api methods
Changes AWS CodePipeline introduces a Compute category
{'category': {'Compute'}}
Response {'actionType': {'id': {'category': {'Compute'}}}}
Creates a new custom action that can be used in all pipelines associated with the Amazon Web Services account. Only used for custom actions.
See also: AWS API Documentation
Request Syntax
client.create_custom_action_type(
category='Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval'|'Compute',
provider='string',
version='string',
settings={
'thirdPartyConfigurationUrl': 'string',
'entityUrlTemplate': 'string',
'executionUrlTemplate': 'string',
'revisionUrlTemplate': 'string'
},
configurationProperties=[
{
'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
},
outputArtifactDetails={
'minimumCount': 123,
'maximumCount': 123
},
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
string
[REQUIRED]
The category of the custom action, such as a build action or a test action.
string
[REQUIRED]
The provider of the service used in the custom action, such as CodeDeploy.
string
[REQUIRED]
The version identifier of the custom action.
dict
URLs that provide users information about this custom action.
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.
list
The configuration properties for the custom action.
Note
You can refer to a name in the configuration properties of the custom action within the URL templates by following the format of {Config:name}, as long as the configuration property is both required and not secret. For more information, see Create a Custom Action for a Pipeline.
(dict) --
Represents information about an action configuration property.
name (string) -- [REQUIRED]
The name of the action configuration property.
required (boolean) -- [REQUIRED]
Whether the configuration property is a required value.
key (boolean) -- [REQUIRED]
Whether the configuration property is a key.
secret (boolean) -- [REQUIRED]
Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails , GetThirdPartyJobDetails , PollForJobs , and PollForThirdPartyJobs .
When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.
queryable (boolean) --
Indicates that the property is used with PollForJobs . When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.
If you create a pipeline with a custom action type, and that custom action 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.
dict
[REQUIRED]
The details of the input artifact for the action, such as its commit ID.
minimumCount (integer) -- [REQUIRED]
The minimum number of artifacts allowed for the action type.
maximumCount (integer) -- [REQUIRED]
The maximum number of artifacts allowed for the action type.
dict
[REQUIRED]
The details of the output artifact of the action, such as its commit ID.
minimumCount (integer) -- [REQUIRED]
The minimum number of artifacts allowed for the action type.
maximumCount (integer) -- [REQUIRED]
The maximum number of artifacts allowed for the action type.
list
The tags for the custom action.
(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
{
'actionType': {
'id': {
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval'|'Compute',
'owner': 'AWS'|'ThirdParty'|'Custom',
'provider': 'string',
'version': 'string'
},
'settings': {
'thirdPartyConfigurationUrl': 'string',
'entityUrlTemplate': 'string',
'executionUrlTemplate': 'string',
'revisionUrlTemplate': 'string'
},
'actionConfigurationProperties': [
{
'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
},
'outputArtifactDetails': {
'minimumCount': 123,
'maximumCount': 123
}
},
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
Response Structure
(dict) --
Represents the output of a CreateCustomActionType operation.
actionType (dict) --
Returns information about the details of an action type.
id (dict) --
Represents information about an action type.
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.
settings (dict) --
The settings for the action 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.
actionConfigurationProperties (list) --
The configuration properties for the action type.
(dict) --
Represents information about an action configuration property.
name (string) --
The name of the action 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. Secrets are hidden from all calls except for GetJobDetails , GetThirdPartyJobDetails , PollForJobs , and PollForThirdPartyJobs .
When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.
queryable (boolean) --
Indicates that the property is used with PollForJobs . When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.
If you create a pipeline with a custom action type, and that custom action 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) --
The details of the input artifact for the action, such as its commit ID.
minimumCount (integer) --
The minimum number of artifacts allowed for the action type.
maximumCount (integer) --
The maximum number of artifacts allowed for the action type.
outputArtifactDetails (dict) --
The details of the output artifact of the action, such as its commit ID.
minimumCount (integer) --
The minimum number of artifacts allowed for the action type.
maximumCount (integer) --
The maximum number of artifacts allowed for the action type.
tags (list) --
Specifies the tags applied to the custom action.
(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': {'actions': {'actionTypeId': {'category': {'Compute'}}}}}}
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'|'Compute',
'owner': 'AWS'|'ThirdParty'|'Custom',
'provider': 'string',
'version': 'string'
},
'runOrder': 123,
'configuration': {
'string': 'string'
},
'commands': [
'string',
],
'outputArtifacts': [
{
'name': 'string',
'files': [
'string',
]
},
],
'inputArtifacts': [
{
'name': 'string'
},
],
'outputVariables': [
'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) --
commands (list) --
The shell commands to run with your compute action in CodePipeline. All commands are supported except multi-line formats. While CodeBuild logs and permissions are used, you do not need to create any resources in CodeBuild.
Note
Using compute time for this action will incur separate charges in CodeBuild.
(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.
files (list) --
The files that you want to associate with the output artifact that will be exported from the compute action.
(string) --
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.
outputVariables (list) --
The list of variables that are to be exported from the compute action. This is specifically CodeBuild environment variables as used for that action.
(string) --
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. The valid category is 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 rule provider, such as the DeploymentWindow rule.
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. The valid category is 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 rule provider, such as the DeploymentWindow rule.
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. The valid category is 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 rule provider, such as the DeploymentWindow rule.
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'|'Compute',
'owner': 'AWS'|'ThirdParty'|'Custom',
'provider': 'string',
'version': 'string'
},
'runOrder': 123,
'configuration': {
'string': 'string'
},
'commands': [
'string',
],
'outputArtifacts': [
{
'name': 'string',
'files': [
'string',
]
},
],
'inputArtifacts': [
{
'name': 'string'
},
],
'outputVariables': [
'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) --
commands (list) --
The shell commands to run with your compute action in CodePipeline. All commands are supported except multi-line formats. While CodeBuild logs and permissions are used, you do not need to create any resources in CodeBuild.
Note
Using compute time for this action will incur separate charges in CodeBuild.
(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.
files (list) --
The files that you want to associate with the output artifact that will be exported from the compute action.
(string) --
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.
outputVariables (list) --
The list of variables that are to be exported from the compute action. This is specifically CodeBuild environment variables as used for that action.
(string) --
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. The valid category is 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 rule provider, such as the DeploymentWindow rule.
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. The valid category is 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 rule provider, such as the DeploymentWindow rule.
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. The valid category is 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 rule provider, such as the DeploymentWindow rule.
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.
{'category': {'Compute'}}
Marks a custom action as deleted. PollForJobs for the custom action fails after the action is marked for deletion. Used for custom actions only.
Warning
To re-create a custom action after it has been deleted you must use a string in the version field that has never been used before. This string can be an incremented version number, for example. To restore a deleted custom action, use a JSON file that is identical to the deleted action, including the original string in the version field.
See also: AWS API Documentation
Request Syntax
client.delete_custom_action_type(
category='Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval'|'Compute',
provider='string',
version='string'
)
string
[REQUIRED]
The category of the custom action that you want to delete, such as source or deploy.
string
[REQUIRED]
The provider of the service used in the custom action, such as CodeDeploy.
string
[REQUIRED]
The version of the custom action to delete.
None
{'category': {'Compute'}}
Response {'actionType': {'id': {'category': {'Compute'}}}}
Returns information about an action type created for an external provider, where the action is to be used by customers of the external provider. The action can be created with any supported integration model.
See also: AWS API Documentation
Request Syntax
client.get_action_type(
category='Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval'|'Compute',
owner='string',
provider='string',
version='string'
)
string
[REQUIRED]
Defines what kind of action can be taken in the stage. The following are the valid values:
Source
Build
Test
Deploy
Approval
Invoke
string
[REQUIRED]
The creator of an action type that was created with any supported integration model. There are two valid values: AWS and ThirdParty .
string
[REQUIRED]
The provider of the action type being called. The provider name is specified when the action type is created.
string
[REQUIRED]
A string that describes the action type version.
dict
Response Syntax
{
'actionType': {
'description': 'string',
'executor': {
'configuration': {
'lambdaExecutorConfiguration': {
'lambdaFunctionArn': 'string'
},
'jobWorkerExecutorConfiguration': {
'pollingAccounts': [
'string',
],
'pollingServicePrincipals': [
'string',
]
}
},
'type': 'JobWorker'|'Lambda',
'policyStatementsTemplate': 'string',
'jobTimeout': 123
},
'id': {
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval'|'Compute',
'owner': 'string',
'provider': 'string',
'version': 'string'
},
'inputArtifactDetails': {
'minimumCount': 123,
'maximumCount': 123
},
'outputArtifactDetails': {
'minimumCount': 123,
'maximumCount': 123
},
'permissions': {
'allowedAccounts': [
'string',
]
},
'properties': [
{
'name': 'string',
'optional': True|False,
'key': True|False,
'noEcho': True|False,
'queryable': True|False,
'description': 'string'
},
],
'urls': {
'configurationUrl': 'string',
'entityUrlTemplate': 'string',
'executionUrlTemplate': 'string',
'revisionUrlTemplate': 'string'
}
}
}
Response Structure
(dict) --
actionType (dict) --
The action type information for the requested action type, such as the action type ID.
description (string) --
The description for the action type to be updated.
executor (dict) --
Information about the executor for an action type that was created with any supported integration model.
configuration (dict) --
The action configuration properties for the action type. These properties are specified in the action definition when the action type is created.
lambdaExecutorConfiguration (dict) --
Details about the Lambda executor of the action type.
lambdaFunctionArn (string) --
The ARN of the Lambda function used by the action engine.
jobWorkerExecutorConfiguration (dict) --
Details about the JobWorker executor of the action type.
pollingAccounts (list) --
The accounts in which the job worker is configured and might poll for jobs as part of the action execution.
(string) --
pollingServicePrincipals (list) --
The service Principals in which the job worker is configured and might poll for jobs as part of the action execution.
(string) --
type (string) --
The integration model used to create and update the action type, Lambda or JobWorker .
policyStatementsTemplate (string) --
The policy statement that specifies the permissions in the CodePipeline customer account that are needed to successfully run an action.
To grant permission to another account, specify the account ID as the Principal, a domain-style identifier defined by the service, for example codepipeline.amazonaws.com .
Note
The size of the passed JSON policy document cannot exceed 2048 characters.
jobTimeout (integer) --
The timeout in seconds for the job. An action execution can have multiple jobs. This is the timeout for a single job, not the entire action execution.
id (dict) --
The action category, owner, provider, and version of the action type to be updated.
category (string) --
Defines what kind of action can be taken in the stage, one of the following:
Source
Build
Test
Deploy
Approval
Invoke
owner (string) --
The creator of the action type being called: AWS or ThirdParty .
provider (string) --
The provider of the action type being called. The provider name is supplied when the action type is created.
version (string) --
A string that describes the action type version.
inputArtifactDetails (dict) --
Details for the artifacts, such as application files, to be worked on by the action. For example, the minimum and maximum number of input artifacts allowed.
minimumCount (integer) --
The minimum number of artifacts that can be used with the action type. For example, you should specify a minimum and maximum of zero input artifacts for an action type with a category of source .
maximumCount (integer) --
The maximum number of artifacts that can be used with the actiontype. For example, you should specify a minimum and maximum of zero input artifacts for an action type with a category of source .
outputArtifactDetails (dict) --
Details for the output artifacts, such as a built application, that are the result of the action. For example, the minimum and maximum number of output artifacts allowed.
minimumCount (integer) --
The minimum number of artifacts that can be used with the action type. For example, you should specify a minimum and maximum of zero input artifacts for an action type with a category of source .
maximumCount (integer) --
The maximum number of artifacts that can be used with the actiontype. For example, you should specify a minimum and maximum of zero input artifacts for an action type with a category of source .
permissions (dict) --
Details identifying the accounts with permissions to use the action type.
allowedAccounts (list) --
A list of Amazon Web Services account IDs with access to use the action type in their pipelines.
(string) --
properties (list) --
The properties of the action type to be updated.
(dict) --
Represents information about each property specified in the action configuration, such as the description and key name that display for the customer using the action type.
name (string) --
The property name that is displayed to users.
optional (boolean) --
Whether the configuration property is an optional value.
key (boolean) --
Whether the configuration property is a key.
noEcho (boolean) --
Whether to omit the field value entered by the customer in the log. If true , the value is not saved in CloudTrail logs for the action execution.
queryable (boolean) --
Indicates that the property is used with polling. An action type can have up to one queryable property. If it has one, that property must be both required and not secret.
description (string) --
The description of the property that is displayed to users.
urls (dict) --
The links associated with the action type to be updated.
configurationUrl (string) --
The URL returned to the CodePipeline console that contains a link to the page where customers can configure the external action.
entityUrlTemplate (string) --
The URL returned to the CodePipeline console that provides a deep link to the resources of the external system, such as a status page. This link is provided as part of the action display in the pipeline.
executionUrlTemplate (string) --
The link to an execution page for the action type in progress. For example, for a CodeDeploy action, this link is shown on the pipeline view page in the CodePipeline console, and it links to a CodeDeploy status page.
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.
{'jobDetails': {'data': {'actionTypeId': {'category': {'Compute'}}}}}
Returns information about a job. Used for custom actions only.
Warning
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
See also: AWS API Documentation
Request Syntax
client.get_job_details(
jobId='string'
)
string
[REQUIRED]
The unique system-generated ID for the job.
dict
Response Syntax
{
'jobDetails': {
'id': 'string',
'data': {
'actionTypeId': {
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval'|'Compute',
'owner': 'AWS'|'ThirdParty'|'Custom',
'provider': 'string',
'version': 'string'
},
'actionConfiguration': {
'configuration': {
'string': 'string'
}
},
'pipelineContext': {
'pipelineName': 'string',
'stage': {
'name': 'string'
},
'action': {
'name': 'string',
'actionExecutionId': 'string'
},
'pipelineArn': 'string',
'pipelineExecutionId': 'string'
},
'inputArtifacts': [
{
'name': 'string',
'revision': 'string',
'location': {
'type': 'S3',
's3Location': {
'bucketName': 'string',
'objectKey': 'string'
}
}
},
],
'outputArtifacts': [
{
'name': 'string',
'revision': 'string',
'location': {
'type': 'S3',
's3Location': {
'bucketName': 'string',
'objectKey': 'string'
}
}
},
],
'artifactCredentials': {
'accessKeyId': 'string',
'secretAccessKey': 'string',
'sessionToken': 'string'
},
'continuationToken': 'string',
'encryptionKey': {
'id': 'string',
'type': 'KMS'
}
},
'accountId': 'string'
}
}
Response Structure
(dict) --
Represents the output of a GetJobDetails action.
jobDetails (dict) --
The details of the job.
Note
If AWSSessionCredentials is used, a long-running job can call GetJobDetails again to obtain new credentials.
id (string) --
The unique system-generated ID of the job.
data (dict) --
Represents other information about a job required for a job worker to complete the job.
actionTypeId (dict) --
Represents information about an action type.
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.
actionConfiguration (dict) --
Represents information about an action configuration.
configuration (dict) --
The configuration data for the action.
(string) --
(string) --
pipelineContext (dict) --
Represents information about a pipeline to a job worker.
Note
Includes pipelineArn and pipelineExecutionId for custom jobs.
pipelineName (string) --
The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names under an Amazon Web Services account.
stage (dict) --
The stage of the pipeline.
name (string) --
The name of the stage.
action (dict) --
The context of an action to a job worker in the stage of a pipeline.
name (string) --
The name of the action in the context of a job.
actionExecutionId (string) --
The system-generated unique ID that corresponds to an action's execution.
pipelineArn (string) --
The Amazon Resource Name (ARN) of the pipeline.
pipelineExecutionId (string) --
The execution ID of the pipeline.
inputArtifacts (list) --
The artifact supplied to the job.
(dict) --
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 artifact is a file name (or file path), and the files are generally provided as a ZIP file. Example artifact name: SampleApp_Windows.zip
name (string) --
The artifact's name.
revision (string) --
The artifact's revision ID. Depending on the type of object, this could be a commit ID (GitHub) or a revision ID (Amazon S3).
location (dict) --
The location of an artifact.
type (string) --
The type of artifact in the location.
s3Location (dict) --
The S3 bucket that contains the artifact.
bucketName (string) --
The name of the S3 bucket.
objectKey (string) --
The key of the object in the S3 bucket, which uniquely identifies the object in the bucket.
outputArtifacts (list) --
The output of the job.
(dict) --
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 artifact is a file name (or file path), and the files are generally provided as a ZIP file. Example artifact name: SampleApp_Windows.zip
name (string) --
The artifact's name.
revision (string) --
The artifact's revision ID. Depending on the type of object, this could be a commit ID (GitHub) or a revision ID (Amazon S3).
location (dict) --
The location of an artifact.
type (string) --
The type of artifact in the location.
s3Location (dict) --
The S3 bucket that contains the artifact.
bucketName (string) --
The name of the S3 bucket.
objectKey (string) --
The key of the object in the S3 bucket, which uniquely identifies the object in the bucket.
artifactCredentials (dict) --
Represents an Amazon Web Services session credentials object. These credentials are temporary credentials that are issued by Amazon Web Services Secure Token Service (STS). They can be used to access input and output artifacts in the S3 bucket used to store artifacts for the pipeline in CodePipeline.
accessKeyId (string) --
The access key for the session.
secretAccessKey (string) --
The secret access key for the session.
sessionToken (string) --
The token for the session.
continuationToken (string) --
A system-generated token, such as a deployment ID, required by a job to continue the job asynchronously.
encryptionKey (dict) --
Represents information about the key used to encrypt data in the artifact store, such as an KMS key.
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'.
accountId (string) --
The Amazon Web Services account ID associated with the job.
{'pipeline': {'stages': {'actions': {'actionTypeId': {'category': {'Compute'}}}}}}
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'|'Compute',
'owner': 'AWS'|'ThirdParty'|'Custom',
'provider': 'string',
'version': 'string'
},
'runOrder': 123,
'configuration': {
'string': 'string'
},
'commands': [
'string',
],
'outputArtifacts': [
{
'name': 'string',
'files': [
'string',
]
},
],
'inputArtifacts': [
{
'name': 'string'
},
],
'outputVariables': [
'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) --
commands (list) --
The shell commands to run with your compute action in CodePipeline. All commands are supported except multi-line formats. While CodeBuild logs and permissions are used, you do not need to create any resources in CodeBuild.
Note
Using compute time for this action will incur separate charges in CodeBuild.
(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.
files (list) --
The files that you want to associate with the output artifact that will be exported from the compute action.
(string) --
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.
outputVariables (list) --
The list of variables that are to be exported from the compute action. This is specifically CodeBuild environment variables as used for that action.
(string) --
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. The valid category is 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 rule provider, such as the DeploymentWindow rule.
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. The valid category is 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 rule provider, such as the DeploymentWindow rule.
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. The valid category is 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 rule provider, such as the DeploymentWindow rule.
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.
{'jobDetails': {'data': {'actionTypeId': {'category': {'Compute'}}}}}
Requests the details of a job for a third party action. Used for partner actions only.
Warning
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
See also: AWS API Documentation
Request Syntax
client.get_third_party_job_details(
jobId='string',
clientToken='string'
)
string
[REQUIRED]
The unique system-generated ID used for identifying the job.
string
[REQUIRED]
The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
dict
Response Syntax
{
'jobDetails': {
'id': 'string',
'data': {
'actionTypeId': {
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval'|'Compute',
'owner': 'AWS'|'ThirdParty'|'Custom',
'provider': 'string',
'version': 'string'
},
'actionConfiguration': {
'configuration': {
'string': 'string'
}
},
'pipelineContext': {
'pipelineName': 'string',
'stage': {
'name': 'string'
},
'action': {
'name': 'string',
'actionExecutionId': 'string'
},
'pipelineArn': 'string',
'pipelineExecutionId': 'string'
},
'inputArtifacts': [
{
'name': 'string',
'revision': 'string',
'location': {
'type': 'S3',
's3Location': {
'bucketName': 'string',
'objectKey': 'string'
}
}
},
],
'outputArtifacts': [
{
'name': 'string',
'revision': 'string',
'location': {
'type': 'S3',
's3Location': {
'bucketName': 'string',
'objectKey': 'string'
}
}
},
],
'artifactCredentials': {
'accessKeyId': 'string',
'secretAccessKey': 'string',
'sessionToken': 'string'
},
'continuationToken': 'string',
'encryptionKey': {
'id': 'string',
'type': 'KMS'
}
},
'nonce': 'string'
}
}
Response Structure
(dict) --
Represents the output of a GetThirdPartyJobDetails action.
jobDetails (dict) --
The details of the job, including any protected values defined for the job.
id (string) --
The identifier used to identify the job details in CodePipeline.
data (dict) --
The data to be returned by the third party job worker.
actionTypeId (dict) --
Represents information about an action type.
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.
actionConfiguration (dict) --
Represents information about an action configuration.
configuration (dict) --
The configuration data for the action.
(string) --
(string) --
pipelineContext (dict) --
Represents information about a pipeline to a job worker.
Note
Does not include pipelineArn and pipelineExecutionId for ThirdParty jobs.
pipelineName (string) --
The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names under an Amazon Web Services account.
stage (dict) --
The stage of the pipeline.
name (string) --
The name of the stage.
action (dict) --
The context of an action to a job worker in the stage of a pipeline.
name (string) --
The name of the action in the context of a job.
actionExecutionId (string) --
The system-generated unique ID that corresponds to an action's execution.
pipelineArn (string) --
The Amazon Resource Name (ARN) of the pipeline.
pipelineExecutionId (string) --
The execution ID of the pipeline.
inputArtifacts (list) --
The name of the artifact that is worked on by the action, if any. This name might be system-generated, such as "MyApp", or it might be defined by the user when the action is created. The input artifact name must match the name of an output artifact generated by an action in an earlier action or stage of the pipeline.
(dict) --
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 artifact is a file name (or file path), and the files are generally provided as a ZIP file. Example artifact name: SampleApp_Windows.zip
name (string) --
The artifact's name.
revision (string) --
The artifact's revision ID. Depending on the type of object, this could be a commit ID (GitHub) or a revision ID (Amazon S3).
location (dict) --
The location of an artifact.
type (string) --
The type of artifact in the location.
s3Location (dict) --
The S3 bucket that contains the artifact.
bucketName (string) --
The name of the S3 bucket.
objectKey (string) --
The key of the object in the S3 bucket, which uniquely identifies the object in the bucket.
outputArtifacts (list) --
The name of the artifact that is the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or it might be defined by the user when the action is created.
(dict) --
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 artifact is a file name (or file path), and the files are generally provided as a ZIP file. Example artifact name: SampleApp_Windows.zip
name (string) --
The artifact's name.
revision (string) --
The artifact's revision ID. Depending on the type of object, this could be a commit ID (GitHub) or a revision ID (Amazon S3).
location (dict) --
The location of an artifact.
type (string) --
The type of artifact in the location.
s3Location (dict) --
The S3 bucket that contains the artifact.
bucketName (string) --
The name of the S3 bucket.
objectKey (string) --
The key of the object in the S3 bucket, which uniquely identifies the object in the bucket.
artifactCredentials (dict) --
Represents an Amazon Web Services session credentials object. These credentials are temporary credentials that are issued by Amazon Web Services Secure Token Service (STS). They can be used to access input and output artifacts in the S3 bucket used to store artifact for the pipeline in CodePipeline.
accessKeyId (string) --
The access key for the session.
secretAccessKey (string) --
The secret access key for the session.
sessionToken (string) --
The token for the session.
continuationToken (string) --
A system-generated token, such as a CodeDeploy deployment ID, that a job requires to continue the job asynchronously.
encryptionKey (dict) --
The encryption key used to encrypt and decrypt data in the artifact store for the pipeline, such as an Amazon Web Services Key Management Service (Amazon Web Services KMS) key. This is optional and might not be present.
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'.
nonce (string) --
A system-generated random number that CodePipeline uses to ensure that the job is being worked on by only one job worker. Use this number in an AcknowledgeThirdPartyJob request.
{'actionExecutionDetails': {'input': {'actionTypeId': {'category': {'Compute'}}}}}
Lists the action executions that have occurred in a pipeline.
See also: AWS API Documentation
Request Syntax
client.list_action_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 list action execution history.
dict
Input information used to filter action execution history.
pipelineExecutionId (string) --
The pipeline execution ID used to filter action execution history.
latestInPipelineExecution (dict) --
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. Action execution history is retained for up to 12 months, based on action execution start times. Default value is 100.
string
The token that was returned from the previous ListActionExecutions call, which can be used to return the next set of action executions in the list.
dict
Response Syntax
{
'actionExecutionDetails': [
{
'pipelineExecutionId': 'string',
'actionExecutionId': 'string',
'pipelineVersion': 123,
'stageName': 'string',
'actionName': 'string',
'startTime': datetime(2015, 1, 1),
'lastUpdateTime': datetime(2015, 1, 1),
'updatedBy': 'string',
'status': 'InProgress'|'Abandoned'|'Succeeded'|'Failed',
'input': {
'actionTypeId': {
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval'|'Compute',
'owner': 'AWS'|'ThirdParty'|'Custom',
'provider': 'string',
'version': 'string'
},
'configuration': {
'string': 'string'
},
'resolvedConfiguration': {
'string': 'string'
},
'roleArn': 'string',
'region': 'string',
'inputArtifacts': [
{
'name': 'string',
's3location': {
'bucket': 'string',
'key': 'string'
}
},
],
'namespace': 'string'
},
'output': {
'outputArtifacts': [
{
'name': 'string',
's3location': {
'bucket': 'string',
'key': 'string'
}
},
],
'executionResult': {
'externalExecutionId': 'string',
'externalExecutionSummary': 'string',
'externalExecutionUrl': 'string',
'errorDetails': {
'code': 'string',
'message': 'string'
}
},
'outputVariables': {
'string': 'string'
}
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
actionExecutionDetails (list) --
The details for a list of recent executions, such as action execution ID.
(dict) --
Returns information about an execution of an action, including the action execution ID, and the name, version, and timing of the action.
pipelineExecutionId (string) --
The pipeline execution ID for the action execution.
actionExecutionId (string) --
The action execution ID.
pipelineVersion (integer) --
The version of the pipeline where the action was run.
stageName (string) --
The name of the stage that contains the action.
actionName (string) --
The name of the action.
startTime (datetime) --
The start time of the action execution.
lastUpdateTime (datetime) --
The last update time of the action execution.
updatedBy (string) --
The ARN of the user who changed the pipeline execution details.
status (string) --
The status of the action execution. Status categories are InProgress , Succeeded , and Failed .
input (dict) --
Input details for the action execution, such as role ARN, Region, and input artifacts.
actionTypeId (dict) --
Represents information about an action type.
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.
configuration (dict) --
Configuration data for an action execution.
(string) --
(string) --
resolvedConfiguration (dict) --
Configuration data for an action 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 action. This is assumed through the roleArn for the pipeline.
region (string) --
The Amazon Web Services Region for the action, such as us-east-1.
inputArtifacts (list) --
Details of input artifacts of the action that correspond to the action 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.
namespace (string) --
The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
output (dict) --
Output details for the action execution, such as the action execution result.
outputArtifacts (list) --
Details of output artifacts of the action that correspond to the action 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.
executionResult (dict) --
Execution result information listed in the output details for an action execution.
externalExecutionId (string) --
The action provider's external ID for the action execution.
externalExecutionSummary (string) --
The action provider's summary for the action 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 action.
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.
outputVariables (dict) --
The outputVariables field shows the key-value pairs that were output as part of that execution.
(string) --
(string) --
nextToken (string) --
If the amount of returned information is significantly large, an identifier is also returned and can be used in a subsequent ListActionExecutions call to return the next set of action executions in the list.
{'actionTypes': {'id': {'category': {'Compute'}}}}
Gets a summary of all CodePipeline action types associated with your account.
See also: AWS API Documentation
Request Syntax
client.list_action_types(
actionOwnerFilter='AWS'|'ThirdParty'|'Custom',
nextToken='string',
regionFilter='string'
)
string
Filters the list of action types to those created by a specified entity.
string
An identifier that was returned from the previous list action types call, which can be used to return the next set of action types in the list.
string
The Region to filter on for the list of action types.
dict
Response Syntax
{
'actionTypes': [
{
'id': {
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval'|'Compute',
'owner': 'AWS'|'ThirdParty'|'Custom',
'provider': 'string',
'version': 'string'
},
'settings': {
'thirdPartyConfigurationUrl': 'string',
'entityUrlTemplate': 'string',
'executionUrlTemplate': 'string',
'revisionUrlTemplate': 'string'
},
'actionConfigurationProperties': [
{
'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
},
'outputArtifactDetails': {
'minimumCount': 123,
'maximumCount': 123
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Represents the output of a ListActionTypes action.
actionTypes (list) --
Provides details of the action types.
(dict) --
Returns information about the details of an action type.
id (dict) --
Represents information about an action type.
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.
settings (dict) --
The settings for the action 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.
actionConfigurationProperties (list) --
The configuration properties for the action type.
(dict) --
Represents information about an action configuration property.
name (string) --
The name of the action 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. Secrets are hidden from all calls except for GetJobDetails , GetThirdPartyJobDetails , PollForJobs , and PollForThirdPartyJobs .
When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.
queryable (boolean) --
Indicates that the property is used with PollForJobs . When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.
If you create a pipeline with a custom action type, and that custom action 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) --
The details of the input artifact for the action, such as its commit ID.
minimumCount (integer) --
The minimum number of artifacts allowed for the action type.
maximumCount (integer) --
The maximum number of artifacts allowed for the action type.
outputArtifactDetails (dict) --
The details of the output artifact of the action, such as its commit ID.
minimumCount (integer) --
The minimum number of artifacts allowed for the action type.
maximumCount (integer) --
The maximum number of artifacts allowed for the action type.
nextToken (string) --
If the amount of returned information is significantly large, an identifier is also returned. It can be used in a subsequent list action types call to return the next set of action types in the list.
{'actionTypeId': {'category': {'Compute'}}}
Response {'jobs': {'data': {'actionTypeId': {'category': {'Compute'}}}}}
Returns information about any jobs for CodePipeline to act on. PollForJobs is valid only for action types with "Custom" in the owner field. If the action type contains AWS or ThirdParty in the owner field, the PollForJobs action returns an error.
Warning
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
See also: AWS API Documentation
Request Syntax
client.poll_for_jobs(
actionTypeId={
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval'|'Compute',
'owner': 'AWS'|'ThirdParty'|'Custom',
'provider': 'string',
'version': 'string'
},
maxBatchSize=123,
queryParam={
'string': 'string'
}
)
dict
[REQUIRED]
Represents information about an action type.
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.
integer
The maximum number of jobs to return in a poll for jobs call.
dict
A map of property names and values. For an action type with no queryable properties, this value must be null or an empty map. For an action type with a queryable property, you must supply that property as a key in the map. Only jobs whose action configuration matches the mapped value are returned.
(string) --
(string) --
dict
Response Syntax
{
'jobs': [
{
'id': 'string',
'data': {
'actionTypeId': {
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval'|'Compute',
'owner': 'AWS'|'ThirdParty'|'Custom',
'provider': 'string',
'version': 'string'
},
'actionConfiguration': {
'configuration': {
'string': 'string'
}
},
'pipelineContext': {
'pipelineName': 'string',
'stage': {
'name': 'string'
},
'action': {
'name': 'string',
'actionExecutionId': 'string'
},
'pipelineArn': 'string',
'pipelineExecutionId': 'string'
},
'inputArtifacts': [
{
'name': 'string',
'revision': 'string',
'location': {
'type': 'S3',
's3Location': {
'bucketName': 'string',
'objectKey': 'string'
}
}
},
],
'outputArtifacts': [
{
'name': 'string',
'revision': 'string',
'location': {
'type': 'S3',
's3Location': {
'bucketName': 'string',
'objectKey': 'string'
}
}
},
],
'artifactCredentials': {
'accessKeyId': 'string',
'secretAccessKey': 'string',
'sessionToken': 'string'
},
'continuationToken': 'string',
'encryptionKey': {
'id': 'string',
'type': 'KMS'
}
},
'nonce': 'string',
'accountId': 'string'
},
]
}
Response Structure
(dict) --
Represents the output of a PollForJobs action.
jobs (list) --
Information about the jobs to take action on.
(dict) --
Represents information about a job.
id (string) --
The unique system-generated ID of the job.
data (dict) --
Other data about a job.
actionTypeId (dict) --
Represents information about an action type.
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.
actionConfiguration (dict) --
Represents information about an action configuration.
configuration (dict) --
The configuration data for the action.
(string) --
(string) --
pipelineContext (dict) --
Represents information about a pipeline to a job worker.
Note
Includes pipelineArn and pipelineExecutionId for custom jobs.
pipelineName (string) --
The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names under an Amazon Web Services account.
stage (dict) --
The stage of the pipeline.
name (string) --
The name of the stage.
action (dict) --
The context of an action to a job worker in the stage of a pipeline.
name (string) --
The name of the action in the context of a job.
actionExecutionId (string) --
The system-generated unique ID that corresponds to an action's execution.
pipelineArn (string) --
The Amazon Resource Name (ARN) of the pipeline.
pipelineExecutionId (string) --
The execution ID of the pipeline.
inputArtifacts (list) --
The artifact supplied to the job.
(dict) --
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 artifact is a file name (or file path), and the files are generally provided as a ZIP file. Example artifact name: SampleApp_Windows.zip
name (string) --
The artifact's name.
revision (string) --
The artifact's revision ID. Depending on the type of object, this could be a commit ID (GitHub) or a revision ID (Amazon S3).
location (dict) --
The location of an artifact.
type (string) --
The type of artifact in the location.
s3Location (dict) --
The S3 bucket that contains the artifact.
bucketName (string) --
The name of the S3 bucket.
objectKey (string) --
The key of the object in the S3 bucket, which uniquely identifies the object in the bucket.
outputArtifacts (list) --
The output of the job.
(dict) --
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 artifact is a file name (or file path), and the files are generally provided as a ZIP file. Example artifact name: SampleApp_Windows.zip
name (string) --
The artifact's name.
revision (string) --
The artifact's revision ID. Depending on the type of object, this could be a commit ID (GitHub) or a revision ID (Amazon S3).
location (dict) --
The location of an artifact.
type (string) --
The type of artifact in the location.
s3Location (dict) --
The S3 bucket that contains the artifact.
bucketName (string) --
The name of the S3 bucket.
objectKey (string) --
The key of the object in the S3 bucket, which uniquely identifies the object in the bucket.
artifactCredentials (dict) --
Represents an Amazon Web Services session credentials object. These credentials are temporary credentials that are issued by Amazon Web Services Secure Token Service (STS). They can be used to access input and output artifacts in the S3 bucket used to store artifacts for the pipeline in CodePipeline.
accessKeyId (string) --
The access key for the session.
secretAccessKey (string) --
The secret access key for the session.
sessionToken (string) --
The token for the session.
continuationToken (string) --
A system-generated token, such as a deployment ID, required by a job to continue the job asynchronously.
encryptionKey (dict) --
Represents information about the key used to encrypt data in the artifact store, such as an KMS key.
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'.
nonce (string) --
A system-generated random number that CodePipeline uses to ensure that the job is being worked on by only one job worker. Use this number in an AcknowledgeJob request.
accountId (string) --
The ID of the Amazon Web Services account to use when performing the job.
{'actionTypeId': {'category': {'Compute'}}}
Determines whether there are any third party jobs for a job worker to act on. Used for partner actions only.
Warning
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts.
See also: AWS API Documentation
Request Syntax
client.poll_for_third_party_jobs(
actionTypeId={
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval'|'Compute',
'owner': 'AWS'|'ThirdParty'|'Custom',
'provider': 'string',
'version': 'string'
},
maxBatchSize=123
)
dict
[REQUIRED]
Represents information about an action type.
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.
integer
The maximum number of jobs to return in a poll for jobs call.
dict
Response Syntax
{
'jobs': [
{
'clientId': 'string',
'jobId': 'string'
},
]
}
Response Structure
(dict) --
Represents the output of a PollForThirdPartyJobs action.
jobs (list) --
Information about the jobs to take action on.
(dict) --
A response to a PollForThirdPartyJobs request returned by CodePipeline when there is a job to be worked on by a partner action.
clientId (string) --
The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
jobId (string) --
The identifier used to identify the job in CodePipeline.
{'actionType': {'id': {'category': {'Compute'}}}}
Updates an action type that was created with any supported integration model, where the action type is to be used by customers of the action type provider. Use a JSON file with the action definition and UpdateActionType to provide the full structure.
See also: AWS API Documentation
Request Syntax
client.update_action_type(
actionType={
'description': 'string',
'executor': {
'configuration': {
'lambdaExecutorConfiguration': {
'lambdaFunctionArn': 'string'
},
'jobWorkerExecutorConfiguration': {
'pollingAccounts': [
'string',
],
'pollingServicePrincipals': [
'string',
]
}
},
'type': 'JobWorker'|'Lambda',
'policyStatementsTemplate': 'string',
'jobTimeout': 123
},
'id': {
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval'|'Compute',
'owner': 'string',
'provider': 'string',
'version': 'string'
},
'inputArtifactDetails': {
'minimumCount': 123,
'maximumCount': 123
},
'outputArtifactDetails': {
'minimumCount': 123,
'maximumCount': 123
},
'permissions': {
'allowedAccounts': [
'string',
]
},
'properties': [
{
'name': 'string',
'optional': True|False,
'key': True|False,
'noEcho': True|False,
'queryable': True|False,
'description': 'string'
},
],
'urls': {
'configurationUrl': 'string',
'entityUrlTemplate': 'string',
'executionUrlTemplate': 'string',
'revisionUrlTemplate': 'string'
}
}
)
dict
[REQUIRED]
The action type definition for the action type to be updated.
description (string) --
The description for the action type to be updated.
executor (dict) -- [REQUIRED]
Information about the executor for an action type that was created with any supported integration model.
configuration (dict) -- [REQUIRED]
The action configuration properties for the action type. These properties are specified in the action definition when the action type is created.
lambdaExecutorConfiguration (dict) --
Details about the Lambda executor of the action type.
lambdaFunctionArn (string) -- [REQUIRED]
The ARN of the Lambda function used by the action engine.
jobWorkerExecutorConfiguration (dict) --
Details about the JobWorker executor of the action type.
pollingAccounts (list) --
The accounts in which the job worker is configured and might poll for jobs as part of the action execution.
(string) --
pollingServicePrincipals (list) --
The service Principals in which the job worker is configured and might poll for jobs as part of the action execution.
(string) --
type (string) -- [REQUIRED]
The integration model used to create and update the action type, Lambda or JobWorker .
policyStatementsTemplate (string) --
The policy statement that specifies the permissions in the CodePipeline customer account that are needed to successfully run an action.
To grant permission to another account, specify the account ID as the Principal, a domain-style identifier defined by the service, for example codepipeline.amazonaws.com .
Note
The size of the passed JSON policy document cannot exceed 2048 characters.
jobTimeout (integer) --
The timeout in seconds for the job. An action execution can have multiple jobs. This is the timeout for a single job, not the entire action execution.
id (dict) -- [REQUIRED]
The action category, owner, provider, and version of the action type to be updated.
category (string) -- [REQUIRED]
Defines what kind of action can be taken in the stage, one of the following:
Source
Build
Test
Deploy
Approval
Invoke
owner (string) -- [REQUIRED]
The creator of the action type being called: AWS or ThirdParty .
provider (string) -- [REQUIRED]
The provider of the action type being called. The provider name is supplied when the action type is created.
version (string) -- [REQUIRED]
A string that describes the action type version.
inputArtifactDetails (dict) -- [REQUIRED]
Details for the artifacts, such as application files, to be worked on by the action. For example, the minimum and maximum number of input artifacts allowed.
minimumCount (integer) -- [REQUIRED]
The minimum number of artifacts that can be used with the action type. For example, you should specify a minimum and maximum of zero input artifacts for an action type with a category of source .
maximumCount (integer) -- [REQUIRED]
The maximum number of artifacts that can be used with the actiontype. For example, you should specify a minimum and maximum of zero input artifacts for an action type with a category of source .
outputArtifactDetails (dict) -- [REQUIRED]
Details for the output artifacts, such as a built application, that are the result of the action. For example, the minimum and maximum number of output artifacts allowed.
minimumCount (integer) -- [REQUIRED]
The minimum number of artifacts that can be used with the action type. For example, you should specify a minimum and maximum of zero input artifacts for an action type with a category of source .
maximumCount (integer) -- [REQUIRED]
The maximum number of artifacts that can be used with the actiontype. For example, you should specify a minimum and maximum of zero input artifacts for an action type with a category of source .
permissions (dict) --
Details identifying the accounts with permissions to use the action type.
allowedAccounts (list) -- [REQUIRED]
A list of Amazon Web Services account IDs with access to use the action type in their pipelines.
(string) --
properties (list) --
The properties of the action type to be updated.
(dict) --
Represents information about each property specified in the action configuration, such as the description and key name that display for the customer using the action type.
name (string) -- [REQUIRED]
The property name that is displayed to users.
optional (boolean) -- [REQUIRED]
Whether the configuration property is an optional value.
key (boolean) -- [REQUIRED]
Whether the configuration property is a key.
noEcho (boolean) -- [REQUIRED]
Whether to omit the field value entered by the customer in the log. If true , the value is not saved in CloudTrail logs for the action execution.
queryable (boolean) --
Indicates that the property is used with polling. An action type can have up to one queryable property. If it has one, that property must be both required and not secret.
description (string) --
The description of the property that is displayed to users.
urls (dict) --
The links associated with the action type to be updated.
configurationUrl (string) --
The URL returned to the CodePipeline console that contains a link to the page where customers can configure the external action.
entityUrlTemplate (string) --
The URL returned to the CodePipeline console that provides a deep link to the resources of the external system, such as a status page. This link is provided as part of the action display in the pipeline.
executionUrlTemplate (string) --
The link to an execution page for the action type in progress. For example, for a CodeDeploy action, this link is shown on the pipeline view page in the CodePipeline console, and it links to a CodeDeploy status page.
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.
None
{'pipeline': {'stages': {'actions': {'actionTypeId': {'category': {'Compute'}}}}}}
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'|'Compute',
'owner': 'AWS'|'ThirdParty'|'Custom',
'provider': 'string',
'version': 'string'
},
'runOrder': 123,
'configuration': {
'string': 'string'
},
'commands': [
'string',
],
'outputArtifacts': [
{
'name': 'string',
'files': [
'string',
]
},
],
'inputArtifacts': [
{
'name': 'string'
},
],
'outputVariables': [
'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) --
commands (list) --
The shell commands to run with your compute action in CodePipeline. All commands are supported except multi-line formats. While CodeBuild logs and permissions are used, you do not need to create any resources in CodeBuild.
Note
Using compute time for this action will incur separate charges in CodeBuild.
(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.
files (list) --
The files that you want to associate with the output artifact that will be exported from the compute action.
(string) --
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.
outputVariables (list) --
The list of variables that are to be exported from the compute action. This is specifically CodeBuild environment variables as used for that action.
(string) --
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. The valid category is 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 rule provider, such as the DeploymentWindow rule.
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. The valid category is 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 rule provider, such as the DeploymentWindow rule.
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. The valid category is 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 rule provider, such as the DeploymentWindow rule.
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'|'Compute',
'owner': 'AWS'|'ThirdParty'|'Custom',
'provider': 'string',
'version': 'string'
},
'runOrder': 123,
'configuration': {
'string': 'string'
},
'commands': [
'string',
],
'outputArtifacts': [
{
'name': 'string',
'files': [
'string',
]
},
],
'inputArtifacts': [
{
'name': 'string'
},
],
'outputVariables': [
'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) --
commands (list) --
The shell commands to run with your compute action in CodePipeline. All commands are supported except multi-line formats. While CodeBuild logs and permissions are used, you do not need to create any resources in CodeBuild.
Note
Using compute time for this action will incur separate charges in CodeBuild.
(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.
files (list) --
The files that you want to associate with the output artifact that will be exported from the compute action.
(string) --
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.
outputVariables (list) --
The list of variables that are to be exported from the compute action. This is specifically CodeBuild environment variables as used for that action.
(string) --
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. The valid category is 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 rule provider, such as the DeploymentWindow rule.
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. The valid category is 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 rule provider, such as the DeploymentWindow rule.
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. The valid category is 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 rule provider, such as the DeploymentWindow rule.
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) --