Skip to content

CodeDeployClient#

Index > CodeDeploy > CodeDeployClient

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

CodeDeployClient#

Type annotations and code completion for boto3.client("codedeploy"). boto3 documentation

# CodeDeployClient usage example

from boto3.session import Session
from mypy_boto3_codedeploy.client import CodeDeployClient

def get_codedeploy_client() -> CodeDeployClient:
    return Session().client("codedeploy")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("codedeploy").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("codedeploy")

try:
    do_something(client)
except (
    client.exceptions.AlarmsLimitExceededException,
    client.exceptions.ApplicationAlreadyExistsException,
    client.exceptions.ApplicationDoesNotExistException,
    client.exceptions.ApplicationLimitExceededException,
    client.exceptions.ApplicationNameRequiredException,
    client.exceptions.ArnNotSupportedException,
    client.exceptions.BatchLimitExceededException,
    client.exceptions.BucketNameFilterRequiredException,
    client.exceptions.ClientError,
    client.exceptions.DeploymentAlreadyCompletedException,
    client.exceptions.DeploymentAlreadyStartedException,
    client.exceptions.DeploymentConfigAlreadyExistsException,
    client.exceptions.DeploymentConfigDoesNotExistException,
    client.exceptions.DeploymentConfigInUseException,
    client.exceptions.DeploymentConfigLimitExceededException,
    client.exceptions.DeploymentConfigNameRequiredException,
    client.exceptions.DeploymentDoesNotExistException,
    client.exceptions.DeploymentGroupAlreadyExistsException,
    client.exceptions.DeploymentGroupDoesNotExistException,
    client.exceptions.DeploymentGroupLimitExceededException,
    client.exceptions.DeploymentGroupNameRequiredException,
    client.exceptions.DeploymentIdRequiredException,
    client.exceptions.DeploymentIsNotInReadyStateException,
    client.exceptions.DeploymentLimitExceededException,
    client.exceptions.DeploymentNotStartedException,
    client.exceptions.DeploymentTargetDoesNotExistException,
    client.exceptions.DeploymentTargetIdRequiredException,
    client.exceptions.DeploymentTargetListSizeExceededException,
    client.exceptions.DescriptionTooLongException,
    client.exceptions.ECSServiceMappingLimitExceededException,
    client.exceptions.GitHubAccountTokenDoesNotExistException,
    client.exceptions.GitHubAccountTokenNameRequiredException,
    client.exceptions.IamArnRequiredException,
    client.exceptions.IamSessionArnAlreadyRegisteredException,
    client.exceptions.IamUserArnAlreadyRegisteredException,
    client.exceptions.IamUserArnRequiredException,
    client.exceptions.InstanceDoesNotExistException,
    client.exceptions.InstanceIdRequiredException,
    client.exceptions.InstanceLimitExceededException,
    client.exceptions.InstanceNameAlreadyRegisteredException,
    client.exceptions.InstanceNameRequiredException,
    client.exceptions.InstanceNotRegisteredException,
    client.exceptions.InvalidAlarmConfigException,
    client.exceptions.InvalidApplicationNameException,
    client.exceptions.InvalidArnException,
    client.exceptions.InvalidAutoRollbackConfigException,
    client.exceptions.InvalidAutoScalingGroupException,
    client.exceptions.InvalidBlueGreenDeploymentConfigurationException,
    client.exceptions.InvalidBucketNameFilterException,
    client.exceptions.InvalidComputePlatformException,
    client.exceptions.InvalidDeployedStateFilterException,
    client.exceptions.InvalidDeploymentConfigNameException,
    client.exceptions.InvalidDeploymentGroupNameException,
    client.exceptions.InvalidDeploymentIdException,
    client.exceptions.InvalidDeploymentInstanceTypeException,
    client.exceptions.InvalidDeploymentStatusException,
    client.exceptions.InvalidDeploymentStyleException,
    client.exceptions.InvalidDeploymentTargetIdException,
    client.exceptions.InvalidDeploymentWaitTypeException,
    client.exceptions.InvalidEC2TagCombinationException,
    client.exceptions.InvalidEC2TagException,
    client.exceptions.InvalidECSServiceException,
    client.exceptions.InvalidExternalIdException,
    client.exceptions.InvalidFileExistsBehaviorException,
    client.exceptions.InvalidGitHubAccountTokenException,
    client.exceptions.InvalidGitHubAccountTokenNameException,
    client.exceptions.InvalidIamSessionArnException,
    client.exceptions.InvalidIamUserArnException,
    client.exceptions.InvalidIgnoreApplicationStopFailuresValueException,
    client.exceptions.InvalidInputException,
    client.exceptions.InvalidInstanceIdException,
    client.exceptions.InvalidInstanceNameException,
    client.exceptions.InvalidInstanceStatusException,
    client.exceptions.InvalidInstanceTypeException,
    client.exceptions.InvalidKeyPrefixFilterException,
    client.exceptions.InvalidLifecycleEventHookExecutionIdException,
    client.exceptions.InvalidLifecycleEventHookExecutionStatusException,
    client.exceptions.InvalidLoadBalancerInfoException,
    client.exceptions.InvalidMinimumHealthyHostValueException,
    client.exceptions.InvalidNextTokenException,
    client.exceptions.InvalidOnPremisesTagCombinationException,
    client.exceptions.InvalidOperationException,
    client.exceptions.InvalidRegistrationStatusException,
    client.exceptions.InvalidRevisionException,
    client.exceptions.InvalidRoleException,
    client.exceptions.InvalidSortByException,
    client.exceptions.InvalidSortOrderException,
    client.exceptions.InvalidTagException,
    client.exceptions.InvalidTagFilterException,
    client.exceptions.InvalidTagsToAddException,
    client.exceptions.InvalidTargetException,
    client.exceptions.InvalidTargetFilterNameException,
    client.exceptions.InvalidTargetGroupPairException,
    client.exceptions.InvalidTargetInstancesException,
    client.exceptions.InvalidTimeRangeException,
    client.exceptions.InvalidTrafficRoutingConfigurationException,
    client.exceptions.InvalidTriggerConfigException,
    client.exceptions.InvalidUpdateOutdatedInstancesOnlyValueException,
    client.exceptions.InvalidZonalDeploymentConfigurationException,
    client.exceptions.LifecycleEventAlreadyCompletedException,
    client.exceptions.LifecycleHookLimitExceededException,
    client.exceptions.MultipleIamArnsProvidedException,
    client.exceptions.OperationNotSupportedException,
    client.exceptions.ResourceArnRequiredException,
    client.exceptions.ResourceValidationException,
    client.exceptions.RevisionDoesNotExistException,
    client.exceptions.RevisionRequiredException,
    client.exceptions.RoleRequiredException,
    client.exceptions.TagLimitExceededException,
    client.exceptions.TagRequiredException,
    client.exceptions.TagSetListLimitExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.TriggerTargetsLimitExceededException,
    client.exceptions.UnsupportedActionForDeploymentTypeException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_codedeploy.client import Exceptions

def handle_error(exc: Exceptions.AlarmsLimitExceededException) -> None:
    ...

Methods#

add_tags_to_on_premises_instances#

Adds tags to on-premises instances.

Type annotations and code completion for boto3.client("codedeploy").add_tags_to_on_premises_instances method. boto3 documentation

# add_tags_to_on_premises_instances method definition

def add_tags_to_on_premises_instances(
    self,
    *,
    tags: Sequence[TagTypeDef],  # (1)
    instanceNames: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See EmptyResponseMetadataTypeDef
# add_tags_to_on_premises_instances method usage example with argument unpacking

kwargs: AddTagsToOnPremisesInstancesInputRequestTypeDef = {  # (1)
    "tags": ...,
    "instanceNames": ...,
}

parent.add_tags_to_on_premises_instances(**kwargs)
  1. See AddTagsToOnPremisesInstancesInputRequestTypeDef

batch_get_application_revisions#

Gets information about one or more application revisions.

Type annotations and code completion for boto3.client("codedeploy").batch_get_application_revisions method. boto3 documentation

# batch_get_application_revisions method definition

def batch_get_application_revisions(
    self,
    *,
    applicationName: str,
    revisions: Sequence[RevisionLocationTypeDef],  # (1)
) -> BatchGetApplicationRevisionsOutputTypeDef:  # (2)
    ...
  1. See RevisionLocationTypeDef
  2. See BatchGetApplicationRevisionsOutputTypeDef
# batch_get_application_revisions method usage example with argument unpacking

kwargs: BatchGetApplicationRevisionsInputRequestTypeDef = {  # (1)
    "applicationName": ...,
    "revisions": ...,
}

parent.batch_get_application_revisions(**kwargs)
  1. See BatchGetApplicationRevisionsInputRequestTypeDef

batch_get_applications#

Gets information about one or more applications.

Type annotations and code completion for boto3.client("codedeploy").batch_get_applications method. boto3 documentation

# batch_get_applications method definition

def batch_get_applications(
    self,
    *,
    applicationNames: Sequence[str],
) -> BatchGetApplicationsOutputTypeDef:  # (1)
    ...
  1. See BatchGetApplicationsOutputTypeDef
# batch_get_applications method usage example with argument unpacking

kwargs: BatchGetApplicationsInputRequestTypeDef = {  # (1)
    "applicationNames": ...,
}

parent.batch_get_applications(**kwargs)
  1. See BatchGetApplicationsInputRequestTypeDef

batch_get_deployment_groups#

Gets information about one or more deployment groups.

Type annotations and code completion for boto3.client("codedeploy").batch_get_deployment_groups method. boto3 documentation

# batch_get_deployment_groups method definition

def batch_get_deployment_groups(
    self,
    *,
    applicationName: str,
    deploymentGroupNames: Sequence[str],
) -> BatchGetDeploymentGroupsOutputTypeDef:  # (1)
    ...
  1. See BatchGetDeploymentGroupsOutputTypeDef
# batch_get_deployment_groups method usage example with argument unpacking

kwargs: BatchGetDeploymentGroupsInputRequestTypeDef = {  # (1)
    "applicationName": ...,
    "deploymentGroupNames": ...,
}

parent.batch_get_deployment_groups(**kwargs)
  1. See BatchGetDeploymentGroupsInputRequestTypeDef

batch_get_deployment_instances#

.

Type annotations and code completion for boto3.client("codedeploy").batch_get_deployment_instances method. boto3 documentation

# batch_get_deployment_instances method definition

def batch_get_deployment_instances(
    self,
    *,
    deploymentId: str,
    instanceIds: Sequence[str],
) -> BatchGetDeploymentInstancesOutputTypeDef:  # (1)
    ...
  1. See BatchGetDeploymentInstancesOutputTypeDef
# batch_get_deployment_instances method usage example with argument unpacking

kwargs: BatchGetDeploymentInstancesInputRequestTypeDef = {  # (1)
    "deploymentId": ...,
    "instanceIds": ...,
}

parent.batch_get_deployment_instances(**kwargs)
  1. See BatchGetDeploymentInstancesInputRequestTypeDef

batch_get_deployment_targets#

Returns an array of one or more targets associated with a deployment.

Type annotations and code completion for boto3.client("codedeploy").batch_get_deployment_targets method. boto3 documentation

# batch_get_deployment_targets method definition

def batch_get_deployment_targets(
    self,
    *,
    deploymentId: str,
    targetIds: Sequence[str],
) -> BatchGetDeploymentTargetsOutputTypeDef:  # (1)
    ...
  1. See BatchGetDeploymentTargetsOutputTypeDef
# batch_get_deployment_targets method usage example with argument unpacking

kwargs: BatchGetDeploymentTargetsInputRequestTypeDef = {  # (1)
    "deploymentId": ...,
    "targetIds": ...,
}

parent.batch_get_deployment_targets(**kwargs)
  1. See BatchGetDeploymentTargetsInputRequestTypeDef

batch_get_deployments#

Gets information about one or more deployments.

Type annotations and code completion for boto3.client("codedeploy").batch_get_deployments method. boto3 documentation

# batch_get_deployments method definition

def batch_get_deployments(
    self,
    *,
    deploymentIds: Sequence[str],
) -> BatchGetDeploymentsOutputTypeDef:  # (1)
    ...
  1. See BatchGetDeploymentsOutputTypeDef
# batch_get_deployments method usage example with argument unpacking

kwargs: BatchGetDeploymentsInputRequestTypeDef = {  # (1)
    "deploymentIds": ...,
}

parent.batch_get_deployments(**kwargs)
  1. See BatchGetDeploymentsInputRequestTypeDef

batch_get_on_premises_instances#

Gets information about one or more on-premises instances.

Type annotations and code completion for boto3.client("codedeploy").batch_get_on_premises_instances method.