CodeDeployClient

Index > CodeDeploy > CodeDeployClient

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

CodeDeployClient

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

# CodeDeployClient usage example

from boto3.session import Session
from types_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 types_boto3_codedeploy.client import Exceptions

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

Methods

can_paginate

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

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url

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

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

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 Sequence[TagTypeDef]
2. See EmptyResponseMetadataTypeDef

# add_tags_to_on_premises_instances method usage example with argument unpacking

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

parent.add_tags_to_on_premises_instances(**kwargs)

1. See AddTagsToOnPremisesInstancesInputTypeDef

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 Sequence[RevisionLocationTypeDef]
2. See BatchGetApplicationRevisionsOutputTypeDef

# batch_get_application_revisions method usage example with argument unpacking

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

parent.batch_get_application_revisions(**kwargs)

1. See BatchGetApplicationRevisionsInputTypeDef

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: BatchGetApplicationsInputTypeDef = {  # (1)
    "applicationNames": ...,
}

parent.batch_get_applications(**kwargs)

1. See BatchGetApplicationsInputTypeDef

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: BatchGetDeploymentGroupsInputTypeDef = {  # (1)
    "applicationName": ...,
    "deploymentGroupNames": ...,
}

parent.batch_get_deployment_groups(**kwargs)

1. See BatchGetDeploymentGroupsInputTypeDef

batch_get_deployment_instances

This method works, but is deprecated.

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: BatchGetDeploymentInstancesInputTypeDef = {  # (1)
    "deploymentId": ...,
    "instanceIds": ...,
}

parent.batch_get_deployment_instances(**kwargs)

1. See BatchGetDeploymentInstancesInputTypeDef

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: BatchGetDeploymentTargetsInputTypeDef = {  # (1)
    "deploymentId": ...,
    "targetIds": ...,
}

parent.batch_get_deployment_targets(**kwargs)

1. See BatchGetDeploymentTargetsInputTypeDef

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: BatchGetDeploymentsInputTypeDef = {  # (1)
    "deploymentIds": ...,
}

parent.batch_get_deployments(**kwargs)

1. See BatchGetDeploymentsInputTypeDef

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. boto3 documentation

# batch_get_on_premises_instances method definition

def batch_get_on_premises_instances(
    self,
    *,
    instanceNames: Sequence[str],
) -> BatchGetOnPremisesInstancesOutputTypeDef:  # (1)
    ...

1. See BatchGetOnPremisesInstancesOutputTypeDef

# batch_get_on_premises_instances method usage example with argument unpacking

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

parent.batch_get_on_premises_instances(**kwargs)

1. See BatchGetOnPremisesInstancesInputTypeDef

continue_deployment

For a blue/green deployment, starts the process of rerouting traffic from instances in the original environment to instances in the replacement environment without waiting for a specified wait time to elapse.

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

# continue_deployment method definition

