Typed dictionaries
Index > CodePipeline > Typed dictionaries
Auto-generated documentation for CodePipeline type annotations stubs module mypy-boto3-codepipeline.
AWSSessionCredentialsTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import AWSSessionCredentialsTypeDef
def get_value() -> AWSSessionCredentialsTypeDef:
return {
"accessKeyId": ...,
"secretAccessKey": ...,
"sessionToken": ...,
}
Definition
class AWSSessionCredentialsTypeDef(TypedDict):
accessKeyId: str,
secretAccessKey: str,
sessionToken: str,
AcknowledgeJobInputRequestTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import AcknowledgeJobInputRequestTypeDef
def get_value() -> AcknowledgeJobInputRequestTypeDef:
return {
"jobId": ...,
"nonce": ...,
}
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
Definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
AcknowledgeThirdPartyJobInputRequestTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import AcknowledgeThirdPartyJobInputRequestTypeDef
def get_value() -> AcknowledgeThirdPartyJobInputRequestTypeDef:
return {
"jobId": ...,
"nonce": ...,
"clientToken": ...,
}
Definition
class AcknowledgeThirdPartyJobInputRequestTypeDef(TypedDict):
jobId: str,
nonce: str,
clientToken: str,
ActionConfigurationPropertyTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ActionConfigurationPropertyTypeDef
def get_value() -> ActionConfigurationPropertyTypeDef:
return {
"name": ...,
"required": ...,
"key": ...,
"secret": ...,
}
Definition
class ActionConfigurationPropertyTypeDef(TypedDict):
name: str,
required: bool,
key: bool,
secret: bool,
queryable: NotRequired[bool],
description: NotRequired[str],
type: NotRequired[ActionConfigurationPropertyTypeType], # (1)
ActionConfigurationTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ActionConfigurationTypeDef
def get_value() -> ActionConfigurationTypeDef:
return {
"configuration": ...,
}
ActionContextTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ActionContextTypeDef
def get_value() -> ActionContextTypeDef:
return {
"name": ...,
}
Definition
class ActionContextTypeDef(TypedDict):
name: NotRequired[str],
actionExecutionId: NotRequired[str],
ActionTypeIdTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ActionTypeIdTypeDef
def get_value() -> ActionTypeIdTypeDef:
return {
"category": ...,
"owner": ...,
"provider": ...,
"version": ...,
}
Definition
class ActionTypeIdTypeDef(TypedDict):
category: ActionCategoryType, # (1)
owner: ActionOwnerType, # (2)
provider: str,
version: str,
- See ActionCategoryType
- See ActionOwnerType
InputArtifactTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import InputArtifactTypeDef
def get_value() -> InputArtifactTypeDef:
return {
"name": ...,
}
OutputArtifactTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import OutputArtifactTypeDef
def get_value() -> OutputArtifactTypeDef:
return {
"name": ...,
}
ActionExecutionFilterTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ActionExecutionFilterTypeDef
def get_value() -> ActionExecutionFilterTypeDef:
return {
"pipelineExecutionId": ...,
}
ActionExecutionResultTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ActionExecutionResultTypeDef
def get_value() -> ActionExecutionResultTypeDef:
return {
"externalExecutionId": ...,
}
Definition
class ActionExecutionResultTypeDef(TypedDict):
externalExecutionId: NotRequired[str],
externalExecutionSummary: NotRequired[str],
externalExecutionUrl: NotRequired[str],
ErrorDetailsTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ErrorDetailsTypeDef
def get_value() -> ErrorDetailsTypeDef:
return {
"code": ...,
}
ActionRevisionTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ActionRevisionTypeDef
def get_value() -> ActionRevisionTypeDef:
return {
"revisionId": ...,
"revisionChangeId": ...,
"created": ...,
}
Definition
class ActionRevisionTypeDef(TypedDict):
revisionId: str,
revisionChangeId: str,
created: datetime,
ActionTypeArtifactDetailsTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ActionTypeArtifactDetailsTypeDef
def get_value() -> ActionTypeArtifactDetailsTypeDef:
return {
"minimumCount": ...,
"maximumCount": ...,
}
ActionTypeIdentifierTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ActionTypeIdentifierTypeDef
def get_value() -> ActionTypeIdentifierTypeDef:
return {
"category": ...,
"owner": ...,
"provider": ...,
"version": ...,
}
Definition
class ActionTypeIdentifierTypeDef(TypedDict):
category: ActionCategoryType, # (1)
owner: str,
provider: str,
version: str,
ActionTypePermissionsTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ActionTypePermissionsTypeDef
def get_value() -> ActionTypePermissionsTypeDef:
return {
"allowedAccounts": ...,
}
ActionTypePropertyTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ActionTypePropertyTypeDef
def get_value() -> ActionTypePropertyTypeDef:
return {
"name": ...,
"optional": ...,
"key": ...,
"noEcho": ...,
}
Definition
class ActionTypePropertyTypeDef(TypedDict):
name: str,
optional: bool,
key: bool,
noEcho: bool,
queryable: NotRequired[bool],
description: NotRequired[str],
ActionTypeUrlsTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ActionTypeUrlsTypeDef
def get_value() -> ActionTypeUrlsTypeDef:
return {
"configurationUrl": ...,
}
Definition
class ActionTypeUrlsTypeDef(TypedDict):
configurationUrl: NotRequired[str],
entityUrlTemplate: NotRequired[str],
executionUrlTemplate: NotRequired[str],
revisionUrlTemplate: NotRequired[str],
ActionTypeSettingsTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ActionTypeSettingsTypeDef
def get_value() -> ActionTypeSettingsTypeDef:
return {
"thirdPartyConfigurationUrl": ...,
}
Definition
class ActionTypeSettingsTypeDef(TypedDict):
thirdPartyConfigurationUrl: NotRequired[str],
entityUrlTemplate: NotRequired[str],
executionUrlTemplate: NotRequired[str],
revisionUrlTemplate: NotRequired[str],
ArtifactDetailsTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ArtifactDetailsTypeDef
def get_value() -> ArtifactDetailsTypeDef:
return {
"minimumCount": ...,
"maximumCount": ...,
}
ApprovalResultTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ApprovalResultTypeDef
def get_value() -> ApprovalResultTypeDef:
return {
"summary": ...,
"status": ...,
}
S3LocationTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import S3LocationTypeDef
def get_value() -> S3LocationTypeDef:
return {
"bucket": ...,
}
S3ArtifactLocationTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import S3ArtifactLocationTypeDef
def get_value() -> S3ArtifactLocationTypeDef:
return {
"bucketName": ...,
"objectKey": ...,
}
ArtifactRevisionTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ArtifactRevisionTypeDef
def get_value() -> ArtifactRevisionTypeDef:
return {
"name": ...,
}
Definition
class ArtifactRevisionTypeDef(TypedDict):
name: NotRequired[str],
revisionId: NotRequired[str],
revisionChangeIdentifier: NotRequired[str],
revisionSummary: NotRequired[str],
created: NotRequired[datetime],
revisionUrl: NotRequired[str],
EncryptionKeyTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import EncryptionKeyTypeDef
def get_value() -> EncryptionKeyTypeDef:
return {
"id": ...,
"type": ...,
}
BlockerDeclarationTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import BlockerDeclarationTypeDef
def get_value() -> BlockerDeclarationTypeDef:
return {
"name": ...,
"type": ...,
}
- See BlockerTypeType
TagTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"key": ...,
"value": ...,
}
CurrentRevisionTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import CurrentRevisionTypeDef
def get_value() -> CurrentRevisionTypeDef:
return {
"revision": ...,
"changeIdentifier": ...,
}
Definition
class CurrentRevisionTypeDef(TypedDict):
revision: str,
changeIdentifier: str,
created: NotRequired[Union[datetime, str]],
revisionSummary: NotRequired[str],
DeleteCustomActionTypeInputRequestTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import DeleteCustomActionTypeInputRequestTypeDef
def get_value() -> DeleteCustomActionTypeInputRequestTypeDef:
return {
"category": ...,
"provider": ...,
"version": ...,
}
Definition
class DeleteCustomActionTypeInputRequestTypeDef(TypedDict):
category: ActionCategoryType, # (1)
provider: str,
version: str,
DeletePipelineInputRequestTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import DeletePipelineInputRequestTypeDef
def get_value() -> DeletePipelineInputRequestTypeDef:
return {
"name": ...,
}
DeleteWebhookInputRequestTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import DeleteWebhookInputRequestTypeDef
def get_value() -> DeleteWebhookInputRequestTypeDef:
return {
"name": ...,
}
DeregisterWebhookWithThirdPartyInputRequestTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import DeregisterWebhookWithThirdPartyInputRequestTypeDef
def get_value() -> DeregisterWebhookWithThirdPartyInputRequestTypeDef:
return {
"webhookName": ...,
}
Definition
class DeregisterWebhookWithThirdPartyInputRequestTypeDef(TypedDict):
webhookName: NotRequired[str],
DisableStageTransitionInputRequestTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import DisableStageTransitionInputRequestTypeDef
def get_value() -> DisableStageTransitionInputRequestTypeDef:
return {
"pipelineName": ...,
"stageName": ...,
"transitionType": ...,
"reason": ...,
}
Definition
class DisableStageTransitionInputRequestTypeDef(TypedDict):
pipelineName: str,
stageName: str,
transitionType: StageTransitionTypeType, # (1)
reason: str,
EnableStageTransitionInputRequestTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import EnableStageTransitionInputRequestTypeDef
def get_value() -> EnableStageTransitionInputRequestTypeDef:
return {
"pipelineName": ...,
"stageName": ...,
"transitionType": ...,
}
Definition
class EnableStageTransitionInputRequestTypeDef(TypedDict):
pipelineName: str,
stageName: str,
transitionType: StageTransitionTypeType, # (1)
ExecutionDetailsTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ExecutionDetailsTypeDef
def get_value() -> ExecutionDetailsTypeDef:
return {
"summary": ...,
}
Definition
class ExecutionDetailsTypeDef(TypedDict):
summary: NotRequired[str],
externalExecutionId: NotRequired[str],
percentComplete: NotRequired[int],
ExecutionTriggerTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ExecutionTriggerTypeDef
def get_value() -> ExecutionTriggerTypeDef:
return {
"triggerType": ...,
}
Definition
class ExecutionTriggerTypeDef(TypedDict):
triggerType: NotRequired[TriggerTypeType], # (1)
triggerDetail: NotRequired[str],
- See TriggerTypeType
JobWorkerExecutorConfigurationTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import JobWorkerExecutorConfigurationTypeDef
def get_value() -> JobWorkerExecutorConfigurationTypeDef:
return {
"pollingAccounts": ...,
}
Definition
class JobWorkerExecutorConfigurationTypeDef(TypedDict):
pollingAccounts: NotRequired[List[str]],
pollingServicePrincipals: NotRequired[List[str]],
LambdaExecutorConfigurationTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import LambdaExecutorConfigurationTypeDef
def get_value() -> LambdaExecutorConfigurationTypeDef:
return {
"lambdaFunctionArn": ...,
}
FailureDetailsTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import FailureDetailsTypeDef
def get_value() -> FailureDetailsTypeDef:
return {
"type": ...,
"message": ...,
}
Definition
class FailureDetailsTypeDef(TypedDict):
type: FailureTypeType, # (1)
message: str,
externalExecutionId: NotRequired[str],
- See FailureTypeType
GetActionTypeInputRequestTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import GetActionTypeInputRequestTypeDef
def get_value() -> GetActionTypeInputRequestTypeDef:
return {
"category": ...,
"owner": ...,
"provider": ...,
"version": ...,
}
Definition
class GetActionTypeInputRequestTypeDef(TypedDict):
category: ActionCategoryType, # (1)
owner: str,
provider: str,
version: str,
GetJobDetailsInputRequestTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import GetJobDetailsInputRequestTypeDef
def get_value() -> GetJobDetailsInputRequestTypeDef:
return {
"jobId": ...,
}
GetPipelineExecutionInputRequestTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import GetPipelineExecutionInputRequestTypeDef
def get_value() -> GetPipelineExecutionInputRequestTypeDef:
return {
"pipelineName": ...,
"pipelineExecutionId": ...,
}
Definition
class GetPipelineExecutionInputRequestTypeDef(TypedDict):
pipelineName: str,
pipelineExecutionId: str,
GetPipelineInputRequestTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import GetPipelineInputRequestTypeDef
def get_value() -> GetPipelineInputRequestTypeDef:
return {
"name": ...,
}
PipelineMetadataTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import PipelineMetadataTypeDef
def get_value() -> PipelineMetadataTypeDef:
return {
"pipelineArn": ...,
}
Definition
class PipelineMetadataTypeDef(TypedDict):
pipelineArn: NotRequired[str],
created: NotRequired[datetime],
updated: NotRequired[datetime],
GetPipelineStateInputRequestTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import GetPipelineStateInputRequestTypeDef
def get_value() -> GetPipelineStateInputRequestTypeDef:
return {
"name": ...,
}
GetThirdPartyJobDetailsInputRequestTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import GetThirdPartyJobDetailsInputRequestTypeDef
def get_value() -> GetThirdPartyJobDetailsInputRequestTypeDef:
return {
"jobId": ...,
"clientToken": ...,
}
Definition
class GetThirdPartyJobDetailsInputRequestTypeDef(TypedDict):
jobId: str,
clientToken: str,
PaginatorConfigTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
Definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListActionTypesInputRequestTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ListActionTypesInputRequestTypeDef
def get_value() -> ListActionTypesInputRequestTypeDef:
return {
"actionOwnerFilter": ...,
}
Definition
class ListActionTypesInputRequestTypeDef(TypedDict):
actionOwnerFilter: NotRequired[ActionOwnerType], # (1)
nextToken: NotRequired[str],
regionFilter: NotRequired[str],
- See ActionOwnerType
ListPipelineExecutionsInputRequestTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ListPipelineExecutionsInputRequestTypeDef
def get_value() -> ListPipelineExecutionsInputRequestTypeDef:
return {
"pipelineName": ...,
}
Definition
class ListPipelineExecutionsInputRequestTypeDef(TypedDict):
pipelineName: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListPipelinesInputRequestTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ListPipelinesInputRequestTypeDef
def get_value() -> ListPipelinesInputRequestTypeDef:
return {
"nextToken": ...,
}
Definition
class ListPipelinesInputRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
PipelineSummaryTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import PipelineSummaryTypeDef
def get_value() -> PipelineSummaryTypeDef:
return {
"name": ...,
}
Definition
class PipelineSummaryTypeDef(TypedDict):
name: NotRequired[str],
version: NotRequired[int],
created: NotRequired[datetime],
updated: NotRequired[datetime],
ListTagsForResourceInputRequestTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ListTagsForResourceInputRequestTypeDef
def get_value() -> ListTagsForResourceInputRequestTypeDef:
return {
"resourceArn": ...,
}
Definition
class ListTagsForResourceInputRequestTypeDef(TypedDict):
resourceArn: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListWebhooksInputRequestTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ListWebhooksInputRequestTypeDef
def get_value() -> ListWebhooksInputRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListWebhooksInputRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
StageContextTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import StageContextTypeDef
def get_value() -> StageContextTypeDef:
return {
"name": ...,
}
SourceRevisionTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import SourceRevisionTypeDef
def get_value() -> SourceRevisionTypeDef:
return {
"actionName": ...,
}
Definition
class SourceRevisionTypeDef(TypedDict):
actionName: str,
revisionId: NotRequired[str],
revisionSummary: NotRequired[str],
revisionUrl: NotRequired[str],
StopExecutionTriggerTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import StopExecutionTriggerTypeDef
def get_value() -> StopExecutionTriggerTypeDef:
return {
"reason": ...,
}
ThirdPartyJobTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ThirdPartyJobTypeDef
def get_value() -> ThirdPartyJobTypeDef:
return {
"clientId": ...,
}
Definition
class ThirdPartyJobTypeDef(TypedDict):
clientId: NotRequired[str],
jobId: NotRequired[str],
RegisterWebhookWithThirdPartyInputRequestTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import RegisterWebhookWithThirdPartyInputRequestTypeDef
def get_value() -> RegisterWebhookWithThirdPartyInputRequestTypeDef:
return {
"webhookName": ...,
}
Definition
class RegisterWebhookWithThirdPartyInputRequestTypeDef(TypedDict):
webhookName: NotRequired[str],
RetryStageExecutionInputRequestTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import RetryStageExecutionInputRequestTypeDef
def get_value() -> RetryStageExecutionInputRequestTypeDef:
return {
"pipelineName": ...,
"stageName": ...,
"pipelineExecutionId": ...,
"retryMode": ...,
}
Definition
class RetryStageExecutionInputRequestTypeDef(TypedDict):
pipelineName: str,
stageName: str,
pipelineExecutionId: str,
retryMode: StageRetryModeType, # (1)
StageExecutionTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import StageExecutionTypeDef
def get_value() -> StageExecutionTypeDef:
return {
"pipelineExecutionId": ...,
"status": ...,
}
Definition
class StageExecutionTypeDef(TypedDict):
pipelineExecutionId: str,
status: StageExecutionStatusType, # (1)
TransitionStateTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import TransitionStateTypeDef
def get_value() -> TransitionStateTypeDef:
return {
"enabled": ...,
}
Definition
class TransitionStateTypeDef(TypedDict):
enabled: NotRequired[bool],
lastChangedBy: NotRequired[str],
lastChangedAt: NotRequired[datetime],
disabledReason: NotRequired[str],
StartPipelineExecutionInputRequestTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import StartPipelineExecutionInputRequestTypeDef
def get_value() -> StartPipelineExecutionInputRequestTypeDef:
return {
"name": ...,
}
Definition
class StartPipelineExecutionInputRequestTypeDef(TypedDict):
name: str,
clientRequestToken: NotRequired[str],
StopPipelineExecutionInputRequestTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import StopPipelineExecutionInputRequestTypeDef
def get_value() -> StopPipelineExecutionInputRequestTypeDef:
return {
"pipelineName": ...,
"pipelineExecutionId": ...,
}
Definition
class StopPipelineExecutionInputRequestTypeDef(TypedDict):
pipelineName: str,
pipelineExecutionId: str,
abandon: NotRequired[bool],
reason: NotRequired[str],
UntagResourceInputRequestTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import UntagResourceInputRequestTypeDef
def get_value() -> UntagResourceInputRequestTypeDef:
return {
"resourceArn": ...,
"tagKeys": ...,
}
Definition
class UntagResourceInputRequestTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],
WebhookAuthConfigurationTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import WebhookAuthConfigurationTypeDef
def get_value() -> WebhookAuthConfigurationTypeDef:
return {
"AllowedIPRange": ...,
}
Definition
class WebhookAuthConfigurationTypeDef(TypedDict):
AllowedIPRange: NotRequired[str],
SecretToken: NotRequired[str],
WebhookFilterRuleTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import WebhookFilterRuleTypeDef
def get_value() -> WebhookFilterRuleTypeDef:
return {
"jsonPath": ...,
}
AcknowledgeJobOutputTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import AcknowledgeJobOutputTypeDef
def get_value() -> AcknowledgeJobOutputTypeDef:
return {
"status": ...,
"ResponseMetadata": ...,
}
Definition
class AcknowledgeJobOutputTypeDef(TypedDict):
status: JobStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See JobStatusType
- See ResponseMetadataTypeDef
AcknowledgeThirdPartyJobOutputTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import AcknowledgeThirdPartyJobOutputTypeDef
def get_value() -> AcknowledgeThirdPartyJobOutputTypeDef:
return {
"status": ...,
"ResponseMetadata": ...,
}
Definition
class AcknowledgeThirdPartyJobOutputTypeDef(TypedDict):
status: JobStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See JobStatusType
- See ResponseMetadataTypeDef
EmptyResponseMetadataTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import EmptyResponseMetadataTypeDef
def get_value() -> EmptyResponseMetadataTypeDef:
return {
"ResponseMetadata": ...,
}
Definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
PutActionRevisionOutputTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import PutActionRevisionOutputTypeDef
def get_value() -> PutActionRevisionOutputTypeDef:
return {
"newRevision": ...,
"pipelineExecutionId": ...,
"ResponseMetadata": ...,
}
Definition
class PutActionRevisionOutputTypeDef(TypedDict):
newRevision: bool,
pipelineExecutionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
PutApprovalResultOutputTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import PutApprovalResultOutputTypeDef
def get_value() -> PutApprovalResultOutputTypeDef:
return {
"approvedAt": ...,
"ResponseMetadata": ...,
}
Definition
class PutApprovalResultOutputTypeDef(TypedDict):
approvedAt: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
RetryStageExecutionOutputTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import RetryStageExecutionOutputTypeDef
def get_value() -> RetryStageExecutionOutputTypeDef:
return {
"pipelineExecutionId": ...,
"ResponseMetadata": ...,
}
Definition
class RetryStageExecutionOutputTypeDef(TypedDict):
pipelineExecutionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartPipelineExecutionOutputTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import StartPipelineExecutionOutputTypeDef
def get_value() -> StartPipelineExecutionOutputTypeDef:
return {
"pipelineExecutionId": ...,
"ResponseMetadata": ...,
}
Definition
class StartPipelineExecutionOutputTypeDef(TypedDict):
pipelineExecutionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StopPipelineExecutionOutputTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import StopPipelineExecutionOutputTypeDef
def get_value() -> StopPipelineExecutionOutputTypeDef:
return {
"pipelineExecutionId": ...,
"ResponseMetadata": ...,
}
Definition
class StopPipelineExecutionOutputTypeDef(TypedDict):
pipelineExecutionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
PollForJobsInputRequestTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import PollForJobsInputRequestTypeDef
def get_value() -> PollForJobsInputRequestTypeDef:
return {
"actionTypeId": ...,
}
Definition
class PollForJobsInputRequestTypeDef(TypedDict):
actionTypeId: ActionTypeIdTypeDef, # (1)
maxBatchSize: NotRequired[int],
queryParam: NotRequired[Mapping[str, str]],
PollForThirdPartyJobsInputRequestTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import PollForThirdPartyJobsInputRequestTypeDef
def get_value() -> PollForThirdPartyJobsInputRequestTypeDef:
return {
"actionTypeId": ...,
}
Definition
class PollForThirdPartyJobsInputRequestTypeDef(TypedDict):
actionTypeId: ActionTypeIdTypeDef, # (1)
maxBatchSize: NotRequired[int],
ActionDeclarationTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ActionDeclarationTypeDef
def get_value() -> ActionDeclarationTypeDef:
return {
"name": ...,
"actionTypeId": ...,
}
Definition
class ActionDeclarationTypeDef(TypedDict):
name: str,
actionTypeId: ActionTypeIdTypeDef, # (1)
runOrder: NotRequired[int],
configuration: NotRequired[Mapping[str, str]],
outputArtifacts: NotRequired[Sequence[OutputArtifactTypeDef]], # (2)
inputArtifacts: NotRequired[Sequence[InputArtifactTypeDef]], # (3)
roleArn: NotRequired[str],
region: NotRequired[str],
namespace: NotRequired[str],
ListActionExecutionsInputRequestTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ListActionExecutionsInputRequestTypeDef
def get_value() -> ListActionExecutionsInputRequestTypeDef:
return {
"pipelineName": ...,
}
Definition
class ListActionExecutionsInputRequestTypeDef(TypedDict):
pipelineName: str,
filter: NotRequired[ActionExecutionFilterTypeDef], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ActionExecutionTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ActionExecutionTypeDef
def get_value() -> ActionExecutionTypeDef:
return {
"actionExecutionId": ...,
}
Definition
class ActionExecutionTypeDef(TypedDict):
actionExecutionId: NotRequired[str],
status: NotRequired[ActionExecutionStatusType], # (1)
summary: NotRequired[str],
lastStatusChange: NotRequired[datetime],
token: NotRequired[str],
lastUpdatedBy: NotRequired[str],
externalExecutionId: NotRequired[str],
externalExecutionUrl: NotRequired[str],
percentComplete: NotRequired[int],
errorDetails: NotRequired[ErrorDetailsTypeDef], # (2)
PutActionRevisionInputRequestTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import PutActionRevisionInputRequestTypeDef
def get_value() -> PutActionRevisionInputRequestTypeDef:
return {
"pipelineName": ...,
"stageName": ...,
"actionName": ...,
"actionRevision": ...,
}
Definition
class PutActionRevisionInputRequestTypeDef(TypedDict):
pipelineName: str,
stageName: str,
actionName: str,
actionRevision: ActionRevisionTypeDef, # (1)
ActionTypeTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ActionTypeTypeDef
def get_value() -> ActionTypeTypeDef:
return {
"id": ...,
"inputArtifactDetails": ...,
"outputArtifactDetails": ...,
}
Definition
class ActionTypeTypeDef(TypedDict):
id: ActionTypeIdTypeDef, # (1)
inputArtifactDetails: ArtifactDetailsTypeDef, # (4)
outputArtifactDetails: ArtifactDetailsTypeDef, # (4)
settings: NotRequired[ActionTypeSettingsTypeDef], # (2)
actionConfigurationProperties: NotRequired[List[ActionConfigurationPropertyTypeDef]], # (3)
- See ActionTypeIdTypeDef
- See ActionTypeSettingsTypeDef
- See ActionConfigurationPropertyTypeDef
- See ArtifactDetailsTypeDef
- See ArtifactDetailsTypeDef
PutApprovalResultInputRequestTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import PutApprovalResultInputRequestTypeDef
def get_value() -> PutApprovalResultInputRequestTypeDef:
return {
"pipelineName": ...,
"stageName": ...,
"actionName": ...,
"result": ...,
"token": ...,
}
Definition
class PutApprovalResultInputRequestTypeDef(TypedDict):
pipelineName: str,
stageName: str,
actionName: str,
result: ApprovalResultTypeDef, # (1)
token: str,
ArtifactDetailTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ArtifactDetailTypeDef
def get_value() -> ArtifactDetailTypeDef:
return {
"name": ...,
}
Definition
class ArtifactDetailTypeDef(TypedDict):
name: NotRequired[str],
s3location: NotRequired[S3LocationTypeDef], # (1)
ArtifactLocationTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ArtifactLocationTypeDef
def get_value() -> ArtifactLocationTypeDef:
return {
"type": ...,
}
Definition
class ArtifactLocationTypeDef(TypedDict):
type: NotRequired[ArtifactLocationTypeType], # (1)
s3Location: NotRequired[S3ArtifactLocationTypeDef], # (2)
PipelineExecutionTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import PipelineExecutionTypeDef
def get_value() -> PipelineExecutionTypeDef:
return {
"pipelineName": ...,
}
Definition
class PipelineExecutionTypeDef(TypedDict):
pipelineName: NotRequired[str],
pipelineVersion: NotRequired[int],
pipelineExecutionId: NotRequired[str],
status: NotRequired[PipelineExecutionStatusType], # (1)
statusSummary: NotRequired[str],
artifactRevisions: NotRequired[List[ArtifactRevisionTypeDef]], # (2)
ArtifactStoreTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ArtifactStoreTypeDef
def get_value() -> ArtifactStoreTypeDef:
return {
"type": ...,
"location": ...,
}
Definition
class ArtifactStoreTypeDef(TypedDict):
type: ArtifactStoreTypeType, # (1)
location: str,
encryptionKey: NotRequired[EncryptionKeyTypeDef], # (2)
CreateCustomActionTypeInputRequestTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import CreateCustomActionTypeInputRequestTypeDef
def get_value() -> CreateCustomActionTypeInputRequestTypeDef:
return {
"category": ...,
"provider": ...,
"version": ...,
"inputArtifactDetails": ...,
"outputArtifactDetails": ...,
}
Definition
class CreateCustomActionTypeInputRequestTypeDef(TypedDict):
category: ActionCategoryType, # (1)
provider: str,
version: str,
inputArtifactDetails: ArtifactDetailsTypeDef, # (2)
outputArtifactDetails: ArtifactDetailsTypeDef, # (2)
settings: NotRequired[ActionTypeSettingsTypeDef], # (4)
configurationProperties: NotRequired[Sequence[ActionConfigurationPropertyTypeDef]], # (5)
tags: NotRequired[Sequence[TagTypeDef]], # (6)
- See ActionCategoryType
- See ArtifactDetailsTypeDef
- See ArtifactDetailsTypeDef
- See ActionTypeSettingsTypeDef
- See ActionConfigurationPropertyTypeDef
- See TagTypeDef
ListTagsForResourceOutputTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ListTagsForResourceOutputTypeDef
def get_value() -> ListTagsForResourceOutputTypeDef:
return {
"tags": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListTagsForResourceOutputTypeDef(TypedDict):
tags: List[TagTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
TagResourceInputRequestTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import TagResourceInputRequestTypeDef
def get_value() -> TagResourceInputRequestTypeDef:
return {
"resourceArn": ...,
"tags": ...,
}
Definition
class TagResourceInputRequestTypeDef(TypedDict):
resourceArn: str,
tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
PutJobSuccessResultInputRequestTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import PutJobSuccessResultInputRequestTypeDef
def get_value() -> PutJobSuccessResultInputRequestTypeDef:
return {
"jobId": ...,
}
Definition
class PutJobSuccessResultInputRequestTypeDef(TypedDict):
jobId: str,
currentRevision: NotRequired[CurrentRevisionTypeDef], # (1)
continuationToken: NotRequired[str],
executionDetails: NotRequired[ExecutionDetailsTypeDef], # (2)
outputVariables: NotRequired[Mapping[str, str]],
PutThirdPartyJobSuccessResultInputRequestTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import PutThirdPartyJobSuccessResultInputRequestTypeDef
def get_value() -> PutThirdPartyJobSuccessResultInputRequestTypeDef:
return {
"jobId": ...,
"clientToken": ...,
}
Definition
class PutThirdPartyJobSuccessResultInputRequestTypeDef(TypedDict):
jobId: str,
clientToken: str,
currentRevision: NotRequired[CurrentRevisionTypeDef], # (1)
continuationToken: NotRequired[str],
executionDetails: NotRequired[ExecutionDetailsTypeDef], # (2)
ExecutorConfigurationTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ExecutorConfigurationTypeDef
def get_value() -> ExecutorConfigurationTypeDef:
return {
"lambdaExecutorConfiguration": ...,
}
Definition
class ExecutorConfigurationTypeDef(TypedDict):
lambdaExecutorConfiguration: NotRequired[LambdaExecutorConfigurationTypeDef], # (1)
jobWorkerExecutorConfiguration: NotRequired[JobWorkerExecutorConfigurationTypeDef], # (2)
PutJobFailureResultInputRequestTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import PutJobFailureResultInputRequestTypeDef
def get_value() -> PutJobFailureResultInputRequestTypeDef:
return {
"jobId": ...,
"failureDetails": ...,
}
Definition
class PutJobFailureResultInputRequestTypeDef(TypedDict):
jobId: str,
failureDetails: FailureDetailsTypeDef, # (1)
PutThirdPartyJobFailureResultInputRequestTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import PutThirdPartyJobFailureResultInputRequestTypeDef
def get_value() -> PutThirdPartyJobFailureResultInputRequestTypeDef:
return {
"jobId": ...,
"clientToken": ...,
"failureDetails": ...,
}
Definition
class PutThirdPartyJobFailureResultInputRequestTypeDef(TypedDict):
jobId: str,
clientToken: str,
failureDetails: FailureDetailsTypeDef, # (1)
ListActionExecutionsInputListActionExecutionsPaginateTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ListActionExecutionsInputListActionExecutionsPaginateTypeDef
def get_value() -> ListActionExecutionsInputListActionExecutionsPaginateTypeDef:
return {
"pipelineName": ...,
}
Definition
class ListActionExecutionsInputListActionExecutionsPaginateTypeDef(TypedDict):
pipelineName: str,
filter: NotRequired[ActionExecutionFilterTypeDef], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListActionTypesInputListActionTypesPaginateTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ListActionTypesInputListActionTypesPaginateTypeDef
def get_value() -> ListActionTypesInputListActionTypesPaginateTypeDef:
return {
"actionOwnerFilter": ...,
}
Definition
class ListActionTypesInputListActionTypesPaginateTypeDef(TypedDict):
actionOwnerFilter: NotRequired[ActionOwnerType], # (1)
regionFilter: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListPipelineExecutionsInputListPipelineExecutionsPaginateTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ListPipelineExecutionsInputListPipelineExecutionsPaginateTypeDef
def get_value() -> ListPipelineExecutionsInputListPipelineExecutionsPaginateTypeDef:
return {
"pipelineName": ...,
}
Definition
class ListPipelineExecutionsInputListPipelineExecutionsPaginateTypeDef(TypedDict):
pipelineName: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListPipelinesInputListPipelinesPaginateTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ListPipelinesInputListPipelinesPaginateTypeDef
def get_value() -> ListPipelinesInputListPipelinesPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class ListPipelinesInputListPipelinesPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListTagsForResourceInputListTagsForResourcePaginateTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ListTagsForResourceInputListTagsForResourcePaginateTypeDef
def get_value() -> ListTagsForResourceInputListTagsForResourcePaginateTypeDef:
return {
"resourceArn": ...,
}
Definition
class ListTagsForResourceInputListTagsForResourcePaginateTypeDef(TypedDict):
resourceArn: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListWebhooksInputListWebhooksPaginateTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ListWebhooksInputListWebhooksPaginateTypeDef
def get_value() -> ListWebhooksInputListWebhooksPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class ListWebhooksInputListWebhooksPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListPipelinesOutputTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import ListPipelinesOutputTypeDef
def get_value() -> ListPipelinesOutputTypeDef:
return {
"pipelines": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListPipelinesOutputTypeDef(TypedDict):
pipelines: List[PipelineSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PipelineContextTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import PipelineContextTypeDef
def get_value() -> PipelineContextTypeDef:
return {
"pipelineName": ...,
}
Definition
class PipelineContextTypeDef(TypedDict):
pipelineName: NotRequired[str],
stage: NotRequired[StageContextTypeDef], # (1)
action: NotRequired[ActionContextTypeDef], # (2)
pipelineArn: NotRequired[str],
pipelineExecutionId: NotRequired[str],
PipelineExecutionSummaryTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import PipelineExecutionSummaryTypeDef
def get_value() -> PipelineExecutionSummaryTypeDef:
return {
"pipelineExecutionId": ...,
}
Definition
class PipelineExecutionSummaryTypeDef(TypedDict):
pipelineExecutionId: NotRequired[str],
status: NotRequired[PipelineExecutionStatusType], # (1)
startTime: NotRequired[datetime],
lastUpdateTime: NotRequired[datetime],
sourceRevisions: NotRequired[List[SourceRevisionTypeDef]], # (2)
trigger: NotRequired[ExecutionTriggerTypeDef], # (3)
stopTrigger: NotRequired[StopExecutionTriggerTypeDef], # (4)
- See PipelineExecutionStatusType
- See SourceRevisionTypeDef
- See ExecutionTriggerTypeDef
- See StopExecutionTriggerTypeDef
PollForThirdPartyJobsOutputTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import PollForThirdPartyJobsOutputTypeDef
def get_value() -> PollForThirdPartyJobsOutputTypeDef:
return {
"jobs": ...,
"ResponseMetadata": ...,
}
Definition
class PollForThirdPartyJobsOutputTypeDef(TypedDict):
jobs: List[ThirdPartyJobTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
WebhookDefinitionTypeDef
Usage Example
from mypy_boto3_codepipeline.type_defs import WebhookDefinitionTypeDef
def get_value() -> WebhookDefinitionTypeDef:
return {
"name": ...,
"targetPipeline": ...,
"targetAction": ...,
"filters": ...,
"authentication": ...,
"authenticationConfiguration": ...,
}
Definition
class WebhookDefinitionTypeDef(TypedDict):
name: str,
targetPipeline: str,
targetAction: str,
filters: List[WebhookFilterRuleTypeDef], # (1)
authentication: WebhookAuthenticationTypeType, # (2)
authenticationConfiguration: WebhookAuthConfigurationTypeDef, # (3)