Skip to content

Type definitions#

Index > CodePipeline > Type definitions

Auto-generated documentation for CodePipeline type annotations stubs module mypy-boto3-codepipeline.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

AWSSessionCredentialsTypeDef#

# AWSSessionCredentialsTypeDef definition

class AWSSessionCredentialsTypeDef(TypedDict):
    accessKeyId: str,
    secretAccessKey: str,
    sessionToken: str,

AcknowledgeJobInputRequestTypeDef#

# AcknowledgeJobInputRequestTypeDef definition

class AcknowledgeJobInputRequestTypeDef(TypedDict):
    jobId: str,
    nonce: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

AcknowledgeThirdPartyJobInputRequestTypeDef#

# AcknowledgeThirdPartyJobInputRequestTypeDef definition

class AcknowledgeThirdPartyJobInputRequestTypeDef(TypedDict):
    jobId: str,
    nonce: str,
    clientToken: str,

ActionConfigurationPropertyTypeDef#

# ActionConfigurationPropertyTypeDef definition

class ActionConfigurationPropertyTypeDef(TypedDict):
    name: str,
    required: bool,
    key: bool,
    secret: bool,
    queryable: NotRequired[bool],
    description: NotRequired[str],
    type: NotRequired[ActionConfigurationPropertyTypeType],  # (1)
  1. See ActionConfigurationPropertyTypeType

ActionConfigurationTypeDef#

# ActionConfigurationTypeDef definition

class ActionConfigurationTypeDef(TypedDict):
    configuration: NotRequired[Dict[str, str]],

ActionContextTypeDef#

# ActionContextTypeDef definition

class ActionContextTypeDef(TypedDict):
    name: NotRequired[str],
    actionExecutionId: NotRequired[str],

ActionTypeIdTypeDef#

# ActionTypeIdTypeDef definition

class ActionTypeIdTypeDef(TypedDict):
    category: ActionCategoryType,  # (1)
    owner: ActionOwnerType,  # (2)
    provider: str,
    version: str,
  1. See ActionCategoryType
  2. See ActionOwnerType

InputArtifactTypeDef#

# InputArtifactTypeDef definition

class InputArtifactTypeDef(TypedDict):
    name: str,

OutputArtifactTypeDef#

# OutputArtifactTypeDef definition

class OutputArtifactTypeDef(TypedDict):
    name: str,

ActionExecutionFilterTypeDef#

# ActionExecutionFilterTypeDef definition

class ActionExecutionFilterTypeDef(TypedDict):
    pipelineExecutionId: NotRequired[str],

ActionExecutionResultTypeDef#

# ActionExecutionResultTypeDef definition

class ActionExecutionResultTypeDef(TypedDict):
    externalExecutionId: NotRequired[str],
    externalExecutionSummary: NotRequired[str],
    externalExecutionUrl: NotRequired[str],

ErrorDetailsTypeDef#

# ErrorDetailsTypeDef definition

class ErrorDetailsTypeDef(TypedDict):
    code: NotRequired[str],
    message: NotRequired[str],

ActionRevisionTypeDef#

# ActionRevisionTypeDef definition

class ActionRevisionTypeDef(TypedDict):
    revisionId: str,
    revisionChangeId: str,
    created: datetime,

ActionTypeArtifactDetailsTypeDef#

# ActionTypeArtifactDetailsTypeDef definition

class ActionTypeArtifactDetailsTypeDef(TypedDict):
    minimumCount: int,
    maximumCount: int,

ActionTypeIdentifierTypeDef#

# ActionTypeIdentifierTypeDef definition

class ActionTypeIdentifierTypeDef(TypedDict):
    category: ActionCategoryType,  # (1)
    owner: str,
    provider: str,
    version: str,
  1. See ActionCategoryType

ActionTypePermissionsTypeDef#

# ActionTypePermissionsTypeDef definition

class ActionTypePermissionsTypeDef(TypedDict):
    allowedAccounts: List[str],

ActionTypePropertyTypeDef#

# ActionTypePropertyTypeDef definition

class ActionTypePropertyTypeDef(TypedDict):
    name: str,
    optional: bool,
    key: bool,
    noEcho: bool,
    queryable: NotRequired[bool],
    description: NotRequired[str],

ActionTypeUrlsTypeDef#

# ActionTypeUrlsTypeDef definition

class ActionTypeUrlsTypeDef(TypedDict):
    configurationUrl: NotRequired[str],
    entityUrlTemplate: NotRequired[str],
    executionUrlTemplate: NotRequired[str],
    revisionUrlTemplate: NotRequired[str],

