2024/11/22 - AWS CodePipeline - 2 updated api methods
Changes AWS CodePipeline V2 type pipelines now support ECRBuildAndPublish and InspectorScan actions.
{'stageStates': {'actionStates': {'latestExecution': {'logStreamARN': 'string'}}}}
Returns information about the state of a pipeline, including the stages and actions.
See also: AWS API Documentation
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',
'inboundExecution': {
'pipelineExecutionId': 'string',
'status': 'Cancelled'|'InProgress'|'Failed'|'Stopped'|'Stopping'|'Succeeded'|'Skipped',
'type': 'STANDARD'|'ROLLBACK'
},
'inboundExecutions': [
{
'pipelineExecutionId': 'string',
'status': 'Cancelled'|'InProgress'|'Failed'|'Stopped'|'Stopping'|'Succeeded'|'Skipped',
'type': 'STANDARD'|'ROLLBACK'
},
],
'inboundTransitionState': {
'enabled': True|False,
'lastChangedBy': 'string',
'lastChangedAt': datetime(2015, 1, 1),
'disabledReason': 'string'
},
'actionStates': [
{
'actionName': 'string',
'currentRevision': {
'revisionId': 'string',
'revisionChangeId': 'string',
'created': datetime(2015, 1, 1)
},
'latestExecution': {
'actionExecutionId': 'string',
'status': 'InProgress'|'Abandoned'|'Succeeded'|'Failed',
'summary': 'string',
'lastStatusChange': datetime(2015, 1, 1),
'token': 'string',
'lastUpdatedBy': 'string',
'externalExecutionId': 'string',
'externalExecutionUrl': 'string',
'percentComplete': 123,
'errorDetails': {
'code': 'string',
'message': 'string'
},
'logStreamARN': 'string'
},
'entityUrl': 'string',
'revisionUrl': 'string'
},
],
'latestExecution': {
'pipelineExecutionId': 'string',
'status': 'Cancelled'|'InProgress'|'Failed'|'Stopped'|'Stopping'|'Succeeded'|'Skipped',
'type': 'STANDARD'|'ROLLBACK'
},
'beforeEntryConditionState': {
'latestExecution': {
'status': 'InProgress'|'Failed'|'Errored'|'Succeeded'|'Cancelled'|'Abandoned'|'Overridden',
'summary': 'string'
},
'conditionStates': [
{
'latestExecution': {
'status': 'InProgress'|'Failed'|'Errored'|'Succeeded'|'Cancelled'|'Abandoned'|'Overridden',
'summary': 'string',
'lastStatusChange': datetime(2015, 1, 1)
},
'ruleStates': [
{
'ruleName': 'string',
'currentRevision': {
'revisionId': 'string',
'revisionChangeId': 'string',
'created': datetime(2015, 1, 1)
},
'latestExecution': {
'ruleExecutionId': 'string',
'status': 'InProgress'|'Abandoned'|'Succeeded'|'Failed',
'summary': 'string',
'lastStatusChange': datetime(2015, 1, 1),
'token': 'string',
'lastUpdatedBy': 'string',
'externalExecutionId': 'string',
'externalExecutionUrl': 'string',
'errorDetails': {
'code': 'string',
'message': 'string'
}
},
'entityUrl': 'string',
'revisionUrl': 'string'
},
]
},
]
},
'onSuccessConditionState': {
'latestExecution': {
'status': 'InProgress'|'Failed'|'Errored'|'Succeeded'|'Cancelled'|'Abandoned'|'Overridden',
'summary': 'string'
},
'conditionStates': [
{
'latestExecution': {
'status': 'InProgress'|'Failed'|'Errored'|'Succeeded'|'Cancelled'|'Abandoned'|'Overridden',
'summary': 'string',
'lastStatusChange': datetime(2015, 1, 1)
},
'ruleStates': [
{
'ruleName': 'string',
'currentRevision': {
'revisionId': 'string',
'revisionChangeId': 'string',
'created': datetime(2015, 1, 1)
},
'latestExecution': {
'ruleExecutionId': 'string',
'status': 'InProgress'|'Abandoned'|'Succeeded'|'Failed',
'summary': 'string',
'lastStatusChange': datetime(2015, 1, 1),
'token': 'string',
'lastUpdatedBy': 'string',
'externalExecutionId': 'string',
'externalExecutionUrl': 'string',
'errorDetails': {
'code': 'string',
'message': 'string'
}
},
'entityUrl': 'string',
'revisionUrl': 'string'
},
]
},
]
},
'onFailureConditionState': {
'latestExecution': {
'status': 'InProgress'|'Failed'|'Errored'|'Succeeded'|'Cancelled'|'Abandoned'|'Overridden',
'summary': 'string'
},
'conditionStates': [
{
'latestExecution': {
'status': 'InProgress'|'Failed'|'Errored'|'Succeeded'|'Cancelled'|'Abandoned'|'Overridden',
'summary': 'string',
'lastStatusChange': datetime(2015, 1, 1)
},
'ruleStates': [
{
'ruleName': 'string',
'currentRevision': {
'revisionId': 'string',
'revisionChangeId': 'string',
'created': datetime(2015, 1, 1)
},
'latestExecution': {
'ruleExecutionId': 'string',
'status': 'InProgress'|'Abandoned'|'Succeeded'|'Failed',
'summary': 'string',
'lastStatusChange': datetime(2015, 1, 1),
'token': 'string',
'lastUpdatedBy': 'string',
'externalExecutionId': 'string',
'externalExecutionUrl': 'string',
'errorDetails': {
'code': 'string',
'message': 'string'
}
},
'entityUrl': 'string',
'revisionUrl': 'string'
},
]
},
]
},
'retryStageMetadata': {
'autoStageRetryAttempt': 123,
'manualStageRetryAttempt': 123,
'latestRetryTrigger': 'AutomatedStageRetry'|'ManualStageRetry'
}
},
],
'created': datetime(2015, 1, 1),
'updated': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Represents the output of a GetPipelineState action.
pipelineName (string) --
The name of the pipeline for which you want to get the state.
pipelineVersion (integer) --
The version number of the pipeline.
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.
inboundExecution (dict) --
Represents information about the run of a stage.
pipelineExecutionId (string) --
The ID of the pipeline execution associated with the stage.
status (string) --
The status of the stage, or for a completed stage, the last status of the stage.
type (string) --
The type of pipeline execution for the stage, such as a rollback pipeline execution.
inboundExecutions (list) --
The inbound executions for a stage.
(dict) --
Represents information about the run of a stage.
pipelineExecutionId (string) --
The ID of the pipeline execution associated with the stage.
status (string) --
The status of the stage, or for a completed stage, the last status of the stage.
type (string) --
The type of pipeline execution for the stage, such as a rollback pipeline execution.
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 the run of an action.
actionExecutionId (string) --
ID of the workflow action execution in the current stage. Use the GetPipelineState action to retrieve the current action execution details of the current stage.
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.
token (string) --
The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the GetPipelineState command. It is used to validate that the approval request corresponding to this token is still valid.
lastUpdatedBy (string) --
The ARN of the user who last changed the pipeline.
externalExecutionId (string) --
The external ID of the run of the action.
externalExecutionUrl (string) --
The URL of a resource external to Amazon Web Services that is 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 Amazon Web Services.
code (string) --
The system ID or number code of the error.
message (string) --
The text of the error message.
logStreamARN (string) --
The Amazon Resource Name (ARN) of the log stream for the action compute.
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.
latestExecution (dict) --
Information about the latest execution in the stage, including its ID and status.
pipelineExecutionId (string) --
The ID of the pipeline execution associated with the stage.
status (string) --
The status of the stage, or for a completed stage, the last status of the stage.
type (string) --
The type of pipeline execution for the stage, such as a rollback pipeline execution.
beforeEntryConditionState (dict) --
The state of the entry conditions for a stage.
latestExecution (dict) --
Represents information about the latest run of a condition for a stage.
status (string) --
The status of a run of a condition for a stage.
summary (string) --
A summary of the run of the condition for a stage.
conditionStates (list) --
The states of the conditions for a run of a condition for a stage.
(dict) --
Information about the state of the condition.
latestExecution (dict) --
The state of the latest run of the rule.
status (string) --
The status of the run for a condition.
summary (string) --
The summary of information about a run for a condition.
lastStatusChange (datetime) --
The last status change of the condition.
ruleStates (list) --
The state of the rules for the condition.
(dict) --
Returns information about the state of a rule.
ruleName (string) --
The name of the rule.
currentRevision (dict) --
The ID of the current revision of the artifact successfully worked on by the job.
revisionId (string) --
The system-generated unique ID that identifies the revision number of the rule.
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 rule was created, in timestamp format.
latestExecution (dict) --
Represents information about the latest run of an rule.
ruleExecutionId (string) --
The execution ID for the run of the rule.
status (string) --
The status of the run of the rule, such as FAILED.
summary (string) --
A summary of the run of the rule.
lastStatusChange (datetime) --
The last status change of the rule.
token (string) --
The system-generated token used to identify a unique request.
lastUpdatedBy (string) --
The ARN of the user who last changed the rule.
externalExecutionId (string) --
The external ID of the run of the rule.
externalExecutionUrl (string) --
The URL of a resource external to Amazon Web Services that is used when running the rule (for example, an external repository URL).
errorDetails (dict) --
Represents information about an error in CodePipeline.
code (string) --
The system ID or number code of the error.
message (string) --
The text of the error message.
entityUrl (string) --
A URL link for more information about the state of the action, such as a details page.
revisionUrl (string) --
A URL link for more information about the revision, such as a commit details page.
onSuccessConditionState (dict) --
The state of the success conditions for a stage.
latestExecution (dict) --
Represents information about the latest run of a condition for a stage.
status (string) --
The status of a run of a condition for a stage.
summary (string) --
A summary of the run of the condition for a stage.
conditionStates (list) --
The states of the conditions for a run of a condition for a stage.
(dict) --
Information about the state of the condition.
latestExecution (dict) --
The state of the latest run of the rule.
status (string) --
The status of the run for a condition.
summary (string) --
The summary of information about a run for a condition.
lastStatusChange (datetime) --
The last status change of the condition.
ruleStates (list) --
The state of the rules for the condition.
(dict) --
Returns information about the state of a rule.
ruleName (string) --
The name of the rule.
currentRevision (dict) --
The ID of the current revision of the artifact successfully worked on by the job.
revisionId (string) --
The system-generated unique ID that identifies the revision number of the rule.
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 rule was created, in timestamp format.
latestExecution (dict) --
Represents information about the latest run of an rule.
ruleExecutionId (string) --
The execution ID for the run of the rule.
status (string) --
The status of the run of the rule, such as FAILED.
summary (string) --
A summary of the run of the rule.
lastStatusChange (datetime) --
The last status change of the rule.
token (string) --
The system-generated token used to identify a unique request.
lastUpdatedBy (string) --
The ARN of the user who last changed the rule.
externalExecutionId (string) --
The external ID of the run of the rule.
externalExecutionUrl (string) --
The URL of a resource external to Amazon Web Services that is used when running the rule (for example, an external repository URL).
errorDetails (dict) --
Represents information about an error in CodePipeline.
code (string) --
The system ID or number code of the error.
message (string) --
The text of the error message.
entityUrl (string) --
A URL link for more information about the state of the action, such as a details page.
revisionUrl (string) --
A URL link for more information about the revision, such as a commit details page.
onFailureConditionState (dict) --
The state of the failure conditions for a stage.
latestExecution (dict) --
Represents information about the latest run of a condition for a stage.
status (string) --
The status of a run of a condition for a stage.
summary (string) --
A summary of the run of the condition for a stage.
conditionStates (list) --
The states of the conditions for a run of a condition for a stage.
(dict) --
Information about the state of the condition.
latestExecution (dict) --
The state of the latest run of the rule.
status (string) --
The status of the run for a condition.
summary (string) --
The summary of information about a run for a condition.
lastStatusChange (datetime) --
The last status change of the condition.
ruleStates (list) --
The state of the rules for the condition.
(dict) --
Returns information about the state of a rule.
ruleName (string) --
The name of the rule.
currentRevision (dict) --
The ID of the current revision of the artifact successfully worked on by the job.
revisionId (string) --
The system-generated unique ID that identifies the revision number of the rule.
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 rule was created, in timestamp format.
latestExecution (dict) --
Represents information about the latest run of an rule.
ruleExecutionId (string) --
The execution ID for the run of the rule.
status (string) --
The status of the run of the rule, such as FAILED.
summary (string) --
A summary of the run of the rule.
lastStatusChange (datetime) --
The last status change of the rule.
token (string) --
The system-generated token used to identify a unique request.
lastUpdatedBy (string) --
The ARN of the user who last changed the rule.
externalExecutionId (string) --
The external ID of the run of the rule.
externalExecutionUrl (string) --
The URL of a resource external to Amazon Web Services that is used when running the rule (for example, an external repository URL).
errorDetails (dict) --
Represents information about an error in CodePipeline.
code (string) --
The system ID or number code of the error.
message (string) --
The text of the error message.
entityUrl (string) --
A URL link for more information about the state of the action, such as a details page.
revisionUrl (string) --
A URL link for more information about the revision, such as a commit details page.
retryStageMetadata (dict) --
he details of a specific automatic retry on stage failure, including the attempt number and trigger.
autoStageRetryAttempt (integer) --
The number of attempts for a specific stage with automatic retry on stage failure. One attempt is allowed for automatic stage retry on failure.
manualStageRetryAttempt (integer) --
The number of attempts for a specific stage where manual retries have been made upon stage failure.
latestRetryTrigger (string) --
The latest trigger for a specific stage where manual or automatic retries have been made upon stage failure.
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.
{'actionExecutionDetails': {'output': {'executionResult': {'logStreamARN': 'string'}}}}
Lists the action executions that have occurred in a pipeline.
See also: AWS API Documentation
Request Syntax
client.list_action_executions(
pipelineName='string',
filter={
'pipelineExecutionId': 'string',
'latestInPipelineExecution': {
'pipelineExecutionId': 'string',
'startTimeRange': 'Latest'|'All'
}
},
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The name of the pipeline for which you want to list action execution history.
dict
Input information used to filter action execution history.
pipelineExecutionId (string) --
The pipeline execution ID used to filter action execution history.
latestInPipelineExecution (dict) --
The latest execution in the pipeline.
pipelineExecutionId (string) -- [REQUIRED]
The execution ID for the latest execution in the pipeline.
startTimeRange (string) -- [REQUIRED]
The start time to filter on for the latest execution in the pipeline. Valid options:
All
Latest
integer
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. Action execution history is retained for up to 12 months, based on action execution start times. Default value is 100.
string
The token that was returned from the previous ListActionExecutions call, which can be used to return the next set of action executions in the list.
dict
Response Syntax
{
'actionExecutionDetails': [
{
'pipelineExecutionId': 'string',
'actionExecutionId': 'string',
'pipelineVersion': 123,
'stageName': 'string',
'actionName': 'string',
'startTime': datetime(2015, 1, 1),
'lastUpdateTime': datetime(2015, 1, 1),
'updatedBy': 'string',
'status': 'InProgress'|'Abandoned'|'Succeeded'|'Failed',
'input': {
'actionTypeId': {
'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval'|'Compute',
'owner': 'AWS'|'ThirdParty'|'Custom',
'provider': 'string',
'version': 'string'
},
'configuration': {
'string': 'string'
},
'resolvedConfiguration': {
'string': 'string'
},
'roleArn': 'string',
'region': 'string',
'inputArtifacts': [
{
'name': 'string',
's3location': {
'bucket': 'string',
'key': 'string'
}
},
],
'namespace': 'string'
},
'output': {
'outputArtifacts': [
{
'name': 'string',
's3location': {
'bucket': 'string',
'key': 'string'
}
},
],
'executionResult': {
'externalExecutionId': 'string',
'externalExecutionSummary': 'string',
'externalExecutionUrl': 'string',
'errorDetails': {
'code': 'string',
'message': 'string'
},
'logStreamARN': 'string'
},
'outputVariables': {
'string': 'string'
}
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
actionExecutionDetails (list) --
The details for a list of recent executions, such as action execution ID.
(dict) --
Returns information about an execution of an action, including the action execution ID, and the name, version, and timing of the action.
pipelineExecutionId (string) --
The pipeline execution ID for the action execution.
actionExecutionId (string) --
The action execution ID.
pipelineVersion (integer) --
The version of the pipeline where the action was run.
stageName (string) --
The name of the stage that contains the action.
actionName (string) --
The name of the action.
startTime (datetime) --
The start time of the action execution.
lastUpdateTime (datetime) --
The last update time of the action execution.
updatedBy (string) --
The ARN of the user who changed the pipeline execution details.
status (string) --
The status of the action execution. Status categories are InProgress, Succeeded, and Failed.
input (dict) --
Input details for the action execution, such as role ARN, Region, and input artifacts.
actionTypeId (dict) --
Represents information about an action type.
category (string) --
A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the following values.
Source
Build
Test
Deploy
Invoke
Approval
owner (string) --
The creator of the action being called. There are three valid values for the Owner field in the action category section within your pipeline structure: AWS, ThirdParty, and Custom. For more information, see Valid Action Types and Providers in CodePipeline.
provider (string) --
The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of CodeDeploy, which would be specified as CodeDeploy. For more information, see Valid Action Types and Providers in CodePipeline.
version (string) --
A string that describes the action version.
configuration (dict) --
Configuration data for an action execution.
(string) --
(string) --
resolvedConfiguration (dict) --
Configuration data for an action execution with all variable references replaced with their real values for the execution.
(string) --
(string) --
roleArn (string) --
The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
region (string) --
The Amazon Web Services Region for the action, such as us-east-1.
inputArtifacts (list) --
Details of input artifacts of the action that correspond to the action execution.
(dict) --
Artifact details for the action execution, such as the artifact location.
name (string) --
The artifact object name for the action execution.
s3location (dict) --
The Amazon S3 artifact location for the action execution.
bucket (string) --
The Amazon S3 artifact bucket for an action's artifacts.
key (string) --
The artifact name.
namespace (string) --
The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
output (dict) --
Output details for the action execution, such as the action execution result.
outputArtifacts (list) --
Details of output artifacts of the action that correspond to the action execution.
(dict) --
Artifact details for the action execution, such as the artifact location.
name (string) --
The artifact object name for the action execution.
s3location (dict) --
The Amazon S3 artifact location for the action execution.
bucket (string) --
The Amazon S3 artifact bucket for an action's artifacts.
key (string) --
The artifact name.
executionResult (dict) --
Execution result information listed in the output details for an action execution.
externalExecutionId (string) --
The action provider's external ID for the action execution.
externalExecutionSummary (string) --
The action provider's summary for the action execution.
externalExecutionUrl (string) --
The deepest external link to the external resource (for example, a repository URL or deployment endpoint) that is used when running the action.
errorDetails (dict) --
Represents information about an error in CodePipeline.
code (string) --
The system ID or number code of the error.
message (string) --
The text of the error message.
logStreamARN (string) --
The Amazon Resource Name (ARN) of the log stream for the action compute.
outputVariables (dict) --
The outputVariables field shows the key-value pairs that were output as part of that execution.
(string) --
(string) --
nextToken (string) --
If the amount of returned information is significantly large, an identifier is also returned and can be used in a subsequent ListActionExecutions call to return the next set of action executions in the list.