2015/07/09 - AWS CodePipeline - 23 new api methods
Provides information to AWS CodePipeline about new revisions to a source.
Request Syntax
client.put_action_revision(
pipelineName='string',
stageName='string',
actionName='string',
actionRevision={
'revisionId': 'string',
'revisionChangeId': 'string',
'created': datetime(2015, 1, 1)
}
)
string
[REQUIRED]
The name of the pipeline that will start processing the revision to the source.
string
[REQUIRED]
The name of the stage that contains the action that will act upon the revision.
string
[REQUIRED]
The name of the action that will process the revision.
dict
[REQUIRED]
Represents information about the version (or revision) of an action.
revisionId (string) -- [REQUIRED]
The system-generated unique ID that identifies the revision number of the action.
revisionChangeId (string) --
The unique identifier of the change that set the state to this revision, for example a deployment ID or timestamp.
created (datetime) -- [REQUIRED]
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 put action revision action.
newRevision (boolean) --
The new revision number or ID for the revision after the action completes.
pipelineExecutionId (string) --
The ID of the current workflow state of the pipeline.
Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions.
Request Syntax
client.put_job_failure_result(
jobId='string',
failureDetails={
'type': 'JobFailed'|'ConfigurationError'|'PermissionError'|'RevisionOutOfSync'|'RevisionUnavailable'|'SystemUnavailable',
'message': 'string',
'externalExecutionId': 'string'
}
)
string
[REQUIRED]
The unique system-generated ID of the job that failed. This is the same ID returned from PollForJobs.
dict
[REQUIRED]
The details about the failure of a job.
type (string) -- [REQUIRED]
The type of the failure.
message (string) --
The message about the failure.
externalExecutionId (string) --
The external ID of the run of the action that failed.
None
Marks a custom action as deleted. PollForJobs for the custom action will fail after the action is marked for deletion. Only used for custom actions.
Warning
You cannot recreate a custom action after it has been deleted unless you increase the version number of the action.
Request Syntax
client.delete_custom_action_type(
category='Source'|'Build'|'Deploy'|'Test'|'Invoke',
provider='string',
version='string'
)
string
[REQUIRED]
The category of the custom action that you want to delete, such as source or deploy.
string
[REQUIRED]
The provider of the service used in the custom action, such as AWS CodeDeploy.
string
[REQUIRED]
The version of the custom action to delete.
None
Requests the details of a job for a third party action. Only used for partner actions.
Warning
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.
Request Syntax
client.get_third_party_job_details(
jobId='string',
clientToken='string'
)
string
[REQUIRED]
The unique system-generated ID used for identifying the job.
string
[REQUIRED]
The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
dict
Response Syntax
{
'jobDetails': {
'id': 'string',
'data': {
'actionTypeId': {
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke',
'owner': 'AWS'|'ThirdParty'|'Custom',
'provider': 'string',
'version': 'string'
},
'actionConfiguration': {
'configuration': {
'string': 'string'
}
},
'pipelineContext': {
'pipelineName': 'string',
'stage': {
'name': 'string'
},
'action': {
'name': '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'
},
'nonce': 'string'
}
}
Response Structure
(dict) --
Represents the output of a get third party job details 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 values below.
owner (string) --
The creator of the action being called.
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.
version (string) --
A string that identifies the action type.
actionConfiguration (dict) --
Represents information about an action configuration.
configuration (dict) --
The configuration data for the action.
(string) --
(string) --
pipelineContext (dict) --
Represents information about a pipeline to a job worker.
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) --
Represents the context of an action within the stage of a pipeline to a job worker.
name (string) --
The name of the action within the context of a job.
inputArtifacts (list) --
The name of the artifact that will be worked upon by the action, if any. This name might be system-generated, such as "MyApp", or 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 will be worked upon 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 Amazon S3 bucket that contains the artifact.
bucketName (string) --
The name of the Amazon S3 bucket.
objectKey (string) --
The key of the object in the Amazon S3 bucket, which uniquely identifies the object in the bucket.
outputArtifacts (list) --
The name of the artifact that will be the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or might be defined by the user when the action is created.
(dict) --
Represents information about an artifact that will be worked upon 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 Amazon S3 bucket that contains the artifact.
bucketName (string) --
The name of the Amazon S3 bucket.
objectKey (string) --
The key of the object in the Amazon 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 Amazon 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 in order to continue the job asynchronously.
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. This number must be returned in the response.
Gets a summary of all of the pipelines associated with your account.
Request Syntax
client.list_pipelines(
nextToken='string'
)
string
An identifier that was returned from the previous list pipelines call, which can be used to return the next set of pipelines in the list.
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 list pipelines 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 which can be used in a subsequent list pipelines call to return the next set of pipelines in the list.
Determines whether there are any third party jobs for a job worker to act on. Only used for partner actions.
Warning
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts.
Request Syntax
client.poll_for_third_party_jobs(
actionTypeId={
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke',
'owner': 'AWS'|'ThirdParty'|'Custom',
'provider': 'string',
'version': 'string'
},
maxBatchSize=123
)
dict
[REQUIRED]
Represents information about an action type.
category (string) -- [REQUIRED]
A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the values below.
owner (string) -- [REQUIRED]
The creator of the action being called.
provider (string) -- [REQUIRED]
The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of AWS CodeDeploy, which would be specified as CodeDeploy.
version (string) -- [REQUIRED]
A string that identifies the action type.
integer
The maximum number of jobs to return in a poll for jobs call.
dict
Response Syntax
{
'jobs': [
{
'clientId': 'string',
'jobId': 'string'
},
]
}
Response Structure
(dict) --
Represents the output of a poll for third party jobs 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 upon 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.
Confirms a job worker has received the specified job. Only used for partner actions.
Request Syntax
client.acknowledge_third_party_job(
jobId='string',
nonce='string',
clientToken='string'
)
string
[REQUIRED]
The unique system-generated ID of the job.
string
[REQUIRED]
A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. This number must be returned in the response.
string
[REQUIRED]
The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
dict
Response Syntax
{
'status': 'Created'|'Queued'|'Dispatched'|'InProgress'|'TimedOut'|'Succeeded'|'Failed'
}
Response Structure
(dict) --
Represents the output of an acknowledge third party job action.
status (string) --
The status information for the third party job, if any.
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.
Request Syntax
client.get_pipeline(
name='string',
version=123
)
string
[REQUIRED]
The name of the pipeline for which you want to get information. Pipeline names must be unique under an Amazon Web Services (AWS) user account.
integer
The version number of the pipeline. If you do not specify a version, defaults to the most current version.
dict
Response Syntax
{
'pipeline': {
'name': 'string',
'roleArn': 'string',
'artifactStore': {
'type': 'S3',
'location': 'string'
},
'stages': [
{
'name': 'string',
'blockers': [
{
'name': 'string',
'type': 'Schedule'
},
],
'actions': [
{
'name': 'string',
'actionTypeId': {
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke',
'owner': 'AWS'|'ThirdParty'|'Custom',
'provider': 'string',
'version': 'string'
},
'runOrder': 123,
'configuration': {
'string': 'string'
},
'outputArtifacts': [
{
'name': 'string'
},
],
'inputArtifacts': [
{
'name': 'string'
},
],
'roleArn': 'string'
},
]
},
],
'version': 123
}
}
Response Structure
(dict) --
Represents the output of a get pipeline action.
pipeline (dict) --
Represents the structure of actions and stages to be performed in the pipeline.
name (string) --
The name of the action to be performed.
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) --
The Amazon S3 location where artifacts are stored for the pipeline. If this Amazon S3 bucket is created manually, it must meet the requirements for AWS CodePipeline. For more information, see the Concepts.
type (string) --
The type of the artifact store, such as S3.
location (string) --
The location for storing the artifacts for a pipeline, such as an S3 bucket or folder.
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) --
The gates included in a stage.
(dict) --
Represents information about a gate declaration.
name (string) --
The name of the gate declaration.
type (string) --
The type of the gate declaration.
actions (list) --
The actions included in a stage.
(dict) --
Represents information about an action declaration.
name (string) --
The action declaration's name.
actionTypeId (dict) --
The configuration information for the 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 values below.
owner (string) --
The creator of the action being called.
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.
version (string) --
A string that identifies the action type.
runOrder (integer) --
The order in which actions are run.
configuration (dict) --
The action declaration's configuration.
(string) --
(string) --
outputArtifacts (list) --
The name or ID of the result of the action declaration, such as a test or build artifact.
(dict) --
Represents information about the output of an action.
name (string) --
The name of the output of an artifact, such as "My App".
The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
Output artifact names must be unique within a pipeline.
inputArtifacts (list) --
The name or ID of the artifact consumed by the action, such as a test or build artifact.
(dict) --
Represents information about an artifact to be worked on, such as a test or build artifact.
name (string) --
The name of the artifact to be worked on, for example, "My App".
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 will perform the declared action. This is assumed through the roleArn for the pipeline.
version (integer) --
The version number of the pipeline. A new pipeline always has a version number of 1. This number is automatically incremented when a pipeline is updated.
Gets a summary of all AWS CodePipeline action types associated with your account.
Request Syntax
client.list_action_types(
actionOwnerFilter='AWS'|'ThirdParty'|'Custom',
nextToken='string'
)
string
Filters the list of action types to those created by a specified entity.
string
An identifier that was returned from the previous list action types call, which can be used to return the next set of action types in the list.
dict
Response Syntax
{
'actionTypes': [
{
'id': {
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke',
'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 list action types 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 values below.
owner (string) --
The creator of the action being called.
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.
version (string) --
A string that identifies the action type.
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 within 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 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 will preserve the prior value of the secret.
queryable (boolean) --
Indicates that the proprety will be used in conjunction 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 additional 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 will be 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 which can be used in a subsequent list action types call to return the next set of action types in the list.
Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure in conjunction with UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1.
Request Syntax
client.update_pipeline(
pipeline={
'name': 'string',
'roleArn': 'string',
'artifactStore': {
'type': 'S3',
'location': 'string'
},
'stages': [
{
'name': 'string',
'blockers': [
{
'name': 'string',
'type': 'Schedule'
},
],
'actions': [
{
'name': 'string',
'actionTypeId': {
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke',
'owner': 'AWS'|'ThirdParty'|'Custom',
'provider': 'string',
'version': 'string'
},
'runOrder': 123,
'configuration': {
'string': 'string'
},
'outputArtifacts': [
{
'name': 'string'
},
],
'inputArtifacts': [
{
'name': 'string'
},
],
'roleArn': 'string'
},
]
},
],
'version': 123
}
)
dict
[REQUIRED]
The name of the pipeline to be updated.
name (string) -- [REQUIRED]
The name of the action to be performed.
roleArn (string) -- [REQUIRED]
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) -- [REQUIRED]
The Amazon S3 location where artifacts are stored for the pipeline. If this Amazon S3 bucket is created manually, it must meet the requirements for AWS CodePipeline. For more information, see the Concepts.
type (string) -- [REQUIRED]
The type of the artifact store, such as S3.
location (string) -- [REQUIRED]
The location for storing the artifacts for a pipeline, such as an S3 bucket or folder.
stages (list) -- [REQUIRED]
The stage in which to perform the action.
(dict) --
Represents information about a stage and its definition.
name (string) -- [REQUIRED]
The name of the stage.
blockers (list) --
The gates included in a stage.
(dict) --
Represents information about a gate declaration.
name (string) -- [REQUIRED]
The name of the gate declaration.
type (string) -- [REQUIRED]
The type of the gate declaration.
actions (list) -- [REQUIRED]
The actions included in a stage.
(dict) --
Represents information about an action declaration.
name (string) -- [REQUIRED]
The action declaration's name.
actionTypeId (dict) -- [REQUIRED]
The configuration information for the action type.
category (string) -- [REQUIRED]
A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the values below.
owner (string) -- [REQUIRED]
The creator of the action being called.
provider (string) -- [REQUIRED]
The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of AWS CodeDeploy, which would be specified as CodeDeploy.
version (string) -- [REQUIRED]
A string that identifies the action type.
runOrder (integer) --
The order in which actions are run.
configuration (dict) --
The action declaration's configuration.
(string) --
(string) --
outputArtifacts (list) --
The name or ID of the result of the action declaration, such as a test or build artifact.
(dict) --
Represents information about the output of an action.
name (string) -- [REQUIRED]
The name of the output of an artifact, such as "My App".
The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
Output artifact names must be unique within a pipeline.
inputArtifacts (list) --
The name or ID of the artifact consumed by the action, such as a test or build artifact.
(dict) --
Represents information about an artifact to be worked on, such as a test or build artifact.
name (string) -- [REQUIRED]
The name of the artifact to be worked on, for example, "My App".
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 will perform the declared action. This is assumed through the roleArn for the pipeline.
version (integer) --
The version number of the pipeline. A new pipeline always has a version number of 1. This number is automatically incremented when a pipeline is updated.
dict
Response Syntax
{
'pipeline': {
'name': 'string',
'roleArn': 'string',
'artifactStore': {
'type': 'S3',
'location': 'string'
},
'stages': [
{
'name': 'string',
'blockers': [
{
'name': 'string',
'type': 'Schedule'
},
],
'actions': [
{
'name': 'string',
'actionTypeId': {
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke',
'owner': 'AWS'|'ThirdParty'|'Custom',
'provider': 'string',
'version': 'string'
},
'runOrder': 123,
'configuration': {
'string': 'string'
},
'outputArtifacts': [
{
'name': 'string'
},
],
'inputArtifacts': [
{
'name': 'string'
},
],
'roleArn': 'string'
},
]
},
],
'version': 123
}
}
Response Structure
(dict) --
Represents the output of an update pipeline action.
pipeline (dict) --
The structure of the updated pipeline.
name (string) --
The name of the action to be performed.
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) --
The Amazon S3 location where artifacts are stored for the pipeline. If this Amazon S3 bucket is created manually, it must meet the requirements for AWS CodePipeline. For more information, see the Concepts.
type (string) --
The type of the artifact store, such as S3.
location (string) --
The location for storing the artifacts for a pipeline, such as an S3 bucket or folder.
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) --
The gates included in a stage.
(dict) --
Represents information about a gate declaration.
name (string) --
The name of the gate declaration.
type (string) --
The type of the gate declaration.
actions (list) --
The actions included in a stage.
(dict) --
Represents information about an action declaration.
name (string) --
The action declaration's name.
actionTypeId (dict) --
The configuration information for the 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 values below.
owner (string) --
The creator of the action being called.
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.
version (string) --
A string that identifies the action type.
runOrder (integer) --
The order in which actions are run.
configuration (dict) --
The action declaration's configuration.
(string) --
(string) --
outputArtifacts (list) --
The name or ID of the result of the action declaration, such as a test or build artifact.
(dict) --
Represents information about the output of an action.
name (string) --
The name of the output of an artifact, such as "My App".
The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
Output artifact names must be unique within a pipeline.
inputArtifacts (list) --
The name or ID of the artifact consumed by the action, such as a test or build artifact.
(dict) --
Represents information about an artifact to be worked on, such as a test or build artifact.
name (string) --
The name of the artifact to be worked on, for example, "My App".
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 will perform the declared action. This is assumed through the roleArn for the pipeline.
version (integer) --
The version number of the pipeline. A new pipeline always has a version number of 1. This number is automatically incremented when a pipeline is updated.
Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions.
Request Syntax
client.put_third_party_job_failure_result(
jobId='string',
clientToken='string',
failureDetails={
'type': 'JobFailed'|'ConfigurationError'|'PermissionError'|'RevisionOutOfSync'|'RevisionUnavailable'|'SystemUnavailable',
'message': 'string',
'externalExecutionId': 'string'
}
)
string
[REQUIRED]
The ID of the job that failed. This is the same ID returned from PollForThirdPartyJobs.
string
[REQUIRED]
The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
dict
[REQUIRED]
Represents information about failure details.
type (string) -- [REQUIRED]
The type of the failure.
message (string) --
The message about the failure.
externalExecutionId (string) --
The external ID of the run of the action that failed.
None
Deletes the specified pipeline.
Request Syntax
client.delete_pipeline(
name='string'
)
string
[REQUIRED]
The name of the pipeline to be deleted.
None
Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.
Request Syntax
client.start_pipeline_execution(
name='string'
)
string
[REQUIRED]
The name of the pipeline to start.
dict
Response Syntax
{
'pipelineExecutionId': 'string'
}
Response Structure
(dict) --
Represents the output of a start pipeline execution action.
pipelineExecutionId (string) --
The unique system-generated ID of the pipeline that was started.
Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions.
Request Syntax
client.create_custom_action_type(
category='Source'|'Build'|'Deploy'|'Test'|'Invoke',
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
}
)
string
[REQUIRED]
The category of the custom action, such as a source action or a build action.
string
[REQUIRED]
The provider of the service used in the custom action, such as AWS CodeDeploy.
string
[REQUIRED]
The version number of the custom action.
Note
A newly-created custom action is always assigned a version number of 1 . This is required.
dict
Returns information about the settings for an 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 within 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 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.
list
The configuration properties for the custom action.
(dict) --
Represents information about an action configuration property.
name (string) -- [REQUIRED]
The name of the action configuration property.
required (boolean) -- [REQUIRED]
Whether the configuration property is a required value.
key (boolean) -- [REQUIRED]
Whether the configuration property is a key.
secret (boolean) -- [REQUIRED]
Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.
When updating a pipeline, passing * * * * * without changing any other values of the action will preserve the prior value of the secret.
queryable (boolean) --
Indicates that the proprety will be used in conjunction 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 additional 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 will be displayed to users.
type (string) --
The type of the configuration property.
dict
[REQUIRED]
Returns information about the details of an artifact.
minimumCount (integer) -- [REQUIRED]
The minimum number of artifacts allowed for the action type.
maximumCount (integer) -- [REQUIRED]
The maximum number of artifacts allowed for the action type.
dict
[REQUIRED]
Returns information about the details of an artifact.
minimumCount (integer) -- [REQUIRED]
The minimum number of artifacts allowed for the action type.
maximumCount (integer) -- [REQUIRED]
The maximum number of artifacts allowed for the action type.
dict
Response Syntax
{
'actionType': {
'id': {
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke',
'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
}
}
}
Response Structure
(dict) --
Represents the output of a create custom action 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 values below.
owner (string) --
The creator of the action being called.
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.
version (string) --
A string that identifies the action type.
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 within 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 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 will preserve the prior value of the secret.
queryable (boolean) --
Indicates that the proprety will be used in conjunction 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 additional 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 will be 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.
Represents the success of a third party job as returned to the pipeline by a job worker. Only used for partner actions.
Request Syntax
client.put_third_party_job_success_result(
jobId='string',
clientToken='string',
currentRevision={
'revision': 'string',
'changeIdentifier': 'string'
},
continuationToken='string',
executionDetails={
'summary': 'string',
'externalExecutionId': 'string',
'percentComplete': 123
}
)
string
[REQUIRED]
The ID of the job that successfully completed. This is the same ID returned from PollForThirdPartyJobs.
string
[REQUIRED]
The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
dict
Represents information about a current revision.
revision (string) -- [REQUIRED]
The revision ID of the current version of an artifact.
changeIdentifier (string) -- [REQUIRED]
The change identifier for the current revision.
string
A system-generated token, such as a AWS CodeDeploy deployment ID, that a job uses in order to continue the job asynchronously.
dict
The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline.
summary (string) --
The summary of the current status of the actions.
externalExecutionId (string) --
The system-generated unique ID of this action used to identify this job worker in any external systems, such as AWS CodeDeploy.
percentComplete (integer) --
The percentage of work completed on the action, represented on a scale of zero to one hundred percent.
None
Enables artifacts in a pipeline to transition to a stage in a pipeline.
Request Syntax
client.enable_stage_transition(
pipelineName='string',
stageName='string',
transitionType='Inbound'|'Outbound'
)
string
[REQUIRED]
The name of the pipeline in which you want to enable the flow of artifacts from one stage to another.
string
[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).
string
[REQUIRED]
Specifies whether artifacts will be allowed to enter the stage and be processed by the actions in that stage (inbound) or whether already-processed artifacts will be allowed to transition to the next stage (outbound).
None
Represents the success of a job as returned to the pipeline by a job worker. Only used for custom actions.
Request Syntax
client.put_job_success_result(
jobId='string',
currentRevision={
'revision': 'string',
'changeIdentifier': 'string'
},
continuationToken='string',
executionDetails={
'summary': 'string',
'externalExecutionId': 'string',
'percentComplete': 123
}
)
string
[REQUIRED]
The unique system-generated ID of the job that succeeded. This is the same ID returned from PollForJobs.
dict
The ID of the current revision of the artifact successfully worked upon by the job.
revision (string) -- [REQUIRED]
The revision ID of the current version of an artifact.
changeIdentifier (string) -- [REQUIRED]
The change identifier for the current revision.
string
A system-generated token, such as a AWS CodeDeploy deployment ID, that the successful job used to complete a job asynchronously.
dict
The execution details of the successful job, such as the actions taken by the job worker.
summary (string) --
The summary of the current status of the actions.
externalExecutionId (string) --
The system-generated unique ID of this action used to identify this job worker in any external systems, such as AWS CodeDeploy.
percentComplete (integer) --
The percentage of work completed on the action, represented on a scale of zero to one hundred percent.
None
Returns information about the state of a pipeline, including the stages, actions, and details about the last run of the pipeline.
Request Syntax
client.get_pipeline_state(
name='string'
)
string
[REQUIRED]
The name of the pipeline about which you want to get information.
dict
Response Syntax
{
'pipelineName': 'string',
'pipelineVersion': 123,
'stageStates': [
{
'stageName': 'string',
'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': {
'status': 'InProgress'|'Succeeded'|'Failed',
'summary': 'string',
'lastStatusChange': datetime(2015, 1, 1),
'externalExecutionId': 'string',
'externalExecutionUrl': 'string',
'percentComplete': 123,
'errorDetails': {
'code': 'string',
'message': 'string'
}
},
'entityUrl': 'string',
'revisionUrl': 'string'
},
]
},
],
'created': datetime(2015, 1, 1),
'updated': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Represents the output of a get pipeline state action.
pipelineName (string) --
The name of the pipeline for which you want to get the state.
pipelineVersion (integer) --
The version number of the pipeline.
Note
A newly-created pipeline is always assigned a version number of 1 .
stageStates (list) --
A list of the pipeline stage output information, including stage name, state, most recent run details, whether the stage is disabled, and other data.
(dict) --
Represents information about the state of the stage.
stageName (string) --
The name of the stage.
inboundTransitionState (dict) --
The state of the inbound transition, which is either enabled or disabled.
enabled (boolean) --
Whether the transition between stages is enabled (true) or disabled (false).
lastChangedBy (string) --
The ID of the user who last changed the transition state.
lastChangedAt (datetime) --
The timestamp when the transition state was last changed.
disabledReason (string) --
The user-specified reason why the transition between two stages of a pipeline was disabled.
actionStates (list) --
The state of the stage.
(dict) --
Represents information about the state of an action.
actionName (string) --
The name of the action.
currentRevision (dict) --
Represents information about the version (or revision) of an action.
revisionId (string) --
The system-generated unique ID that identifies the revision number of the action.
revisionChangeId (string) --
The unique identifier of the change that set the state to this revision, for example a deployment ID or timestamp.
created (datetime) --
The date and time when the most recent version of the action was created, in timestamp format.
latestExecution (dict) --
Represents information about how an action runs.
status (string) --
The status of the action, or for a completed action, the last status of the action.
summary (string) --
A summary of the run of the action.
lastStatusChange (datetime) --
The last status change of the action.
externalExecutionId (string) --
The external ID of the run of the action.
externalExecutionUrl (string) --
The URL of a resource external to AWS that will be used when running the action, for example an external repository URL.
percentComplete (integer) --
A percentage of completeness of the action as it runs.
errorDetails (dict) --
The details of an error returned by a URL external to AWS.
code (string) --
The system ID or error number code of the error.
message (string) --
The text of the error message.
entityUrl (string) --
A URL link for more information about the state of the action, such as a deployment group details page.
revisionUrl (string) --
A URL link for more information about the revision, such as a commit details page.
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.
Returns information about a job. Only used for custom actions.
Warning
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.
Request Syntax
client.get_job_details(
jobId='string'
)
string
[REQUIRED]
The unique system-generated ID for the job.
dict
Response Syntax
{
'jobDetails': {
'id': 'string',
'data': {
'actionTypeId': {
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke',
'owner': 'AWS'|'ThirdParty'|'Custom',
'provider': 'string',
'version': 'string'
},
'actionConfiguration': {
'configuration': {
'string': 'string'
}
},
'pipelineContext': {
'pipelineName': 'string',
'stage': {
'name': 'string'
},
'action': {
'name': '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'
},
'accountId': 'string'
}
}
Response Structure
(dict) --
Represents the output of a get job details action.
jobDetails (dict) --
The details of the job.
Note
If AWSSessionCredentials is used, a long-running job can call GetJobDetails again to obtain new credentials.
id (string) --
The unique system-generated ID of the job.
data (dict) --
Represents additional information about a job required for a job worker to complete the job.
actionTypeId (dict) --
Represents information about an action type.
category (string) --
A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the values below.
owner (string) --
The creator of the action being called.
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.
version (string) --
A string that identifies the action type.
actionConfiguration (dict) --
Represents information about an action configuration.
configuration (dict) --
The configuration data for the action.
(string) --
(string) --
pipelineContext (dict) --
Represents information about a pipeline to a job worker.
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) --
Represents the context of an action within the stage of a pipeline to a job worker.
name (string) --
The name of the action within the context of a job.
inputArtifacts (list) --
The artifact supplied to the job.
(dict) --
Represents information about an artifact that will be worked upon 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 Amazon S3 bucket that contains the artifact.
bucketName (string) --
The name of the Amazon S3 bucket.
objectKey (string) --
The key of the object in the Amazon S3 bucket, which uniquely identifies the object in the bucket.
outputArtifacts (list) --
The output of the job.
(dict) --
Represents information about an artifact that will be worked upon 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 Amazon S3 bucket that contains the artifact.
bucketName (string) --
The name of the Amazon S3 bucket.
objectKey (string) --
The key of the object in the Amazon 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 Amazon 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 in order to continue the job asynchronously.
accountId (string) --
The AWS account ID associated with the job.
Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions.
Request Syntax
client.acknowledge_job(
jobId='string',
nonce='string'
)
string
[REQUIRED]
The unique system-generated ID of the job for which you want to confirm receipt.
string
[REQUIRED]
A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. This number must be returned in the response.
dict
Response Syntax
{
'status': 'Created'|'Queued'|'Dispatched'|'InProgress'|'TimedOut'|'Succeeded'|'Failed'
}
Response Structure
(dict) --
Represents the output of an acknowledge job action.
status (string) --
Whether the job worker has received the specified job.
Returns information about any jobs for AWS CodePipeline to act upon.
Warning
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.
Request Syntax
client.poll_for_jobs(
actionTypeId={
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke',
'owner': 'AWS'|'ThirdParty'|'Custom',
'provider': 'string',
'version': 'string'
},
maxBatchSize=123,
queryParam={
'string': 'string'
}
)
dict
[REQUIRED]
Represents information about an action type.
category (string) -- [REQUIRED]
A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the values below.
owner (string) -- [REQUIRED]
The creator of the action being called.
provider (string) -- [REQUIRED]
The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of AWS CodeDeploy, which would be specified as CodeDeploy.
version (string) -- [REQUIRED]
A string that identifies the action type.
integer
The maximum number of jobs to return in a poll for jobs call.
dict
A map of property names and values. For an action type with no queryable properties, this value must be null or an empty map. For an action type with a queryable property, you must supply that property as a key in the map. Only jobs whose action configuration matches the mapped value will be returned.
(string) --
(string) --
dict
Response Syntax
{
'jobs': [
{
'id': 'string',
'data': {
'actionTypeId': {
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke',
'owner': 'AWS'|'ThirdParty'|'Custom',
'provider': 'string',
'version': 'string'
},
'actionConfiguration': {
'configuration': {
'string': 'string'
}
},
'pipelineContext': {
'pipelineName': 'string',
'stage': {
'name': 'string'
},
'action': {
'name': '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'
},
'nonce': 'string',
'accountId': 'string'
},
]
}
Response Structure
(dict) --
Represents the output of a poll for jobs 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) --
Additional 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 values below.
owner (string) --
The creator of the action being called.
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.
version (string) --
A string that identifies the action type.
actionConfiguration (dict) --
Represents information about an action configuration.
configuration (dict) --
The configuration data for the action.
(string) --
(string) --
pipelineContext (dict) --
Represents information about a pipeline to a job worker.
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) --
Represents the context of an action within the stage of a pipeline to a job worker.
name (string) --
The name of the action within the context of a job.
inputArtifacts (list) --
The artifact supplied to the job.
(dict) --
Represents information about an artifact that will be worked upon 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 Amazon S3 bucket that contains the artifact.
bucketName (string) --
The name of the Amazon S3 bucket.
objectKey (string) --
The key of the object in the Amazon S3 bucket, which uniquely identifies the object in the bucket.
outputArtifacts (list) --
The output of the job.
(dict) --
Represents information about an artifact that will be worked upon 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 Amazon S3 bucket that contains the artifact.
bucketName (string) --
The name of the Amazon S3 bucket.
objectKey (string) --
The key of the object in the Amazon 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 Amazon 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 in order to continue the job asynchronously.
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. This number must be returned in the response.
accountId (string) --
The ID of the AWS account to use when performing the job.
Creates a pipeline.
Request Syntax
client.create_pipeline(
pipeline={
'name': 'string',
'roleArn': 'string',
'artifactStore': {
'type': 'S3',
'location': 'string'
},
'stages': [
{
'name': 'string',
'blockers': [
{
'name': 'string',
'type': 'Schedule'
},
],
'actions': [
{
'name': 'string',
'actionTypeId': {
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke',
'owner': 'AWS'|'ThirdParty'|'Custom',
'provider': 'string',
'version': 'string'
},
'runOrder': 123,
'configuration': {
'string': 'string'
},
'outputArtifacts': [
{
'name': 'string'
},
],
'inputArtifacts': [
{
'name': 'string'
},
],
'roleArn': 'string'
},
]
},
],
'version': 123
}
)
dict
[REQUIRED]
Represents the structure of actions and stages to be performed in the pipeline.
name (string) -- [REQUIRED]
The name of the action to be performed.
roleArn (string) -- [REQUIRED]
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) -- [REQUIRED]
The Amazon S3 location where artifacts are stored for the pipeline. If this Amazon S3 bucket is created manually, it must meet the requirements for AWS CodePipeline. For more information, see the Concepts.
type (string) -- [REQUIRED]
The type of the artifact store, such as S3.
location (string) -- [REQUIRED]
The location for storing the artifacts for a pipeline, such as an S3 bucket or folder.
stages (list) -- [REQUIRED]
The stage in which to perform the action.
(dict) --
Represents information about a stage and its definition.
name (string) -- [REQUIRED]
The name of the stage.
blockers (list) --
The gates included in a stage.
(dict) --
Represents information about a gate declaration.
name (string) -- [REQUIRED]
The name of the gate declaration.
type (string) -- [REQUIRED]
The type of the gate declaration.
actions (list) -- [REQUIRED]
The actions included in a stage.
(dict) --
Represents information about an action declaration.
name (string) -- [REQUIRED]
The action declaration's name.
actionTypeId (dict) -- [REQUIRED]
The configuration information for the action type.
category (string) -- [REQUIRED]
A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the values below.
owner (string) -- [REQUIRED]
The creator of the action being called.
provider (string) -- [REQUIRED]
The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of AWS CodeDeploy, which would be specified as CodeDeploy.
version (string) -- [REQUIRED]
A string that identifies the action type.
runOrder (integer) --
The order in which actions are run.
configuration (dict) --
The action declaration's configuration.
(string) --
(string) --
outputArtifacts (list) --
The name or ID of the result of the action declaration, such as a test or build artifact.
(dict) --
Represents information about the output of an action.
name (string) -- [REQUIRED]
The name of the output of an artifact, such as "My App".
The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
Output artifact names must be unique within a pipeline.
inputArtifacts (list) --
The name or ID of the artifact consumed by the action, such as a test or build artifact.
(dict) --
Represents information about an artifact to be worked on, such as a test or build artifact.
name (string) -- [REQUIRED]
The name of the artifact to be worked on, for example, "My App".
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 will perform the declared action. This is assumed through the roleArn for the pipeline.
version (integer) --
The version number of the pipeline. A new pipeline always has a version number of 1. This number is automatically incremented when a pipeline is updated.
dict
Response Syntax
{
'pipeline': {
'name': 'string',
'roleArn': 'string',
'artifactStore': {
'type': 'S3',
'location': 'string'
},
'stages': [
{
'name': 'string',
'blockers': [
{
'name': 'string',
'type': 'Schedule'
},
],
'actions': [
{
'name': 'string',
'actionTypeId': {
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke',
'owner': 'AWS'|'ThirdParty'|'Custom',
'provider': 'string',
'version': 'string'
},
'runOrder': 123,
'configuration': {
'string': 'string'
},
'outputArtifacts': [
{
'name': 'string'
},
],
'inputArtifacts': [
{
'name': 'string'
},
],
'roleArn': 'string'
},
]
},
],
'version': 123
}
}
Response Structure
(dict) --
Represents the output of a create pipeline action.
pipeline (dict) --
Represents the structure of actions and stages to be performed in the pipeline.
name (string) --
The name of the action to be performed.
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) --
The Amazon S3 location where artifacts are stored for the pipeline. If this Amazon S3 bucket is created manually, it must meet the requirements for AWS CodePipeline. For more information, see the Concepts.
type (string) --
The type of the artifact store, such as S3.
location (string) --
The location for storing the artifacts for a pipeline, such as an S3 bucket or folder.
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) --
The gates included in a stage.
(dict) --
Represents information about a gate declaration.
name (string) --
The name of the gate declaration.
type (string) --
The type of the gate declaration.
actions (list) --
The actions included in a stage.
(dict) --
Represents information about an action declaration.
name (string) --
The action declaration's name.
actionTypeId (dict) --
The configuration information for the 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 values below.
owner (string) --
The creator of the action being called.
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.
version (string) --
A string that identifies the action type.
runOrder (integer) --
The order in which actions are run.
configuration (dict) --
The action declaration's configuration.
(string) --
(string) --
outputArtifacts (list) --
The name or ID of the result of the action declaration, such as a test or build artifact.
(dict) --
Represents information about the output of an action.
name (string) --
The name of the output of an artifact, such as "My App".
The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
Output artifact names must be unique within a pipeline.
inputArtifacts (list) --
The name or ID of the artifact consumed by the action, such as a test or build artifact.
(dict) --
Represents information about an artifact to be worked on, such as a test or build artifact.
name (string) --
The name of the artifact to be worked on, for example, "My App".
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 will perform the declared action. This is assumed through the roleArn for the pipeline.
version (integer) --
The version number of the pipeline. A new pipeline always has a version number of 1. This number is automatically incremented when a pipeline is updated.
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
Request Syntax
client.disable_stage_transition(
pipelineName='string',
stageName='string',
transitionType='Inbound'|'Outbound',
reason='string'
)
string
[REQUIRED]
The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.
string
[REQUIRED]
The name of the stage where you want to disable the inbound or outbound transition of artifacts.
string
[REQUIRED]
Specifies whether artifacts will be 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).
string
[REQUIRED]
The reason given to the user why a stage is disabled, such as waiting for manual approval or manual tests. This message is displayed in the pipeline console UI.
None