ActionTypeSettingsTypeDef#

# ActionTypeSettingsTypeDef definition

class ActionTypeSettingsTypeDef(TypedDict):
    thirdPartyConfigurationUrl: NotRequired[str],
    entityUrlTemplate: NotRequired[str],
    executionUrlTemplate: NotRequired[str],
    revisionUrlTemplate: NotRequired[str],

ArtifactDetailsTypeDef#

# ArtifactDetailsTypeDef definition

class ArtifactDetailsTypeDef(TypedDict):
    minimumCount: int,
    maximumCount: int,

ApprovalResultTypeDef#

# ApprovalResultTypeDef definition

class ApprovalResultTypeDef(TypedDict):
    summary: str,
    status: ApprovalStatusType,  # (1)
  1. See ApprovalStatusType

S3LocationTypeDef#

# S3LocationTypeDef definition

class S3LocationTypeDef(TypedDict):
    bucket: NotRequired[str],
    key: NotRequired[str],

S3ArtifactLocationTypeDef#

# S3ArtifactLocationTypeDef definition

class S3ArtifactLocationTypeDef(TypedDict):
    bucketName: str,
    objectKey: str,

ArtifactRevisionTypeDef#

# ArtifactRevisionTypeDef definition

class ArtifactRevisionTypeDef(TypedDict):
    name: NotRequired[str],
    revisionId: NotRequired[str],
    revisionChangeIdentifier: NotRequired[str],
    revisionSummary: NotRequired[str],
    created: NotRequired[datetime],
    revisionUrl: NotRequired[str],

EncryptionKeyTypeDef#

# EncryptionKeyTypeDef definition

class EncryptionKeyTypeDef(TypedDict):
    id: str,
    type: EncryptionKeyTypeType,  # (1)
  1. See EncryptionKeyTypeType

BlockerDeclarationTypeDef#

# BlockerDeclarationTypeDef definition

class BlockerDeclarationTypeDef(TypedDict):
    name: str,
    type: BlockerTypeType,  # (1)
  1. See BlockerTypeType

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    key: str,
    value: str,

DeleteCustomActionTypeInputRequestTypeDef#

# DeleteCustomActionTypeInputRequestTypeDef definition

class DeleteCustomActionTypeInputRequestTypeDef(TypedDict):
    category: ActionCategoryType,  # (1)
    provider: str,
    version: str,
  1. See ActionCategoryType

DeletePipelineInputRequestTypeDef#

# DeletePipelineInputRequestTypeDef definition

class DeletePipelineInputRequestTypeDef(TypedDict):
    name: str,

DeleteWebhookInputRequestTypeDef#

# DeleteWebhookInputRequestTypeDef definition

class DeleteWebhookInputRequestTypeDef(TypedDict):
    name: str,

DeregisterWebhookWithThirdPartyInputRequestTypeDef#

# DeregisterWebhookWithThirdPartyInputRequestTypeDef definition

class DeregisterWebhookWithThirdPartyInputRequestTypeDef(TypedDict):
    webhookName: NotRequired[str],

DisableStageTransitionInputRequestTypeDef#

# DisableStageTransitionInputRequestTypeDef definition

class DisableStageTransitionInputRequestTypeDef(TypedDict):
    pipelineName: str,
    stageName: str,
    transitionType: StageTransitionTypeType,  # (1)
    reason: str,
  1. See StageTransitionTypeType

EnableStageTransitionInputRequestTypeDef#

# EnableStageTransitionInputRequestTypeDef definition

class EnableStageTransitionInputRequestTypeDef(TypedDict):
    pipelineName: str,
    stageName: str,
    transitionType: StageTransitionTypeType,  # (1)
  1. See StageTransitionTypeType

ExecutionDetailsTypeDef#

# ExecutionDetailsTypeDef definition

class ExecutionDetailsTypeDef(TypedDict):
    summary: NotRequired[str],
    externalExecutionId: NotRequired[str],
    percentComplete: NotRequired[int],

ExecutionTriggerTypeDef#

# ExecutionTriggerTypeDef definition

class ExecutionTriggerTypeDef(TypedDict):
    triggerType: NotRequired[TriggerTypeType],  # (1)
    triggerDetail: NotRequired[str],
  1. See TriggerTypeType

JobWorkerExecutorConfigurationTypeDef#

# JobWorkerExecutorConfigurationTypeDef definition

class JobWorkerExecutorConfigurationTypeDef(TypedDict):
    pollingAccounts: NotRequired[List[str]],
    pollingServicePrincipals: NotRequired[List[str]],

