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,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

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,

LatestInPipelineExecutionFilterTypeDef#

# LatestInPipelineExecutionFilterTypeDef definition

class LatestInPipelineExecutionFilterTypeDef(TypedDict):
    pipelineExecutionId: str,
    startTimeRange: StartTimeRangeType,  # (1)
  1. See StartTimeRangeType

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