Skip to content

Type definitions#

Index > CodeDeploy > Type definitions

Auto-generated documentation for CodeDeploy type annotations stubs module mypy-boto3-codedeploy.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: NotRequired[str],
    Value: NotRequired[str],

AlarmTypeDef#

# AlarmTypeDef definition

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

AppSpecContentTypeDef#

# AppSpecContentTypeDef definition

class AppSpecContentTypeDef(TypedDict):
    content: NotRequired[str],
    sha256: NotRequired[str],

ApplicationInfoTypeDef#

# ApplicationInfoTypeDef definition

class ApplicationInfoTypeDef(TypedDict):
    applicationId: NotRequired[str],
    applicationName: NotRequired[str],
    createTime: NotRequired[datetime],
    linkedToGitHub: NotRequired[bool],
    gitHubAccountName: NotRequired[str],
    computePlatform: NotRequired[ComputePlatformType],  # (1)
  1. See ComputePlatformType

AutoRollbackConfigurationTypeDef#

# AutoRollbackConfigurationTypeDef definition

class AutoRollbackConfigurationTypeDef(TypedDict):
    enabled: NotRequired[bool],
    events: NotRequired[List[AutoRollbackEventType]],  # (1)
  1. See AutoRollbackEventType

AutoScalingGroupTypeDef#

# AutoScalingGroupTypeDef definition

class AutoScalingGroupTypeDef(TypedDict):
    name: NotRequired[str],
    hook: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

BatchGetApplicationsInputRequestTypeDef#

# BatchGetApplicationsInputRequestTypeDef definition

class BatchGetApplicationsInputRequestTypeDef(TypedDict):
    applicationNames: Sequence[str],

BatchGetDeploymentGroupsInputRequestTypeDef#

# BatchGetDeploymentGroupsInputRequestTypeDef definition

class BatchGetDeploymentGroupsInputRequestTypeDef(TypedDict):
    applicationName: str,
    deploymentGroupNames: Sequence[str],

BatchGetDeploymentInstancesInputRequestTypeDef#

# BatchGetDeploymentInstancesInputRequestTypeDef definition

class BatchGetDeploymentInstancesInputRequestTypeDef(TypedDict):
    deploymentId: str,
    instanceIds: Sequence[str],

BatchGetDeploymentTargetsInputRequestTypeDef#

# BatchGetDeploymentTargetsInputRequestTypeDef definition

class BatchGetDeploymentTargetsInputRequestTypeDef(TypedDict):
    deploymentId: NotRequired[str],
    targetIds: NotRequired[Sequence[str]],

BatchGetDeploymentsInputRequestTypeDef#

# BatchGetDeploymentsInputRequestTypeDef definition

class BatchGetDeploymentsInputRequestTypeDef(TypedDict):
    deploymentIds: Sequence[str],

BatchGetOnPremisesInstancesInputRequestTypeDef#

# BatchGetOnPremisesInstancesInputRequestTypeDef definition

class BatchGetOnPremisesInstancesInputRequestTypeDef(TypedDict):
    instanceNames: Sequence[str],

BlueInstanceTerminationOptionTypeDef#

# BlueInstanceTerminationOptionTypeDef definition

class BlueInstanceTerminationOptionTypeDef(TypedDict):
    action: NotRequired[InstanceActionType],  # (1)
    terminationWaitTimeInMinutes: NotRequired[int],
  1. See InstanceActionType

DeploymentReadyOptionTypeDef#

# DeploymentReadyOptionTypeDef definition

class DeploymentReadyOptionTypeDef(TypedDict):
    actionOnTimeout: NotRequired[DeploymentReadyActionType],  # (1)
    waitTimeInMinutes: NotRequired[int],
  1. See DeploymentReadyActionType

GreenFleetProvisioningOptionTypeDef#

# GreenFleetProvisioningOptionTypeDef definition

class GreenFleetProvisioningOptionTypeDef(TypedDict):
    action: NotRequired[GreenFleetProvisioningActionType],  # (1)
  1. See GreenFleetProvisioningActionType

ContinueDeploymentInputRequestTypeDef#

# ContinueDeploymentInputRequestTypeDef definition

class ContinueDeploymentInputRequestTypeDef(TypedDict):
    deploymentId: NotRequired[str],
    deploymentWaitType: NotRequired[DeploymentWaitTypeType],  # (1)
  1. See DeploymentWaitTypeType