LambdaExecutorConfigurationTypeDef#

# LambdaExecutorConfigurationTypeDef definition

class LambdaExecutorConfigurationTypeDef(TypedDict):
    lambdaFunctionArn: str,

FailureDetailsTypeDef#

# FailureDetailsTypeDef definition

class FailureDetailsTypeDef(TypedDict):
    type: FailureTypeType,  # (1)
    message: str,
    externalExecutionId: NotRequired[str],
  1. See FailureTypeType

GetActionTypeInputRequestTypeDef#

# GetActionTypeInputRequestTypeDef definition

class GetActionTypeInputRequestTypeDef(TypedDict):
    category: ActionCategoryType,  # (1)
    owner: str,
    provider: str,
    version: str,
  1. See ActionCategoryType

GetJobDetailsInputRequestTypeDef#

# GetJobDetailsInputRequestTypeDef definition

class GetJobDetailsInputRequestTypeDef(TypedDict):
    jobId: str,

GetPipelineExecutionInputRequestTypeDef#

# GetPipelineExecutionInputRequestTypeDef definition

class GetPipelineExecutionInputRequestTypeDef(TypedDict):
    pipelineName: str,
    pipelineExecutionId: str,

GetPipelineInputRequestTypeDef#

# GetPipelineInputRequestTypeDef definition

class GetPipelineInputRequestTypeDef(TypedDict):
    name: str,
    version: NotRequired[int],

PipelineMetadataTypeDef#

# PipelineMetadataTypeDef definition

class PipelineMetadataTypeDef(TypedDict):
    pipelineArn: NotRequired[str],
    created: NotRequired[datetime],
    updated: NotRequired[datetime],
    pollingDisabledAt: NotRequired[datetime],

GetPipelineStateInputRequestTypeDef#

# GetPipelineStateInputRequestTypeDef definition

class GetPipelineStateInputRequestTypeDef(TypedDict):
    name: str,

GetThirdPartyJobDetailsInputRequestTypeDef#

# GetThirdPartyJobDetailsInputRequestTypeDef definition

class GetThirdPartyJobDetailsInputRequestTypeDef(TypedDict):
    jobId: str,
    clientToken: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListActionTypesInputRequestTypeDef#

# ListActionTypesInputRequestTypeDef definition

class ListActionTypesInputRequestTypeDef(TypedDict):
    actionOwnerFilter: NotRequired[ActionOwnerType],  # (1)
    nextToken: NotRequired[str],
    regionFilter: NotRequired[str],
  1. See ActionOwnerType

ListPipelineExecutionsInputRequestTypeDef#

# ListPipelineExecutionsInputRequestTypeDef definition

class ListPipelineExecutionsInputRequestTypeDef(TypedDict):
    pipelineName: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListPipelinesInputRequestTypeDef#

# ListPipelinesInputRequestTypeDef definition

class ListPipelinesInputRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

PipelineSummaryTypeDef#

# PipelineSummaryTypeDef definition

class PipelineSummaryTypeDef(TypedDict):
    name: NotRequired[str],
    version: NotRequired[int],
    created: NotRequired[datetime],
    updated: NotRequired[datetime],

ListTagsForResourceInputRequestTypeDef#

# ListTagsForResourceInputRequestTypeDef definition

class ListTagsForResourceInputRequestTypeDef(TypedDict):
    resourceArn: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListWebhooksInputRequestTypeDef#

# ListWebhooksInputRequestTypeDef definition

class ListWebhooksInputRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

StageContextTypeDef#

# StageContextTypeDef definition

class StageContextTypeDef(TypedDict):
    name: NotRequired[str],

SourceRevisionTypeDef#

# SourceRevisionTypeDef definition

class SourceRevisionTypeDef(TypedDict):
    actionName: str,
    revisionId: NotRequired[str],
    revisionSummary: NotRequired[str],
    revisionUrl: NotRequired[str],

StopExecutionTriggerTypeDef#

# StopExecutionTriggerTypeDef definition

class StopExecutionTriggerTypeDef(TypedDict):
    reason: NotRequired[str],

ThirdPartyJobTypeDef#

# ThirdPartyJobTypeDef definition

class ThirdPartyJobTypeDef(TypedDict):
    clientId: NotRequired[str],
    jobId: NotRequired[str],

RegisterWebhookWithThirdPartyInputRequestTypeDef#

# RegisterWebhookWithThirdPartyInputRequestTypeDef definition

