# This file is automatically generated by botocraft. Do not edit directly.
# mypy: disable-error-code="index, override, assignment, union-attr, misc"
from typing import Any
from .abstract import (
Boto3Model,
ReadonlyBoto3Model,
PrimaryBoto3Model,
ReadonlyPrimaryBoto3Model,
Boto3ModelManager,
ReadonlyBoto3ModelManager,
)
from .abstract import PrimaryBoto3ModelQuerySet
from botocraft.mixins.codepipeline import pipeline_response_to_pipeline
from datetime import datetime
import builtins
from botocraft.mixins.codepipeline import (
action_type_declaration_response_to_action_type,
)
from botocraft.mixins.codepipeline import pipeline_execution_list_add_pipeline_name
from botocraft.services.codebuild import EnvironmentVariable
from botocraft.mixins.codepipeline import (
pipeline_execution_response_to_pipeline_execution,
)
from pydantic import Field
from collections import OrderedDict
from typing import ClassVar, Literal, cast
from botocraft.mixins.codepipeline import action_type_response_to_action_type
from botocraft.mixins.tags import TagsDictMixin
from botocraft.services.common import Tag
from botocraft.mixins.codepipeline import pipeline_summaries_to_pipelines
# ===============
# Managers
# ===============
[docs]class PipelineManager(Boto3ModelManager):
service_name: str = "codepipeline"
[docs] @pipeline_response_to_pipeline
def create(
self, model: "Pipeline", tags: "builtins.list[Tag] | None" = None
) -> "CreatePipelineOutput":
"""
Creates a pipeline.
Args:
model: The :py:class:`PipelineDeclaration` to create.
Keyword Args:
tags: The tags for the pipeline.
"""
data = model.model_dump(exclude_none=True, by_alias=True)
args = dict(
pipeline=self.serialize(
{
"name": data.get("name"),
**{
key: data.get(key)
for key in [
"roleArn",
"artifactStore",
"artifactStores",
"stages",
"version",
"executionMode",
"pipelineType",
"variables",
"triggers",
]
if data.get(key) not in (None, [], {})
},
}
if data.get("name") is not None
else None
),
tags=self.serialize(tags),
)
_response = self.client.create_pipeline(
**{k: v for k, v in args.items() if v is not None}
)
response = CreatePipelineOutput(**_response)
self.sessionize(response)
return cast("CreatePipelineOutput", response)
[docs] @pipeline_response_to_pipeline
def update(self, model: "Pipeline") -> "UpdatePipelineOutput":
"""
Updates a specified pipeline with edits or changes to its structure. Use a JSON
file with the pipeline structure and ``UpdatePipeline`` to provide the full
structure of the pipeline. Updating the pipeline increases the version number of
the pipeline by 1.
Args:
model: The :py:class:`PipelineDeclaration` to update.
"""
data = model.model_dump(exclude_none=True, by_alias=True)
args = dict(
pipeline=self.serialize(
{
"name": data.get("name"),
**{
key: data.get(key)
for key in [
"roleArn",
"artifactStore",
"artifactStores",
"stages",
"version",
"executionMode",
"pipelineType",
"variables",
"triggers",
]
if data.get(key) not in (None, [], {})
},
}
if data.get("name") is not None
else None
)
)
_response = self.client.update_pipeline(
**{k: v for k, v in args.items() if v is not None}
)
response = UpdatePipelineOutput(**_response)
self.sessionize(response)
return cast("UpdatePipelineOutput", response)
[docs] def delete(self, name: str) -> None:
"""
Deletes the specified pipeline.
Args:
name: The name of the pipeline to be deleted.
"""
args: dict[str, Any] = dict(name=self.serialize(name))
self.client.delete_pipeline(**{k: v for k, v in args.items() if v is not None})
[docs] @pipeline_response_to_pipeline
def get(
self, name: str, *, version: "int | None" = None
) -> "GetPipelineOutput | None":
"""
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.
Args:
name: The name of the pipeline for which you want to get information. Pipeline names must be unique in an Amazon Web
Services account.
Keyword Args:
version: The version number of the pipeline. If you do not specify a version, defaults to the current version.
"""
args: dict[str, Any] = dict(
name=self.serialize(name), version=self.serialize(version)
)
_response = self.client.get_pipeline(
**{k: v for k, v in args.items() if v is not None}
)
response = GetPipelineOutput(**_response)
if response:
self.sessionize(response)
return response
return None
[docs] @pipeline_summaries_to_pipelines
def list(self, *, version: "int | None" = None) -> PrimaryBoto3ModelQuerySet:
"""
Returns every pipeline in the account. Each entry is loaded with
````GetPipeline```` after listing, so models include the full definition
(stages, artifact stores, variables, triggers, ````pipelineArn````, etc.), not
only ````ListPipelines```` summary fields. Optional ````version```` pins the
pipeline revision fetched for every name; omit it to load the latest revision
for each pipeline.
Keyword Args:
version: When set, each pipeline is loaded with ````GetPipeline```` using this version number. When omitted, the
current (latest) revision is used.
"""
paginator = self.client.get_paginator("list_pipelines")
args: dict[str, Any] = dict()
response_iterator = paginator.paginate(
**{k: v for k, v in args.items() if v is not None}
)
results = []
for _response in response_iterator:
if list(_response.keys()) == ["ResponseMetadata"]:
break
if "ResponseMetadata" in _response:
del _response["ResponseMetadata"]
response = ListPipelinesOutput(**_response)
if response.pipelines:
results.extend(response.pipelines)
else:
if getattr(response, "NextToken", None):
continue
break
self.sessionize(results)
if results and isinstance(results[0], Boto3Model):
return PrimaryBoto3ModelQuerySet(results)
return results
[docs] def start_execution(
self,
name: str,
*,
variables: "builtins.list[PipelineVariable] | None" = None,
clientRequestToken: "str | None" = None,
sourceRevisions: "builtins.list[SourceRevisionOverride] | None" = None,
) -> str:
"""
Starts the specified pipeline. Specifically, it begins processing the latest
commit to the source location specified as part of the pipeline.
Args:
name: The name of the pipeline to start.
Keyword Args:
variables: A list that overrides pipeline variables for a pipeline execution that's being started. Variable names
must match ``[A-Za-z0-9@-_]+``, and the values can be anything except an empty string.
clientRequestToken: The system-generated unique ID used to identify a unique execution request.
sourceRevisions: A list that allows you to specify, or override, the source revision for a pipeline execution that's
being started. A source revision is the version with all the changes to your application code, or source artifact,
for the pipeline execution.
"""
args: dict[str, Any] = dict(
name=self.serialize(name),
variables=self.serialize(variables),
clientRequestToken=self.serialize(clientRequestToken),
sourceRevisions=self.serialize(sourceRevisions),
)
_response = self.client.start_pipeline_execution(
**{k: v for k, v in args.items() if v is not None}
)
response = StartPipelineExecutionOutput(**_response)
results: str = None
if response is not None:
results = response.pipelineExecutionId
self.sessionize(results)
return cast("str", results)
[docs] def stop_execution(
self,
pipelineName: str,
pipelineExecutionId: str,
*,
abandon: "bool | None" = None,
reason: "str | None" = None,
) -> str:
"""
Stops the specified pipeline execution. You choose to either stop the pipeline
execution by completing in-progress actions without starting subsequent actions,
or by abandoning in-progress actions. While completing or abandoning in-
progress actions, the pipeline execution is in a ``Stopping`` state. After all
in-progress actions are completed or abandoned, the pipeline execution is in a
``Stopped`` state.
Args:
pipelineName: The name of the pipeline to stop.
pipelineExecutionId: The ID of the pipeline execution to be stopped in the current stage. Use the
``GetPipelineState`` action to retrieve the current pipelineExecutionId.
Keyword Args:
abandon: Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.
reason: Use this option to enter comments, such as the reason the pipeline was stopped.
"""
args: dict[str, Any] = dict(
pipelineName=self.serialize(pipelineName),
pipelineExecutionId=self.serialize(pipelineExecutionId),
abandon=self.serialize(abandon),
reason=self.serialize(reason),
)
_response = self.client.stop_pipeline_execution(
**{k: v for k, v in args.items() if v is not None}
)
response = StopPipelineExecutionOutput(**_response)
results: str = None
if response is not None:
results = response.pipelineExecutionId
self.sessionize(results)
return cast("str", results)
[docs]class PipelineExecutionManager(ReadonlyBoto3ModelManager):
service_name: str = "codepipeline"
[docs] @pipeline_execution_response_to_pipeline_execution
def get(
self, pipelineName: str, pipelineExecutionId: str
) -> "GetPipelineExecutionOutput | None":
"""
Returns information about an execution of a pipeline, including details about
artifacts, the pipeline execution ID, and the name, version, and status of the
pipeline.
Args:
pipelineName: The name of the pipeline about which you want to get execution details.
pipelineExecutionId: The ID of the pipeline execution about which you want to get execution details.
"""
args: dict[str, Any] = dict(
pipelineName=self.serialize(pipelineName),
pipelineExecutionId=self.serialize(pipelineExecutionId),
)
_response = self.client.get_pipeline_execution(
**{k: v for k, v in args.items() if v is not None}
)
response = GetPipelineExecutionOutput(**_response)
if response:
self.sessionize(response)
return response
return None
[docs] @pipeline_execution_list_add_pipeline_name
def list(
self, pipelineName: str, *, filter: "PipelineExecutionFilter | None" = None
) -> PrimaryBoto3ModelQuerySet:
"""
Gets a summary of the most recent executions for a pipeline.
Args:
pipelineName: The name of the pipeline for which you want to get execution summary information.
Keyword Args:
filter: The pipeline execution to filter on.
"""
paginator = self.client.get_paginator("list_pipeline_executions")
args: dict[str, Any] = dict(
pipelineName=self.serialize(pipelineName), filter=self.serialize(filter)
)
response_iterator = paginator.paginate(
**{k: v for k, v in args.items() if v is not None}
)
results = []
for _response in response_iterator:
if list(_response.keys()) == ["ResponseMetadata"]:
break
if "ResponseMetadata" in _response:
del _response["ResponseMetadata"]
response = ListPipelineExecutionsOutput(**_response)
if response.pipelineExecutionSummaries:
results.extend(response.pipelineExecutionSummaries)
else:
if getattr(response, "NextToken", None):
continue
break
self.sessionize(results)
if results and isinstance(results[0], Boto3Model):
return PrimaryBoto3ModelQuerySet(results)
return results
[docs] def stop(
self,
pipelineName: str,
pipelineExecutionId: str,
*,
abandon: "bool | None" = None,
reason: "str | None" = None,
) -> str:
"""
Stops the specified pipeline execution. You choose to either stop the pipeline
execution by completing in-progress actions without starting subsequent actions,
or by abandoning in-progress actions. While completing or abandoning in-
progress actions, the pipeline execution is in a ``Stopping`` state. After all
in-progress actions are completed or abandoned, the pipeline execution is in a
``Stopped`` state.
Args:
pipelineName: The name of the pipeline to stop.
pipelineExecutionId: The ID of the pipeline execution to be stopped in the current stage. Use the
``GetPipelineState`` action to retrieve the current pipelineExecutionId.
Keyword Args:
abandon: Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.
reason: Use this option to enter comments, such as the reason the pipeline was stopped.
"""
args: dict[str, Any] = dict(
pipelineName=self.serialize(pipelineName),
pipelineExecutionId=self.serialize(pipelineExecutionId),
abandon=self.serialize(abandon),
reason=self.serialize(reason),
)
_response = self.client.stop_pipeline_execution(
**{k: v for k, v in args.items() if v is not None}
)
response = StopPipelineExecutionOutput(**_response)
results: str = None
if response is not None:
results = response.pipelineExecutionId
self.sessionize(results)
return cast("str", results)
[docs]class ActionTypeManager(Boto3ModelManager):
service_name: str = "codepipeline"
[docs] @action_type_response_to_action_type
def create(
self, model: "ActionType", tags: "builtins.list[Tag] | None" = None
) -> "CreateCustomActionTypeOutput":
"""
Creates a new custom action that can be used in all pipelines associated with
the Amazon Web Services account. Only used for custom actions.
Args:
model: The :py:class:`ActionType` to create.
Keyword Args:
tags: The tags for the custom action.
"""
data = model.model_dump(exclude_none=True, by_alias=True)
args = dict(
category=self.serialize(data.get("id", {}).get("category")),
provider=self.serialize(data.get("id", {}).get("provider")),
version=self.serialize(data.get("id", {}).get("version")),
inputArtifactDetails=data.get("inputArtifactDetails"),
outputArtifactDetails=data.get("outputArtifactDetails"),
settings=data.get("settings"),
configurationProperties=data.get("actionConfigurationProperties"),
tags=self.serialize(tags),
)
_response = self.client.create_custom_action_type(
**{k: v for k, v in args.items() if v is not None}
)
response = CreateCustomActionTypeOutput(**_response)
self.sessionize(response)
return cast("CreateCustomActionTypeOutput", response)
[docs] def delete(
self,
category: Literal[
"Source", "Build", "Deploy", "Test", "Invoke", "Approval", "Compute"
],
provider: str,
version: str,
) -> None:
"""
Marks a custom action as deleted. ``PollForJobs`` for the custom action fails
after the action is marked for deletion. Used for custom actions only.
Args:
category: The category of the custom action that you want to delete, such as source or deploy.
provider: The provider of the service used in the custom action, such as CodeDeploy.
version: The version of the custom action to delete.
"""
args: dict[str, Any] = dict(
category=self.serialize(category),
provider=self.serialize(provider),
version=self.serialize(version),
)
self.client.delete_custom_action_type(
**{k: v for k, v in args.items() if v is not None}
)
[docs] @action_type_declaration_response_to_action_type
def get(
self,
category: Literal[
"Source", "Build", "Deploy", "Test", "Invoke", "Approval", "Compute"
],
owner: str,
provider: str,
version: str,
) -> "GetActionTypeOutput | None":
"""
Returns information about an action type created for an external provider, where
the action is to be used by customers of the external provider. The action can
be created with any supported integration model.
Args:
category: Defines what kind of action can be taken in the stage. The following are the valid values:
owner: The creator of an action type that was created with any supported integration model. There are two valid
values: ``AWS`` and ``ThirdParty``.
provider: The provider of the action type being called. The provider name is specified when the action type is
created.
version: A string that describes the action type version.
"""
args: dict[str, Any] = dict(
category=self.serialize(category),
owner=self.serialize(owner),
provider=self.serialize(provider),
version=self.serialize(version),
)
_response = self.client.get_action_type(
**{k: v for k, v in args.items() if v is not None}
)
response = GetActionTypeOutput(**_response)
if response:
self.sessionize(response)
return response
return None
[docs] def list(
self,
*,
actionOwnerFilter: "Literal['AWS', 'ThirdParty', 'Custom'] | None" = None,
regionFilter: "str | None" = None,
) -> PrimaryBoto3ModelQuerySet:
"""
Gets a summary of all CodePipeline action types associated with your account.
Keyword Args:
actionOwnerFilter: Filters the list of action types to those created by a specified entity.
regionFilter: The Region to filter on for the list of action types.
"""
paginator = self.client.get_paginator("list_action_types")
args: dict[str, Any] = dict(
actionOwnerFilter=self.serialize(actionOwnerFilter),
regionFilter=self.serialize(regionFilter),
)
response_iterator = paginator.paginate(
**{k: v for k, v in args.items() if v is not None}
)
results = []
for _response in response_iterator:
if list(_response.keys()) == ["ResponseMetadata"]:
break
if "ResponseMetadata" in _response:
del _response["ResponseMetadata"]
response = ListActionTypesOutput(**_response)
if response.actionTypes:
results.extend(response.actionTypes)
else:
if getattr(response, "NextToken", None):
continue
break
self.sessionize(results)
if results and isinstance(results[0], Boto3Model):
return PrimaryBoto3ModelQuerySet(results)
return results
[docs] def update(self, model: "ActionType") -> None:
"""
Updates an action type that was created with any supported integration model,
where the action type is to be used by customers of the action type provider.
Use a JSON file with the action definition and ``UpdateActionType`` to provide
the full structure.
Args:
model: The :py:class:`ActionType` to update.
"""
data = model.model_dump(exclude_none=True, by_alias=True)
args = dict(
actionType=self.serialize(
{
key: data.get(key)
for key in [
"description",
"executor",
"id",
"inputArtifactDetails",
"outputArtifactDetails",
"permissions",
"properties",
"urls",
]
if data.get(key) is not None
}
)
)
self.client.update_action_type(
**{k: v for k, v in args.items() if v is not None}
)
# ==============
# Service Models
# ==============
[docs]class BlockerDeclaration(Boto3Model):
"""
Reserved for future use.
"""
name: str
"""
Reserved for future use.
"""
type: Literal["Schedule"]
"""
Reserved for future use.
"""
[docs]class ActionTypeId(Boto3Model):
"""
Represents information about an action type.
"""
category: Literal[
"Source", "Build", "Deploy", "Test", "Invoke", "Approval", "Compute"
]
"""
A category defines what kind of action can be taken in the stage, and constrains the
provider type for the action.
Valid categories are limited to one of the following values.
"""
owner: Literal["AWS", "ThirdParty", "Custom"]
"""
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 <https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-
structure.html#actions-valid-providers>`_.
"""
provider: str
"""
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 <https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#actions-valid-
providers>`_.
"""
version: str
"""
A string that describes the action version.
"""
[docs]class OutputArtifact(Boto3Model):
"""
Represents information about the output of an action.
"""
name: str
"""
The name of the output of an artifact, such as "My App".
"""
files: "builtins.list[str] | None" = Field(default_factory=list)
"""
The files that you want to associate with the output artifact that will be exported
from the compute action.
"""
[docs]class ActionDeclaration(Boto3Model):
"""
Represents information about an action declaration.
"""
name: str
"""
The action declaration's name.
"""
actionTypeId: ActionTypeId
"""
Specifies the action type and the provider of the action.
"""
runOrder: "int | None" = None
"""
The order in which actions are run.
"""
configuration: "dict[str, str] | None" = Field(default_factory=dict)
"""
The action's configuration.
These are key-value pairs that specify input values for an action. For more information, see
`Action Structure Requirements in CodePipeline <https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-
pipeline-structure.html#action-requirements>`_. For the list of configuration properties for the CloudFormation action
type in CodePipeline, see `Configuration Properties
Reference <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-delivery-codepipeline-action-
reference.html>`_ in the *CloudFormation User Guide*. For template snippets with examples, see `Using Parameter Override
Functions with CodePipeline Pipelines <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-
delivery-codepipeline-parameter-override-functions.html>`_ in the *CloudFormation User Guide*.
"""
commands: "builtins.list[str] | None" = Field(default_factory=list)
"""
The shell commands to run with your compute action in CodePipeline.
All commands are supported except multi-line formats. While CodeBuild logs and
permissions are used, you do not need to create any resources in CodeBuild.
"""
outputArtifacts: "builtins.list[OutputArtifact] | None" = Field(
default_factory=list
)
"""
The name or ID of the result of the action declaration, such as a test or build
artifact.
"""
inputArtifacts: "builtins.list[InputArtifact] | None" = Field(default_factory=list)
"""
The name or ID of the artifact consumed by the action, such as a test or build
artifact.
"""
outputVariables: "builtins.list[str] | None" = Field(default_factory=list)
"""
The list of variables that are to be exported from the compute action.
This is specifically CodeBuild environment variables as used for that action.
"""
roleArn: "str | None" = None
"""
The ARN of the IAM service role that performs the declared action.
This is assumed through the roleArn for the pipeline.
"""
region: "str | None" = None
"""
The action declaration's Amazon Web Services Region, such as us-east-1.
"""
namespace: "str | None" = None
"""
The variable namespace associated with the action.
All variables produced as output by this action fall under this namespace.
"""
timeoutInMinutes: "int | None" = None
"""
A timeout duration in minutes that can be applied against the ActionType’s default timeout value specified in `Quotas
for CodePipeline <https://docs.aws.amazon.com/codepipeline/latest/userguide/limits.html>`_ . This attribute is available
only to the manual approval ActionType.
"""
environmentVariables: "builtins.list[EnvironmentVariable] | None" = Field(
default_factory=list
)
"""
The environment variables for the action.
"""
[docs]class RetryConfiguration(Boto3Model):
"""
The retry configuration specifies automatic retry for a failed stage, along with the
configured retry mode.
"""
retryMode: "Literal['FAILED_ACTIONS', 'ALL_ACTIONS'] | None" = None
"""
The method that you want to configure for automatic stage retry on stage failure.
You can specify to retry only failed action in the stage or all actions in the
stage.
"""
[docs]class RuleTypeId(Boto3Model):
"""
The ID for the rule type, which is made up of the combined values for category,
owner, provider, and version.
For more information about conditions, see
`Stage conditions <https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-
conditions.html>`_. For more information about rules, see the
`CodePipeline rule reference <https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html>`_.
"""
owner: "Literal['AWS'] | None" = None
"""
The owner for this rule type.
"""
category: Literal["Rule"]
"""
A category defines what kind of rule can be run in the stage, and constrains the
provider type for the rule.
The valid
category is ``Rule``.
"""
provider: str
"""
The rule provider, such as the ``DeploymentWindow`` rule.
For a list of rule provider names, see the rules listed in the
`CodePipeline rule reference <https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html>`_.
"""
version: "str | None" = None
"""
A string that describes the rule version.
"""
[docs]class RuleDeclaration(Boto3Model):
"""
Represents information about the rule to be created for an associated condition.
An example would be creating a new rule for an entry condition, such as a rule that
checks for a test result before allowing the run to enter the deployment stage. For
more information about conditions, see
`Stage conditions <https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html>`_
and
`How do stage conditions work? <https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html>`_.
For more information about rules, see the
`CodePipeline rule reference <https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html>`_.
"""
name: str
"""
The name of the rule that is created for the condition, such as ``VariableCheck``.
"""
ruleTypeId: RuleTypeId
"""
The ID for the rule type, which is made up of the combined values for category,
owner, provider, and version.
"""
configuration: "dict[str, str] | None" = Field(default_factory=dict)
"""
The action configuration fields for the rule.
"""
commands: "builtins.list[str] | None" = Field(default_factory=list)
"""
The shell commands to run with your commands rule in CodePipeline.
All commands are supported except multi-line formats. While CodeBuild logs and
permissions are used, you do not need to create any resources in CodeBuild.
"""
inputArtifacts: "builtins.list[InputArtifact] | None" = Field(default_factory=list)
"""
The input artifacts fields for the rule, such as specifying an input file for the
rule.
"""
roleArn: "str | None" = None
"""
The pipeline role ARN associated with the rule.
"""
region: "str | None" = None
"""
The Region for the condition associated with the rule.
"""
timeoutInMinutes: "int | None" = None
"""
The action timeout for the rule.
"""
[docs]class Condition(Boto3Model):
"""
The condition for the stage.
A condition is made up of the rules and the result for the condition. For more information
about conditions, see `Stage conditions <https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-
conditions.html>`_ and `How do stage conditions work? <https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-
how-it-works-conditions.html>`_.. For more information about rules, see the `CodePipeline rule
reference <https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html>`_.
"""
result: "Literal['ROLLBACK', 'FAIL', 'RETRY', 'SKIP'] | None" = None
"""
The action to be done when the condition is met.
For example, rolling back an execution for a failure condition.
"""
rules: "builtins.list[RuleDeclaration] | None" = Field(default_factory=list)
"""
The rules that make up the condition.
"""
[docs]class FailureConditions(Boto3Model):
"""
The configuration that specifies the result, such as rollback, to occur upon stage
failure.
For more information about conditions, see
`Stage conditions <https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html>`_
and
`How do stage conditions work? <https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-
conditions.html>`_.
"""
result: "Literal['ROLLBACK', 'FAIL', 'RETRY', 'SKIP'] | None" = None
"""
The specified result for when the failure conditions are met, such as rolling back
the stage.
"""
retryConfiguration: "RetryConfiguration | None" = None
"""
The retry configuration specifies automatic retry for a failed stage, along with the
configured retry mode.
"""
conditions: "builtins.list[Condition] | None" = Field(default_factory=list)
"""
The conditions that are configured as failure conditions.
For more information about conditions, see
`Stage conditions <https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html>`_
and
`How do stage conditions work? <https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html>`_.
"""
[docs]class SuccessConditions(Boto3Model):
"""
The conditions for making checks that, if met, succeed a stage.
For more information about conditions, see
`Stage conditions <https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html>`_
and
`How do stage conditions work? <https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html>`_.
"""
conditions: "builtins.list[Condition]"
"""
The conditions that are success conditions.
"""
[docs]class BeforeEntryConditions(Boto3Model):
"""
The conditions for making checks for entry to a stage.
For more information about conditions, see
`Stage conditions <https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html>`_
and
`How do stage conditions work? <https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html>`_.
"""
conditions: "builtins.list[Condition]"
"""
The conditions that are configured as entry conditions.
"""
[docs]class StageDeclaration(Boto3Model):
"""
Represents information about a stage and its definition.
"""
name: str
"""
The name of the stage.
"""
blockers: "builtins.list[BlockerDeclaration] | None" = Field(default_factory=list)
"""
Reserved for future use.
"""
actions: "builtins.list[ActionDeclaration]"
"""
The actions included in a stage.
"""
onFailure: "FailureConditions | None" = None
"""
The method to use when a stage has not completed successfully.
For example, configuring this field for rollback will roll back a failed stage
automatically to the last successful pipeline execution in the stage.
"""
onSuccess: "SuccessConditions | None" = None
"""
The method to use when a stage has succeeded.
For example, configuring this field for conditions will allow the stage to succeed
when the conditions are met.
"""
beforeEntry: "BeforeEntryConditions | None" = None
"""
The method to use when a stage allows entry.
For example, configuring this field for conditions will allow entry to the stage
when the conditions are met.
"""
[docs]class EncryptionKey(Boto3Model):
"""
Represents information about the key used to encrypt data in the artifact store,
such as an Amazon Web Services Key Management Service (Key Management Service) key.
"""
id: str
"""
The ID used to identify the key.
For an Amazon Web Services KMS key, you can use the key ID, the key ARN, or the
alias ARN.
"""
type: Literal["KMS"]
"""
The type of encryption key, such as an Amazon Web Services KMS key.
When creating or updating a pipeline, the value must be set to 'KMS'.
"""
[docs]class ArtifactStore(Boto3Model):
"""
The S3 bucket where artifacts for the pipeline are stored.
You must include either ``artifactStore`` or ``artifactStores`` in your pipeline, but you cannot use both. If you create
a cross-region action in your pipeline, you must use ``artifactStores``.
"""
type: Literal["S3"]
"""
The type of the artifact store, such as S3.
"""
location: str
"""
The S3 bucket used for storing the artifacts for a pipeline.
You can specify the name of an S3 bucket but not a folder in the bucket. A folder to
contain the pipeline artifacts is created for you based on the name of the pipeline.
You can use any S3 bucket in the same Amazon Web Services Region as the pipeline to
store your pipeline artifacts.
"""
encryptionKey: "EncryptionKey | None" = None
"""
The encryption key used to encrypt the data in the artifact store, such as an Amazon
Web Services Key Management Service key.
If this is undefined, the default key for Amazon S3 is used.
"""
[docs]class PipelineVariableDeclaration(Boto3Model):
"""
A variable declared at the pipeline level.
"""
name: str
"""
The name of a pipeline-level variable.
"""
defaultValue: "str | None" = None
"""
The value of a pipeline-level variable.
"""
description: "str | None" = None
"""
The description of a pipeline-level variable.
It's used to add additional context about the variable, and not being used at time
when pipeline executes.
"""
[docs]class GitTagFilterCriteria(Boto3Model):
"""
The Git tags specified as filter criteria for whether a Git tag repository event
will start the pipeline.
"""
includes: "builtins.list[str] | None" = Field(default_factory=list)
"""
The list of patterns of Git tags that, when pushed, are to be included as criteria
that starts the pipeline.
"""
excludes: "builtins.list[str] | None" = Field(default_factory=list)
"""
The list of patterns of Git tags that, when pushed, are to be excluded from starting
the pipeline.
"""
[docs]class GitBranchFilterCriteria(Boto3Model):
"""
The Git repository branches specified as filter criteria to start the pipeline.
"""
includes: "builtins.list[str] | None" = Field(default_factory=list)
"""
The list of patterns of Git branches that, when a commit is pushed, are to be
included as criteria that starts the pipeline.
"""
excludes: "builtins.list[str] | None" = Field(default_factory=list)
"""
The list of patterns of Git branches that, when a commit is pushed, are to be
excluded from starting the pipeline.
"""
[docs]class GitFilePathFilterCriteria(Boto3Model):
"""
The Git repository file paths specified as filter criteria to start the pipeline.
"""
includes: "builtins.list[str] | None" = Field(default_factory=list)
"""
The list of patterns of Git repository file paths that, when a commit is pushed, are
to be included as criteria that starts the pipeline.
"""
excludes: "builtins.list[str] | None" = Field(default_factory=list)
"""
The list of patterns of Git repository file paths that, when a commit is pushed, are
to be excluded from starting the pipeline.
"""
[docs]class GitPushFilter(TagsDictMixin, Boto3Model):
"""
The event criteria that specify when a specified repository event will start the
pipeline for the specified trigger configuration, such as the lists of Git tags to
include and exclude.
"""
tag_class: ClassVar[type[Boto3Model]] = GitTagFilterCriteria
Tags: GitTagFilterCriteria = Field(default=None, alias="tags")
"""
The field that contains the details for the Git tags trigger configuration.
"""
branches: "GitBranchFilterCriteria | None" = None
"""
The field that specifies to filter on branches for the push trigger configuration.
"""
filePaths: "GitFilePathFilterCriteria | None" = None
"""
The field that specifies to filter on file paths for the push trigger configuration.
"""
[docs]class GitPullRequestFilter(Boto3Model):
"""
The event criteria for the pull request trigger configuration, such as the lists of
branches or file paths to include and exclude.
The following are valid values for the events for this filter:
* CLOSED
* OPEN
* UPDATED
"""
events: "builtins.list[Literal['OPEN', 'UPDATED', 'CLOSED']] | None" = Field(
default_factory=list
)
"""
The field that specifies which pull request events to filter on (OPEN, UPDATED,
CLOSED) for the trigger configuration.
"""
branches: "GitBranchFilterCriteria | None" = None
"""
The field that specifies to filter on branches for the pull request trigger
configuration.
"""
filePaths: "GitFilePathFilterCriteria | None" = None
"""
The field that specifies to filter on file paths for the pull request trigger
configuration.
"""
[docs]class GitConfiguration(Boto3Model):
"""
A type of trigger configuration for Git-based source actions.
You can specify the Git configuration trigger type for all third-party Git-based source actions that are supported by
the ``CodeStarSourceConnection`` action type.
"""
sourceActionName: str
"""
The name of the pipeline source action where the trigger configuration, such as Git
tags, is specified.
The trigger configuration will start the pipeline upon the specified change only.
"""
push: "builtins.list[GitPushFilter] | None" = Field(default_factory=list)
"""
The field where the repository event that will start the pipeline, such as pushing
Git tags, is specified with details.
"""
pullRequest: "builtins.list[GitPullRequestFilter] | None" = Field(
default_factory=list
)
"""
The field where the repository event that will start the pipeline is specified as
pull requests.
"""
[docs]class PipelineTriggerDeclaration(Boto3Model):
"""
Represents information about the specified trigger configuration, such as the filter
criteria and the source stage for the action that contains the trigger.
This is only supported for the ``CodeStarSourceConnection`` action type.
When a trigger configuration is specified, default change detection for repository and branch commits is disabled.
"""
providerType: Literal["CodeStarSourceConnection"]
"""
The source provider for the event, such as connections configured for a repository
with Git tags, for the specified trigger configuration.
"""
gitConfiguration: GitConfiguration
"""
Provides the filter criteria and the source stage for the repository event that
starts the pipeline, such as Git tags.
"""
[docs]class PipelineVariable(Boto3Model):
"""
A pipeline-level variable used for a pipeline execution.
"""
name: str
"""
The name of a pipeline-level variable.
"""
value: str
"""
The value of a pipeline-level variable.
"""
[docs]class SourceRevisionOverride(Boto3Model):
"""
A list that allows you to specify, or override, the source revision for a pipeline
execution that's being started. A source revision is the version with all the
changes to your application code, or source artifact, for the pipeline execution.
For the ``S3_OBJECT_VERSION_ID`` and ``S3_OBJECT_KEY`` types of source revisions, either of the types can be used
independently, or they can be used together to override the source with a specific ObjectKey and VersionID.
"""
actionName: str
"""
The name of the action where the override will be applied.
"""
revisionType: Literal[
"COMMIT_ID", "IMAGE_DIGEST", "S3_OBJECT_VERSION_ID", "S3_OBJECT_KEY"
]
"""
The type of source revision, based on the source provider.
For example, the revision type for the CodeCommit action provider is the commit ID.
"""
revisionValue: str
"""
The source revision, or version of your source artifact, with the changes that you
want to run in the pipeline execution.
"""
[docs]class Pipeline(PrimaryBoto3Model):
"""
Represents the structure of actions and stages to be performed in the pipeline.
"""
manager_class: ClassVar[type[Boto3ModelManager]] = PipelineManager
pipelineName: str = Field(default=None, alias="name")
"""
The name of the pipeline.
"""
roleArn: "str | None" = None
"""
The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions
with no ``actionRoleArn``, or to use to assume roles for actions with an
``actionRoleArn``.
"""
stages: "builtins.list[StageDeclaration] | None" = Field(default_factory=list)
"""
The stage in which to perform the action.
"""
artifactStore: "ArtifactStore | None" = None
"""
Represents information about the S3 bucket where artifacts are stored for the
pipeline.
"""
artifactStores: "dict[str, ArtifactStore] | None" = Field(default_factory=dict)
"""
A mapping of ``artifactStore`` objects and their corresponding Amazon Web Services
Regions.
There must be an artifact store for the pipeline Region and for each cross-region
action in the pipeline.
"""
version: "int | None" = None
"""
The version number of the pipeline.
A new pipeline always has a version number of 1. This number is incremented when a
pipeline is updated.
"""
executionMode: "Literal['QUEUED', 'SUPERSEDED', 'PARALLEL'] | None" = None
"""
The method that the pipeline will use to handle multiple executions.
The default mode is SUPERSEDED.
"""
pipelineType: "Literal['V1', 'V2'] | None" = None
"""
CodePipeline provides the following pipeline types, which differ in characteristics
and price, so that you can tailor your pipeline features and cost to the needs of
your applications.
"""
variables: "builtins.list[PipelineVariableDeclaration] | None" = Field(
default_factory=list
)
"""
A list that defines the pipeline variables for a pipeline resource.
Variable names can have alphanumeric and underscore
characters, and the values must match ``[A-Za-z0-9@-_]+``.
"""
triggers: "builtins.list[PipelineTriggerDeclaration] | None" = Field(
default_factory=list
)
"""
The trigger configuration specifying a type of event, such as Git tags, that starts
the pipeline.
"""
pipelineArn: str | None = None
"""
The ARN of the pipeline when returned by detail APIs.
"""
@property
def pk(self) -> str | None:
"""
Return the primary key of the model. This is the value of the
:py:attr:`pipelineName` attribute.
Returns:
The primary key of the model instance.
"""
return self.pipelineName
@property
def name(self) -> str | None:
"""
Return the name of the model. This is the value of the :py:attr:`pipelineName`
attribute.
Returns:
The name of the model instance.
"""
return self.pipelineName
def __hash__(self) -> int:
"""
Return the hash of the model.
This is the value of the
:py:attr:`pipelineName` attribute.
"""
return hash(self.pipelineName)
[docs] def start_execution(
self,
variables: builtins.list[PipelineVariable] | None = None,
clientRequestToken: str | None = None,
sourceRevisions: builtins.list[SourceRevisionOverride] | None = None,
) -> "str":
"""
Start a new execution for this pipeline.
Keyword Args:
variables: A list that overrides pipeline variables for a pipeline execution that's being started. Variable names
must match ``[A-Za-z0-9@-_]+``, and the values can be anything except an empty string.
clientRequestToken: The system-generated unique ID used to identify a unique execution request.
sourceRevisions: A list that allows you to specify, or override, the source revision for a pipeline execution that's
being started. A source revision is the version with all the changes to your application code, or source artifact,
for the pipeline execution.
"""
return (
cast("PipelineManager", self.objects) # type: ignore[attr-defined]
.using(self.session)
.start_execution(
cast("str", self.name),
variables=variables,
clientRequestToken=clientRequestToken,
sourceRevisions=sourceRevisions,
)
)
[docs]class ArtifactRevision(Boto3Model):
"""
Represents revision details of an artifact.
"""
name: "str | None" = None
"""
The name of an artifact.
This name might be system-generated, such as "MyApp", or defined by the user when an
action is created.
"""
revisionId: "str | None" = None
"""
The revision ID of the artifact.
"""
revisionChangeIdentifier: "str | None" = None
"""
An additional identifier for a revision, such as a commit date or, for artifacts
stored in Amazon S3 buckets, the ETag value.
"""
revisionSummary: "str | None" = None
"""
Summary information about the most recent revision of the artifact.
For GitHub and CodeCommit repositories, the commit
message. For Amazon S3 buckets or actions, the user-provided content of a ``codepipeline-artifact-revision-summary`` key
specified in the object metadata.
"""
created: "datetime | None" = None
"""
The date and time when the most recent revision of the artifact was created, in
timestamp format.
"""
revisionUrl: "str | None" = None
"""
The commit ID for the artifact revision.
For artifacts stored in GitHub or CodeCommit repositories, the commit ID is linked
to a commit details page.
"""
[docs]class ResolvedPipelineVariable(Boto3Model):
"""
A pipeline-level variable used for a pipeline execution.
"""
name: "str | None" = None
"""
The name of a pipeline-level variable.
"""
resolvedValue: "str | None" = None
"""
The resolved value of a pipeline-level variable.
"""
[docs]class ExecutionTrigger(Boto3Model):
"""
The interaction or event that started a pipeline execution.
"""
triggerType: "Literal['CreatePipeline', 'StartPipelineExecution', 'PollForSourceChanges', 'Webhook', 'CloudWatchEvent', 'PutActionRevision', 'WebhookV2', 'ManualRollback', 'AutomatedRollback'] | None" = None
"""
The type of change-detection method, command, or user interaction that started a
pipeline execution.
"""
triggerDetail: "str | None" = None
"""
Detail related to the event that started a pipeline execution, such as the webhook
ARN of the webhook that triggered the pipeline execution or the user ARN for a user-
initiated ``start-pipeline-execution`` CLI command.
"""
[docs]class PipelineExecution(ReadonlyPrimaryBoto3Model):
"""
Represents information about an execution of a pipeline.
"""
manager_class: ClassVar[type[Boto3ModelManager]] = PipelineExecutionManager
pipelineName: "str | None" = None
"""
The name of the pipeline with the specified pipeline execution.
"""
pipelineVersion: "int | None" = None
"""
The version number of the pipeline with the specified pipeline execution.
"""
pipelineExecutionId: "str | None" = None
"""
The ID of the pipeline execution.
"""
status: "Literal['Cancelled', 'InProgress', 'Stopped', 'Stopping', 'Succeeded', 'Superseded', 'Failed'] | None" = None
"""
The status of the pipeline execution.
"""
statusSummary: "str | None" = None
"""
A summary that contains a description of the pipeline execution status.
"""
artifactRevisions: "builtins.list[ArtifactRevision] | None" = Field(
default_factory=list
)
"""
A list of ``ArtifactRevision`` objects included in a pipeline execution.
"""
variables: "builtins.list[ResolvedPipelineVariable] | None" = Field(
default_factory=list
)
"""
A list of pipeline variables used for the pipeline execution.
"""
trigger: "ExecutionTrigger | None" = None
"""
The interaction or event that started a pipeline execution.
"""
executionMode: "Literal['QUEUED', 'SUPERSEDED', 'PARALLEL'] | None" = None
"""
The method that the pipeline will use to handle multiple executions.
The default mode is SUPERSEDED.
"""
executionType: "Literal['STANDARD', 'ROLLBACK'] | None" = None
"""
The type of the pipeline execution.
"""
rollbackMetadata: "PipelineRollbackMetadata | None" = None
"""
The metadata about the execution pertaining to stage rollback.
"""
@property
def pk(self) -> OrderedDict[str, Any]:
"""
The composite primary key for this pipeline execution.
"""
return OrderedDict(
{
"pipelineName": self.pipelineName,
"pipelineExecutionId": self.pipelineExecutionId,
}
)
[docs]class ActionTypeSettings(Boto3Model):
"""
Returns information about the settings for an action type.
"""
thirdPartyConfigurationUrl: "str | None" = None
"""
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: "str | None" = None
"""
The URL returned to the CodePipeline console that provides a deep link to the
resources of the external system, such as the configuration page for a CodeDeploy
deployment group.
This link is provided as part of the action display in the pipeline.
"""
executionUrlTemplate: "str | None" = None
"""
The URL returned to the CodePipeline console that contains a link to the top-level
landing page for the external system, such as the console page for CodeDeploy.
This link is shown on the pipeline view page in the CodePipeline console and
provides a link to the execution entity of the external action.
"""
revisionUrlTemplate: "str | None" = None
"""
The URL returned to the CodePipeline console that contains a link to the page where
customers can update or change the configuration of the external action.
"""
[docs]class ActionConfigurationProperty(Boto3Model):
"""
Represents information about an action configuration property.
"""
name: str
"""
The name of the action configuration property.
"""
required: bool
"""
Whether the configuration property is a required value.
"""
key: bool
"""
Whether the configuration property is a key.
"""
secret: bool
"""
Whether the configuration property is secret.
Secrets are hidden from all calls except for ``GetJobDetails``,
``GetThirdPartyJobDetails``, ``PollForJobs``, and ``PollForThirdPartyJobs``.
"""
queryable: "bool | None" = None
"""
Indicates that the property is used with ``PollForJobs``.
When creating a custom action, an action can have up to one queryable property. If
it has one, that property must be both required and not secret.
"""
description: "str | None" = None
"""
The description of the action configuration property that is displayed to users.
"""
type: "Literal['String', 'Number', 'Boolean'] | None" = None
"""
The type of the configuration property.
"""
[docs]class ArtifactDetails(Boto3Model):
"""
Returns information about the details of an artifact.
"""
minimumCount: int
"""
The minimum number of artifacts allowed for the action type.
"""
maximumCount: int
"""
The maximum number of artifacts allowed for the action type.
"""
[docs]class ActionType(PrimaryBoto3Model):
"""
Returns information about the details of an action type.
"""
manager_class: ClassVar[type[Boto3ModelManager]] = ActionTypeManager
id: ActionTypeId
"""
Represents information about an action type.
"""
settings: "ActionTypeSettings | None" = None
"""
The settings for the action type.
"""
actionConfigurationProperties: "builtins.list[ActionConfigurationProperty] | None" = Field(
default_factory=list
)
"""
The configuration properties for the action type.
"""
inputArtifactDetails: ArtifactDetails
"""
The details of the input artifact for the action, such as its commit ID.
"""
outputArtifactDetails: ArtifactDetails
"""
The details of the output artifact of the action, such as its commit ID.
"""
description: str | None = None
"""
The description returned by detail APIs.
"""
executor: builtins.dict[str, Any] | None = None
"""
The executor configuration returned by detail APIs.
"""
permissions: builtins.dict[str, Any] | None = None
"""
The permissions returned by detail APIs.
"""
properties: builtins.list[builtins.dict[str, Any]] | None = Field(
default_factory=list
)
"""
The action-type properties returned by detail APIs.
"""
urls: builtins.dict[str, Any] | None = None
"""
The URLs returned by detail APIs.
"""
@property
def pk(self) -> OrderedDict[str, Any]:
"""
The identity accepted by custom-action delete operations.
"""
return OrderedDict(
{
"category": self.id.category,
"provider": self.id.provider,
"version": self.id.version,
}
)
# =======================
# Request/Response Models
# =======================
[docs]class CreatePipelineOutput(TagsDictMixin, Boto3Model):
"""
Represents the output of a ``CreatePipeline`` action.
"""
tag_class: ClassVar[type[Boto3Model]] = Tag
pipeline: "Pipeline | None" = None
"""
The created pipeline definition.
"""
Tags: "builtins.list[Tag]" = Field(default_factory=list, alias="tags")
"""
Specifies the tags applied to the pipeline.
"""
[docs]class UpdatePipelineOutput(Boto3Model):
"""
Represents the output of an ``UpdatePipeline`` action.
"""
pipeline: "Pipeline | None" = None
"""
The updated pipeline definition.
"""
[docs]class GetPipelineOutput(Boto3Model):
"""
Represents the output of a ``GetPipeline`` action.
"""
pipeline: "Pipeline | None" = None
"""
The requested pipeline definition.
"""
metadata: "PipelineMetadata | None" = None
"""
Metadata returned for the requested pipeline.
"""
[docs]class PipelineSummary(Boto3Model):
"""
Returns a summary of a pipeline.
"""
name: "str | None" = None
"""
The name of the pipeline.
"""
version: "int | None" = None
"""
The version number of the pipeline.
"""
pipelineType: "Literal['V1', 'V2'] | None" = None
"""
CodePipeline provides the following pipeline types, which differ in characteristics
and price, so that you can tailor your pipeline features and cost to the needs of
your applications.
"""
executionMode: "Literal['QUEUED', 'SUPERSEDED', 'PARALLEL'] | None" = None
"""
The method that the pipeline will use to handle multiple executions.
The default mode is SUPERSEDED.
"""
created: "datetime | None" = None
"""
The date and time the pipeline was created, in timestamp format.
"""
updated: "datetime | None" = None
"""
The date and time of the last update to the pipeline, in timestamp format.
"""
[docs]class ListPipelinesOutput(Boto3Model):
"""
Represents the output of a ``ListPipelines`` action.
"""
pipelines: "builtins.list[PipelineSummary] | None" = Field(default_factory=list)
"""
The list of pipelines.
"""
nextToken: "str | None" = None
"""
If the amount of returned information is significantly large, an identifier is also
returned.
It can be used in a subsequent list pipelines call to return the next set of
pipelines in the list.
"""
[docs]class StartPipelineExecutionOutput(Boto3Model):
"""
Represents the output of a ``StartPipelineExecution`` action.
"""
pipelineExecutionId: "str | None" = None
"""
The unique system-generated ID of the pipeline execution that was started.
"""
[docs]class StopPipelineExecutionOutput(Boto3Model):
pipelineExecutionId: "str | None" = None
"""
The unique system-generated ID of the pipeline execution that was stopped.
"""
[docs]class GetPipelineExecutionOutput(Boto3Model):
"""
Represents the output of a ``GetPipelineExecution`` action.
"""
pipelineExecution: "PipelineExecution | None" = None
"""
Represents information about the execution of a pipeline.
"""
[docs]class SucceededInStageFilter(Boto3Model):
"""
Filter for pipeline executions that have successfully completed the stage in the
current pipeline version.
"""
stageName: "str | None" = None
"""
The name of the stage for filtering for pipeline executions where the stage was
successful in the current pipeline version.
"""
[docs]class PipelineExecutionFilter(Boto3Model):
"""
The pipeline execution to filter on.
"""
succeededInStage: "SucceededInStageFilter | None" = None
"""
Filter for pipeline executions where the stage was successful in the current
pipeline version.
"""
[docs]class SourceRevision(Boto3Model):
"""
Information about the version (or revision) of a source artifact that initiated a
pipeline execution.
"""
actionName: str
"""
The name of the action that processed the revision to the source artifact.
"""
revisionId: "str | None" = None
"""
The system-generated unique ID that identifies the revision number of the artifact.
"""
revisionSummary: "str | None" = None
"""
Summary information about the most recent revision of the artifact.
For GitHub and CodeCommit repositories, the commit
message. For Amazon S3 buckets or actions, the user-provided content of a ``codepipeline-artifact-revision-summary`` key
specified in the object metadata.
"""
revisionUrl: "str | None" = None
"""
The commit ID for the artifact revision.
For artifacts stored in GitHub or CodeCommit repositories, the commit ID is linked
to a commit details page.
"""
[docs]class StopExecutionTrigger(Boto3Model):
"""
The interaction that stopped a pipeline execution.
"""
reason: "str | None" = None
"""
The user-specified reason the pipeline was stopped.
"""
[docs]class PipelineExecutionSummary(Boto3Model):
"""
Summary information about a pipeline execution.
"""
pipelineExecutionId: "str | None" = None
"""
The ID of the pipeline execution.
"""
status: "Literal['Cancelled', 'InProgress', 'Stopped', 'Stopping', 'Succeeded', 'Superseded', 'Failed'] | None" = None
"""
The status of the pipeline execution.
"""
statusSummary: "str | None" = None
"""
Status summary for the pipeline.
"""
startTime: "datetime | None" = None
"""
The date and time when the pipeline execution began, in timestamp format.
"""
lastUpdateTime: "datetime | None" = None
"""
The date and time of the last change to the pipeline execution, in timestamp format.
"""
sourceRevisions: "builtins.list[SourceRevision] | None" = Field(
default_factory=list
)
"""
A list of the source artifact revisions that initiated a pipeline execution.
"""
trigger: "ExecutionTrigger | None" = None
"""
The interaction or event that started a pipeline execution, such as automated change
detection or a ``StartPipelineExecution`` API call.
"""
stopTrigger: "StopExecutionTrigger | None" = None
"""
The interaction that stopped a pipeline execution.
"""
executionMode: "Literal['QUEUED', 'SUPERSEDED', 'PARALLEL'] | None" = None
"""
The method that the pipeline will use to handle multiple executions.
The default mode is SUPERSEDED.
"""
executionType: "Literal['STANDARD', 'ROLLBACK'] | None" = None
"""
Type of the pipeline execution.
"""
rollbackMetadata: "PipelineRollbackMetadata | None" = None
"""
The metadata for the stage execution to be rolled back.
"""
[docs]class ListPipelineExecutionsOutput(Boto3Model):
"""
Represents the output of a ``ListPipelineExecutions`` action.
"""
pipelineExecutionSummaries: "builtins.list[PipelineExecutionSummary] | None" = (
Field(default_factory=list)
)
"""
A list of executions in the history of a pipeline.
"""
nextToken: "str | None" = None
"""
A token that can be used in the next ``ListPipelineExecutions`` call.
To view all items in the list, continue to call this operation with each subsequent
token until no more nextToken values are returned.
"""
[docs]class CreateCustomActionTypeOutput(TagsDictMixin, Boto3Model):
"""
Represents the output of a ``CreateCustomActionType`` operation.
"""
tag_class: ClassVar[type[Boto3Model]] = Tag
Tags: "builtins.list[Tag]" = Field(default_factory=list, alias="tags")
"""
Specifies the tags applied to the custom action.
"""
actionType: ActionType
"""
Returns information about the details of an action type.
"""
[docs]class LambdaExecutorConfiguration(Boto3Model):
"""
Details about the configuration for the ``Lambda`` action engine, or executor.
"""
lambdaFunctionArn: str
"""
The ARN of the Lambda function used by the action engine.
"""
[docs]class JobWorkerExecutorConfiguration(Boto3Model):
"""
Details about the polling configuration for the ``JobWorker`` action engine, or
executor.
"""
pollingAccounts: "builtins.list[str] | None" = Field(default_factory=list)
"""
The accounts in which the job worker is configured and might poll for jobs as part
of the action execution.
"""
pollingServicePrincipals: "builtins.list[str] | None" = Field(default_factory=list)
"""
The service Principals in which the job worker is configured and might poll for jobs
as part of the action execution.
"""
[docs]class ExecutorConfiguration(Boto3Model):
"""
The action engine, or executor, related to the supported integration model used to
create and update the action type.
The available executor types are ``Lambda`` and ``JobWorker``.
"""
lambdaExecutorConfiguration: "LambdaExecutorConfiguration | None" = None
"""
Details about the ``Lambda`` executor of the action type.
"""
jobWorkerExecutorConfiguration: "JobWorkerExecutorConfiguration | None" = None
"""
Details about the ``JobWorker`` executor of the action type.
"""
[docs]class ActionTypeExecutor(Boto3Model):
"""
The action engine, or executor, for an action type created for a provider, where the
action is to be used by customers of the provider.
The action engine is associated with the model used to create and update the action,
such as the Lambda integration model.
"""
type: "Literal['JobWorker', 'Lambda'] | None" = None
"""
The executor type used by this action type.
"""
configuration: ExecutorConfiguration
"""
The action configuration properties for the action type.
These properties are specified in the action definition when the action type is
created.
"""
policyStatementsTemplate: "str | None" = None
"""
The policy statement that specifies the permissions in the CodePipeline customer
account that are needed to successfully run an action.
"""
jobTimeout: "int | None" = None
"""
The timeout in seconds for the job.
An action execution can have multiple jobs. This is the timeout for a single job,
not the entire action execution.
"""
[docs]class ActionTypeIdentifier(Boto3Model):
"""
Specifies the category, owner, provider, and version of the action type.
"""
category: Literal[
"Source", "Build", "Deploy", "Test", "Invoke", "Approval", "Compute"
]
"""
Defines what kind of action can be taken in the stage, one of the following:
"""
owner: str
"""
The creator of the action type being called: ``AWS`` or ``ThirdParty``.
"""
provider: str
"""
The provider of the action type being called.
The provider name is supplied when the action type is created.
"""
version: str
"""
A string that describes the action type version.
"""
[docs]class ActionTypeArtifactDetails(Boto3Model):
"""
Information about parameters for artifacts associated with the action type, such as
the minimum and maximum artifacts allowed.
"""
minimumCount: int
"""
The minimum number of artifacts that can be used with the action type.
For example, you should specify a minimum and
maximum of zero input artifacts for an action type with a category of ``source``.
"""
maximumCount: int
"""
The maximum number of artifacts that can be used with the actiontype.
For example, you should specify a minimum and
maximum of zero input artifacts for an action type with a category of ``source``.
"""
[docs]class ActionTypePermissions(Boto3Model):
"""
Details identifying the users with permissions to use the action type.
"""
allowedAccounts: "builtins.list[str]"
"""
A list of Amazon Web Services account IDs with access to use the action type in
their pipelines.
"""
[docs]class ActionTypeProperty(Boto3Model):
"""
Represents information about each property specified in the action configuration,
such as the description and key name that display for the customer using the action
type.
"""
name: str
"""
The property name that is displayed to users.
"""
optional: bool
"""
Whether the configuration property is an optional value.
"""
key: bool
"""
Whether the configuration property is a key.
"""
noEcho: bool
"""
Whether to omit the field value entered by the customer in the log.
If ``true``, the value is not saved in CloudTrail
logs for the action execution.
"""
queryable: "bool | None" = None
"""
Indicates that the property is used with polling.
An action type can have up to one queryable property. If it has one, that property
must be both required and not secret.
"""
description: "str | None" = None
"""
The description of the property that is displayed to users.
"""
[docs]class ActionTypeUrls(Boto3Model):
"""
Returns information about URLs for web pages that display to customers as links on
the pipeline view, such as an external configuration page for the action type.
"""
configurationUrl: "str | None" = None
"""
The URL returned to the CodePipeline console that contains a link to the page where
customers can configure the external action.
"""
entityUrlTemplate: "str | None" = None
"""
The URL returned to the CodePipeline console that provides a deep link to the
resources of the external system, such as a status page.
This link is provided as part of the action display in the pipeline.
"""
executionUrlTemplate: "str | None" = None
"""
The link to an execution page for the action type in progress.
For example, for a CodeDeploy action, this link is shown on the pipeline view page
in the CodePipeline console, and it links to a CodeDeploy status page.
"""
revisionUrlTemplate: "str | None" = None
"""
The URL returned to the CodePipeline console that contains a link to the page where
customers can update or change the configuration of the external action.
"""
[docs]class ActionTypeDeclaration(Boto3Model):
"""
The parameters for the action type definition that are provided when the action type
is created or updated.
"""
description: "str | None" = None
"""
The description for the action type to be updated.
"""
executor: ActionTypeExecutor
"""
Information about the executor for an action type that was created with any
supported integration model.
"""
id: ActionTypeIdentifier
"""
The action category, owner, provider, and version of the action type to be updated.
"""
inputArtifactDetails: ActionTypeArtifactDetails
"""
Details for the artifacts, such as application files, to be worked on by the action.
For example, the minimum and maximum number of input artifacts allowed.
"""
outputArtifactDetails: ActionTypeArtifactDetails
"""
Details for the output artifacts, such as a built application, that are the result
of the action.
For example, the minimum and maximum number of output artifacts allowed.
"""
permissions: "ActionTypePermissions | None" = None
"""
Details identifying the accounts with permissions to use the action type.
"""
properties: "builtins.list[ActionTypeProperty] | None" = Field(default_factory=list)
"""
The properties of the action type to be updated.
"""
urls: "ActionTypeUrls | None" = None
"""
The links associated with the action type to be updated.
"""
[docs]class GetActionTypeOutput(Boto3Model):
actionType: "ActionTypeDeclaration | None" = None
"""
The action type information for the requested action type, such as the action type
ID.
"""
[docs]class ListActionTypesOutput(Boto3Model):
"""
Represents the output of a ``ListActionTypes`` action.
"""
actionTypes: "builtins.list[ActionType]"
"""
Provides details of the action types.
"""
nextToken: "str | None" = None
"""
If the amount of returned information is significantly large, an identifier is also
returned.
It can be used in a subsequent list action types call to return the next set of
action types in the list.
"""