def continue_deployment(
    self,
    *,
    deploymentId: str = ...,
    deploymentWaitType: DeploymentWaitTypeType = ...,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See DeploymentWaitTypeType
2. See EmptyResponseMetadataTypeDef

# continue_deployment method usage example with argument unpacking

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

parent.continue_deployment(**kwargs)

1. See ContinueDeploymentInputTypeDef

create_application

Creates an application.

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

# create_application method definition

def create_application(
    self,
    *,
    applicationName: str,
    computePlatform: ComputePlatformType = ...,  # (1)
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateApplicationOutputTypeDef:  # (3)
    ...

1. See ComputePlatformType
2. See Sequence[TagTypeDef]
3. See CreateApplicationOutputTypeDef

# create_application method usage example with argument unpacking

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

parent.create_application(**kwargs)

1. See CreateApplicationInputTypeDef

create_deployment

Deploys an application revision through the specified deployment group.

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

# create_deployment method definition

def create_deployment(
    self,
    *,
    applicationName: str,
    deploymentGroupName: str = ...,
    revision: RevisionLocationTypeDef = ...,  # (1)
    deploymentConfigName: str = ...,
    description: str = ...,
    ignoreApplicationStopFailures: bool = ...,
    targetInstances: TargetInstancesUnionTypeDef = ...,  # (2)
    autoRollbackConfiguration: AutoRollbackConfigurationUnionTypeDef = ...,  # (3)
    updateOutdatedInstancesOnly: bool = ...,
    fileExistsBehavior: FileExistsBehaviorType = ...,  # (4)
    overrideAlarmConfiguration: AlarmConfigurationUnionTypeDef = ...,  # (5)
) -> CreateDeploymentOutputTypeDef:  # (6)
    ...

1. See RevisionLocationTypeDef
2. See TargetInstancesUnionTypeDef
3. See AutoRollbackConfigurationUnionTypeDef
4. See FileExistsBehaviorType
5. See AlarmConfigurationUnionTypeDef
6. See CreateDeploymentOutputTypeDef

# create_deployment method usage example with argument unpacking

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

parent.create_deployment(**kwargs)

1. See CreateDeploymentInputTypeDef

create_deployment_config

Creates a deployment configuration.

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

# create_deployment_config method definition

def create_deployment_config(
    self,
    *,
    deploymentConfigName: str,
    minimumHealthyHosts: MinimumHealthyHostsTypeDef = ...,  # (1)
    trafficRoutingConfig: TrafficRoutingConfigTypeDef = ...,  # (2)
    computePlatform: ComputePlatformType = ...,  # (3)
    zonalConfig: ZonalConfigTypeDef = ...,  # (4)
) -> CreateDeploymentConfigOutputTypeDef:  # (5)
    ...

1. See MinimumHealthyHostsTypeDef
2. See TrafficRoutingConfigTypeDef
3. See ComputePlatformType
4. See ZonalConfigTypeDef
5. See CreateDeploymentConfigOutputTypeDef

# create_deployment_config method usage example with argument unpacking

kwargs: CreateDeploymentConfigInputTypeDef = {  # (1)
    "deploymentConfigName": ...,
}

parent.create_deployment_config(**kwargs)

1. See CreateDeploymentConfigInputTypeDef

create_deployment_group

Creates a deployment group to which application revisions are deployed.

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

# create_deployment_group method definition

def create_deployment_group(
    self,
    *,
    applicationName: str,
    deploymentGroupName: str,
    serviceRoleArn: str,
    deploymentConfigName: str = ...,
    ec2TagFilters: Sequence[EC2TagFilterTypeDef] = ...,  # (1)
    onPremisesInstanceTagFilters: Sequence[TagFilterTypeDef] = ...,  # (2)
    autoScalingGroups: Sequence[str] = ...,
    triggerConfigurations: Sequence[TriggerConfigUnionTypeDef] = ...,  # (3)
    alarmConfiguration: AlarmConfigurationUnionTypeDef = ...,  # (4)
    autoRollbackConfiguration: AutoRollbackConfigurationUnionTypeDef = ...,  # (5)
    outdatedInstancesStrategy: OutdatedInstancesStrategyType = ...,  # (6)
    deploymentStyle: DeploymentStyleTypeDef = ...,  # (7)
    blueGreenDeploymentConfiguration: BlueGreenDeploymentConfigurationTypeDef = ...,  # (8)
    loadBalancerInfo: LoadBalancerInfoUnionTypeDef = ...,  # (9)
    ec2TagSet: EC2TagSetUnionTypeDef = ...,  # (10)
    ecsServices: Sequence[ECSServiceTypeDef] = ...,  # (11)
    onPremisesTagSet: OnPremisesTagSetUnionTypeDef = ...,  # (12)
    tags: Sequence[TagTypeDef] = ...,  # (13)
    terminationHookEnabled: bool = ...,
) -> CreateDeploymentGroupOutputTypeDef:  # (14)
    ...

1. See Sequence[EC2TagFilterTypeDef]
2. See Sequence[TagFilterTypeDef]
3. See Sequence[TriggerConfigUnionTypeDef]
4. See AlarmConfigurationUnionTypeDef
5. See AutoRollbackConfigurationUnionTypeDef
6. See OutdatedInstancesStrategyType
7. See DeploymentStyleTypeDef
8. See BlueGreenDeploymentConfigurationTypeDef
9. See LoadBalancerInfoUnionTypeDef
10. See EC2TagSetUnionTypeDef
11. See Sequence[ECSServiceTypeDef]
12. See OnPremisesTagSetUnionTypeDef
13. See Sequence[TagTypeDef]
14. See CreateDeploymentGroupOutputTypeDef

# create_deployment_group method usage example with argument unpacking

kwargs: CreateDeploymentGroupInputTypeDef = {  # (1)
    "applicationName": ...,
    "deploymentGroupName": ...,
    "serviceRoleArn": ...,
}

parent.create_deployment_group(**kwargs)

1. See CreateDeploymentGroupInputTypeDef

delete_application

Deletes an application.

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

# delete_application method definition

def delete_application(
    self,
    *,
    applicationName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_application method usage example with argument unpacking

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

parent.delete_application(**kwargs)

1. See DeleteApplicationInputTypeDef

delete_deployment_config

Deletes a deployment configuration.

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

# delete_deployment_config method definition

def delete_deployment_config(
    self,
    *,
    deploymentConfigName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_deployment_config method usage example with argument unpacking

kwargs: DeleteDeploymentConfigInputTypeDef = {  # (1)
    "deploymentConfigName": ...,
}

parent.delete_deployment_config(**kwargs)

1. See DeleteDeploymentConfigInputTypeDef

delete_deployment_group

Deletes a deployment group.

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

# delete_deployment_group method definition

def delete_deployment_group(
    self,
    *,
    applicationName: str,
    deploymentGroupName: str,
) -> DeleteDeploymentGroupOutputTypeDef:  # (1)
    ...

1. See DeleteDeploymentGroupOutputTypeDef

# delete_deployment_group method usage example with argument unpacking

kwargs: DeleteDeploymentGroupInputTypeDef = {  # (1)
    "applicationName": ...,
    "deploymentGroupName": ...,
}

parent.delete_deployment_group(**kwargs)

1. See DeleteDeploymentGroupInputTypeDef

delete_git_hub_account_token

Deletes a GitHub account connection.

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

# delete_git_hub_account_token method definition

def delete_git_hub_account_token(
    self,
    *,
    tokenName: str = ...,
) -> DeleteGitHubAccountTokenOutputTypeDef:  # (1)
    ...

1. See DeleteGitHubAccountTokenOutputTypeDef

# delete_git_hub_account_token method usage example with argument unpacking

kwargs: DeleteGitHubAccountTokenInputTypeDef = {  # (1)
    "tokenName": ...,
}

parent.delete_git_hub_account_token(**kwargs)

1. See DeleteGitHubAccountTokenInputTypeDef

delete_resources_by_external_id

Deletes resources linked to an external ID.

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

# delete_resources_by_external_id method definition

def delete_resources_by_external_id(
    self,
    *,
    externalId: str = ...,
) -> Dict[str, Any]:
    ...

# delete_resources_by_external_id method usage example with argument unpacking

kwargs: DeleteResourcesByExternalIdInputTypeDef = {  # (1)
    "externalId": ...,
}

parent.delete_resources_by_external_id(**kwargs)

1. See DeleteResourcesByExternalIdInputTypeDef

deregister_on_premises_instance

Deregisters an on-premises instance.

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

# deregister_on_premises_instance method definition

def deregister_on_premises_instance(
    self,
    *,
    instanceName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# deregister_on_premises_instance method usage example with argument unpacking

kwargs: DeregisterOnPremisesInstanceInputTypeDef = {  # (1)
    "instanceName": ...,
}

parent.deregister_on_premises_instance(**kwargs)

1. See DeregisterOnPremisesInstanceInputTypeDef

get_application

Gets information about an application.

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

# get_application method definition

def get_application(
    self,
    *,
    applicationName: str,
) -> GetApplicationOutputTypeDef:  # (1)
    ...

1. See GetApplicationOutputTypeDef

# get_application method usage example with argument unpacking

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

parent.get_application(**kwargs)

1. See GetApplicationInputTypeDef

get_application_revision

Gets information about an application revision.

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

# get_application_revision method definition

def get_application_revision(
    self,
    *,
    applicationName: str,
    revision: RevisionLocationTypeDef,  # (1)
) -> GetApplicationRevisionOutputTypeDef:  # (2)
    ...

1. See RevisionLocationTypeDef
2. See GetApplicationRevisionOutputTypeDef

# get_application_revision method usage example with argument unpacking

kwargs: GetApplicationRevisionInputTypeDef = {  # (1)
    "applicationName": ...,
    "revision": ...,
}

parent.get_application_revision(**kwargs)

1. See GetApplicationRevisionInputTypeDef

get_deployment

Gets information about a deployment.

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

# get_deployment method definition

def get_deployment(
    self,
    *,
    deploymentId: str,
) -> GetDeploymentOutputTypeDef:  # (1)
    ...

1. See GetDeploymentOutputTypeDef

# get_deployment method usage example with argument unpacking

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

parent.get_deployment(**kwargs)

1. See GetDeploymentInputTypeDef

get_deployment_config

Gets information about a deployment configuration.

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

# get_deployment_config method definition

def get_deployment_config(
    self,
    *,
    deploymentConfigName: str,
) -> GetDeploymentConfigOutputTypeDef:  # (1)
    ...

1. See GetDeploymentConfigOutputTypeDef

# get_deployment_config method usage example with argument unpacking

kwargs: GetDeploymentConfigInputTypeDef = {  # (1)
    "deploymentConfigName": ...,
}

parent.get_deployment_config(**kwargs)

1. See GetDeploymentConfigInputTypeDef

get_deployment_group

Gets information about a deployment group.

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

# get_deployment_group method definition

def get_deployment_group(
    self,
    *,
    applicationName: str,
    deploymentGroupName: str,
) -> GetDeploymentGroupOutputTypeDef:  # (1)
    ...

1. See GetDeploymentGroupOutputTypeDef

# get_deployment_group method usage example with argument unpacking

kwargs: GetDeploymentGroupInputTypeDef = {  # (1)
    "applicationName": ...,
    "deploymentGroupName": ...,
}

parent.get_deployment_group(**kwargs)

1. See GetDeploymentGroupInputTypeDef

get_deployment_instance

Gets information about an instance as part of a deployment.

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

# get_deployment_instance method definition

def get_deployment_instance(
    self,
    *,
    deploymentId: str,
    instanceId: str,
) -> GetDeploymentInstanceOutputTypeDef:  # (1)
    ...

1. See GetDeploymentInstanceOutputTypeDef

# get_deployment_instance method usage example with argument unpacking

kwargs: GetDeploymentInstanceInputTypeDef = {  # (1)
    "deploymentId": ...,
    "instanceId": ...,
}

parent.get_deployment_instance(**kwargs)

1. See GetDeploymentInstanceInputTypeDef

get_deployment_target

Returns information about a deployment target.

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

# get_deployment_target method definition

def get_deployment_target(
    self,
    *,
    deploymentId: str,
    targetId: str,
) -> GetDeploymentTargetOutputTypeDef:  # (1)
    ...

1. See GetDeploymentTargetOutputTypeDef

# get_deployment_target method usage example with argument unpacking

kwargs: GetDeploymentTargetInputTypeDef = {  # (1)
    "deploymentId": ...,
    "targetId": ...,
}

parent.get_deployment_target(**kwargs)

1. See GetDeploymentTargetInputTypeDef

get_on_premises_instance

Gets information about an on-premises instance.

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

# get_on_premises_instance method definition

def get_on_premises_instance(
    self,
    *,
    instanceName: str,
) -> GetOnPremisesInstanceOutputTypeDef:  # (1)
    ...

1. See GetOnPremisesInstanceOutputTypeDef

# get_on_premises_instance method usage example with argument unpacking

kwargs: GetOnPremisesInstanceInputTypeDef = {  # (1)
    "instanceName": ...,
}

parent.get_on_premises_instance(**kwargs)

1. See GetOnPremisesInstanceInputTypeDef

list_application_revisions

Lists information about revisions for an application.

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

# list_application_revisions method definition

def list_application_revisions(
    self,
    *,
    applicationName: str,
    sortBy: ApplicationRevisionSortByType = ...,  # (1)
    sortOrder: SortOrderType = ...,  # (2)
    s3Bucket: str = ...,
    s3KeyPrefix: str = ...,
    deployed: ListStateFilterActionType = ...,  # (3)
    nextToken: str = ...,
) -> ListApplicationRevisionsOutputTypeDef:  # (4)
    ...

1. See ApplicationRevisionSortByType
2. See SortOrderType
3. See ListStateFilterActionType
4. See ListApplicationRevisionsOutputTypeDef

# list_application_revisions method usage example with argument unpacking

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

parent.list_application_revisions(**kwargs)

1. See ListApplicationRevisionsInputTypeDef

list_applications

Lists the applications registered with the user or Amazon Web Services account.

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

# list_applications method definition

def list_applications(
    self,
    *,
    nextToken: str = ...,
) -> ListApplicationsOutputTypeDef:  # (1)
    ...

1. See ListApplicationsOutputTypeDef

# list_applications method usage example with argument unpacking

kwargs: ListApplicationsInputTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_applications(**kwargs)

1. See ListApplicationsInputTypeDef

list_deployment_configs

Lists the deployment configurations with the user or Amazon Web Services account.

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

# list_deployment_configs method definition

def list_deployment_configs(
    self,
    *,
    nextToken: str = ...,
) -> ListDeploymentConfigsOutputTypeDef:  # (1)
    ...

1. See ListDeploymentConfigsOutputTypeDef

# list_deployment_configs method usage example with argument unpacking

kwargs: ListDeploymentConfigsInputTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_deployment_configs(**kwargs)

1. See ListDeploymentConfigsInputTypeDef

list_deployment_groups

Lists the deployment groups for an application registered with the Amazon Web Services user or Amazon Web Services account.

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

# list_deployment_groups method definition

def list_deployment_groups(
    self,
    *,
    applicationName: str,
    nextToken: str = ...,
) -> ListDeploymentGroupsOutputTypeDef:  # (1)
    ...

1. See ListDeploymentGroupsOutputTypeDef

# list_deployment_groups method usage example with argument unpacking

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

parent.list_deployment_groups(**kwargs)

1. See ListDeploymentGroupsInputTypeDef

list_deployment_instances

The newer BatchGetDeploymentTargets should be used instead because it works with all compute types.

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

# list_deployment_instances method definition

def list_deployment_instances(
    self,
    *,
    deploymentId: str,
    nextToken: str = ...,
    instanceStatusFilter: Sequence[InstanceStatusType] = ...,  # (1)
    instanceTypeFilter: Sequence[InstanceTypeType] = ...,  # (2)
) -> ListDeploymentInstancesOutputTypeDef:  # (3)
    ...

1. See Sequence[InstanceStatusType]
2. See Sequence[InstanceTypeType]
3. See ListDeploymentInstancesOutputTypeDef

# list_deployment_instances method usage example with argument unpacking

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

parent.list_deployment_instances(**kwargs)

1. See ListDeploymentInstancesInputTypeDef

list_deployment_targets

Returns an array of target IDs that are associated a deployment.

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

# list_deployment_targets method definition

def list_deployment_targets(
    self,
    *,
    deploymentId: str,
    nextToken: str = ...,
    targetFilters: Mapping[TargetFilterNameType, Sequence[str]] = ...,  # (1)
) -> ListDeploymentTargetsOutputTypeDef:  # (2)
    ...

1. See Mapping[TargetFilterNameType, Sequence[str]]
2. See ListDeploymentTargetsOutputTypeDef

# list_deployment_targets method usage example with argument unpacking

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

parent.list_deployment_targets(**kwargs)

1. See ListDeploymentTargetsInputTypeDef

list_deployments

Lists the deployments in a deployment group for an application registered with the user or Amazon Web Services account.

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

# list_deployments method definition

def list_deployments(
    self,
    *,
    applicationName: str = ...,
    deploymentGroupName: str = ...,
    externalId: str = ...,
    includeOnlyStatuses: Sequence[DeploymentStatusType] = ...,  # (1)
    createTimeRange: TimeRangeTypeDef = ...,  # (2)
    nextToken: str = ...,
) -> ListDeploymentsOutputTypeDef:  # (3)
    ...

1. See Sequence[DeploymentStatusType]
2. See TimeRangeTypeDef
3. See ListDeploymentsOutputTypeDef

# list_deployments method usage example with argument unpacking

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

parent.list_deployments(**kwargs)

1. See ListDeploymentsInputTypeDef

list_git_hub_account_token_names

Lists the names of stored connections to GitHub accounts.

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

# list_git_hub_account_token_names method definition

def list_git_hub_account_token_names(
    self,
    *,
    nextToken: str = ...,
) -> ListGitHubAccountTokenNamesOutputTypeDef:  # (1)
    ...

1. See ListGitHubAccountTokenNamesOutputTypeDef

# list_git_hub_account_token_names method usage example with argument unpacking

kwargs: ListGitHubAccountTokenNamesInputTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_git_hub_account_token_names(**kwargs)

1. See ListGitHubAccountTokenNamesInputTypeDef

list_on_premises_instances

Gets a list of names for one or more on-premises instances.

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

# list_on_premises_instances method definition

def list_on_premises_instances(
    self,
    *,
    registrationStatus: RegistrationStatusType = ...,  # (1)
    tagFilters: Sequence[TagFilterTypeDef] = ...,  # (2)
    nextToken: str = ...,
) -> ListOnPremisesInstancesOutputTypeDef:  # (3)
    ...

1. See RegistrationStatusType
2. See Sequence[TagFilterTypeDef]
3. See ListOnPremisesInstancesOutputTypeDef

# list_on_premises_instances method usage example with argument unpacking

kwargs: ListOnPremisesInstancesInputTypeDef = {  # (1)
    "registrationStatus": ...,
}

parent.list_on_premises_instances(**kwargs)

1. See ListOnPremisesInstancesInputTypeDef

list_tags_for_resource

Returns a list of tags for the resource identified by a specified Amazon Resource Name (ARN).

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
    NextToken: str = ...,
) -> ListTagsForResourceOutputTypeDef:  # (1)
    ...

1. See ListTagsForResourceOutputTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceInputTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceInputTypeDef

put_lifecycle_event_hook_execution_status

Sets the result of a Lambda validation function.

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

# put_lifecycle_event_hook_execution_status method definition

def put_lifecycle_event_hook_execution_status(
    self,
    *,
    deploymentId: str = ...,
    lifecycleEventHookExecutionId: str = ...,
    status: LifecycleEventStatusType = ...,  # (1)
) -> PutLifecycleEventHookExecutionStatusOutputTypeDef:  # (2)
    ...

1. See LifecycleEventStatusType
2. See PutLifecycleEventHookExecutionStatusOutputTypeDef

# put_lifecycle_event_hook_execution_status method usage example with argument unpacking

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

parent.put_lifecycle_event_hook_execution_status(**kwargs)

1. See PutLifecycleEventHookExecutionStatusInputTypeDef

register_application_revision

Registers with CodeDeploy a revision for the specified application.

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

# register_application_revision method definition

def register_application_revision(
    self,
    *,
    applicationName: str,
    revision: RevisionLocationTypeDef,  # (1)
    description: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See RevisionLocationTypeDef
2. See EmptyResponseMetadataTypeDef

# register_application_revision method usage example with argument unpacking

kwargs: RegisterApplicationRevisionInputTypeDef = {  # (1)
    "applicationName": ...,
    "revision": ...,
}

parent.register_application_revision(**kwargs)

1. See RegisterApplicationRevisionInputTypeDef

register_on_premises_instance

Registers an on-premises instance.

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

# register_on_premises_instance method definition

def register_on_premises_instance(
    self,
    *,
    instanceName: str,
    iamSessionArn: str = ...,
    iamUserArn: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# register_on_premises_instance method usage example with argument unpacking

kwargs: RegisterOnPremisesInstanceInputTypeDef = {  # (1)
    "instanceName": ...,
}

parent.register_on_premises_instance(**kwargs)

1. See RegisterOnPremisesInstanceInputTypeDef

remove_tags_from_on_premises_instances

Removes one or more tags from one or more on-premises instances.

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

# remove_tags_from_on_premises_instances method definition

def remove_tags_from_on_premises_instances(
    self,
    *,
    tags: Sequence[TagTypeDef],  # (1)
    instanceNames: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See Sequence[TagTypeDef]
2. See EmptyResponseMetadataTypeDef

# remove_tags_from_on_premises_instances method usage example with argument unpacking

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

parent.remove_tags_from_on_premises_instances(**kwargs)

1. See RemoveTagsFromOnPremisesInstancesInputTypeDef

skip_wait_time_for_instance_termination

In a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after the traffic routing is complete.

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

# skip_wait_time_for_instance_termination method definition

def skip_wait_time_for_instance_termination(
    self,
    *,
    deploymentId: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# skip_wait_time_for_instance_termination method usage example with argument unpacking

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

parent.skip_wait_time_for_instance_termination(**kwargs)

1. See SkipWaitTimeForInstanceTerminationInputTypeDef

stop_deployment

Attempts to stop an ongoing deployment.

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

# stop_deployment method definition

def stop_deployment(
    self,
    *,
    deploymentId: str,
    autoRollbackEnabled: bool = ...,
) -> StopDeploymentOutputTypeDef:  # (1)
    ...

1. See StopDeploymentOutputTypeDef

# stop_deployment method usage example with argument unpacking

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

parent.stop_deployment(**kwargs)

1. See StopDeploymentInputTypeDef

tag_resource

Associates the list of tags in the input Tags parameter with the resource identified by the ResourceArn input parameter.

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See Sequence[TagTypeDef]

# tag_resource method usage example with argument unpacking

kwargs: TagResourceInputTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceInputTypeDef

untag_resource

Disassociates a resource from a list of tags.

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceInputTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceInputTypeDef

update_application

Changes the name of an application.

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

# update_application method definition

def update_application(
    self,
    *,
    applicationName: str = ...,
    newApplicationName: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# update_application method usage example with argument unpacking

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

parent.update_application(**kwargs)

1. See UpdateApplicationInputTypeDef

update_deployment_group

Changes information about a deployment group.

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

# update_deployment_group method definition

def update_deployment_group(
    self,
    *,
    applicationName: str,
    currentDeploymentGroupName: str,
    newDeploymentGroupName: str = ...,
    deploymentConfigName: str = ...,
    ec2TagFilters: Sequence[EC2TagFilterTypeDef] = ...,  # (1)
    onPremisesInstanceTagFilters: Sequence[TagFilterTypeDef] = ...,  # (2)
    autoScalingGroups: Sequence[str] = ...,
    serviceRoleArn: str = ...,
    triggerConfigurations: Sequence[TriggerConfigUnionTypeDef] = ...,  # (3)
    alarmConfiguration: AlarmConfigurationUnionTypeDef = ...,  # (4)
    autoRollbackConfiguration: AutoRollbackConfigurationUnionTypeDef = ...,  # (5)
    outdatedInstancesStrategy: OutdatedInstancesStrategyType = ...,  # (6)
    deploymentStyle: DeploymentStyleTypeDef = ...,  # (7)
    blueGreenDeploymentConfiguration: BlueGreenDeploymentConfigurationTypeDef = ...,  # (8)
    loadBalancerInfo: LoadBalancerInfoUnionTypeDef = ...,  # (9)
    ec2TagSet: EC2TagSetUnionTypeDef = ...,  # (10)
    ecsServices: Sequence[ECSServiceTypeDef] = ...,  # (11)
    onPremisesTagSet: OnPremisesTagSetUnionTypeDef = ...,  # (12)
    terminationHookEnabled: bool = ...,
) -> UpdateDeploymentGroupOutputTypeDef:  # (13)
    ...

1. See Sequence[EC2TagFilterTypeDef]
2. See Sequence[TagFilterTypeDef]
3. See Sequence[TriggerConfigUnionTypeDef]
4. See AlarmConfigurationUnionTypeDef
5. See AutoRollbackConfigurationUnionTypeDef
6. See OutdatedInstancesStrategyType
7. See DeploymentStyleTypeDef
8. See BlueGreenDeploymentConfigurationTypeDef
9. See LoadBalancerInfoUnionTypeDef
10. See EC2TagSetUnionTypeDef
11. See Sequence[ECSServiceTypeDef]
12. See OnPremisesTagSetUnionTypeDef
13. See UpdateDeploymentGroupOutputTypeDef

# update_deployment_group method usage example with argument unpacking

kwargs: UpdateDeploymentGroupInputTypeDef = {  # (1)
    "applicationName": ...,
    "currentDeploymentGroupName": ...,
}

parent.update_deployment_group(**kwargs)

1. See UpdateDeploymentGroupInputTypeDef

get_paginator

Type annotations and code completion for boto3.client("codedeploy").get_paginator method with overloads.

• client.get_paginator("list_application_revisions") -> ListApplicationRevisionsPaginator
• client.get_paginator("list_applications") -> ListApplicationsPaginator
• client.get_paginator("list_deployment_configs") -> ListDeploymentConfigsPaginator
• client.get_paginator("list_deployment_groups") -> ListDeploymentGroupsPaginator
• client.get_paginator("list_deployment_instances") -> ListDeploymentInstancesPaginator
• client.get_paginator("list_deployment_targets") -> ListDeploymentTargetsPaginator
• client.get_paginator("list_deployments") -> ListDeploymentsPaginator
• client.get_paginator("list_git_hub_account_token_names") -> ListGitHubAccountTokenNamesPaginator
• client.get_paginator("list_on_premises_instances") -> ListOnPremisesInstancesPaginator

get_waiter

Type annotations and code completion for boto3.client("codedeploy").get_waiter method with overloads.

• client.get_waiter("deployment_successful") -> DeploymentSuccessfulWaiter