class RegisterWebhookWithThirdPartyInputRequestTypeDef(TypedDict):
    webhookName: NotRequired[str],

RetryStageExecutionInputRequestTypeDef#

# RetryStageExecutionInputRequestTypeDef definition

class RetryStageExecutionInputRequestTypeDef(TypedDict):
    pipelineName: str,
    stageName: str,
    pipelineExecutionId: str,
    retryMode: StageRetryModeType,  # (1)
  1. See StageRetryModeType

StageExecutionTypeDef#

# StageExecutionTypeDef definition

class StageExecutionTypeDef(TypedDict):
    pipelineExecutionId: str,
    status: StageExecutionStatusType,  # (1)
  1. See StageExecutionStatusType

TransitionStateTypeDef#

# TransitionStateTypeDef definition

class TransitionStateTypeDef(TypedDict):
    enabled: NotRequired[bool],
    lastChangedBy: NotRequired[str],
    lastChangedAt: NotRequired[datetime],
    disabledReason: NotRequired[str],

StartPipelineExecutionInputRequestTypeDef#

# StartPipelineExecutionInputRequestTypeDef definition

class StartPipelineExecutionInputRequestTypeDef(TypedDict):
    name: str,
    clientRequestToken: NotRequired[str],

StopPipelineExecutionInputRequestTypeDef#

# StopPipelineExecutionInputRequestTypeDef definition

class StopPipelineExecutionInputRequestTypeDef(TypedDict):
    pipelineName: str,
    pipelineExecutionId: str,
    abandon: NotRequired[bool],
    reason: NotRequired[str],

UntagResourceInputRequestTypeDef#

# UntagResourceInputRequestTypeDef definition

class UntagResourceInputRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

WebhookAuthConfigurationTypeDef#

# WebhookAuthConfigurationTypeDef definition

class WebhookAuthConfigurationTypeDef(TypedDict):
    AllowedIPRange: NotRequired[str],
    SecretToken: NotRequired[str],

WebhookFilterRuleTypeDef#

# WebhookFilterRuleTypeDef definition

class WebhookFilterRuleTypeDef(TypedDict):
    jsonPath: str,
    matchEquals: NotRequired[str],

AcknowledgeJobOutputTypeDef#

# AcknowledgeJobOutputTypeDef definition

class AcknowledgeJobOutputTypeDef(TypedDict):
    status: JobStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobStatusType
  2. See ResponseMetadataTypeDef

AcknowledgeThirdPartyJobOutputTypeDef#

# AcknowledgeThirdPartyJobOutputTypeDef definition

class AcknowledgeThirdPartyJobOutputTypeDef(TypedDict):
    status: JobStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobStatusType
  2. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PutActionRevisionOutputTypeDef#

# PutActionRevisionOutputTypeDef definition

class PutActionRevisionOutputTypeDef(TypedDict):
    newRevision: bool,
    pipelineExecutionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PutApprovalResultOutputTypeDef#

# PutApprovalResultOutputTypeDef definition

class PutApprovalResultOutputTypeDef(TypedDict):
    approvedAt: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RetryStageExecutionOutputTypeDef#

# RetryStageExecutionOutputTypeDef definition

class RetryStageExecutionOutputTypeDef(TypedDict):
    pipelineExecutionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartPipelineExecutionOutputTypeDef#

# StartPipelineExecutionOutputTypeDef definition

class StartPipelineExecutionOutputTypeDef(TypedDict):
    pipelineExecutionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StopPipelineExecutionOutputTypeDef#

# StopPipelineExecutionOutputTypeDef definition

class StopPipelineExecutionOutputTypeDef(TypedDict):
    pipelineExecutionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PollForJobsInputRequestTypeDef#

# PollForJobsInputRequestTypeDef definition

class PollForJobsInputRequestTypeDef(TypedDict):
    actionTypeId: ActionTypeIdTypeDef,  # (1)
    maxBatchSize: NotRequired[int],
    queryParam: NotRequired[Mapping[str, str]],
  1. See ActionTypeIdTypeDef

PollForThirdPartyJobsInputRequestTypeDef#

# PollForThirdPartyJobsInputRequestTypeDef definition

class PollForThirdPartyJobsInputRequestTypeDef(TypedDict):
    actionTypeId: ActionTypeIdTypeDef,  # (1)
    maxBatchSize: NotRequired[int],
  1. See ActionTypeIdTypeDef

ActionDeclarationTypeDef#

# ActionDeclarationTypeDef 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],
  1. See ActionTypeIdTypeDef
  2. See OutputArtifactTypeDef
  3. See InputArtifactTypeDef