MinimumHealthyHostsTypeDef#

# MinimumHealthyHostsTypeDef definition

class MinimumHealthyHostsTypeDef(TypedDict):
    type: NotRequired[MinimumHealthyHostsTypeType],  # (1)
    value: NotRequired[int],
  1. See MinimumHealthyHostsTypeType

DeploymentStyleTypeDef#

# DeploymentStyleTypeDef definition

class DeploymentStyleTypeDef(TypedDict):
    deploymentType: NotRequired[DeploymentTypeType],  # (1)
    deploymentOption: NotRequired[DeploymentOptionType],  # (2)
  1. See DeploymentTypeType
  2. See DeploymentOptionType

EC2TagFilterTypeDef#

# EC2TagFilterTypeDef definition

class EC2TagFilterTypeDef(TypedDict):
    Key: NotRequired[str],
    Value: NotRequired[str],
    Type: NotRequired[EC2TagFilterTypeType],  # (1)
  1. See EC2TagFilterTypeType

ECSServiceTypeDef#

# ECSServiceTypeDef definition

class ECSServiceTypeDef(TypedDict):
    serviceName: NotRequired[str],
    clusterName: NotRequired[str],

TagFilterTypeDef#

# TagFilterTypeDef definition

class TagFilterTypeDef(TypedDict):
    Key: NotRequired[str],
    Value: NotRequired[str],
    Type: NotRequired[TagFilterTypeType],  # (1)
  1. See TagFilterTypeType

TriggerConfigTypeDef#

# TriggerConfigTypeDef definition

class TriggerConfigTypeDef(TypedDict):
    triggerName: NotRequired[str],
    triggerTargetArn: NotRequired[str],
    triggerEvents: NotRequired[List[TriggerEventTypeType]],  # (1)
  1. See TriggerEventTypeType

DeleteApplicationInputRequestTypeDef#

# DeleteApplicationInputRequestTypeDef definition

class DeleteApplicationInputRequestTypeDef(TypedDict):
    applicationName: str,

DeleteDeploymentConfigInputRequestTypeDef#

# DeleteDeploymentConfigInputRequestTypeDef definition

class DeleteDeploymentConfigInputRequestTypeDef(TypedDict):
    deploymentConfigName: str,

DeleteDeploymentGroupInputRequestTypeDef#

# DeleteDeploymentGroupInputRequestTypeDef definition

class DeleteDeploymentGroupInputRequestTypeDef(TypedDict):
    applicationName: str,
    deploymentGroupName: str,

DeleteGitHubAccountTokenInputRequestTypeDef#

# DeleteGitHubAccountTokenInputRequestTypeDef definition

class DeleteGitHubAccountTokenInputRequestTypeDef(TypedDict):
    tokenName: NotRequired[str],

DeleteResourcesByExternalIdInputRequestTypeDef#

# DeleteResourcesByExternalIdInputRequestTypeDef definition

class DeleteResourcesByExternalIdInputRequestTypeDef(TypedDict):
    externalId: NotRequired[str],

LastDeploymentInfoTypeDef#

# LastDeploymentInfoTypeDef definition

class LastDeploymentInfoTypeDef(TypedDict):
    deploymentId: NotRequired[str],
    status: NotRequired[DeploymentStatusType],  # (1)
    endTime: NotRequired[datetime],
    createTime: NotRequired[datetime],
  1. See DeploymentStatusType

DeploymentOverviewTypeDef#

# DeploymentOverviewTypeDef definition

class DeploymentOverviewTypeDef(TypedDict):
    Pending: NotRequired[int],
    InProgress: NotRequired[int],
    Succeeded: NotRequired[int],
    Failed: NotRequired[int],
    Skipped: NotRequired[int],
    Ready: NotRequired[int],

ErrorInformationTypeDef#

# ErrorInformationTypeDef definition

class ErrorInformationTypeDef(TypedDict):
    code: NotRequired[ErrorCodeType],  # (1)
    message: NotRequired[str],
  1. See ErrorCodeType

RelatedDeploymentsTypeDef#

# RelatedDeploymentsTypeDef definition

class RelatedDeploymentsTypeDef(TypedDict):
    autoUpdateOutdatedInstancesRootDeploymentId: NotRequired[str],
    autoUpdateOutdatedInstancesDeploymentIds: NotRequired[List[str]],

