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

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.

Usage example
client = boto3.client("codedeploy")

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

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
Usage example with kwargs
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

Method definition
def batch_get_application_revisions(
    self,
    *,
    applicationName: str,
    revisions: Sequence[RevisionLocationTypeDef],  # (1)
) -> BatchGetApplicationRevisionsOutputTypeDef:  # (2)
    ...
  1. See RevisionLocationTypeDef
  2. See BatchGetApplicationRevisionsOutputTypeDef
Usage example with kwargs
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

Method definition
def batch_get_applications(
    self,
    *,
    applicationNames: Sequence[str],
) -> BatchGetApplicationsOutputTypeDef:  # (1)
    ...
  1. See BatchGetApplicationsOutputTypeDef
Usage example with kwargs
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

Method definition
def batch_get_deployment_groups(
    self,
    *,
    applicationName: str,
    deploymentGroupNames: Sequence[str],
) -> BatchGetDeploymentGroupsOutputTypeDef:  # (1)
    ...
  1. See BatchGetDeploymentGroupsOutputTypeDef
Usage example with kwargs
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

Method definition
def batch_get_deployment_instances(
    self,
    *,
    deploymentId: str,
    instanceIds: Sequence[str],
) -> BatchGetDeploymentInstancesOutputTypeDef:  # (1)
    ...
  1. See BatchGetDeploymentInstancesOutputTypeDef
Usage example with kwargs
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

Method definition
def batch_get_deployment_targets(
    self,
    *,
    deploymentId: str = ...,
    targetIds: Sequence[str] = ...,
) -> BatchGetDeploymentTargetsOutputTypeDef:  # (1)
    ...
  1. See BatchGetDeploymentTargetsOutputTypeDef
Usage example with kwargs
kwargs: BatchGetDeploymentTargetsInputRequestTypeDef = {  # (1)
    "deploymentId": ...,
}

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

Method definition
def batch_get_deployments(
    self,
    *,
    deploymentIds: Sequence[str],
) -> BatchGetDeploymentsOutputTypeDef:  # (1)
    ...
  1. See BatchGetDeploymentsOutputTypeDef
Usage example with kwargs
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. boto3 documentation

Method definition
def batch_get_on_premises_instances(
    self,
    *,
    instanceNames: Sequence[str],
) -> BatchGetOnPremisesInstancesOutputTypeDef:  # (1)
    ...
  1. See BatchGetOnPremisesInstancesOutputTypeDef
Usage example with kwargs
kwargs: BatchGetOnPremisesInstancesInputRequestTypeDef = {  # (1)
    "instanceNames": ...,
}

parent.batch_get_on_premises_instances(**kwargs)
  1. See BatchGetOnPremisesInstancesInputRequestTypeDef

can_paginate

Check if an operation can be paginated.

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

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

close

Closes underlying endpoint connections.

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

Method definition
def close(
    self,
) -> None:
    ...

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