ListActionExecutionsInputRequestTypeDef#

# ListActionExecutionsInputRequestTypeDef definition

class ListActionExecutionsInputRequestTypeDef(TypedDict):
    pipelineName: str,
    filter: NotRequired[ActionExecutionFilterTypeDef],  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See ActionExecutionFilterTypeDef

ActionExecutionTypeDef#

# ActionExecutionTypeDef 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)
  1. See ActionExecutionStatusType
  2. See ErrorDetailsTypeDef

PutActionRevisionInputRequestTypeDef#

# PutActionRevisionInputRequestTypeDef definition

class PutActionRevisionInputRequestTypeDef(TypedDict):
    pipelineName: str,
    stageName: str,
    actionName: str,
    actionRevision: ActionRevisionTypeDef,  # (1)
  1. See ActionRevisionTypeDef

ActionTypeTypeDef#

# ActionTypeTypeDef definition

class ActionTypeTypeDef(TypedDict):
    id: ActionTypeIdTypeDef,  # (1)
    inputArtifactDetails: ArtifactDetailsTypeDef,  # (4)
    outputArtifactDetails: ArtifactDetailsTypeDef,  # (4)
    settings: NotRequired[ActionTypeSettingsTypeDef],  # (2)
    actionConfigurationProperties: NotRequired[List[ActionConfigurationPropertyTypeDef]],  # (3)
  1. See ActionTypeIdTypeDef
  2. See ActionTypeSettingsTypeDef
  3. See ActionConfigurationPropertyTypeDef
  4. See ArtifactDetailsTypeDef
  5. See ArtifactDetailsTypeDef

PutApprovalResultInputRequestTypeDef#

# PutApprovalResultInputRequestTypeDef definition

class PutApprovalResultInputRequestTypeDef(TypedDict):
    pipelineName: str,
    stageName: str,
    actionName: str,
    result: ApprovalResultTypeDef,  # (1)
    token: str,
  1. See ApprovalResultTypeDef

ArtifactDetailTypeDef#

# ArtifactDetailTypeDef definition

class ArtifactDetailTypeDef(TypedDict):
    name: NotRequired[str],
    s3location: NotRequired[S3LocationTypeDef],  # (1)
  1. See S3LocationTypeDef

ArtifactLocationTypeDef#

# ArtifactLocationTypeDef definition

class ArtifactLocationTypeDef(TypedDict):
    type: NotRequired[ArtifactLocationTypeType],  # (1)
    s3Location: NotRequired[S3ArtifactLocationTypeDef],  # (2)
  1. See ArtifactLocationTypeType
  2. See S3ArtifactLocationTypeDef

PipelineExecutionTypeDef#

# PipelineExecutionTypeDef 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)
  1. See PipelineExecutionStatusType
  2. See ArtifactRevisionTypeDef

ArtifactStoreTypeDef#

# ArtifactStoreTypeDef definition

class ArtifactStoreTypeDef(TypedDict):
    type: ArtifactStoreTypeType,  # (1)
    location: str,
    encryptionKey: NotRequired[EncryptionKeyTypeDef],  # (2)
  1. See ArtifactStoreTypeType
  2. See EncryptionKeyTypeDef

CreateCustomActionTypeInputRequestTypeDef#

# CreateCustomActionTypeInputRequestTypeDef 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)
  1. See ActionCategoryType
  2. See ArtifactDetailsTypeDef
  3. See ArtifactDetailsTypeDef
  4. See ActionTypeSettingsTypeDef
  5. See ActionConfigurationPropertyTypeDef
  6. See TagTypeDef

ListTagsForResourceOutputTypeDef#

# ListTagsForResourceOutputTypeDef definition