RollbackInfoTypeDef#

# RollbackInfoTypeDef definition

class RollbackInfoTypeDef(TypedDict):
    rollbackDeploymentId: NotRequired[str],
    rollbackTriggeringDeploymentId: NotRequired[str],
    rollbackMessage: NotRequired[str],

DeregisterOnPremisesInstanceInputRequestTypeDef#

# DeregisterOnPremisesInstanceInputRequestTypeDef definition

class DeregisterOnPremisesInstanceInputRequestTypeDef(TypedDict):
    instanceName: str,

DiagnosticsTypeDef#

# DiagnosticsTypeDef definition

class DiagnosticsTypeDef(TypedDict):
    errorCode: NotRequired[LifecycleErrorCodeType],  # (1)
    scriptName: NotRequired[str],
    message: NotRequired[str],
    logTail: NotRequired[str],
  1. See LifecycleErrorCodeType

TargetGroupInfoTypeDef#

# TargetGroupInfoTypeDef definition

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

ELBInfoTypeDef#

# ELBInfoTypeDef definition

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

GenericRevisionInfoTypeDef#

# GenericRevisionInfoTypeDef definition

class GenericRevisionInfoTypeDef(TypedDict):
    description: NotRequired[str],
    deploymentGroups: NotRequired[List[str]],
    firstUsedTime: NotRequired[datetime],
    lastUsedTime: NotRequired[datetime],
    registerTime: NotRequired[datetime],

GetApplicationInputRequestTypeDef#

# GetApplicationInputRequestTypeDef definition

class GetApplicationInputRequestTypeDef(TypedDict):
    applicationName: str,

GetDeploymentConfigInputRequestTypeDef#

# GetDeploymentConfigInputRequestTypeDef definition

class GetDeploymentConfigInputRequestTypeDef(TypedDict):
    deploymentConfigName: str,

GetDeploymentGroupInputRequestTypeDef#

# GetDeploymentGroupInputRequestTypeDef definition

class GetDeploymentGroupInputRequestTypeDef(TypedDict):
    applicationName: str,
    deploymentGroupName: str,

WaiterConfigTypeDef#

# WaiterConfigTypeDef definition

class WaiterConfigTypeDef(TypedDict):
    Delay: NotRequired[int],
    MaxAttempts: NotRequired[int],

GetDeploymentInputRequestTypeDef#

# GetDeploymentInputRequestTypeDef definition

class GetDeploymentInputRequestTypeDef(TypedDict):
    deploymentId: str,

GetDeploymentInstanceInputRequestTypeDef#

# GetDeploymentInstanceInputRequestTypeDef definition

class GetDeploymentInstanceInputRequestTypeDef(TypedDict):
    deploymentId: str,
    instanceId: str,

GetDeploymentTargetInputRequestTypeDef#

# GetDeploymentTargetInputRequestTypeDef definition

class GetDeploymentTargetInputRequestTypeDef(TypedDict):
    deploymentId: NotRequired[str],
    targetId: NotRequired[str],

GetOnPremisesInstanceInputRequestTypeDef#

# GetOnPremisesInstanceInputRequestTypeDef definition

class GetOnPremisesInstanceInputRequestTypeDef(TypedDict):
    instanceName: str,

GitHubLocationTypeDef#

# GitHubLocationTypeDef definition

class GitHubLocationTypeDef(TypedDict):
    repository: NotRequired[str],
    commitId: NotRequired[str],

LambdaFunctionInfoTypeDef#

# LambdaFunctionInfoTypeDef definition

class LambdaFunctionInfoTypeDef(TypedDict):
    functionName: NotRequired[str],
    functionAlias: NotRequired[str],
    currentVersion: NotRequired[str],
    targetVersion: NotRequired[str],
    targetVersionWeight: NotRequired[float],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

ListApplicationRevisionsInputRequestTypeDef#

# ListApplicationRevisionsInputRequestTypeDef definition

class ListApplicationRevisionsInputRequestTypeDef(TypedDict):
    applicationName: str,
    sortBy: NotRequired[ApplicationRevisionSortByType],  # (1)
    sortOrder: NotRequired[SortOrderType],  # (2)
    s3Bucket: NotRequired[str],
    s3KeyPrefix: NotRequired[str],
    deployed: NotRequired[ListStateFilterActionType],  # (3)
    nextToken: NotRequired[str],
  1. See ApplicationRevisionSortByType
  2. See SortOrderType
  3. See ListStateFilterActionType