Method definition
def continue_deployment(
    self,
    *,
    deploymentId: str = ...,
    deploymentWaitType: DeploymentWaitTypeType = ...,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See DeploymentWaitTypeType
  2. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: ContinueDeploymentInputRequestTypeDef = {  # (1)
    "deploymentId": ...,
}

parent.continue_deployment(**kwargs)
  1. See ContinueDeploymentInputRequestTypeDef

create_application

Creates an application.

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

Method definition
def create_application(
    self,
    *,
    applicationName: str,
    computePlatform: ComputePlatformType = ...,  # (1)
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateApplicationOutputTypeDef:  # (3)
    ...
  1. See ComputePlatformType
  2. See TagTypeDef
  3. See CreateApplicationOutputTypeDef
Usage example with kwargs
kwargs: CreateApplicationInputRequestTypeDef = {  # (1)
    "applicationName": ...,
}

parent.create_application(**kwargs)
  1. See CreateApplicationInputRequestTypeDef

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

Method definition
def create_deployment(
    self,
    *,
    applicationName: str,
    deploymentGroupName: str = ...,
    revision: RevisionLocationTypeDef = ...,  # (1)
    deploymentConfigName: str = ...,
    description: str = ...,
    ignoreApplicationStopFailures: bool = ...,
    targetInstances: TargetInstancesTypeDef = ...,  # (2)
    autoRollbackConfiguration: AutoRollbackConfigurationTypeDef = ...,  # (3)
    updateOutdatedInstancesOnly: bool = ...,
    fileExistsBehavior: FileExistsBehaviorType = ...,  # (4)
) -> CreateDeploymentOutputTypeDef:  # (5)
    ...
  1. See RevisionLocationTypeDef
  2. See TargetInstancesTypeDef
  3. See AutoRollbackConfigurationTypeDef
  4. See FileExistsBehaviorType
  5. See CreateDeploymentOutputTypeDef
Usage example with kwargs
kwargs: CreateDeploymentInputRequestTypeDef = {  # (1)
    "applicationName": ...,
}

parent.create_deployment(**kwargs)
  1. See CreateDeploymentInputRequestTypeDef

create_deployment_config

Creates a deployment configuration.

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

Method definition
def create_deployment_config(
    self,
    *,
    deploymentConfigName: str,
    minimumHealthyHosts: MinimumHealthyHostsTypeDef = ...,  # (1)
    trafficRoutingConfig: TrafficRoutingConfigTypeDef = ...,  # (2)
    computePlatform: ComputePlatformType = ...,  # (3)
) -> CreateDeploymentConfigOutputTypeDef:  # (4)
    ...
  1. See MinimumHealthyHostsTypeDef
  2. See TrafficRoutingConfigTypeDef
  3. See ComputePlatformType
  4. See CreateDeploymentConfigOutputTypeDef
Usage example with kwargs
kwargs: CreateDeploymentConfigInputRequestTypeDef = {  # (1)
    "deploymentConfigName": ...,
}

parent.create_deployment_config(**kwargs)
  1. See CreateDeploymentConfigInputRequestTypeDef

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

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[TriggerConfigTypeDef] = ...,  # (3)
    alarmConfiguration: AlarmConfigurationTypeDef = ...,  # (4)
    autoRollbackConfiguration: AutoRollbackConfigurationTypeDef = ...,  # (5)
    outdatedInstancesStrategy: OutdatedInstancesStrategyType = ...,  # (6)
    deploymentStyle: DeploymentStyleTypeDef = ...,  # (7)
    blueGreenDeploymentConfiguration: BlueGreenDeploymentConfigurationTypeDef = ...,  # (8)
    loadBalancerInfo: LoadBalancerInfoTypeDef = ...,  # (9)
    ec2TagSet: EC2TagSetTypeDef = ...,  # (10)
    ecsServices: Sequence[ECSServiceTypeDef] = ...,  # (11)
    onPremisesTagSet: OnPremisesTagSetTypeDef = ...,  # (12)
    tags: Sequence[TagTypeDef] = ...,  # (13)
) -> CreateDeploymentGroupOutputTypeDef:  # (14)
    ...
  1. See EC2TagFilterTypeDef
  2. See TagFilterTypeDef
  3. See TriggerConfigTypeDef
  4. See AlarmConfigurationTypeDef
  5. See AutoRollbackConfigurationTypeDef
  6. See OutdatedInstancesStrategyType
  7. See DeploymentStyleTypeDef
  8. See BlueGreenDeploymentConfigurationTypeDef
  9. See LoadBalancerInfoTypeDef
  10. See EC2TagSetTypeDef
  11. See ECSServiceTypeDef
  12. See OnPremisesTagSetTypeDef
  13. See TagTypeDef
  14. See CreateDeploymentGroupOutputTypeDef
Usage example with kwargs
kwargs: CreateDeploymentGroupInputRequestTypeDef = {  # (1)
    "applicationName": ...,
    "deploymentGroupName": ...,
    "serviceRoleArn": ...,
}

parent.create_deployment_group(**kwargs)
  1. See CreateDeploymentGroupInputRequestTypeDef

delete_application

Deletes an application.

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

Method definition
def delete_application(
    self,
    *,
    applicationName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteApplicationInputRequestTypeDef = {  # (1)
    "applicationName": ...,
}

parent.delete_application(**kwargs)
  1. See DeleteApplicationInputRequestTypeDef

delete_deployment_config

Deletes a deployment configuration.

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

Method definition
def delete_deployment_config(
    self,
    *,
    deploymentConfigName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteDeploymentConfigInputRequestTypeDef = {  # (1)
    "deploymentConfigName": ...,
}

parent.delete_deployment_config(**kwargs)
  1. See DeleteDeploymentConfigInputRequestTypeDef

delete_deployment_group

Deletes a deployment group.

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

Method definition
def delete_deployment_group(
    self,
    *,
    applicationName: str,
    deploymentGroupName: str,
) -> DeleteDeploymentGroupOutputTypeDef:  # (1)
    ...
  1. See DeleteDeploymentGroupOutputTypeDef
Usage example with kwargs
kwargs: DeleteDeploymentGroupInputRequestTypeDef = {  # (1)
    "applicationName": ...,
    "deploymentGroupName": ...,
}

parent.delete_deployment_group(**kwargs)
  1. See DeleteDeploymentGroupInputRequestTypeDef

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

Method definition
def delete_git_hub_account_token(
    self,
    *,
    tokenName: str = ...,
) -> DeleteGitHubAccountTokenOutputTypeDef:  # (1)
    ...
  1. See DeleteGitHubAccountTokenOutputTypeDef
Usage example with kwargs
kwargs: DeleteGitHubAccountTokenInputRequestTypeDef = {  # (1)
    "tokenName": ...,
}

parent.delete_git_hub_account_token(**kwargs)
  1. See DeleteGitHubAccountTokenInputRequestTypeDef

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

Method definition
def delete_resources_by_external_id(
    self,
    *,
    externalId: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteResourcesByExternalIdInputRequestTypeDef = {  # (1)
    "externalId": ...,
}

parent.delete_resources_by_external_id(**kwargs)
  1. See DeleteResourcesByExternalIdInputRequestTypeDef

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

Method definition
def deregister_on_premises_instance(
    self,
    *,
    instanceName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeregisterOnPremisesInstanceInputRequestTypeDef = {  # (1)
    "instanceName": ...,
}

parent.deregister_on_premises_instance(**kwargs)
  1. See DeregisterOnPremisesInstanceInputRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

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

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

get_application

Gets information about an application.

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

Method definition
def get_application(
    self,
    *,
    applicationName: str,
) -> GetApplicationOutputTypeDef:  # (1)
    ...
  1. See GetApplicationOutputTypeDef
Usage example with kwargs
kwargs: GetApplicationInputRequestTypeDef = {  # (1)
    "applicationName": ...,
}

parent.get_application(**kwargs)
  1. See GetApplicationInputRequestTypeDef

get_application_revision

Gets information about an application revision.

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

Method definition
def get_application_revision(
    self,
    *,
    applicationName: str,
    revision: RevisionLocationTypeDef,  # (1)
) -> GetApplicationRevisionOutputTypeDef:  # (2)
    ...
  1. See RevisionLocationTypeDef
  2. See GetApplicationRevisionOutputTypeDef
Usage example with kwargs
kwargs: GetApplicationRevisionInputRequestTypeDef = {  # (1)
    "applicationName": ...,
    "revision": ...,
}

parent.get_application_revision(**kwargs)
  1. See GetApplicationRevisionInputRequestTypeDef

get_deployment

Gets information about a deployment.

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

Method definition
def get_deployment(
    self,
    *,
    deploymentId: str,
) -> GetDeploymentOutputTypeDef:  # (1)
    ...
  1. See GetDeploymentOutputTypeDef
Usage example with kwargs
kwargs: GetDeploymentInputRequestTypeDef = {  # (1)
    "deploymentId": ...,
}

parent.get_deployment(**kwargs)
  1. See GetDeploymentInputRequestTypeDef

get_deployment_config

Gets information about a deployment configuration.

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

Method definition
def get_deployment_config(
    self,
    *,
    deploymentConfigName: str,
) -> GetDeploymentConfigOutputTypeDef:  # (1)
    ...
  1. See GetDeploymentConfigOutputTypeDef
Usage example with kwargs
kwargs: GetDeploymentConfigInputRequestTypeDef = {  # (1)
    "deploymentConfigName": ...,
}

parent.get_deployment_config(**kwargs)
  1. See GetDeploymentConfigInputRequestTypeDef

get_deployment_group

Gets information about a deployment group.

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

Method definition
def get_deployment_group(
    self,
    *,
    applicationName: str,
    deploymentGroupName: str,
) -> GetDeploymentGroupOutputTypeDef:  # (1)
    ...
  1. See GetDeploymentGroupOutputTypeDef
Usage example with kwargs
kwargs: GetDeploymentGroupInputRequestTypeDef = {  # (1)
    "applicationName": ...,
    "deploymentGroupName": ...,
}

parent.get_deployment_group(**kwargs)
  1. See GetDeploymentGroupInputRequestTypeDef

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

Method definition
def get_deployment_instance(
    self,
    *,
    deploymentId: str,
    instanceId: str,
) -> GetDeploymentInstanceOutputTypeDef:  # (1)
    ...
  1. See GetDeploymentInstanceOutputTypeDef
Usage example with kwargs
kwargs: GetDeploymentInstanceInputRequestTypeDef = {  # (1)
    "deploymentId": ...,
    "instanceId": ...,
}

parent.get_deployment_instance(**kwargs)
  1. See GetDeploymentInstanceInputRequestTypeDef

get_deployment_target

Returns information about a deployment target.

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

Method definition
def get_deployment_target(
    self,
    *,
    deploymentId: str = ...,
    targetId: str = ...,
) -> GetDeploymentTargetOutputTypeDef:  # (1)
    ...
  1. See GetDeploymentTargetOutputTypeDef
Usage example with kwargs
kwargs: GetDeploymentTargetInputRequestTypeDef = {  # (1)
    "deploymentId": ...,
}

parent.get_deployment_target(**kwargs)
  1. See GetDeploymentTargetInputRequestTypeDef

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

Method definition
def get_on_premises_instance(
    self,
    *,
    instanceName: str,
) -> GetOnPremisesInstanceOutputTypeDef:  # (1)
    ...
  1. See GetOnPremisesInstanceOutputTypeDef
Usage example with kwargs
kwargs: GetOnPremisesInstanceInputRequestTypeDef = {  # (1)
    "instanceName": ...,
}

parent.get_on_premises_instance(**kwargs)
  1. See GetOnPremisesInstanceInputRequestTypeDef

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

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
Usage example with kwargs
kwargs: ListApplicationRevisionsInputRequestTypeDef = {  # (1)
    "applicationName": ...,
}

parent.list_application_revisions(**kwargs)
  1. See ListApplicationRevisionsInputRequestTypeDef

list_applications

Lists the applications registered with the IAM user or AWS account.

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

Method definition
def list_applications(
    self,
    *,
    nextToken: str = ...,
) -> ListApplicationsOutputTypeDef:  # (1)
    ...
  1. See ListApplicationsOutputTypeDef
Usage example with kwargs
kwargs: ListApplicationsInputRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_applications(**kwargs)
  1. See ListApplicationsInputRequestTypeDef

list_deployment_configs

Lists the deployment configurations with the IAM user or AWS account.

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

Method definition
def list_deployment_configs(
    self,
    *,
    nextToken: str = ...,
) -> ListDeploymentConfigsOutputTypeDef:  # (1)
    ...
  1. See ListDeploymentConfigsOutputTypeDef
Usage example with kwargs
kwargs: ListDeploymentConfigsInputRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_deployment_configs(**kwargs)
  1. See ListDeploymentConfigsInputRequestTypeDef

list_deployment_groups

Lists the deployment groups for an application registered with the IAM user or AWS account.

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

Method definition
def list_deployment_groups(
    self,
    *,
    applicationName: str,
    nextToken: str = ...,
) -> ListDeploymentGroupsOutputTypeDef:  # (1)
    ...
  1. See ListDeploymentGroupsOutputTypeDef
Usage example with kwargs
kwargs: ListDeploymentGroupsInputRequestTypeDef = {  # (1)
    "applicationName": ...,
}

parent.list_deployment_groups(**kwargs)
  1. See ListDeploymentGroupsInputRequestTypeDef

list_deployment_instances

.

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

Method definition
def list_deployment_instances(
    self,
    *,
    deploymentId: str,
    nextToken: str = ...,
    instanceStatusFilter: Sequence[InstanceStatusType] = ...,  # (1)
    instanceTypeFilter: Sequence[InstanceTypeType] = ...,  # (2)
) -> ListDeploymentInstancesOutputTypeDef:  # (3)
    ...
  1. See InstanceStatusType
  2. See InstanceTypeType
  3. See ListDeploymentInstancesOutputTypeDef
Usage example with kwargs
kwargs: ListDeploymentInstancesInputRequestTypeDef = {  # (1)
    "deploymentId": ...,
}

parent.list_deployment_instances(**kwargs)
  1. See ListDeploymentInstancesInputRequestTypeDef

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

Method definition
def list_deployment_targets(
    self,
    *,
    deploymentId: str = ...,
    nextToken: str = ...,
    targetFilters: Mapping[TargetFilterNameType, Sequence[str]] = ...,  # (1)
) -> ListDeploymentTargetsOutputTypeDef:  # (2)
    ...
  1. See TargetFilterNameType
  2. See ListDeploymentTargetsOutputTypeDef
Usage example with kwargs
kwargs: ListDeploymentTargetsInputRequestTypeDef = {  # (1)
    "deploymentId": ...,
}

parent.list_deployment_targets(**kwargs)
  1. See ListDeploymentTargetsInputRequestTypeDef

list_deployments

Lists the deployments in a deployment group for an application registered with the IAM user or AWS account.

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

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 DeploymentStatusType
  2. See TimeRangeTypeDef
  3. See ListDeploymentsOutputTypeDef
Usage example with kwargs
kwargs: ListDeploymentsInputRequestTypeDef = {  # (1)
    "applicationName": ...,
}

parent.list_deployments(**kwargs)
  1. See ListDeploymentsInputRequestTypeDef

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

Method definition
def list_git_hub_account_token_names(
    self,
    *,
    nextToken: str = ...,
) -> ListGitHubAccountTokenNamesOutputTypeDef:  # (1)
    ...
  1. See ListGitHubAccountTokenNamesOutputTypeDef
Usage example with kwargs
kwargs: ListGitHubAccountTokenNamesInputRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_git_hub_account_token_names(**kwargs)
  1. See ListGitHubAccountTokenNamesInputRequestTypeDef

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

Method definition
def list_on_premises_instances(
    self,
    *,
    registrationStatus: RegistrationStatusType = ...,  # (1)
    tagFilters: Sequence[TagFilterTypeDef] = ...,  # (2)
    nextToken: str = ...,
) -> ListOnPremisesInstancesOutputTypeDef:  # (3)
    ...
  1. See RegistrationStatusType
  2. See TagFilterTypeDef
  3. See ListOnPremisesInstancesOutputTypeDef
Usage example with kwargs
kwargs: ListOnPremisesInstancesInputRequestTypeDef = {  # (1)
    "registrationStatus": ...,
}

parent.list_on_premises_instances(**kwargs)
  1. See ListOnPremisesInstancesInputRequestTypeDef

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

Method definition
def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
    NextToken: str = ...,
) -> ListTagsForResourceOutputTypeDef:  # (1)
    ...
  1. See ListTagsForResourceOutputTypeDef
Usage example with kwargs
kwargs: ListTagsForResourceInputRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceInputRequestTypeDef

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

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
Usage example with kwargs
kwargs: PutLifecycleEventHookExecutionStatusInputRequestTypeDef = {  # (1)
    "deploymentId": ...,
}

parent.put_lifecycle_event_hook_execution_status(**kwargs)
  1. See PutLifecycleEventHookExecutionStatusInputRequestTypeDef

register_application_revision

Registers with AWS CodeDeploy a revision for the specified application.

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

Method definition
def register_application_revision(
    self,
    *,
    applicationName: str,
    revision: RevisionLocationTypeDef,  # (1)
    description: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See RevisionLocationTypeDef
  2. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: RegisterApplicationRevisionInputRequestTypeDef = {  # (1)
    "applicationName": ...,
    "revision": ...,
}

parent.register_application_revision(**kwargs)
  1. See RegisterApplicationRevisionInputRequestTypeDef

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

Method definition
def register_on_premises_instance(
    self,
    *,
    instanceName: str,
    iamSessionArn: str = ...,
    iamUserArn: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: RegisterOnPremisesInstanceInputRequestTypeDef = {  # (1)
    "instanceName": ...,
}

parent.register_on_premises_instance(**kwargs)
  1. See RegisterOnPremisesInstanceInputRequestTypeDef

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

Method definition
def remove_tags_from_on_premises_instances(
    self,
    *,
    tags: Sequence[TagTypeDef],  # (1)
    instanceNames: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: RemoveTagsFromOnPremisesInstancesInputRequestTypeDef = {  # (1)
    "tags": ...,
    "instanceNames": ...,
}

parent.remove_tags_from_on_premises_instances(**kwargs)
  1. See RemoveTagsFromOnPremisesInstancesInputRequestTypeDef

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

Method definition
def skip_wait_time_for_instance_termination(
    self,
    *,
    deploymentId: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: SkipWaitTimeForInstanceTerminationInputRequestTypeDef = {  # (1)
    "deploymentId": ...,
}

parent.skip_wait_time_for_instance_termination(**kwargs)
  1. See SkipWaitTimeForInstanceTerminationInputRequestTypeDef

stop_deployment

Attempts to stop an ongoing deployment.

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

Method definition
def stop_deployment(
    self,
    *,
    deploymentId: str,
    autoRollbackEnabled: bool = ...,
) -> StopDeploymentOutputTypeDef:  # (1)
    ...
  1. See StopDeploymentOutputTypeDef
Usage example with kwargs
kwargs: StopDeploymentInputRequestTypeDef = {  # (1)
    "deploymentId": ...,
}

parent.stop_deployment(**kwargs)
  1. See StopDeploymentInputRequestTypeDef

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

Method definition
def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See TagTypeDef
Usage example with kwargs
kwargs: TagResourceInputRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceInputRequestTypeDef

untag_resource

Disassociates a resource from a list of tags.

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

Method definition
def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UntagResourceInputRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceInputRequestTypeDef

update_application

Changes the name of an application.

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

Method definition
def update_application(
    self,
    *,
    applicationName: str = ...,
    newApplicationName: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: UpdateApplicationInputRequestTypeDef = {  # (1)
    "applicationName": ...,
}

parent.update_application(**kwargs)
  1. See UpdateApplicationInputRequestTypeDef

update_deployment_group

Changes information about a deployment group.

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

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[TriggerConfigTypeDef] = ...,  # (3)
    alarmConfiguration: AlarmConfigurationTypeDef = ...,  # (4)
    autoRollbackConfiguration: AutoRollbackConfigurationTypeDef = ...,  # (5)
    outdatedInstancesStrategy: OutdatedInstancesStrategyType = ...,  # (6)
    deploymentStyle: DeploymentStyleTypeDef = ...,  # (7)
    blueGreenDeploymentConfiguration: BlueGreenDeploymentConfigurationTypeDef = ...,  # (8)
    loadBalancerInfo: LoadBalancerInfoTypeDef = ...,  # (9)
    ec2TagSet: EC2TagSetTypeDef = ...,  # (10)
    ecsServices: Sequence[ECSServiceTypeDef] = ...,  # (11)
    onPremisesTagSet: OnPremisesTagSetTypeDef = ...,  # (12)
) -> UpdateDeploymentGroupOutputTypeDef:  # (13)
    ...
  1. See EC2TagFilterTypeDef
  2. See TagFilterTypeDef
  3. See