class ListTagsForResourceOutputTypeDef(TypedDict):
    tags: List[TagTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

TagResourceInputRequestTypeDef#

# TagResourceInputRequestTypeDef definition

class TagResourceInputRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CurrentRevisionTypeDef#

# CurrentRevisionTypeDef definition

class CurrentRevisionTypeDef(TypedDict):
    revision: str,
    changeIdentifier: str,
    created: NotRequired[Union[datetime, str]],
    revisionSummary: NotRequired[str],

ExecutorConfigurationTypeDef#

# ExecutorConfigurationTypeDef definition

class ExecutorConfigurationTypeDef(TypedDict):
    lambdaExecutorConfiguration: NotRequired[LambdaExecutorConfigurationTypeDef],  # (1)
    jobWorkerExecutorConfiguration: NotRequired[JobWorkerExecutorConfigurationTypeDef],  # (2)
  1. See LambdaExecutorConfigurationTypeDef
  2. See JobWorkerExecutorConfigurationTypeDef

PutJobFailureResultInputRequestTypeDef#

# PutJobFailureResultInputRequestTypeDef definition

class PutJobFailureResultInputRequestTypeDef(TypedDict):
    jobId: str,
    failureDetails: FailureDetailsTypeDef,  # (1)
  1. See FailureDetailsTypeDef

PutThirdPartyJobFailureResultInputRequestTypeDef#

# PutThirdPartyJobFailureResultInputRequestTypeDef definition

class PutThirdPartyJobFailureResultInputRequestTypeDef(TypedDict):
    jobId: str,
    clientToken: str,
    failureDetails: FailureDetailsTypeDef,  # (1)
  1. See FailureDetailsTypeDef

ListActionExecutionsInputListActionExecutionsPaginateTypeDef#

# ListActionExecutionsInputListActionExecutionsPaginateTypeDef definition

class ListActionExecutionsInputListActionExecutionsPaginateTypeDef(TypedDict):
    pipelineName: str,
    filter: NotRequired[ActionExecutionFilterTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ActionExecutionFilterTypeDef
  2. See PaginatorConfigTypeDef

ListActionTypesInputListActionTypesPaginateTypeDef#

# ListActionTypesInputListActionTypesPaginateTypeDef definition

class ListActionTypesInputListActionTypesPaginateTypeDef(TypedDict):
    actionOwnerFilter: NotRequired[ActionOwnerType],  # (1)
    regionFilter: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ActionOwnerType
  2. See PaginatorConfigTypeDef

ListPipelineExecutionsInputListPipelineExecutionsPaginateTypeDef#

# ListPipelineExecutionsInputListPipelineExecutionsPaginateTypeDef definition

class ListPipelineExecutionsInputListPipelineExecutionsPaginateTypeDef(TypedDict):
    pipelineName: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListPipelinesInputListPipelinesPaginateTypeDef#

# ListPipelinesInputListPipelinesPaginateTypeDef definition

class ListPipelinesInputListPipelinesPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTagsForResourceInputListTagsForResourcePaginateTypeDef#

# ListTagsForResourceInputListTagsForResourcePaginateTypeDef definition

class ListTagsForResourceInputListTagsForResourcePaginateTypeDef(TypedDict):
    resourceArn: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListWebhooksInputListWebhooksPaginateTypeDef#

# ListWebhooksInputListWebhooksPaginateTypeDef definition

class ListWebhooksInputListWebhooksPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListPipelinesOutputTypeDef#

# ListPipelinesOutputTypeDef definition

class ListPipelinesOutputTypeDef(TypedDict):
    pipelines: List[PipelineSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PipelineSummaryTypeDef
  2. See ResponseMetadataTypeDef

PipelineContextTypeDef#

# PipelineContextTypeDef definition

class PipelineContextTypeDef(TypedDict):
    pipelineName: NotRequired[str],
    stage: NotRequired[StageContextTypeDef],  # (1)
    action: NotRequired[ActionContextTypeDef],  # (2)
    pipelineArn: NotRequired[str],
    pipelineExecutionId: NotRequired[str],
  1. See StageContextTypeDef
  2. See ActionContextTypeDef

PipelineExecutionSummaryTypeDef#

# PipelineExecutionSummaryTypeDef 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)
  1. See PipelineExecutionStatusType
  2. See SourceRevisionTypeDef
  3. See ExecutionTriggerTypeDef
  4. See StopExecutionTriggerTypeDef

PollForThirdPartyJobsOutputTypeDef#

# PollForThirdPartyJobsOutputTypeDef definition

class PollForThirdPartyJobsOutputTypeDef(TypedDict):
    jobs: List[ThirdPartyJobTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ThirdPartyJobTypeDef
  2. See ResponseMetadataTypeDef

WebhookDefinitionTypeDef#

# WebhookDefinitionTypeDef definition

class WebhookDefinitionTypeDef(TypedDict):
    name: str,
    targetPipeline: str,
    targetAction: str,
    filters: List[WebhookFilterRuleTypeDef],  # (1)
    authentication: WebhookAuthenticationTypeType,  # (2)
    authenticationConfiguration: WebhookAuthConfigurationTypeDef,  # (3)
  1. See WebhookFilterRuleTypeDef
  2. See WebhookAuthenticationTypeType
  3. See WebhookAuthConfigurationTypeDef

StageDeclarationTypeDef#

# StageDeclarationTypeDef definition

class StageDeclarationTypeDef(TypedDict):
    name: str,
    actions: Sequence[ActionDeclarationTypeDef],  # (2)
    blockers: NotRequired[Sequence[BlockerDeclarationTypeDef]],  # (1)
  1. See BlockerDeclarationTypeDef
  2. See ActionDeclarationTypeDef

ActionStateTypeDef#

# ActionStateTypeDef definition

class ActionStateTypeDef(TypedDict):
    actionName: NotRequired[str],
    currentRevision: NotRequired[ActionRevisionTypeDef],  # (1)
    latestExecution: NotRequired[ActionExecutionTypeDef],  # (2)
    entityUrl: NotRequired[str],
    revisionUrl: NotRequired[str],
  1. See ActionRevisionTypeDef
  2. See ActionExecutionTypeDef

CreateCustomActionTypeOutputTypeDef#

# CreateCustomActionTypeOutputTypeDef definition

class CreateCustomActionTypeOutputTypeDef(TypedDict):
    actionType: ActionTypeTypeDef,  # (1)
    tags: List[TagTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ActionTypeTypeDef
  2. See TagTypeDef
  3. See ResponseMetadataTypeDef

ListActionTypesOutputTypeDef#

# ListActionTypesOutputTypeDef definition

class ListActionTypesOutputTypeDef(TypedDict):
    actionTypes: List[ActionTypeTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ActionTypeTypeDef
  2. See ResponseMetadataTypeDef

ActionExecutionInputTypeDef#

# ActionExecutionInputTypeDef definition

class ActionExecutionInputTypeDef(TypedDict):
    actionTypeId: NotRequired[ActionTypeIdTypeDef],  # (1)
    configuration: NotRequired[Dict[str, str]],
    resolvedConfiguration: NotRequired[Dict[str, str]],
    roleArn: NotRequired[str],
    region: NotRequired[str],
    inputArtifacts: NotRequired[List[ArtifactDetailTypeDef]],  # (2)
    namespace: NotRequired[str],
  1. See ActionTypeIdTypeDef
  2. See ArtifactDetailTypeDef

ActionExecutionOutputTypeDef#

# ActionExecutionOutputTypeDef definition

class ActionExecutionOutputTypeDef(TypedDict):
    outputArtifacts: NotRequired[List[ArtifactDetailTypeDef]],  # (1)
    executionResult: NotRequired[ActionExecutionResultTypeDef],  # (2)
    outputVariables: NotRequired[Dict[str, str]],
  1. See ArtifactDetailTypeDef
  2. See ActionExecutionResultTypeDef

ArtifactTypeDef#

# ArtifactTypeDef definition

class ArtifactTypeDef(TypedDict):
    name: NotRequired[str],
    revision: NotRequired[str],
    location: NotRequired[ArtifactLocationTypeDef],  # (1)
  1. See ArtifactLocationTypeDef

GetPipelineExecutionOutputTypeDef#

# GetPipelineExecutionOutputTypeDef definition

class GetPipelineExecutionOutputTypeDef(TypedDict):
    pipelineExecution: PipelineExecutionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PipelineExecutionTypeDef
  2. See ResponseMetadataTypeDef

PutJobSuccessResultInputRequestTypeDef#

# PutJobSuccessResultInputRequestTypeDef definition

class PutJobSuccessResultInputRequestTypeDef(TypedDict):
    jobId: str,
    currentRevision: NotRequired[CurrentRevisionTypeDef],  # (1)
    continuationToken: NotRequired[str],
    executionDetails: NotRequired[ExecutionDetailsTypeDef],  # (2)
    outputVariables: NotRequired[Mapping[str, str]],
  1. See CurrentRevisionTypeDef
  2. See ExecutionDetailsTypeDef

PutThirdPartyJobSuccessResultInputRequestTypeDef#

# PutThirdPartyJobSuccessResultInputRequestTypeDef definition

class PutThirdPartyJobSuccessResultInputRequestTypeDef(TypedDict):
    jobId: str,
    clientToken: str,
    currentRevision: NotRequired[CurrentRevisionTypeDef],  # (1)
    continuationToken: NotRequired[str],
    executionDetails: NotRequired[ExecutionDetailsTypeDef],  # (2)
  1. See CurrentRevisionTypeDef
  2. See ExecutionDetailsTypeDef

ActionTypeExecutorTypeDef#

# ActionTypeExecutorTypeDef definition

class ActionTypeExecutorTypeDef(TypedDict):
    configuration: ExecutorConfigurationTypeDef,  # (1)
    type: ExecutorTypeType,  # (2)
    policyStatementsTemplate: NotRequired[str],
    jobTimeout: NotRequired[int],
  1. See ExecutorConfigurationTypeDef
  2. See ExecutorTypeType

ListPipelineExecutionsOutputTypeDef#

# ListPipelineExecutionsOutputTypeDef definition

class ListPipelineExecutionsOutputTypeDef(TypedDict):
    pipelineExecutionSummaries: List[PipelineExecutionSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PipelineExecutionSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListWebhookItemTypeDef#

# ListWebhookItemTypeDef definition

class ListWebhookItemTypeDef(TypedDict):
    definition: WebhookDefinitionTypeDef,  # (1)
    url: str,
    errorMessage: NotRequired[str],
    errorCode: NotRequired[str],
    lastTriggered: NotRequired[datetime],
    arn: NotRequired[str],
    tags: NotRequired[List[TagTypeDef]],  # (2)
  1. See WebhookDefinitionTypeDef
  2. See TagTypeDef

PutWebhookInputRequestTypeDef#

# PutWebhookInputRequestTypeDef definition

class PutWebhookInputRequestTypeDef(TypedDict):
    webhook: WebhookDefinitionTypeDef,  # (1)
    tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See WebhookDefinitionTypeDef
  2. See TagTypeDef

PipelineDeclarationTypeDef#

# PipelineDeclarationTypeDef definition

class PipelineDeclarationTypeDef(TypedDict):
    name: str,
    roleArn: str,
    stages: Sequence[StageDeclarationTypeDef],  # (3)
    artifactStore: NotRequired[ArtifactStoreTypeDef],  # (1)
    artifactStores: NotRequired[Mapping[str, ArtifactStoreTypeDef]],  # (2)
    version: NotRequired[int],
  1. See ArtifactStoreTypeDef
  2. See ArtifactStoreTypeDef
  3. See StageDeclarationTypeDef

StageStateTypeDef#

# StageStateTypeDef definition

class StageStateTypeDef(TypedDict):
    stageName: NotRequired[str],
    inboundExecution: NotRequired[StageExecutionTypeDef],  # (1)
    inboundTransitionState: NotRequired[TransitionStateTypeDef],  # (2)
    actionStates: NotRequired[List[ActionStateTypeDef]],  # (3)
    latestExecution: NotRequired[StageExecutionTypeDef],  # (1)
  1. See StageExecutionTypeDef
  2. See TransitionStateTypeDef
  3. See ActionStateTypeDef
  4. See StageExecutionTypeDef

ActionExecutionDetailTypeDef#

# ActionExecutionDetailTypeDef definition

class ActionExecutionDetailTypeDef(TypedDict):
    pipelineExecutionId: NotRequired[str],
    actionExecutionId: NotRequired[str],
    pipelineVersion: NotRequired[int],
    stageName: NotRequired[str],
    actionName: NotRequired[str],
    startTime: NotRequired[datetime],
    lastUpdateTime: NotRequired[datetime],
    status: NotRequired[ActionExecutionStatusType],  # (1)
    input: NotRequired[ActionExecutionInputTypeDef],  # (2)
    output: NotRequired[ActionExecutionOutputTypeDef],  # (3)
  1. See ActionExecutionStatusType
  2. See ActionExecutionInputTypeDef
  3. See ActionExecutionOutputTypeDef

JobDataTypeDef#

# JobDataTypeDef definition

class JobDataTypeDef(TypedDict):
    actionTypeId: NotRequired[ActionTypeIdTypeDef],  # (1)
    actionConfiguration: NotRequired[ActionConfigurationTypeDef],  # (2)
    pipelineContext: NotRequired[PipelineContextTypeDef],  # (3)
    inputArtifacts: NotRequired[List[ArtifactTypeDef]],  # (4)
    outputArtifacts: NotRequired[List[ArtifactTypeDef]],  # (4)
    artifactCredentials: NotRequired[AWSSessionCredentialsTypeDef],  # (6)
    continuationToken: NotRequired[str],
    encryptionKey: NotRequired[EncryptionKeyTypeDef],  # (7)
  1. See ActionTypeIdTypeDef
  2. See ActionConfigurationTypeDef
  3. See PipelineContextTypeDef
  4. See ArtifactTypeDef
  5. See ArtifactTypeDef
  6. See AWSSessionCredentialsTypeDef
  7. See EncryptionKeyTypeDef