ListApplicationsInputRequestTypeDef#

# ListApplicationsInputRequestTypeDef definition

class ListApplicationsInputRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],

ListDeploymentConfigsInputRequestTypeDef#

# ListDeploymentConfigsInputRequestTypeDef definition

class ListDeploymentConfigsInputRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],

ListDeploymentGroupsInputRequestTypeDef#

# ListDeploymentGroupsInputRequestTypeDef definition

class ListDeploymentGroupsInputRequestTypeDef(TypedDict):
    applicationName: str,
    nextToken: NotRequired[str],

ListDeploymentInstancesInputRequestTypeDef#

# ListDeploymentInstancesInputRequestTypeDef definition

class ListDeploymentInstancesInputRequestTypeDef(TypedDict):
    deploymentId: str,
    nextToken: NotRequired[str],
    instanceStatusFilter: NotRequired[Sequence[InstanceStatusType]],  # (1)
    instanceTypeFilter: NotRequired[Sequence[InstanceTypeType]],  # (2)
  1. See InstanceStatusType
  2. See InstanceTypeType

ListDeploymentTargetsInputRequestTypeDef#

# ListDeploymentTargetsInputRequestTypeDef definition

class ListDeploymentTargetsInputRequestTypeDef(TypedDict):
    deploymentId: NotRequired[str],
    nextToken: NotRequired[str],
    targetFilters: NotRequired[Mapping[TargetFilterNameType, Sequence[str]]],  # (1)
  1. See TargetFilterNameType

ListGitHubAccountTokenNamesInputRequestTypeDef#

# ListGitHubAccountTokenNamesInputRequestTypeDef definition

class ListGitHubAccountTokenNamesInputRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],

ListTagsForResourceInputRequestTypeDef#

# ListTagsForResourceInputRequestTypeDef definition

class ListTagsForResourceInputRequestTypeDef(TypedDict):
    ResourceArn: str,
    NextToken: NotRequired[str],

PutLifecycleEventHookExecutionStatusInputRequestTypeDef#

# PutLifecycleEventHookExecutionStatusInputRequestTypeDef definition

class PutLifecycleEventHookExecutionStatusInputRequestTypeDef(TypedDict):
    deploymentId: NotRequired[str],
    lifecycleEventHookExecutionId: NotRequired[str],
    status: NotRequired[LifecycleEventStatusType],  # (1)
  1. See LifecycleEventStatusType

RawStringTypeDef#

# RawStringTypeDef definition

class RawStringTypeDef(TypedDict):
    content: NotRequired[str],
    sha256: NotRequired[str],

RegisterOnPremisesInstanceInputRequestTypeDef#

# RegisterOnPremisesInstanceInputRequestTypeDef definition

class RegisterOnPremisesInstanceInputRequestTypeDef(TypedDict):
    instanceName: str,
    iamSessionArn: NotRequired[str],
    iamUserArn: NotRequired[str],

S3LocationTypeDef#

# S3LocationTypeDef definition

class S3LocationTypeDef(TypedDict):
    bucket: NotRequired[str],
    key: NotRequired[str],
    bundleType: NotRequired[BundleTypeType],  # (1)
    version: NotRequired[str],
    eTag: NotRequired[str],
  1. See BundleTypeType

SkipWaitTimeForInstanceTerminationInputRequestTypeDef#

# SkipWaitTimeForInstanceTerminationInputRequestTypeDef definition

class SkipWaitTimeForInstanceTerminationInputRequestTypeDef(TypedDict):
    deploymentId: NotRequired[str],

StopDeploymentInputRequestTypeDef#

# StopDeploymentInputRequestTypeDef definition

class StopDeploymentInputRequestTypeDef(TypedDict):
    deploymentId: str,
    autoRollbackEnabled: NotRequired[bool],

TrafficRouteTypeDef#

# TrafficRouteTypeDef definition

class TrafficRouteTypeDef(TypedDict):
    listenerArns: NotRequired[List[str]],

TimeBasedCanaryTypeDef#

# TimeBasedCanaryTypeDef definition

class TimeBasedCanaryTypeDef(TypedDict):
    canaryPercentage: NotRequired[int],
    canaryInterval: NotRequired[int],

TimeBasedLinearTypeDef#

# TimeBasedLinearTypeDef definition

