2019/04/30 - AWS CodePipeline - 3 updated api methods
Changes This release contains an update to the PipelineContext object that includes the Pipeline ARN, and the Pipeline Execution Id. The ActionContext object is also updated to include the Action Execution Id.
{'jobDetails': {'data': {'pipelineContext': {'action': {'actionExecutionId': 'string'},
'pipelineArn': 'string',
'pipelineExecutionId': 'string'}}}}
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.
See also: AWS API Documentation
Request Syntax
client.get_job_details(
jobId='string'
)
string
[REQUIRED]
The unique system-generated ID for the job.
dict
Response Syntax
{
'jobDetails': {
'id': 'string',
'data': {
'actionTypeId': {
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval',
'owner': 'AWS'|'ThirdParty'|'Custom',
'provider': 'string',
'version': 'string'
},
'actionConfiguration': {
'configuration': {
'string': 'string'
}
},
'pipelineContext': {
'pipelineName': 'string',
'stage': {
'name': 'string'
},
'action': {
'name': 'string',
'actionExecutionId': 'string'
},
'pipelineArn': 'string',
'pipelineExecutionId': 'string'
},
'inputArtifacts': [
{
'name': 'string',
'revision': 'string',
'location': {
'type': 'S3',
's3Location': {
'bucketName': 'string',
'objectKey': 'string'
}
}
},
],
'outputArtifacts': [
{
'name': 'string',
'revision': 'string',
'location': {
'type': 'S3',
's3Location': {
'bucketName': 'string',
'objectKey': 'string'
}
}
},
],
'artifactCredentials': {
'accessKeyId': 'string',
'secretAccessKey': 'string',
'sessionToken': 'string'
},
'continuationToken': 'string',
'encryptionKey': {
'id': 'string',
'type': 'KMS'
}
},
'accountId': 'string'
}
}
Response Structure
(dict) --
Represents the output of a GetJobDetails action.
jobDetails (dict) --
The details of the job.
Note
If AWSSessionCredentials is used, a long-running job can call GetJobDetails again to obtain new credentials.
id (string) --
The unique system-generated ID of the job.
data (dict) --
Represents 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. To reference a list of action providers by action type, see Valid Action Types and Providers in CodePipeline.
version (string) --
A string that describes the action version.
actionConfiguration (dict) --
Represents information about an action configuration.
configuration (dict) --
The configuration data for the action.
(string) --
(string) --
pipelineContext (dict) --
Represents information about a pipeline to a job worker.
Note
Includes pipelineArn and pipelineExecutionId for Custom jobs.
pipelineName (string) --
The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names under an Amazon Web Services account.
stage (dict) --
The stage of the pipeline.
name (string) --
The name of the stage.
action (dict) --
The context of an action to a job worker within the stage of a pipeline.
name (string) --
The name of the action within the context of a job.
actionExecutionId (string) --
The system-generated unique ID that corresponds to an action's execution.
pipelineArn (string) --
The pipeline execution ID provided to the job worker.
pipelineExecutionId (string) --
The pipeline Amazon Resource Name (ARN) provided to the job worker.
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.
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, this is the key ID or key ARN.
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'.
accountId (string) --
The AWS account ID associated with the job.
{'jobDetails': {'data': {'pipelineContext': {'action': {'actionExecutionId': 'string'},
'pipelineArn': 'string',
'pipelineExecutionId': 'string'}}}}
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.
See also: AWS API Documentation
Request Syntax
client.get_third_party_job_details(
jobId='string',
clientToken='string'
)
string
[REQUIRED]
The unique system-generated ID used for identifying the job.
string
[REQUIRED]
The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
dict
Response Syntax
{
'jobDetails': {
'id': 'string',
'data': {
'actionTypeId': {
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval',
'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 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. To reference a list of action providers by action type, see Valid Action Types and Providers in CodePipeline.
version (string) --
A string that describes the action version.
actionConfiguration (dict) --
Represents information about an action configuration.
configuration (dict) --
The configuration data for the action.
(string) --
(string) --
pipelineContext (dict) --
Represents information about a pipeline to a job worker.
Note
Does not include pipelineArn and pipelineExecutionId for ThirdParty jobs.
pipelineName (string) --
The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names under an Amazon Web Services account.
stage (dict) --
The stage of the pipeline.
name (string) --
The name of the stage.
action (dict) --
The context of an action to a job worker within the stage of a pipeline.
name (string) --
The name of the action within the context of a job.
actionExecutionId (string) --
The system-generated unique ID that corresponds to an action's execution.
pipelineArn (string) --
The pipeline execution ID provided to the job worker.
pipelineExecutionId (string) --
The pipeline Amazon Resource Name (ARN) provided to the job worker.
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.
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, this is the key ID or key ARN.
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.
{'jobs': {'data': {'pipelineContext': {'action': {'actionExecutionId': 'string'},
'pipelineArn': 'string',
'pipelineExecutionId': 'string'}}}}
Returns information about any jobs for AWS CodePipeline to act upon. PollForJobs is only valid 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 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.
See also: AWS API Documentation
Request Syntax
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'
}
)
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. To reference a list of action providers by action type, see Valid Action Types and Providers in CodePipeline.
version (string) -- [REQUIRED]
A string that describes the action version.
integer
The maximum number of jobs to return in a poll for jobs call.
dict
A map of property names and values. For an action type with no queryable properties, this value must be null or an empty map. For an action type with a queryable property, you must supply that property as a key in the map. Only jobs whose action configuration matches the mapped value will be returned.
(string) --
(string) --
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) --
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. To reference a list of action providers by action type, see Valid Action Types and Providers in CodePipeline.
version (string) --
A string that describes the action version.
actionConfiguration (dict) --
Represents information about an action configuration.
configuration (dict) --
The configuration data for the action.
(string) --
(string) --
pipelineContext (dict) --
Represents information about a pipeline to a job worker.
Note
Includes pipelineArn and pipelineExecutionId for Custom jobs.
pipelineName (string) --
The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names under an Amazon Web Services account.
stage (dict) --
The stage of the pipeline.
name (string) --
The name of the stage.
action (dict) --
The context of an action to a job worker within the stage of a pipeline.
name (string) --
The name of the action within the context of a job.
actionExecutionId (string) --
The system-generated unique ID that corresponds to an action's execution.
pipelineArn (string) --
The pipeline execution ID provided to the job worker.
pipelineExecutionId (string) --
The pipeline Amazon Resource Name (ARN) provided to the job worker.
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.
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, this is the key ID or key ARN.
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.