Table of Contents
CodePipeline.Client¶A low-level client representing AWS CodePipeline
Overview
This is the AWS CodePipeline API Reference. This guide provides descriptions of the actions and data types for AWS CodePipeline. Some functionality for your pipeline can only be configured through the API. For more information, see the AWS CodePipeline User Guide .
You can use the AWS CodePipeline API to work with pipelines, stages, actions, and transitions.
Pipelines are models of automated release processes. Each pipeline is uniquely named, and consists of stages, actions, and transitions.
You can work with pipelines by calling:
Pipelines include stages . Each stage contains one or more actions that must complete before the next stage begins. A stage results in success or failure. If a stage fails, the pipeline stops at that stage and remains stopped until either a new version of an artifact appears in the source location, or a user takes action to rerun the most recent artifact through the pipeline. You can call GetPipelineState , which displays the status of a pipeline, including the status of stages in the pipeline, or GetPipeline , which returns the entire structure of the pipeline, including the stages of that pipeline. For more information about the structure of stages and actions, see AWS CodePipeline Pipeline Structure Reference .
Pipeline stages include actions that are categorized into categories such as source or build actions performed in a stage of a pipeline. For example, you can use a source action to import artifacts into a pipeline from a source such as Amazon S3. Like stages, you do not work with actions directly in most cases, but you do define and interact with actions when working with pipeline operations such as CreatePipeline and GetPipelineState . Valid action categories are:
Pipelines also include transitions , which allow the transition of artifacts from one stage to the next in a pipeline after the actions in one stage complete.
You can work with transitions by calling:
Using the API to integrate with AWS CodePipeline
For third-party integrators or developers who want to create their own integrations with AWS CodePipeline, the expected sequence varies from the standard API user. To integrate with AWS CodePipeline, developers need to work with the following items:
Jobs , which are instances of an action. For example, a job for a source action might import a revision of an artifact from a source.
You can work with jobs by calling:
Third party jobs , which are instances of an action created by a partner action and integrated into AWS CodePipeline. Partner actions are created by members of the AWS Partner Network.
You can work with third party jobs by calling:
import boto3
client = boto3.client('codepipeline')
These are the available methods:
acknowledge_job()acknowledge_third_party_job()can_paginate()close()create_custom_action_type()create_pipeline()delete_custom_action_type()delete_pipeline()delete_webhook()deregister_webhook_with_third_party()disable_stage_transition()enable_stage_transition()get_action_type()get_job_details()get_paginator()get_pipeline()get_pipeline_execution()get_pipeline_state()get_third_party_job_details()get_waiter()list_action_executions()list_action_types()list_pipeline_executions()list_pipelines()list_tags_for_resource()list_webhooks()poll_for_jobs()poll_for_third_party_jobs()put_action_revision()put_approval_result()put_job_failure_result()put_job_success_result()put_third_party_job_failure_result()put_third_party_job_success_result()put_webhook()register_webhook_with_third_party()retry_stage_execution()start_pipeline_execution()stop_pipeline_execution()tag_resource()untag_resource()update_action_type()update_pipeline()acknowledge_job(**kwargs)¶Returns information about a specified job and whether that job has been received by the job worker. Used for custom actions only.
See also: AWS API Documentation
Request Syntax
response = client.acknowledge_job(
jobId='string',
nonce='string'
)
[REQUIRED]
The unique system-generated ID of the job for which you want to confirm receipt.
[REQUIRED]
A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response of the PollForJobs request that returned this job.
dict
Response Syntax
{
'status': 'Created'|'Queued'|'Dispatched'|'InProgress'|'TimedOut'|'Succeeded'|'Failed'
}
Response Structure
(dict) --
Represents the output of an AcknowledgeJob action.
status (string) --
Whether the job worker has received the specified job.
Exceptions
CodePipeline.Client.exceptions.ValidationExceptionCodePipeline.Client.exceptions.InvalidNonceExceptionCodePipeline.Client.exceptions.JobNotFoundExceptionacknowledge_third_party_job(**kwargs)¶Confirms a job worker has received the specified job. Used for partner actions only.
See also: AWS API Documentation
Request Syntax
response = client.acknowledge_third_party_job(
jobId='string',
nonce='string',
clientToken='string'
)
[REQUIRED]
The unique system-generated ID of the job.
[REQUIRED]
A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response to a GetThirdPartyJobDetails request.
[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
{
'status': 'Created'|'Queued'|'Dispatched'|'InProgress'|'TimedOut'|'Succeeded'|'Failed'
}
Response Structure
(dict) --
Represents the output of an AcknowledgeThirdPartyJob action.
status (string) --
The status information for the third party job, if any.
Exceptions
CodePipeline.Client.exceptions.ValidationExceptionCodePipeline.Client.exceptions.InvalidNonceExceptionCodePipeline.Client.exceptions.JobNotFoundExceptionCodePipeline.Client.exceptions.InvalidClientTokenExceptioncan_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
create_custom_action_type(**kwargs)¶Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions.
See also: AWS API Documentation
Request Syntax
response = client.create_custom_action_type(
category='Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval',
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'
},
]
)
[REQUIRED]
The category of the custom action, such as a build action or a test action.
[REQUIRED]
The provider of the service used in the custom action, such as AWS CodeDeploy.
[REQUIRED]
The version identifier of the custom action.
URLs that provide users information about this custom action.
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.
The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display in the pipeline.
The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action.
The URL returned to the AWS CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.
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 .
Represents information about an action configuration property.
The name of the action configuration property.
Whether the configuration property is a required value.
Whether the configuration property is a key.
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.
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.
The description of the action configuration property that is displayed to users.
The type of the configuration property.
[REQUIRED]
The details of the input artifact for the action, such as its commit ID.
The minimum number of artifacts allowed for the action type.
The maximum number of artifacts allowed for the action type.
[REQUIRED]
The details of the output artifact of the action, such as its commit ID.
The minimum number of artifacts allowed for the action type.
The maximum number of artifacts allowed for the action type.
The tags for the custom action.
A tag is a key-value pair that is used to manage the resource.
The tag's key.
The tag's value.
dict
Response Syntax
{
'actionType': {
'id': {
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval',
'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.
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 AWS 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 AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display in the pipeline.
executionUrlTemplate (string) --
The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action.
revisionUrlTemplate (string) --
The URL returned to the AWS 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.
Exceptions
CodePipeline.Client.exceptions.ValidationExceptionCodePipeline.Client.exceptions.LimitExceededExceptionCodePipeline.Client.exceptions.TooManyTagsExceptionCodePipeline.Client.exceptions.InvalidTagsExceptionCodePipeline.Client.exceptions.ConcurrentModificationExceptioncreate_pipeline(**kwargs)¶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
response = client.create_pipeline(
pipeline={
'name': 'string',
'roleArn': 'string',
'artifactStore': {
'type': 'S3',
'location': 'string',
'encryptionKey': {
'id': 'string',
'type': 'KMS'
}
},
'artifactStores': {
'string': {
'type': 'S3',
'location': 'string',
'encryptionKey': {
'id': 'string',
'type': 'KMS'
}
}
},
'stages': [
{
'name': 'string',
'blockers': [
{
'name': 'string',
'type': 'Schedule'
},
],
'actions': [
{
'name': 'string',
'actionTypeId': {
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval',
'owner': 'AWS'|'ThirdParty'|'Custom',
'provider': 'string',
'version': 'string'
},
'runOrder': 123,
'configuration': {
'string': 'string'
},
'outputArtifacts': [
{
'name': 'string'
},
],
'inputArtifacts': [
{
'name': 'string'
},
],
'roleArn': 'string',
'region': 'string',
'namespace': 'string'
},
]
},
],
'version': 123
},
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
[REQUIRED]
Represents the structure of actions and stages to be performed in the pipeline.
The name of the pipeline.
The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform actions with no actionRoleArn , or to use to assume roles for actions with an actionRoleArn .
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 .
The type of the artifact store, such as S3.
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 AWS Region as the pipeline to store your pipeline artifacts.
The encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service (AWS KMS) key. If this is undefined, the default key for Amazon S3 is used.
The ID used to identify the key. For an AWS 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 customer master key (CMK). For cross-account actions, you can only use the key ID or key ARN to identify the key.
The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. When creating or updating a pipeline, the value must be set to 'KMS'.
A mapping of artifactStore objects and their corresponding AWS 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 .
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 .
The type of the artifact store, such as S3.
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 AWS Region as the pipeline to store your pipeline artifacts.
The encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service (AWS KMS) key. If this is undefined, the default key for Amazon S3 is used.
The ID used to identify the key. For an AWS 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 customer master key (CMK). For cross-account actions, you can only use the key ID or key ARN to identify the key.
The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. When creating or updating a pipeline, the value must be set to 'KMS'.
The stage in which to perform the action.
Represents information about a stage and its definition.
The name of the stage.
Reserved for future use.
Reserved for future use.
Reserved for future use.
Reserved for future use.
The actions included in a stage.
Represents information about an action declaration.
The action declaration's name.
Specifies the action type and the provider of the action.
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.
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 .
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 AWS CodeDeploy, which would be specified as CodeDeploy. For more information, see Valid Action Types and Providers in CodePipeline .
A string that describes the action version.
The order in which actions are run.
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 AWS CloudFormation action type in CodePipeline, see Configuration Properties Reference in the AWS CloudFormation User Guide . For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the AWS 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 },
The name or ID of the result of the action declaration, such as a test or build artifact.
Represents information about the output of an action.
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.
The name or ID of the artifact consumed by the action, such as a test or build artifact.
Represents information about an artifact to be worked on, such as a test or build artifact.
The name of the artifact to be worked on (for example, "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.
The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
The action declaration's AWS Region, such as us-east-1.
The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
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.
The tags for the pipeline.
A tag is a key-value pair that is used to manage the resource.
The tag's key.
The tag's value.
dict
Response Syntax
{
'pipeline': {
'name': 'string',
'roleArn': 'string',
'artifactStore': {
'type': 'S3',
'location': 'string',
'encryptionKey': {
'id': 'string',
'type': 'KMS'
}
},
'artifactStores': {
'string': {
'type': 'S3',
'location': 'string',
'encryptionKey': {
'id': 'string',
'type': 'KMS'
}
}
},
'stages': [
{
'name': 'string',
'blockers': [
{
'name': 'string',
'type': 'Schedule'
},
],
'actions': [
{
'name': 'string',
'actionTypeId': {
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval',
'owner': 'AWS'|'ThirdParty'|'Custom',
'provider': 'string',
'version': 'string'
},
'runOrder': 123,
'configuration': {
'string': 'string'
},
'outputArtifacts': [
{
'name': 'string'
},
],
'inputArtifacts': [
{
'name': 'string'
},
],
'roleArn': 'string',
'region': 'string',
'namespace': 'string'
},
]
},
],
'version': 123
},
'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 AWS 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 AWS 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 AWS Key Management Service (AWS KMS) key. If this is undefined, the default key for Amazon S3 is used.
id (string) --
The ID used to identify the key. For an AWS 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 customer master key (CMK). For cross-account actions, you can only use the key ID or key ARN to identify the key.
type (string) --
The type of encryption key, such as an AWS Key Management Service (AWS 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 AWS 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 AWS 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 AWS Key Management Service (AWS KMS) key. If this is undefined, the default key for Amazon S3 is used.
id (string) --
The ID used to identify the key. For an AWS 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 customer master key (CMK). For cross-account actions, you can only use the key ID or key ARN to identify the key.
type (string) --
The type of encryption key, such as an AWS Key Management Service (AWS 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.
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 AWS 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 AWS CloudFormation action type in CodePipeline, see Configuration Properties Reference in the AWS CloudFormation User Guide . For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the AWS 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 },
outputArtifacts (list) --
The name or ID of the result of the action declaration, such as a test or build artifact.
(dict) --
Represents information about the output of an action.
name (string) --
The name of the output of an artifact, such as "My App".
The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
Output artifact names must be unique within a pipeline.
inputArtifacts (list) --
The name or ID of the artifact consumed by the action, such as a test or build artifact.
(dict) --
Represents information about an artifact to be worked on, such as a test or build artifact.
name (string) --
The name of the artifact to be worked on (for example, "My App").
The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
roleArn (string) --
The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
region (string) --
The action declaration's AWS Region, such as us-east-1.
namespace (string) --
The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
version (integer) --
The version number of the pipeline. A new pipeline always has a version number of 1. This number is incremented when a pipeline is updated.
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.
Exceptions
CodePipeline.Client.exceptions.ValidationExceptionCodePipeline.Client.exceptions.PipelineNameInUseExceptionCodePipeline.Client.exceptions.InvalidStageDeclarationExceptionCodePipeline.Client.exceptions.InvalidActionDeclarationExceptionCodePipeline.Client.exceptions.InvalidBlockerDeclarationExceptionCodePipeline.Client.exceptions.InvalidStructureExceptionCodePipeline.Client.exceptions.LimitExceededExceptionCodePipeline.Client.exceptions.TooManyTagsExceptionCodePipeline.Client.exceptions.InvalidTagsExceptionCodePipeline.Client.exceptions.ConcurrentModificationExceptiondelete_custom_action_type(**kwargs)¶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
response = client.delete_custom_action_type(
category='Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval',
provider='string',
version='string'
)
[REQUIRED]
The category of the custom action that you want to delete, such as source or deploy.
[REQUIRED]
The provider of the service used in the custom action, such as AWS CodeDeploy.
[REQUIRED]
The version of the custom action to delete.
None
Exceptions
CodePipeline.Client.exceptions.ValidationExceptionCodePipeline.Client.exceptions.ConcurrentModificationExceptiondelete_pipeline(**kwargs)¶Deletes the specified pipeline.
See also: AWS API Documentation
Request Syntax
response = client.delete_pipeline(
name='string'
)
[REQUIRED]
The name of the pipeline to be deleted.
Exceptions
CodePipeline.Client.exceptions.ValidationExceptionCodePipeline.Client.exceptions.ConcurrentModificationExceptiondelete_webhook(**kwargs)¶Deletes a previously created webhook by name. Deleting the webhook stops AWS CodePipeline from starting a pipeline every time an external event occurs. The API returns successfully when trying to delete a webhook that is already deleted. If a deleted webhook is re-created by calling PutWebhook with the same name, it will have a different URL.
See also: AWS API Documentation
Request Syntax
response = client.delete_webhook(
name='string'
)
[REQUIRED]
The name of the webhook you want to delete.
{}
Response Structure
Exceptions
CodePipeline.Client.exceptions.ValidationExceptionCodePipeline.Client.exceptions.ConcurrentModificationExceptionderegister_webhook_with_third_party(**kwargs)¶Removes the connection between the webhook that was created by CodePipeline and the external tool with events to be detected. Currently supported only for webhooks that target an action type of GitHub.
See also: AWS API Documentation
Request Syntax
response = client.deregister_webhook_with_third_party(
webhookName='string'
)
{}
Response Structure
Exceptions
CodePipeline.Client.exceptions.ValidationExceptionCodePipeline.Client.exceptions.WebhookNotFoundExceptiondisable_stage_transition(**kwargs)¶Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
See also: AWS API Documentation
Request Syntax
response = client.disable_stage_transition(
pipelineName='string',
stageName='string',
transitionType='Inbound'|'Outbound',
reason='string'
)
[REQUIRED]
The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.
[REQUIRED]
The name of the stage where you want to disable the inbound or outbound transition of artifacts.
[REQUIRED]
Specifies whether artifacts are prevented from transitioning into the stage and being processed by the actions in that stage (inbound), or prevented from transitioning from the stage after they have been processed by the actions in that stage (outbound).
[REQUIRED]
The reason given to the user that a stage is disabled, such as waiting for manual approval or manual tests. This message is displayed in the pipeline console UI.
None
Exceptions
CodePipeline.Client.exceptions.ValidationExceptionCodePipeline.Client.exceptions.PipelineNotFoundExceptionCodePipeline.Client.exceptions.StageNotFoundExceptionenable_stage_transition(**kwargs)¶Enables artifacts in a pipeline to transition to a stage in a pipeline.
See also: AWS API Documentation
Request Syntax
response = client.enable_stage_transition(
pipelineName='string',
stageName='string',
transitionType='Inbound'|'Outbound'
)
[REQUIRED]
The name of the pipeline in which you want to enable the flow of artifacts from one stage to another.
[REQUIRED]
The name of the stage where you want to enable the transition of artifacts, either into the stage (inbound) or from that stage to the next stage (outbound).
[REQUIRED]
Specifies whether artifacts are allowed to enter the stage and be processed by the actions in that stage (inbound) or whether already processed artifacts are allowed to transition to the next stage (outbound).
None
Exceptions
CodePipeline.Client.exceptions.ValidationExceptionCodePipeline.Client.exceptions.PipelineNotFoundExceptionCodePipeline.Client.exceptions.StageNotFoundExceptionget_action_type(**kwargs)¶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
response = client.get_action_type(
category='Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval',
owner='string',
provider='string',
version='string'
)
[REQUIRED]
Defines what kind of action can be taken in the stage. The following are the valid values:
SourceBuildTestDeployApprovalInvoke[REQUIRED]
The creator of an action type that was created with any supported integration model. There are two valid values: AWS and ThirdParty .
[REQUIRED]
The provider of the action type being called. The provider name is specified when the action type is created.
[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',
'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.
pollingServicePrincipals (list) --
The service Principals in which the job worker is configured and might poll for jobs as part of the action execution.
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’s 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:
SourceBuildTestDeployApprovalInvokeowner (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 AWS account IDs with access to use the action type in their pipelines.
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.
Exceptions
CodePipeline.Client.exceptions.ActionTypeNotFoundExceptionCodePipeline.Client.exceptions.ValidationExceptionget_job_details(**kwargs)¶Returns information about a job. Used for custom actions only.
Warning
When this API is called, AWS 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
response = client.get_job_details(
jobId='string'
)
[REQUIRED]
The unique system-generated ID for the job.
{
'jobDetails': {
'id': 'string',
'data': {
'actionTypeId': {
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval',
'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
Represents the output of a GetJobDetails action.
The details of the job.
Note
If AWSSessionCredentials is used, a long-running job can call GetJobDetails again to obtain new credentials.
The unique system-generated ID of the job.
Represents other information about a job required for a job worker to complete the job.
Represents information about an action type.
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.
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 .
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 AWS CodeDeploy, which would be specified as CodeDeploy. For more information, see Valid Action Types and Providers in CodePipeline .
A string that describes the action version.
Represents information about an action configuration.
The configuration data for the action.
Represents information about a pipeline to a job worker.
Note
Includes pipelineArn and pipelineExecutionId for custom jobs.
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.
The stage of the pipeline.
The name of the stage.
The context of an action to a job worker in the stage of a pipeline.
The name of the action in the context of a job.
The system-generated unique ID that corresponds to an action's execution.
The Amazon Resource Name (ARN) of the pipeline.
The execution ID of the pipeline.
The artifact supplied to the job.
Represents information about an artifact that is worked on by actions in the pipeline.
The artifact's name.
The artifact's revision ID. Depending on the type of object, this could be a commit ID (GitHub) or a revision ID (Amazon S3).
The location of an artifact.
The type of artifact in the location.
The S3 bucket that contains the artifact.
The name of the S3 bucket.
The key of the object in the S3 bucket, which uniquely identifies the object in the bucket.
The output of the job.
Represents information about an artifact that is worked on by actions in the pipeline.
The artifact's name.
The artifact's revision ID. Depending on the type of object, this could be a commit ID (GitHub) or a revision ID (Amazon S3).
The location of an artifact.
The type of artifact in the location.
The S3 bucket that contains the artifact.
The name of the S3 bucket.
The key of the object in the S3 bucket, which uniquely identifies the object in the bucket.
Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS 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 AWS CodePipeline.
The access key for the session.
The secret access key for the session.
The token for the session.
A system-generated token, such as a AWS CodeDeploy deployment ID, required by a job to continue the job asynchronously.
Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS) key.
The ID used to identify the key. For an AWS 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 customer master key (CMK). For cross-account actions, you can only use the key ID or key ARN to identify the key.
The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. When creating or updating a pipeline, the value must be set to 'KMS'.
The AWS account ID associated with the job.
Exceptions
CodePipeline.Client.exceptions.ValidationExceptionCodePipeline.Client.exceptions.JobNotFoundExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_pipeline(**kwargs)¶Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with UpdatePipeline .
See also: AWS API Documentation
Request Syntax
response = client.get_pipeline(
name='string',
version=123
)
[REQUIRED]
The name of the pipeline for which you want to get information. Pipeline names must be unique under an AWS user account.
dict
Response Syntax
{
'pipeline': {
'name': 'string',
'roleArn': 'string',
'artifactStore': {
'type': 'S3',
'location': 'string',
'encryptionKey': {
'id': 'string',
'type': 'KMS'
}
},
'artifactStores': {
'string': {
'type': 'S3',
'location': 'string',
'encryptionKey': {
'id': 'string',
'type': 'KMS'
}
}
},
'stages': [
{
'name': 'string',
'blockers': [
{
'name': 'string',
'type': 'Schedule'
},
],
'actions': [
{
'name': 'string',
'actionTypeId': {
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval',
'owner': 'AWS'|'ThirdParty'|'Custom',
'provider': 'string',
'version': 'string'
},
'runOrder': 123,
'configuration': {
'string': 'string'
},
'outputArtifacts': [
{
'name': 'string'
},
],
'inputArtifacts': [
{
'name': 'string'
},
],
'roleArn': 'string',
'region': 'string',
'namespace': 'string'
},
]
},
],
'version': 123
},
'metadata': {
'pipelineArn': 'string',
'created': datetime(2015, 1, 1),
'updated': 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 AWS 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 AWS 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 AWS Key Management Service (AWS KMS) key. If this is undefined, the default key for Amazon S3 is used.
id (string) --
The ID used to identify the key. For an AWS 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 customer master key (CMK). For cross-account actions, you can only use the key ID or key ARN to identify the key.
type (string) --
The type of encryption key, such as an AWS Key Management Service (AWS 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 AWS 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 AWS 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 AWS Key Management Service (AWS KMS) key. If this is undefined, the default key for Amazon S3 is used.
id (string) --
The ID used to identify the key. For an AWS 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 customer master key (CMK). For cross-account actions, you can only use the key ID or key ARN to identify the key.
type (string) --
The type of encryption key, such as an AWS Key Management Service (AWS 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.
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 AWS 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 AWS CloudFormation action type in CodePipeline, see Configuration Properties Reference in the AWS CloudFormation User Guide . For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the AWS 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 },
outputArtifacts (list) --
The name or ID of the result of the action declaration, such as a test or build artifact.
(dict) --
Represents information about the output of an action.
name (string) --
The name of the output of an artifact, such as "My App".
The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
Output artifact names must be unique within a pipeline.
inputArtifacts (list) --
The name or ID of the artifact consumed by the action, such as a test or build artifact.
(dict) --
Represents information about an artifact to be worked on, such as a test or build artifact.
name (string) --
The name of the artifact to be worked on (for example, "My App").
The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
roleArn (string) --
The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
region (string) --
The action declaration's AWS Region, such as us-east-1.
namespace (string) --
The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
version (integer) --
The version number of the pipeline. A new pipeline always has a version number of 1. This number is incremented when a pipeline is updated.
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.
Exceptions
CodePipeline.Client.exceptions.ValidationExceptionCodePipeline.Client.exceptions.PipelineNotFoundExceptionCodePipeline.Client.exceptions.PipelineVersionNotFoundExceptionget_pipeline_execution(**kwargs)¶Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline.
See also: AWS API Documentation
Request Syntax
response = client.get_pipeline_execution(
pipelineName='string',
pipelineExecutionId='string'
)
[REQUIRED]
The name of the pipeline about which you want to get execution details.
[REQUIRED]
The ID of the pipeline execution about which you want to get execution details.
dict
Response Syntax
{
'pipelineExecution': {
'pipelineName': 'string',
'pipelineVersion': 123,
'pipelineExecutionId': 'string',
'status': 'Cancelled'|'InProgress'|'Stopped'|'Stopping'|'Succeeded'|'Superseded'|'Failed',
'statusSummary': 'string',
'artifactRevisions': [
{
'name': 'string',
'revisionId': 'string',
'revisionChangeIdentifier': 'string',
'revisionSummary': 'string',
'created': datetime(2015, 1, 1),
'revisionUrl': 'string'
},
]
}
}
Response Structure
(dict) --
Represents the output of a GetPipelineExecution action.
pipelineExecution (dict) --
Represents information about the execution of a pipeline.
pipelineName (string) --
The name of the pipeline with the specified pipeline execution.
pipelineVersion (integer) --
The version number of the pipeline with the specified pipeline execution.
pipelineExecutionId (string) --
The ID of the pipeline execution.
status (string) --
The status of the pipeline execution.
statusSummary (string) --
A summary that contains a description of the pipeline execution status.
artifactRevisions (list) --
A list of ArtifactRevision objects included in a pipeline execution.
(dict) --
Represents revision details of an artifact.
name (string) --
The name of an artifact. This name might be system-generated, such as "MyApp", or defined by the user when an action is created.
revisionId (string) --
The revision ID of the artifact.
revisionChangeIdentifier (string) --
An additional identifier for a revision, such as a commit date or, for artifacts stored in Amazon S3 buckets, the ETag value.
revisionSummary (string) --
Summary information about the most recent revision of the artifact. For GitHub and AWS CodeCommit repositories, the commit message. For Amazon S3 buckets or actions, the user-provided content of a codepipeline-artifact-revision-summary key specified in the object metadata.
created (datetime) --
The date and time when the most recent revision of the artifact was created, in timestamp format.
revisionUrl (string) --
The commit ID for the artifact revision. For artifacts stored in GitHub or AWS CodeCommit repositories, the commit ID is linked to a commit details page.
Exceptions
CodePipeline.Client.exceptions.ValidationExceptionCodePipeline.Client.exceptions.PipelineNotFoundExceptionCodePipeline.Client.exceptions.PipelineExecutionNotFoundExceptionget_pipeline_state(**kwargs)¶Returns information about the state of a pipeline, including the stages and actions.
Note
Values returned in the revisionId and revisionUrl fields indicate the source revision information, such as the commit ID, for the current state.
See also: AWS API Documentation
Request Syntax
response = client.get_pipeline_state(
name='string'
)
[REQUIRED]
The name of the pipeline about which you want to get information.
{
'pipelineName': 'string',
'pipelineVersion': 123,
'stageStates': [
{
'stageName': 'string',
'inboundExecution': {
'pipelineExecutionId': 'string',
'status': 'Cancelled'|'InProgress'|'Failed'|'Stopped'|'Stopping'|'Succeeded'
},
'inboundTransitionState': {
'enabled': True|False,
'lastChangedBy': 'string',
'lastChangedAt': datetime(2015, 1, 1),
'disabledReason': 'string'
},
'actionStates': [
{
'actionName': 'string',
'currentRevision': {
'revisionId': 'string',
'revisionChangeId': 'string',
'created': datetime(2015, 1, 1)
},
'latestExecution': {
'actionExecutionId': 'string',
'status': 'InProgress'|'Abandoned'|'Succeeded'|'Failed',
'summary': 'string',
'lastStatusChange': datetime(2015, 1, 1),
'token': 'string',
'lastUpdatedBy': 'string',
'externalExecutionId': 'string',
'externalExecutionUrl': 'string',
'percentComplete': 123,
'errorDetails': {
'code': 'string',
'message': 'string'
}
},
'entityUrl': 'string',
'revisionUrl': 'string'
},
],
'latestExecution': {
'pipelineExecutionId': 'string',
'status': 'Cancelled'|'InProgress'|'Failed'|'Stopped'|'Stopping'|'Succeeded'
}
},
],
'created': datetime(2015, 1, 1),
'updated': datetime(2015, 1, 1)
}
Response Structure
Represents the output of a GetPipelineState action.
The name of the pipeline for which you want to get the state.
The version number of the pipeline.
Note
A newly created pipeline is always assigned a version number of 1 .
A list of the pipeline stage output information, including stage name, state, most recent run details, whether the stage is disabled, and other data.
Represents information about the state of the stage.
The name of the stage.
Represents information about the run of a stage.
The ID of the pipeline execution associated with the stage.
The status of the stage, or for a completed stage, the last status of the stage.
Note
A status of cancelled means that the pipeline’s definition was updated before the stage execution could be completed.
The state of the inbound transition, which is either enabled or disabled.
Whether the transition between stages is enabled (true) or disabled (false).
The ID of the user who last changed the transition state.
The timestamp when the transition state was last changed.
The user-specified reason why the transition between two stages of a pipeline was disabled.
The state of the stage.
Represents information about the state of an action.
The name of the action.
Represents information about the version (or revision) of an action.
The system-generated unique ID that identifies the revision number of the action.
The unique identifier of the change that set the state to this revision (for example, a deployment ID or timestamp).
The date and time when the most recent version of the action was created, in timestamp format.
Represents information about the run of an action.
ID of the workflow action execution in the current stage. Use the GetPipelineState action to retrieve the current action execution details of the current stage.
Note
For older executions, this field might be empty. The action execution ID is available for executions run on or after March 2020.
The status of the action, or for a completed action, the last status of the action.
A summary of the run of the action.
The last status change of the action.
The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the GetPipelineState command. It is used to validate that the approval request corresponding to this token is still valid.
The ARN of the user who last changed the pipeline.
The external ID of the run of the action.
The URL of a resource external to AWS that is used when running the action (for example, an external repository URL).
A percentage of completeness of the action as it runs.
The details of an error returned by a URL external to AWS.
The system ID or number code of the error.
The text of the error message.
A URL link for more information about the state of the action, such as a deployment group details page.
A URL link for more information about the revision, such as a commit details page.
Information about the latest execution in the stage, including its ID and status.
The ID of the pipeline execution associated with the stage.
The status of the stage, or for a completed stage, the last status of the stage.
Note
A status of cancelled means that the pipeline’s definition was updated before the stage execution could be completed.
The date and time the pipeline was created, in timestamp format.
The date and time the pipeline was last updated, in timestamp format.
Exceptions
CodePipeline.Client.exceptions.ValidationExceptionCodePipeline.Client.exceptions.PipelineNotFoundExceptionget_third_party_job_details(**kwargs)¶Requests the details of a job for a third party action. Used for partner actions only.
Warning
When this API is called, AWS 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
response = client.get_third_party_job_details(
jobId='string',
clientToken='string'
)
[REQUIRED]
The unique system-generated ID used for identifying the job.
[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',
'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 AWS 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.
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 AWS 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.
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) --
Represents information about an artifact that is worked on by actions in the pipeline.
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) --
Represents information about an artifact that is worked on by actions in the pipeline.
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 AWS session credentials object. These credentials are temporary credentials that are issued by AWS 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 AWS 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 AWS 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 AWS Key Management Service (AWS KMS) key. This is optional and might not be present.
id (string) --
The ID used to identify the key. For an AWS 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 customer master key (CMK). For cross-account actions, you can only use the key ID or key ARN to identify the key.
type (string) --
The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. When creating or updating a pipeline, the value must be set to 'KMS'.
nonce (string) --
A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Use this number in an AcknowledgeThirdPartyJob request.
Exceptions
CodePipeline.Client.exceptions.JobNotFoundExceptionCodePipeline.Client.exceptions.ValidationExceptionCodePipeline.Client.exceptions.InvalidClientTokenExceptionCodePipeline.Client.exceptions.InvalidJobExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_action_executions(**kwargs)¶Lists the action executions that have occurred in a pipeline.
See also: AWS API Documentation
Request Syntax
response = client.list_action_executions(
pipelineName='string',
filter={
'pipelineExecutionId': 'string'
},
maxResults=123,
nextToken='string'
)
[REQUIRED]
The name of the pipeline for which you want to list action execution history.
Input information used to filter action execution history.
The pipeline execution ID used to filter action execution history.
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.
Note
Detailed execution history is available for executions run on or after February 21, 2019.
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),
'status': 'InProgress'|'Abandoned'|'Succeeded'|'Failed',
'input': {
'actionTypeId': {
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval',
'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'
},
'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.
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.
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 AWS 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.
resolvedConfiguration (dict) --
Configuration data for an action execution with all variable references replaced with their real values for the execution.
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 AWS 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.
outputVariables (dict) --
The outputVariables field shows the key-value pairs that were output as part of that execution.
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.
Exceptions
CodePipeline.Client.exceptions.ValidationExceptionCodePipeline.Client.exceptions.PipelineNotFoundExceptionCodePipeline.Client.exceptions.InvalidNextTokenExceptionCodePipeline.Client.exceptions.PipelineExecutionNotFoundExceptionlist_action_types(**kwargs)¶Gets a summary of all AWS CodePipeline action types associated with your account.
See also: AWS API Documentation
Request Syntax
response = client.list_action_types(
actionOwnerFilter='AWS'|'ThirdParty'|'Custom',
nextToken='string',
regionFilter='string'
)
dict
Response Syntax
{
'actionTypes': [
{
'id': {
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval',
'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.
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 AWS 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 AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display in the pipeline.
executionUrlTemplate (string) --
The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action.
revisionUrlTemplate (string) --
The URL returned to the AWS 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.
Exceptions
CodePipeline.Client.exceptions.ValidationExceptionCodePipeline.Client.exceptions.InvalidNextTokenExceptionlist_pipeline_executions(**kwargs)¶Gets a summary of the most recent executions for a pipeline.
See also: AWS API Documentation
Request Syntax
response = client.list_pipeline_executions(
pipelineName='string',
maxResults=123,
nextToken='string'
)
[REQUIRED]
The name of the pipeline for which you want to get execution summary information.
ListPipelineExecutions call, which can be used to return the next set of pipeline executions in the list.dict
Response Syntax
{
'pipelineExecutionSummaries': [
{
'pipelineExecutionId': 'string',
'status': 'Cancelled'|'InProgress'|'Stopped'|'Stopping'|'Succeeded'|'Superseded'|'Failed',
'startTime': datetime(2015, 1, 1),
'lastUpdateTime': datetime(2015, 1, 1),
'sourceRevisions': [
{
'actionName': 'string',
'revisionId': 'string',
'revisionSummary': 'string',
'revisionUrl': 'string'
},
],
'trigger': {
'triggerType': 'CreatePipeline'|'StartPipelineExecution'|'PollForSourceChanges'|'Webhook'|'CloudWatchEvent'|'PutActionRevision',
'triggerDetail': 'string'
},
'stopTrigger': {
'reason': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Represents the output of a ListPipelineExecutions action.
pipelineExecutionSummaries (list) --
A list of executions in the history of a pipeline.
(dict) --
Summary information about a pipeline execution.
pipelineExecutionId (string) --
The ID of the pipeline execution.
status (string) --
The status of the pipeline execution.
startTime (datetime) --
The date and time when the pipeline execution began, in timestamp format.
lastUpdateTime (datetime) --
The date and time of the last change to the pipeline execution, in timestamp format.
sourceRevisions (list) --
A list of the source artifact revisions that initiated a pipeline execution.
(dict) --
Information about the version (or revision) of a source artifact that initiated a pipeline execution.
actionName (string) --
The name of the action that processed the revision to the source artifact.
revisionId (string) --
The system-generated unique ID that identifies the revision number of the artifact.
revisionSummary (string) --
Summary information about the most recent revision of the artifact. For GitHub and AWS CodeCommit repositories, the commit message. For Amazon S3 buckets or actions, the user-provided content of a codepipeline-artifact-revision-summary key specified in the object metadata.
revisionUrl (string) --
The commit ID for the artifact revision. For artifacts stored in GitHub or AWS CodeCommit repositories, the commit ID is linked to a commit details page.
trigger (dict) --
The interaction or event that started a pipeline execution, such as automated change detection or a StartPipelineExecution API call.
triggerType (string) --
The type of change-detection method, command, or user interaction that started a pipeline execution.
triggerDetail (string) --
Detail related to the event that started a pipeline execution, such as the webhook ARN of the webhook that triggered the pipeline execution or the user ARN for a user-initiated start-pipeline-execution CLI command.
stopTrigger (dict) --
The interaction that stopped a pipeline execution.
reason (string) --
The user-specified reason the pipeline was stopped.
nextToken (string) --
A token that can be used in the next ListPipelineExecutions call. To view all items in the list, continue to call this operation with each subsequent token until no more nextToken values are returned.
Exceptions
CodePipeline.Client.exceptions.ValidationExceptionCodePipeline.Client.exceptions.PipelineNotFoundExceptionCodePipeline.Client.exceptions.InvalidNextTokenExceptionlist_pipelines(**kwargs)¶Gets a summary of all of the pipelines associated with your account.
See also: AWS API Documentation
Request Syntax
response = client.list_pipelines(
nextToken='string',
maxResults=123
)
dict
Response Syntax
{
'pipelines': [
{
'name': 'string',
'version': 123,
'created': datetime(2015, 1, 1),
'updated': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Represents the output of a ListPipelines action.
pipelines (list) --
The list of pipelines.
(dict) --
Returns a summary of a pipeline.
name (string) --
The name of the pipeline.
version (integer) --
The version number of the pipeline.
created (datetime) --
The date and time the pipeline was created, in timestamp format.
updated (datetime) --
The date and time of the last update to the pipeline, in timestamp format.
nextToken (string) --
If the amount of returned information is significantly large, an identifier is also returned. It can be used in a subsequent list pipelines call to return the next set of pipelines in the list.
Exceptions
CodePipeline.Client.exceptions.ValidationExceptionCodePipeline.Client.exceptions.InvalidNextTokenExceptionGets the set of key-value pairs (metadata) that are used to manage the resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource to get tags for.
dict
Response Syntax
{
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
tags (list) --
The tags for the resource.
(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.
nextToken (string) --
If the amount of returned information is significantly large, an identifier is also returned and can be used in a subsequent API call to return the next page of the list. The ListTagsforResource call lists all available tags in one call and does not use pagination.
Exceptions
CodePipeline.Client.exceptions.ValidationExceptionCodePipeline.Client.exceptions.ResourceNotFoundExceptionCodePipeline.Client.exceptions.InvalidNextTokenExceptionCodePipeline.Client.exceptions.InvalidArnExceptionlist_webhooks(**kwargs)¶Gets a listing of all the webhooks in this AWS Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.
See also: AWS API Documentation
Request Syntax
response = client.list_webhooks(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'webhooks': [
{
'definition': {
'name': 'string',
'targetPipeline': 'string',
'targetAction': 'string',
'filters': [
{
'jsonPath': 'string',
'matchEquals': 'string'
},
],
'authentication': 'GITHUB_HMAC'|'IP'|'UNAUTHENTICATED',
'authenticationConfiguration': {
'AllowedIPRange': 'string',
'SecretToken': 'string'
}
},
'url': 'string',
'errorMessage': 'string',
'errorCode': 'string',
'lastTriggered': datetime(2015, 1, 1),
'arn': 'string',
'tags': [
{
'key': 'string',
'value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
webhooks (list) --
The JSON detail returned for each webhook in the list output for the ListWebhooks call.
(dict) --
The detail returned for each webhook after listing webhooks, such as the webhook URL, the webhook name, and the webhook ARN.
definition (dict) --
The detail returned for each webhook, such as the webhook authentication type and filter rules.
name (string) --
The name of the webhook.
targetPipeline (string) --
The name of the pipeline you want to connect to the webhook.
targetAction (string) --
The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.
filters (list) --
A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.
(dict) --
The event criteria that specify when a webhook notification is sent to your URL.
jsonPath (string) --
A JsonPath expression that is applied to the body/payload of the webhook. The value selected by the JsonPath expression must match the value specified in the MatchEquals field. Otherwise, the request is ignored. For more information, see Java JsonPath implementation in GitHub.
matchEquals (string) --
The value selected by the JsonPath expression must match what is supplied in the MatchEquals field. Otherwise, the request is ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly brackets. For example, if the value supplied here is "refs/heads/{Branch}" and the target action has an action configuration property called "Branch" with a value of "master", the MatchEquals value is evaluated as "refs/heads/master". For a list of action configuration properties for built-in action types, see Pipeline Structure Reference Action Requirements .
authentication (string) --
Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
authenticationConfiguration (dict) --
Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.
AllowedIPRange (string) --
The property used to configure acceptance of webhooks in an IP address range. For IP, only the AllowedIPRange property must be set. This property must be set to a valid CIDR range.
SecretToken (string) --
The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set.
url (string) --
A unique URL generated by CodePipeline. When a POST request is made to this URL, the defined pipeline is started as long as the body of the post request satisfies the defined authentication and filtering conditions. Deleting and re-creating a webhook makes the old URL invalid and generates a new one.
errorMessage (string) --
The text of the error message about the webhook.
errorCode (string) --
The number code of the error.
lastTriggered (datetime) --
The date and time a webhook was last successfully triggered, in timestamp format.
arn (string) --
The Amazon Resource Name (ARN) of the webhook.
tags (list) --
Specifies the tags applied to the webhook.
(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.
NextToken (string) --
If the amount of returned information is significantly large, an identifier is also returned and can be used in a subsequent ListWebhooks call to return the next set of webhooks in the list.
Exceptions
CodePipeline.Client.exceptions.ValidationExceptionCodePipeline.Client.exceptions.InvalidNextTokenExceptionpoll_for_jobs(**kwargs)¶Returns information about any jobs for AWS 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, AWS 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
response = client.poll_for_jobs(
actionTypeId={
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval',
'owner': 'AWS'|'ThirdParty'|'Custom',
'provider': 'string',
'version': 'string'
},
maxBatchSize=123,
queryParam={
'string': 'string'
}
)
[REQUIRED]
Represents information about an action type.
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.
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 .
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 AWS CodeDeploy, which would be specified as CodeDeploy. For more information, see Valid Action Types and Providers in CodePipeline .
A string that describes the action version.
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.
dict
Response Syntax
{
'jobs': [
{
'id': 'string',
'data': {
'actionTypeId': {
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval',
'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.
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 AWS 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.
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) --
Represents information about an artifact that is worked on by actions in the pipeline.
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) --
Represents information about an artifact that is worked on by actions in the pipeline.
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 AWS session credentials object. These credentials are temporary credentials that are issued by AWS 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 AWS 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 AWS CodeDeploy 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 AWS Key Management Service (AWS KMS) key.
id (string) --
The ID used to identify the key. For an AWS 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 customer master key (CMK). For cross-account actions, you can only use the key ID or key ARN to identify the key.
type (string) --
The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. When creating or updating a pipeline, the value must be set to 'KMS'.
nonce (string) --
A system-generated random number that AWS 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 AWS account to use when performing the job.
Exceptions
CodePipeline.Client.exceptions.ValidationExceptionCodePipeline.Client.exceptions.ActionTypeNotFoundExceptionpoll_for_third_party_jobs(**kwargs)¶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, AWS 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
response = client.poll_for_third_party_jobs(
actionTypeId={
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval',
'owner': 'AWS'|'ThirdParty'|'Custom',
'provider': 'string',
'version': 'string'
},
maxBatchSize=123
)
[REQUIRED]
Represents information about an action type.
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.
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 .
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 AWS CodeDeploy, which would be specified as CodeDeploy. For more information, see Valid Action Types and Providers in CodePipeline .
A string that describes the action version.
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 AWS 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 AWS CodePipeline.
Exceptions
CodePipeline.Client.exceptions.ActionTypeNotFoundExceptionCodePipeline.Client.exceptions.ValidationExceptionput_action_revision(**kwargs)¶Provides information to AWS CodePipeline about new revisions to a source.
See also: AWS API Documentation
Request Syntax
response = client.put_action_revision(
pipelineName='string',
stageName='string',
actionName='string',
actionRevision={
'revisionId': 'string',
'revisionChangeId': 'string',
'created': datetime(2015, 1, 1)
}
)
[REQUIRED]
The name of the pipeline that starts processing the revision to the source.
[REQUIRED]
The name of the stage that contains the action that acts on the revision.
[REQUIRED]
The name of the action that processes the revision.
[REQUIRED]
Represents information about the version (or revision) of an action.
The system-generated unique ID that identifies the revision number of the action.
The unique identifier of the change that set the state to this revision (for example, a deployment ID or timestamp).
The date and time when the most recent version of the action was created, in timestamp format.
dict
Response Syntax
{
'newRevision': True|False,
'pipelineExecutionId': 'string'
}
Response Structure
(dict) --
Represents the output of a PutActionRevision action.
newRevision (boolean) --
Indicates whether the artifact revision was previously used in an execution of the specified pipeline.
pipelineExecutionId (string) --
The ID of the current workflow state of the pipeline.
Exceptions
CodePipeline.Client.exceptions.PipelineNotFoundExceptionCodePipeline.Client.exceptions.StageNotFoundExceptionCodePipeline.Client.exceptions.ActionNotFoundExceptionCodePipeline.Client.exceptions.ValidationExceptionput_approval_result(**kwargs)¶Provides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and Rejected.
See also: AWS API Documentation
Request Syntax
response = client.put_approval_result(
pipelineName='string',
stageName='string',
actionName='string',
result={
'summary': 'string',
'status': 'Approved'|'Rejected'
},
token='string'
)
[REQUIRED]
The name of the pipeline that contains the action.
[REQUIRED]
The name of the stage that contains the action.
[REQUIRED]
The name of the action for which approval is requested.
[REQUIRED]
Represents information about the result of the approval request.
The summary of the current status of the approval request.
The response submitted by a reviewer assigned to an approval action request.
[REQUIRED]
The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the GetPipelineState action. It is used to validate that the approval request corresponding to this token is still valid.
dict
Response Syntax
{
'approvedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Represents the output of a PutApprovalResult action.
approvedAt (datetime) --
The timestamp showing when the approval or rejection was submitted.
Exceptions
CodePipeline.Client.exceptions.InvalidApprovalTokenExceptionCodePipeline.Client.exceptions.ApprovalAlreadyCompletedExceptionCodePipeline.Client.exceptions.PipelineNotFoundExceptionCodePipeline.Client.exceptions.StageNotFoundExceptionCodePipeline.Client.exceptions.ActionNotFoundExceptionCodePipeline.Client.exceptions.ValidationExceptionput_job_failure_result(**kwargs)¶Represents the failure of a job as returned to the pipeline by a job worker. Used for custom actions only.
See also: AWS API Documentation
Request Syntax
response = client.put_job_failure_result(
jobId='string',
failureDetails={
'type': 'JobFailed'|'ConfigurationError'|'PermissionError'|'RevisionOutOfSync'|'RevisionUnavailable'|'SystemUnavailable',
'message': 'string',
'externalExecutionId': 'string'
}
)
[REQUIRED]
The unique system-generated ID of the job that failed. This is the same ID returned from PollForJobs .
[REQUIRED]
The details about the failure of a job.
The type of the failure.
The message about the failure.
The external ID of the run of the action that failed.
None
Exceptions
CodePipeline.Client.exceptions.ValidationExceptionCodePipeline.Client.exceptions.JobNotFoundExceptionCodePipeline.Client.exceptions.InvalidJobStateExceptionput_job_success_result(**kwargs)¶Represents the success of a job as returned to the pipeline by a job worker. Used for custom actions only.
See also: AWS API Documentation
Request Syntax
response = client.put_job_success_result(
jobId='string',
currentRevision={
'revision': 'string',
'changeIdentifier': 'string',
'created': datetime(2015, 1, 1),
'revisionSummary': 'string'
},
continuationToken='string',
executionDetails={
'summary': 'string',
'externalExecutionId': 'string',
'percentComplete': 123
},
outputVariables={
'string': 'string'
}
)
[REQUIRED]
The unique system-generated ID of the job that succeeded. This is the same ID returned from PollForJobs .
The ID of the current revision of the artifact successfully worked on by the job.
The revision ID of the current version of an artifact.
The change identifier for the current revision.
The date and time when the most recent revision of the artifact was created, in timestamp format.
The summary of the most recent revision of the artifact.
The execution details of the successful job, such as the actions taken by the job worker.
The summary of the current status of the actions.
The system-generated unique ID of this action used to identify this job worker in any external systems, such as AWS CodeDeploy.
The percentage of work completed on the action, represented on a scale of 0 to 100 percent.
Key-value pairs produced as output by a job worker that can be made available to a downstream action configuration. outputVariables can be included only when there is no continuation token on the request.
None
Exceptions
CodePipeline.Client.exceptions.ValidationExceptionCodePipeline.Client.exceptions.JobNotFoundExceptionCodePipeline.Client.exceptions.InvalidJobStateExceptionCodePipeline.Client.exceptions.OutputVariablesSizeExceededExceptionput_third_party_job_failure_result(**kwargs)¶Represents the failure of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
See also: AWS API Documentation
Request Syntax
response = client.put_third_party_job_failure_result(
jobId='string',
clientToken='string',
failureDetails={
'type': 'JobFailed'|'ConfigurationError'|'PermissionError'|'RevisionOutOfSync'|'RevisionUnavailable'|'SystemUnavailable',
'message': 'string',
'externalExecutionId': 'string'
}
)
[REQUIRED]
The ID of the job that failed. This is the same ID returned from PollForThirdPartyJobs .
[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.
[REQUIRED]
Represents information about failure details.
The type of the failure.
The message about the failure.
The external ID of the run of the action that failed.
None
Exceptions
CodePipeline.Client.exceptions.ValidationExceptionCodePipeline.Client.exceptions.JobNotFoundExceptionCodePipeline.Client.exceptions.InvalidJobStateExceptionCodePipeline.Client.exceptions.InvalidClientTokenExceptionput_third_party_job_success_result(**kwargs)¶Represents the success of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
See also: AWS API Documentation
Request Syntax
response = client.put_third_party_job_success_result(
jobId='string',
clientToken='string',
currentRevision={
'revision': 'string',
'changeIdentifier': 'string',
'created': datetime(2015, 1, 1),
'revisionSummary': 'string'
},
continuationToken='string',
executionDetails={
'summary': 'string',
'externalExecutionId': 'string',
'percentComplete': 123
}
)
[REQUIRED]
The ID of the job that successfully completed. This is the same ID returned from PollForThirdPartyJobs .
[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.
Represents information about a current revision.
The revision ID of the current version of an artifact.
The change identifier for the current revision.
The date and time when the most recent revision of the artifact was created, in timestamp format.
The summary of the most recent revision of the artifact.
The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline.
The summary of the current status of the actions.
The system-generated unique ID of this action used to identify this job worker in any external systems, such as AWS CodeDeploy.
The percentage of work completed on the action, represented on a scale of 0 to 100 percent.
None
Exceptions
CodePipeline.Client.exceptions.ValidationExceptionCodePipeline.Client.exceptions.JobNotFoundExceptionCodePipeline.Client.exceptions.InvalidJobStateExceptionCodePipeline.Client.exceptions.InvalidClientTokenExceptionput_webhook(**kwargs)¶Defines a webhook and returns a unique webhook URL generated by CodePipeline. This URL can be supplied to third party source hosting providers to call every time there's a code change. When CodePipeline receives a POST request on this URL, the pipeline defined in the webhook is started as long as the POST request satisfied the authentication and filtering requirements supplied when defining the webhook. RegisterWebhookWithThirdParty and DeregisterWebhookWithThirdParty APIs can be used to automatically configure supported third parties to call the generated webhook URL.
See also: AWS API Documentation
Request Syntax
response = client.put_webhook(
webhook={
'name': 'string',
'targetPipeline': 'string',
'targetAction': 'string',
'filters': [
{
'jsonPath': 'string',
'matchEquals': 'string'
},
],
'authentication': 'GITHUB_HMAC'|'IP'|'UNAUTHENTICATED',
'authenticationConfiguration': {
'AllowedIPRange': 'string',
'SecretToken': 'string'
}
},
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
[REQUIRED]
The detail provided in an input file to create the webhook, such as the webhook name, the pipeline name, and the action name. Give the webhook a unique name that helps you identify it. You might name the webhook after the pipeline and action it targets so that you can easily recognize what it's used for later.
The name of the webhook.
The name of the pipeline you want to connect to the webhook.
The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.
A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.
The event criteria that specify when a webhook notification is sent to your URL.
A JsonPath expression that is applied to the body/payload of the webhook. The value selected by the JsonPath expression must match the value specified in the MatchEquals field. Otherwise, the request is ignored. For more information, see Java JsonPath implementation in GitHub.
The value selected by the JsonPath expression must match what is supplied in the MatchEquals field. Otherwise, the request is ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly brackets. For example, if the value supplied here is "refs/heads/{Branch}" and the target action has an action configuration property called "Branch" with a value of "master", the MatchEquals value is evaluated as "refs/heads/master". For a list of action configuration properties for built-in action types, see Pipeline Structure Reference Action Requirements .
Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.
The property used to configure acceptance of webhooks in an IP address range. For IP, only the AllowedIPRange property must be set. This property must be set to a valid CIDR range.
The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set.
The tags for the webhook.
A tag is a key-value pair that is used to manage the resource.
The tag's key.
The tag's value.
dict
Response Syntax
{
'webhook': {
'definition': {
'name': 'string',
'targetPipeline': 'string',
'targetAction': 'string',
'filters': [
{
'jsonPath': 'string',
'matchEquals': 'string'
},
],
'authentication': 'GITHUB_HMAC'|'IP'|'UNAUTHENTICATED',
'authenticationConfiguration': {
'AllowedIPRange': 'string',
'SecretToken': 'string'
}
},
'url': 'string',
'errorMessage': 'string',
'errorCode': 'string',
'lastTriggered': datetime(2015, 1, 1),
'arn': 'string',
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
}
Response Structure
(dict) --
webhook (dict) --
The detail returned from creating the webhook, such as the webhook name, webhook URL, and webhook ARN.
definition (dict) --
The detail returned for each webhook, such as the webhook authentication type and filter rules.
name (string) --
The name of the webhook.
targetPipeline (string) --
The name of the pipeline you want to connect to the webhook.
targetAction (string) --
The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.
filters (list) --
A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.
(dict) --
The event criteria that specify when a webhook notification is sent to your URL.
jsonPath (string) --
A JsonPath expression that is applied to the body/payload of the webhook. The value selected by the JsonPath expression must match the value specified in the MatchEquals field. Otherwise, the request is ignored. For more information, see Java JsonPath implementation in GitHub.
matchEquals (string) --
The value selected by the JsonPath expression must match what is supplied in the MatchEquals field. Otherwise, the request is ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly brackets. For example, if the value supplied here is "refs/heads/{Branch}" and the target action has an action configuration property called "Branch" with a value of "master", the MatchEquals value is evaluated as "refs/heads/master". For a list of action configuration properties for built-in action types, see Pipeline Structure Reference Action Requirements .
authentication (string) --
Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
authenticationConfiguration (dict) --
Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.
AllowedIPRange (string) --
The property used to configure acceptance of webhooks in an IP address range. For IP, only the AllowedIPRange property must be set. This property must be set to a valid CIDR range.
SecretToken (string) --
The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set.
url (string) --
A unique URL generated by CodePipeline. When a POST request is made to this URL, the defined pipeline is started as long as the body of the post request satisfies the defined authentication and filtering conditions. Deleting and re-creating a webhook makes the old URL invalid and generates a new one.
errorMessage (string) --
The text of the error message about the webhook.
errorCode (string) --
The number code of the error.
lastTriggered (datetime) --
The date and time a webhook was last successfully triggered, in timestamp format.
arn (string) --
The Amazon Resource Name (ARN) of the webhook.
tags (list) --
Specifies the tags applied to the webhook.
(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.
Exceptions
CodePipeline.Client.exceptions.ValidationExceptionCodePipeline.Client.exceptions.LimitExceededExceptionCodePipeline.Client.exceptions.InvalidWebhookFilterPatternExceptionCodePipeline.Client.exceptions.InvalidWebhookAuthenticationParametersExceptionCodePipeline.Client.exceptions.PipelineNotFoundExceptionCodePipeline.Client.exceptions.TooManyTagsExceptionCodePipeline.Client.exceptions.InvalidTagsExceptionCodePipeline.Client.exceptions.ConcurrentModificationExceptionregister_webhook_with_third_party(**kwargs)¶Configures a connection between the webhook that was created and the external tool with events to be detected.
See also: AWS API Documentation
Request Syntax
response = client.register_webhook_with_third_party(
webhookName='string'
)
{}
Response Structure
Exceptions
CodePipeline.Client.exceptions.ValidationExceptionCodePipeline.Client.exceptions.WebhookNotFoundExceptionretry_stage_execution(**kwargs)¶Resumes the pipeline execution by retrying the last failed actions in a stage. You can retry a stage immediately if any of the actions in the stage fail. When you retry, all actions that are still in progress continue working, and failed actions are triggered again.
See also: AWS API Documentation
Request Syntax
response = client.retry_stage_execution(
pipelineName='string',
stageName='string',
pipelineExecutionId='string',
retryMode='FAILED_ACTIONS'
)
[REQUIRED]
The name of the pipeline that contains the failed stage.
[REQUIRED]
The name of the failed stage to be retried.
[REQUIRED]
The ID of the pipeline execution in the failed stage to be retried. Use the GetPipelineState action to retrieve the current pipelineExecutionId of the failed stage
[REQUIRED]
The scope of the retry attempt. Currently, the only supported value is FAILED_ACTIONS.
dict
Response Syntax
{
'pipelineExecutionId': 'string'
}
Response Structure
(dict) --
Represents the output of a RetryStageExecution action.
pipelineExecutionId (string) --
The ID of the current workflow execution in the failed stage.
Exceptions
CodePipeline.Client.exceptions.ValidationExceptionCodePipeline.Client.exceptions.ConflictExceptionCodePipeline.Client.exceptions.PipelineNotFoundExceptionCodePipeline.Client.exceptions.StageNotFoundExceptionCodePipeline.Client.exceptions.StageNotRetryableExceptionCodePipeline.Client.exceptions.NotLatestPipelineExecutionExceptionstart_pipeline_execution(**kwargs)¶Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.
See also: AWS API Documentation
Request Syntax
response = client.start_pipeline_execution(
name='string',
clientRequestToken='string'
)
[REQUIRED]
The name of the pipeline to start.
The system-generated unique ID used to identify a unique execution request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'pipelineExecutionId': 'string'
}
Response Structure
(dict) --
Represents the output of a StartPipelineExecution action.
pipelineExecutionId (string) --
The unique system-generated ID of the pipeline execution that was started.
Exceptions
CodePipeline.Client.exceptions.ValidationExceptionCodePipeline.Client.exceptions.ConflictExceptionCodePipeline.Client.exceptions.PipelineNotFoundExceptionstop_pipeline_execution(**kwargs)¶Stops the specified pipeline execution. You choose to either stop the pipeline execution by completing in-progress actions without starting subsequent actions, or by abandoning in-progress actions. While completing or abandoning in-progress actions, the pipeline execution is in a Stopping state. After all in-progress actions are completed or abandoned, the pipeline execution is in a Stopped state.
See also: AWS API Documentation
Request Syntax
response = client.stop_pipeline_execution(
pipelineName='string',
pipelineExecutionId='string',
abandon=True|False,
reason='string'
)
[REQUIRED]
The name of the pipeline to stop.
[REQUIRED]
The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action to retrieve the current pipelineExecutionId.
Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.
Note
This option can lead to failed or out-of-sequence tasks.
dict
Response Syntax
{
'pipelineExecutionId': 'string'
}
Response Structure
(dict) --
pipelineExecutionId (string) --
The unique system-generated ID of the pipeline execution that was stopped.
Exceptions
CodePipeline.Client.exceptions.ValidationExceptionCodePipeline.Client.exceptions.ConflictExceptionCodePipeline.Client.exceptions.PipelineNotFoundExceptionCodePipeline.Client.exceptions.PipelineExecutionNotStoppableExceptionCodePipeline.Client.exceptions.DuplicatedStopRequestExceptiontag_resource(**kwargs)¶Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource you want to add tags to.
[REQUIRED]
The tags you want to modify or add to the resource.
A tag is a key-value pair that is used to manage the resource.
The tag's key.
The tag's value.
dict
Response Syntax
{}
Response Structure
Exceptions
CodePipeline.Client.exceptions.ValidationExceptionCodePipeline.Client.exceptions.ResourceNotFoundExceptionCodePipeline.Client.exceptions.InvalidArnExceptionCodePipeline.Client.exceptions.TooManyTagsExceptionCodePipeline.Client.exceptions.InvalidTagsExceptionCodePipeline.Client.exceptions.ConcurrentModificationExceptionuntag_resource(**kwargs)¶Removes tags from an AWS resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource to remove tags from.
[REQUIRED]
The list of keys for the tags to be removed from the resource.
dict
Response Syntax
{}
Response Structure
Exceptions
CodePipeline.Client.exceptions.ValidationExceptionCodePipeline.Client.exceptions.ResourceNotFoundExceptionCodePipeline.Client.exceptions.InvalidArnExceptionCodePipeline.Client.exceptions.InvalidTagsExceptionCodePipeline.Client.exceptions.ConcurrentModificationExceptionupdate_action_type(**kwargs)¶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
response = 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',
'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'
}
}
)
[REQUIRED]
The action type definition for the action type to be updated.
The description for the action type to be updated.
Information about the executor for an action type that was created with any supported integration model.
The action configuration properties for the action type. These properties are specified in the action definition when the action type is created.
Details about the Lambda executor of the action type.
The ARN of the Lambda function used by the action engine.
Details about the JobWorker executor of the action type.
The accounts in which the job worker is configured and might poll for jobs as part of the action execution.
The service Principals in which the job worker is configured and might poll for jobs as part of the action execution.
The integration model used to create and update the action type, Lambda or JobWorker .
The policy statement that specifies the permissions in the CodePipeline customer’s 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.
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.
The action category, owner, provider, and version of the action type to be updated.
Defines what kind of action can be taken in the stage, one of the following:
SourceBuildTestDeployApprovalInvokeThe creator of the action type being called: AWS or ThirdParty .
The provider of the action type being called. The provider name is supplied when the action type is created.
A string that describes the action type version.
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.
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 .
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 .
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.
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 .
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 .
Details identifying the accounts with permissions to use the action type.
A list of AWS account IDs with access to use the action type in their pipelines.
The properties of the action type to be updated.
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.
The property name that is displayed to users.
Whether the configuration property is an optional value.
Whether the configuration property is a key.
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.
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.
The description of the property that is displayed to users.
The links associated with the action type to be updated.
The URL returned to the CodePipeline console that contains a link to the page where customers can configure the external action.
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.
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.
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.
Exceptions
CodePipeline.Client.exceptions.RequestFailedExceptionCodePipeline.Client.exceptions.ValidationExceptionCodePipeline.Client.exceptions.ActionTypeNotFoundExceptionupdate_pipeline(**kwargs)¶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
response = client.update_pipeline(
pipeline={
'name': 'string',
'roleArn': 'string',
'artifactStore': {
'type': 'S3',
'location': 'string',
'encryptionKey': {
'id': 'string',
'type': 'KMS'
}
},
'artifactStores': {
'string': {
'type': 'S3',
'location': 'string',
'encryptionKey': {
'id': 'string',
'type': 'KMS'
}
}
},
'stages': [
{
'name': 'string',
'blockers': [
{
'name': 'string',
'type': 'Schedule'
},
],
'actions': [
{
'name': 'string',
'actionTypeId': {
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval',
'owner': 'AWS'|'ThirdParty'|'Custom',
'provider': 'string',
'version': 'string'
},
'runOrder': 123,
'configuration': {
'string': 'string'
},
'outputArtifacts': [
{
'name': 'string'
},
],
'inputArtifacts': [
{
'name': 'string'
},
],
'roleArn': 'string',
'region': 'string',
'namespace': 'string'
},
]
},
],
'version': 123
}
)
[REQUIRED]
The name of the pipeline to be updated.
The name of the pipeline.
The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform actions with no actionRoleArn , or to use to assume roles for actions with an actionRoleArn .
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 .
The type of the artifact store, such as S3.
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 AWS Region as the pipeline to store your pipeline artifacts.
The encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service (AWS KMS) key. If this is undefined, the default key for Amazon S3 is used.
The ID used to identify the key. For an AWS 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 customer master key (CMK). For cross-account actions, you can only use the key ID or key ARN to identify the key.
The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. When creating or updating a pipeline, the value must be set to 'KMS'.
A mapping of artifactStore objects and their corresponding AWS 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 .
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 .
The type of the artifact store, such as S3.
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 AWS Region as the pipeline to store your pipeline artifacts.
The encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service (AWS KMS) key. If this is undefined, the default key for Amazon S3 is used.
The ID used to identify the key. For an AWS 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 customer master key (CMK). For cross-account actions, you can only use the key ID or key ARN to identify the key.
The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. When creating or updating a pipeline, the value must be set to 'KMS'.
The stage in which to perform the action.
Represents information about a stage and its definition.
The name of the stage.
Reserved for future use.
Reserved for future use.
Reserved for future use.
Reserved for future use.
The actions included in a stage.
Represents information about an action declaration.
The action declaration's name.
Specifies the action type and the provider of the action.
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.
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 .
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 AWS CodeDeploy, which would be specified as CodeDeploy. For more information, see Valid Action Types and Providers in CodePipeline .
A string that describes the action version.
The order in which actions are run.
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 AWS CloudFormation action type in CodePipeline, see Configuration Properties Reference in the AWS CloudFormation User Guide . For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the AWS 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 },
The name or ID of the result of the action declaration, such as a test or build artifact.
Represents information about the output of an action.
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.
The name or ID of the artifact consumed by the action, such as a test or build artifact.
Represents information about an artifact to be worked on, such as a test or build artifact.
The name of the artifact to be worked on (for example, "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.
The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
The action declaration's AWS Region, such as us-east-1.
The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
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.
{
'pipeline': {
'name': 'string',
'roleArn': 'string',
'artifactStore': {
'type': 'S3',
'location': 'string',
'encryptionKey': {
'id': 'string',
'type': 'KMS'
}
},
'artifactStores': {
'string': {
'type': 'S3',
'location': 'string',
'encryptionKey': {
'id': 'string',
'type': 'KMS'
}
}
},
'stages': [
{
'name': 'string',
'blockers': [
{
'name': 'string',
'type': 'Schedule'
},
],
'actions': [
{
'name': 'string',
'actionTypeId': {
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval',
'owner': 'AWS'|'ThirdParty'|'Custom',
'provider': 'string',
'version': 'string'
},
'runOrder': 123,
'configuration': {
'string': 'string'
},
'outputArtifacts': [
{
'name': 'string'
},
],
'inputArtifacts': [
{
'name': 'string'
},
],
'roleArn': 'string',
'region': 'string',
'namespace': 'string'
},
]
},
],
'version': 123
}
}
Response Structure
Represents the output of an UpdatePipeline action.
The structure of the updated pipeline.
The name of the pipeline.
The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform actions with no actionRoleArn , or to use to assume roles for actions with an actionRoleArn .
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 .
The type of the artifact store, such as S3.
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 AWS Region as the pipeline to store your pipeline artifacts.
The encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service (AWS KMS) key. If this is undefined, the default key for Amazon S3 is used.
The ID used to identify the key. For an AWS 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 customer master key (CMK). For cross-account actions, you can only use the key ID or key ARN to identify the key.
The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. When creating or updating a pipeline, the value must be set to 'KMS'.
A mapping of artifactStore objects and their corresponding AWS 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 .
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 .
The type of the artifact store, such as S3.
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 AWS Region as the pipeline to store your pipeline artifacts.
The encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service (AWS KMS) key. If this is undefined, the default key for Amazon S3 is used.
The ID used to identify the key. For an AWS 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 customer master key (CMK). For cross-account actions, you can only use the key ID or key ARN to identify the key.
The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. When creating or updating a pipeline, the value must be set to 'KMS'.
The stage in which to perform the action.
Represents information about a stage and its definition.
The name of the stage.
Reserved for future use.
Reserved for future use.
Reserved for future use.
Reserved for future use.
The actions included in a stage.
Represents information about an action declaration.
The action declaration's name.
Specifies the action type and the provider of the action.
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.
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 .
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 AWS CodeDeploy, which would be specified as CodeDeploy. For more information, see Valid Action Types and Providers in CodePipeline .
A string that describes the action version.
The order in which actions are run.
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 AWS CloudFormation action type in CodePipeline, see Configuration Properties Reference in the AWS CloudFormation User Guide . For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the AWS 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 },
The name or ID of the result of the action declaration, such as a test or build artifact.
Represents information about the output of an action.
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.
The name or ID of the artifact consumed by the action, such as a test or build artifact.
Represents information about an artifact to be worked on, such as a test or build artifact.
The name of the artifact to be worked on (for example, "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.
The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
The action declaration's AWS Region, such as us-east-1.
The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
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.
Exceptions
CodePipeline.Client.exceptions.ValidationExceptionCodePipeline.Client.exceptions.InvalidStageDeclarationExceptionCodePipeline.Client.exceptions.InvalidActionDeclarationExceptionCodePipeline.Client.exceptions.InvalidBlockerDeclarationExceptionCodePipeline.Client.exceptions.InvalidStructureExceptionCodePipeline.Client.exceptions.LimitExceededExceptionThe available paginators are:
CodePipeline.Paginator.ListActionExecutionsCodePipeline.Paginator.ListActionTypesCodePipeline.Paginator.ListPipelineExecutionsCodePipeline.Paginator.ListPipelinesCodePipeline.Paginator.ListTagsForResourceCodePipeline.Paginator.ListWebhooksCodePipeline.Paginator.ListActionExecutions¶paginator = client.get_paginator('list_action_executions')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CodePipeline.Client.list_action_executions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
pipelineName='string',
filter={
'pipelineExecutionId': 'string'
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the pipeline for which you want to list action execution history.
Input information used to filter action execution history.
The pipeline execution ID used to filter action execution history.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'actionExecutionDetails': [
{
'pipelineExecutionId': 'string',
'actionExecutionId': 'string',
'pipelineVersion': 123,
'stageName': 'string',
'actionName': 'string',
'startTime': datetime(2015, 1, 1),
'lastUpdateTime': datetime(2015, 1, 1),
'status': 'InProgress'|'Abandoned'|'Succeeded'|'Failed',
'input': {
'actionTypeId': {
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval',
'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'
},
'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.
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.
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 AWS 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.
resolvedConfiguration (dict) --
Configuration data for an action execution with all variable references replaced with their real values for the execution.
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 AWS 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.
outputVariables (dict) --
The outputVariables field shows the key-value pairs that were output as part of that execution.
NextToken (string) --
A token to resume pagination.
CodePipeline.Paginator.ListActionTypes¶paginator = client.get_paginator('list_action_types')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CodePipeline.Client.list_action_types().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
actionOwnerFilter='AWS'|'ThirdParty'|'Custom',
regionFilter='string',
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'actionTypes': [
{
'id': {
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval',
'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.
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 AWS 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 AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display in the pipeline.
executionUrlTemplate (string) --
The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action.
revisionUrlTemplate (string) --
The URL returned to the AWS 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) --
A token to resume pagination.
CodePipeline.Paginator.ListPipelineExecutions¶paginator = client.get_paginator('list_pipeline_executions')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CodePipeline.Client.list_pipeline_executions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
pipelineName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the pipeline for which you want to get execution summary information.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'pipelineExecutionSummaries': [
{
'pipelineExecutionId': 'string',
'status': 'Cancelled'|'InProgress'|'Stopped'|'Stopping'|'Succeeded'|'Superseded'|'Failed',
'startTime': datetime(2015, 1, 1),
'lastUpdateTime': datetime(2015, 1, 1),
'sourceRevisions': [
{
'actionName': 'string',
'revisionId': 'string',
'revisionSummary': 'string',
'revisionUrl': 'string'
},
],
'trigger': {
'triggerType': 'CreatePipeline'|'StartPipelineExecution'|'PollForSourceChanges'|'Webhook'|'CloudWatchEvent'|'PutActionRevision',
'triggerDetail': 'string'
},
'stopTrigger': {
'reason': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Represents the output of a ListPipelineExecutions action.
pipelineExecutionSummaries (list) --
A list of executions in the history of a pipeline.
(dict) --
Summary information about a pipeline execution.
pipelineExecutionId (string) --
The ID of the pipeline execution.
status (string) --
The status of the pipeline execution.
startTime (datetime) --
The date and time when the pipeline execution began, in timestamp format.
lastUpdateTime (datetime) --
The date and time of the last change to the pipeline execution, in timestamp format.
sourceRevisions (list) --
A list of the source artifact revisions that initiated a pipeline execution.
(dict) --
Information about the version (or revision) of a source artifact that initiated a pipeline execution.
actionName (string) --
The name of the action that processed the revision to the source artifact.
revisionId (string) --
The system-generated unique ID that identifies the revision number of the artifact.
revisionSummary (string) --
Summary information about the most recent revision of the artifact. For GitHub and AWS CodeCommit repositories, the commit message. For Amazon S3 buckets or actions, the user-provided content of a codepipeline-artifact-revision-summary key specified in the object metadata.
revisionUrl (string) --
The commit ID for the artifact revision. For artifacts stored in GitHub or AWS CodeCommit repositories, the commit ID is linked to a commit details page.
trigger (dict) --
The interaction or event that started a pipeline execution, such as automated change detection or a StartPipelineExecution API call.
triggerType (string) --
The type of change-detection method, command, or user interaction that started a pipeline execution.
triggerDetail (string) --
Detail related to the event that started a pipeline execution, such as the webhook ARN of the webhook that triggered the pipeline execution or the user ARN for a user-initiated start-pipeline-execution CLI command.
stopTrigger (dict) --
The interaction that stopped a pipeline execution.
reason (string) --
The user-specified reason the pipeline was stopped.
NextToken (string) --
A token to resume pagination.
CodePipeline.Paginator.ListPipelines¶paginator = client.get_paginator('list_pipelines')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CodePipeline.Client.list_pipelines().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'pipelines': [
{
'name': 'string',
'version': 123,
'created': datetime(2015, 1, 1),
'updated': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
Represents the output of a ListPipelines action.
The list of pipelines.
Returns a summary of a pipeline.
The name of the pipeline.
The version number of the pipeline.
The date and time the pipeline was created, in timestamp format.
The date and time of the last update to the pipeline, in timestamp format.
A token to resume pagination.
CodePipeline.Paginator.ListTagsForResource¶paginator = client.get_paginator('list_tags_for_resource')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CodePipeline.Client.list_tags_for_resource().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
resourceArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource to get tags for.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
tags (list) --
The tags for the resource.
(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.
NextToken (string) --
A token to resume pagination.
CodePipeline.Paginator.ListWebhooks¶paginator = client.get_paginator('list_webhooks')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CodePipeline.Client.list_webhooks().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'webhooks': [
{
'definition': {
'name': 'string',
'targetPipeline': 'string',
'targetAction': 'string',
'filters': [
{
'jsonPath': 'string',
'matchEquals': 'string'
},
],
'authentication': 'GITHUB_HMAC'|'IP'|'UNAUTHENTICATED',
'authenticationConfiguration': {
'AllowedIPRange': 'string',
'SecretToken': 'string'
}
},
'url': 'string',
'errorMessage': 'string',
'errorCode': 'string',
'lastTriggered': datetime(2015, 1, 1),
'arn': 'string',
'tags': [
{
'key': 'string',
'value': 'string'
},
]
},
],
}
Response Structure
The JSON detail returned for each webhook in the list output for the ListWebhooks call.
The detail returned for each webhook after listing webhooks, such as the webhook URL, the webhook name, and the webhook ARN.
The detail returned for each webhook, such as the webhook authentication type and filter rules.
The name of the webhook.
The name of the pipeline you want to connect to the webhook.
The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.
A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.
The event criteria that specify when a webhook notification is sent to your URL.
A JsonPath expression that is applied to the body/payload of the webhook. The value selected by the JsonPath expression must match the value specified in the MatchEquals field. Otherwise, the request is ignored. For more information, see Java JsonPath implementation in GitHub.
The value selected by the JsonPath expression must match what is supplied in the MatchEquals field. Otherwise, the request is ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly brackets. For example, if the value supplied here is "refs/heads/{Branch}" and the target action has an action configuration property called "Branch" with a value of "master", the MatchEquals value is evaluated as "refs/heads/master". For a list of action configuration properties for built-in action types, see Pipeline Structure Reference Action Requirements .
Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.
The property used to configure acceptance of webhooks in an IP address range. For IP, only the AllowedIPRange property must be set. This property must be set to a valid CIDR range.
The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set.
A unique URL generated by CodePipeline. When a POST request is made to this URL, the defined pipeline is started as long as the body of the post request satisfies the defined authentication and filtering conditions. Deleting and re-creating a webhook makes the old URL invalid and generates a new one.
The text of the error message about the webhook.
The number code of the error.
The date and time a webhook was last successfully triggered, in timestamp format.
The Amazon Resource Name (ARN) of the webhook.
Specifies the tags applied to the webhook.
A tag is a key-value pair that is used to manage the resource.
The tag's key.
The tag's value.