class TimeBasedLinearTypeDef(TypedDict):
    linearPercentage: NotRequired[int],
    linearInterval: NotRequired[int],

UntagResourceInputRequestTypeDef#

# UntagResourceInputRequestTypeDef definition

class UntagResourceInputRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

UpdateApplicationInputRequestTypeDef#

# UpdateApplicationInputRequestTypeDef definition

class UpdateApplicationInputRequestTypeDef(TypedDict):
    applicationName: NotRequired[str],
    newApplicationName: NotRequired[str],

AddTagsToOnPremisesInstancesInputRequestTypeDef#

# AddTagsToOnPremisesInstancesInputRequestTypeDef definition

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

CreateApplicationInputRequestTypeDef#

# CreateApplicationInputRequestTypeDef definition

class CreateApplicationInputRequestTypeDef(TypedDict):
    applicationName: str,
    computePlatform: NotRequired[ComputePlatformType],  # (1)
    tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See ComputePlatformType
  2. See TagTypeDef

InstanceInfoTypeDef#

# InstanceInfoTypeDef definition

class InstanceInfoTypeDef(TypedDict):
    instanceName: NotRequired[str],
    iamSessionArn: NotRequired[str],
    iamUserArn: NotRequired[str],
    instanceArn: NotRequired[str],
    registerTime: NotRequired[datetime],
    deregisterTime: NotRequired[datetime],
    tags: NotRequired[List[TagTypeDef]],  # (1)
  1. See TagTypeDef

RemoveTagsFromOnPremisesInstancesInputRequestTypeDef#

# RemoveTagsFromOnPremisesInstancesInputRequestTypeDef definition

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

TagResourceInputRequestTypeDef#

# TagResourceInputRequestTypeDef definition

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

AlarmConfigurationTypeDef#

# AlarmConfigurationTypeDef definition

class AlarmConfigurationTypeDef(TypedDict):
    enabled: NotRequired[bool],
    ignorePollAlarmFailure: NotRequired[bool],
    alarms: NotRequired[List[AlarmTypeDef]],  # (1)
  1. See AlarmTypeDef

BatchGetApplicationsOutputTypeDef#

# BatchGetApplicationsOutputTypeDef definition

class BatchGetApplicationsOutputTypeDef(TypedDict):
    applicationsInfo: List[ApplicationInfoTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ApplicationInfoTypeDef
  2. See ResponseMetadataTypeDef

CreateApplicationOutputTypeDef#

# CreateApplicationOutputTypeDef definition

class CreateApplicationOutputTypeDef(TypedDict):
    applicationId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateDeploymentConfigOutputTypeDef#

# CreateDeploymentConfigOutputTypeDef definition

class CreateDeploymentConfigOutputTypeDef(TypedDict):
    deploymentConfigId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateDeploymentGroupOutputTypeDef#

# CreateDeploymentGroupOutputTypeDef definition

class CreateDeploymentGroupOutputTypeDef(TypedDict):
    deploymentGroupId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateDeploymentOutputTypeDef#

# CreateDeploymentOutputTypeDef definition

class CreateDeploymentOutputTypeDef(TypedDict):
    deploymentId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteDeploymentGroupOutputTypeDef#

# DeleteDeploymentGroupOutputTypeDef definition

class DeleteDeploymentGroupOutputTypeDef(TypedDict):
    hooksNotCleanedUp: List[AutoScalingGroupTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AutoScalingGroupTypeDef
  2. See ResponseMetadataTypeDef

DeleteGitHubAccountTokenOutputTypeDef#

# DeleteGitHubAccountTokenOutputTypeDef definition

class DeleteGitHubAccountTokenOutputTypeDef(TypedDict):
    tokenName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

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

GetApplicationOutputTypeDef#

# GetApplicationOutputTypeDef definition

class GetApplicationOutputTypeDef(TypedDict):
    application: ApplicationInfoTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ApplicationInfoTypeDef
  2. See ResponseMetadataTypeDef

ListApplicationsOutputTypeDef#

# ListApplicationsOutputTypeDef definition

class ListApplicationsOutputTypeDef(TypedDict):
    applications: List[str],
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListDeploymentConfigsOutputTypeDef#

# ListDeploymentConfigsOutputTypeDef definition

class ListDeploymentConfigsOutputTypeDef(TypedDict):
    deploymentConfigsList: List[str],
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See