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
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.
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)
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
def add_tags_to_on_premises_instances(
self,
*,
tags: Sequence[TagTypeDef], # (1)
instanceNames: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: AddTagsToOnPremisesInstancesInputRequestTypeDef = { # (1)
"tags": ...,
"instanceNames": ...,
}
parent.add_tags_to_on_premises_instances(**kwargs)
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
def batch_get_application_revisions(
self,
*,
applicationName: str,
revisions: Sequence[RevisionLocationTypeDef], # (1)
) -> BatchGetApplicationRevisionsOutputTypeDef: # (2)
...
kwargs: BatchGetApplicationRevisionsInputRequestTypeDef = { # (1)
"applicationName": ...,
"revisions": ...,
}
parent.batch_get_application_revisions(**kwargs)
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
def batch_get_applications(
self,
*,
applicationNames: Sequence[str],
) -> BatchGetApplicationsOutputTypeDef: # (1)
...
kwargs: BatchGetApplicationsInputRequestTypeDef = { # (1)
"applicationNames": ...,
}
parent.batch_get_applications(**kwargs)
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
def batch_get_deployment_groups(
self,
*,
applicationName: str,
deploymentGroupNames: Sequence[str],
) -> BatchGetDeploymentGroupsOutputTypeDef: # (1)
...
kwargs: BatchGetDeploymentGroupsInputRequestTypeDef = { # (1)
"applicationName": ...,
"deploymentGroupNames": ...,
}
parent.batch_get_deployment_groups(**kwargs)
batch_get_deployment_instances
.
Type annotations and code completion for boto3.client("codedeploy").batch_get_deployment_instances
method.
boto3 documentation
def batch_get_deployment_instances(
self,
*,
deploymentId: str,
instanceIds: Sequence[str],
) -> BatchGetDeploymentInstancesOutputTypeDef: # (1)
...
kwargs: BatchGetDeploymentInstancesInputRequestTypeDef = { # (1)
"deploymentId": ...,
"instanceIds": ...,
}
parent.batch_get_deployment_instances(**kwargs)
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
def batch_get_deployment_targets(
self,
*,
deploymentId: str = ...,
targetIds: Sequence[str] = ...,
) -> BatchGetDeploymentTargetsOutputTypeDef: # (1)
...
kwargs: BatchGetDeploymentTargetsInputRequestTypeDef = { # (1)
"deploymentId": ...,
}
parent.batch_get_deployment_targets(**kwargs)
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
def batch_get_deployments(
self,
*,
deploymentIds: Sequence[str],
) -> BatchGetDeploymentsOutputTypeDef: # (1)
...
kwargs: BatchGetDeploymentsInputRequestTypeDef = { # (1)
"deploymentIds": ...,
}
parent.batch_get_deployments(**kwargs)
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
def batch_get_on_premises_instances(
self,
*,
instanceNames: Sequence[str],
) -> BatchGetOnPremisesInstancesOutputTypeDef: # (1)
...
kwargs: BatchGetOnPremisesInstancesInputRequestTypeDef = { # (1)
"instanceNames": ...,
}
parent.batch_get_on_premises_instances(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("codedeploy").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("codedeploy").close
method.
boto3 documentation
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
def continue_deployment(
self,
*,
deploymentId: str = ...,
deploymentWaitType: DeploymentWaitTypeType = ..., # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: ContinueDeploymentInputRequestTypeDef = { # (1)
"deploymentId": ...,
}
parent.continue_deployment(**kwargs)
create_application
Creates an application.
Type annotations and code completion for boto3.client("codedeploy").create_application
method.
boto3 documentation
def create_application(
self,
*,
applicationName: str,
computePlatform: ComputePlatformType = ..., # (1)
tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateApplicationOutputTypeDef: # (3)
...
kwargs: CreateApplicationInputRequestTypeDef = { # (1)
"applicationName": ...,
}
parent.create_application(**kwargs)
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
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)
overrideAlarmConfiguration: AlarmConfigurationTypeDef = ..., # (5)
) -> CreateDeploymentOutputTypeDef: # (6)
...
- See RevisionLocationTypeDef
- See TargetInstancesTypeDef
- See AutoRollbackConfigurationTypeDef
- See FileExistsBehaviorType
- See AlarmConfigurationTypeDef
- See CreateDeploymentOutputTypeDef
kwargs: CreateDeploymentInputRequestTypeDef = { # (1)
"applicationName": ...,
}
parent.create_deployment(**kwargs)
create_deployment_config
Creates a deployment configuration.
Type annotations and code completion for boto3.client("codedeploy").create_deployment_config
method.
boto3 documentation
def create_deployment_config(
self,
*,
deploymentConfigName: str,
minimumHealthyHosts: MinimumHealthyHostsTypeDef = ..., # (1)
trafficRoutingConfig: TrafficRoutingConfigTypeDef = ..., # (2)
computePlatform: ComputePlatformType = ..., # (3)
) -> CreateDeploymentConfigOutputTypeDef: # (4)
...
- See MinimumHealthyHostsTypeDef
- See TrafficRoutingConfigTypeDef
- See ComputePlatformType
- See CreateDeploymentConfigOutputTypeDef
kwargs: CreateDeploymentConfigInputRequestTypeDef = { # (1)
"deploymentConfigName": ...,
}
parent.create_deployment_config(**kwargs)
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
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)
...
- See EC2TagFilterTypeDef
- See TagFilterTypeDef
- See TriggerConfigTypeDef
- See AlarmConfigurationTypeDef
- See AutoRollbackConfigurationTypeDef
- See OutdatedInstancesStrategyType
- See DeploymentStyleTypeDef
- See BlueGreenDeploymentConfigurationTypeDef
- See LoadBalancerInfoTypeDef
- See EC2TagSetTypeDef
- See ECSServiceTypeDef
- See OnPremisesTagSetTypeDef
- See TagTypeDef
- See CreateDeploymentGroupOutputTypeDef
kwargs: CreateDeploymentGroupInputRequestTypeDef = { # (1)
"applicationName": ...,
"deploymentGroupName": ...,
"serviceRoleArn": ...,
}
parent.create_deployment_group(**kwargs)
delete_application
Deletes an application.
Type annotations and code completion for boto3.client("codedeploy").delete_application
method.
boto3 documentation
def delete_application(
self,
*,
applicationName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteApplicationInputRequestTypeDef = { # (1)
"applicationName": ...,
}
parent.delete_application(**kwargs)
delete_deployment_config
Deletes a deployment configuration.
Type annotations and code completion for boto3.client("codedeploy").delete_deployment_config
method.
boto3 documentation
def delete_deployment_config(
self,
*,
deploymentConfigName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteDeploymentConfigInputRequestTypeDef = { # (1)
"deploymentConfigName": ...,
}
parent.delete_deployment_config(**kwargs)
delete_deployment_group
Deletes a deployment group.
Type annotations and code completion for boto3.client("codedeploy").delete_deployment_group
method.
boto3 documentation
def delete_deployment_group(
self,
*,
applicationName: str,
deploymentGroupName: str,
) -> DeleteDeploymentGroupOutputTypeDef: # (1)
...
kwargs: DeleteDeploymentGroupInputRequestTypeDef = { # (1)
"applicationName": ...,
"deploymentGroupName": ...,
}
parent.delete_deployment_group(**kwargs)
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
def delete_git_hub_account_token(
self,
*,
tokenName: str = ...,
) -> DeleteGitHubAccountTokenOutputTypeDef: # (1)
...
kwargs: DeleteGitHubAccountTokenInputRequestTypeDef = { # (1)
"tokenName": ...,
}
parent.delete_git_hub_account_token(**kwargs)
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
def delete_resources_by_external_id(
self,
*,
externalId: str = ...,
) -> Dict[str, Any]:
...
kwargs: DeleteResourcesByExternalIdInputRequestTypeDef = { # (1)
"externalId": ...,
}
parent.delete_resources_by_external_id(**kwargs)
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
def deregister_on_premises_instance(
self,
*,
instanceName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeregisterOnPremisesInstanceInputRequestTypeDef = { # (1)
"instanceName": ...,
}
parent.deregister_on_premises_instance(**kwargs)
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
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
def get_application(
self,
*,
applicationName: str,
) -> GetApplicationOutputTypeDef: # (1)
...
kwargs: GetApplicationInputRequestTypeDef = { # (1)
"applicationName": ...,
}
parent.get_application(**kwargs)
get_application_revision
Gets information about an application revision.
Type annotations and code completion for boto3.client("codedeploy").get_application_revision
method.
boto3 documentation
def get_application_revision(
self,
*,
applicationName: str,
revision: RevisionLocationTypeDef, # (1)
) -> GetApplicationRevisionOutputTypeDef: # (2)
...
kwargs: GetApplicationRevisionInputRequestTypeDef = { # (1)
"applicationName": ...,
"revision": ...,
}
parent.get_application_revision(**kwargs)
get_deployment
Gets information about a deployment.
Type annotations and code completion for boto3.client("codedeploy").get_deployment
method.
boto3 documentation
def get_deployment(
self,
*,
deploymentId: str,
) -> GetDeploymentOutputTypeDef: # (1)
...
kwargs: GetDeploymentInputRequestTypeDef = { # (1)
"deploymentId": ...,
}
parent.get_deployment(**kwargs)
get_deployment_config
Gets information about a deployment configuration.
Type annotations and code completion for boto3.client("codedeploy").get_deployment_config
method.
boto3 documentation
def get_deployment_config(
self,
*,
deploymentConfigName: str,
) -> GetDeploymentConfigOutputTypeDef: # (1)
...
kwargs: GetDeploymentConfigInputRequestTypeDef = { # (1)
"deploymentConfigName": ...,
}
parent.get_deployment_config(**kwargs)
get_deployment_group
Gets information about a deployment group.
Type annotations and code completion for boto3.client("codedeploy").get_deployment_group
method.
boto3 documentation
def get_deployment_group(
self,
*,
applicationName: str,
deploymentGroupName: str,
) -> GetDeploymentGroupOutputTypeDef: # (1)
...
kwargs: GetDeploymentGroupInputRequestTypeDef = { # (1)
"applicationName": ...,
"deploymentGroupName": ...,
}
parent.get_deployment_group(**kwargs)
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
def get_deployment_instance(
self,
*,
deploymentId: str,
instanceId: str,
) -> GetDeploymentInstanceOutputTypeDef: # (1)
...
kwargs: GetDeploymentInstanceInputRequestTypeDef = { # (1)
"deploymentId": ...,
"instanceId": ...,
}
parent.get_deployment_instance(**kwargs)
get_deployment_target
Returns information about a deployment target.
Type annotations and code completion for boto3.client("codedeploy").get_deployment_target
method.
boto3 documentation
def get_deployment_target(
self,
*,
deploymentId: str = ...,
targetId: str = ...,
) -> GetDeploymentTargetOutputTypeDef: # (1)
...
kwargs: GetDeploymentTargetInputRequestTypeDef = { # (1)
"deploymentId": ...,
}
parent.get_deployment_target(**kwargs)
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
def get_on_premises_instance(
self,
*,
instanceName: str,
) -> GetOnPremisesInstanceOutputTypeDef: # (1)
...
kwargs: GetOnPremisesInstanceInputRequestTypeDef = { # (1)
"instanceName": ...,
}
parent.get_on_premises_instance(**kwargs)
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
def list_application_revisions(
self,
*,
applicationName: str,
sortBy: ApplicationRevisionSortByType = ..., # (1)
sortOrder: SortOrderType = ..., # (2)
s3Bucket: str = ...,
s3KeyPrefix: str = ...,
deployed: ListStateFilterActionType = ..., # (3)
nextToken: str = ...,
) -> ListApplicationRevisionsOutputTypeDef: # (4)
...
- See ApplicationRevisionSortByType
- See SortOrderType
- See ListStateFilterActionType
- See ListApplicationRevisionsOutputTypeDef
kwargs: ListApplicationRevisionsInputRequestTypeDef = { # (1)
"applicationName": ...,
}
parent.list_application_revisions(**kwargs)
list_applications
Lists the applications registered with the IAM user or Amazon Web Services account.
Type annotations and code completion for boto3.client("codedeploy").list_applications
method.
boto3 documentation
def list_applications(
self,
*,
nextToken: str = ...,
) -> ListApplicationsOutputTypeDef: # (1)
...
kwargs: ListApplicationsInputRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_applications(**kwargs)
list_deployment_configs
Lists the deployment configurations with the IAM user or Amazon Web Services account.
Type annotations and code completion for boto3.client("codedeploy").list_deployment_configs
method.
boto3 documentation
def list_deployment_configs(
self,
*,
nextToken: str = ...,
) -> ListDeploymentConfigsOutputTypeDef: # (1)
...
kwargs: ListDeploymentConfigsInputRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_deployment_configs(**kwargs)
list_deployment_groups
Lists the deployment groups for an application registered with the IAM user or Amazon Web Services account.
Type annotations and code completion for boto3.client("codedeploy").list_deployment_groups
method.
boto3 documentation
def list_deployment_groups(
self,
*,
applicationName: str,
nextToken: str = ...,
) -> ListDeploymentGroupsOutputTypeDef: # (1)
...
kwargs: ListDeploymentGroupsInputRequestTypeDef = { # (1)
"applicationName": ...,
}
parent.list_deployment_groups(**kwargs)
list_deployment_instances
.
Type annotations and code completion for boto3.client("codedeploy").list_deployment_instances
method.
boto3 documentation
def list_deployment_instances(
self,
*,
deploymentId: str,
nextToken: str = ...,
instanceStatusFilter: Sequence[InstanceStatusType] = ..., # (1)
instanceTypeFilter: Sequence[InstanceTypeType] = ..., # (2)
) -> ListDeploymentInstancesOutputTypeDef: # (3)
...
kwargs: ListDeploymentInstancesInputRequestTypeDef = { # (1)
"deploymentId": ...,
}
parent.list_deployment_instances(**kwargs)
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
def list_deployment_targets(
self,
*,
deploymentId: str = ...,
nextToken: str = ...,
targetFilters: Mapping[TargetFilterNameType, Sequence[str]] = ..., # (1)
) -> ListDeploymentTargetsOutputTypeDef: # (2)
...
kwargs: ListDeploymentTargetsInputRequestTypeDef = { # (1)
"deploymentId": ...,
}
parent.list_deployment_targets(**kwargs)
list_deployments
Lists the deployments in a deployment group for an application registered with the IAM user or Amazon Web Services account.
Type annotations and code completion for boto3.client("codedeploy").list_deployments
method.
boto3 documentation
def list_deployments(
self,
*,
applicationName: str = ...,
deploymentGroupName: str = ...,
externalId: str = ...,
includeOnlyStatuses: Sequence[DeploymentStatusType] = ..., # (1)
createTimeRange: TimeRangeTypeDef = ..., # (2)
nextToken: str = ...,
) -> ListDeploymentsOutputTypeDef: # (3)
...
kwargs: ListDeploymentsInputRequestTypeDef = { # (1)
"applicationName": ...,
}
parent.list_deployments(**kwargs)
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
def list_git_hub_account_token_names(
self,
*,
nextToken: str = ...,
) -> ListGitHubAccountTokenNamesOutputTypeDef: # (1)
...
kwargs: ListGitHubAccountTokenNamesInputRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_git_hub_account_token_names(**kwargs)
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
def list_on_premises_instances(
self,
*,
registrationStatus: RegistrationStatusType = ..., # (1)
tagFilters: Sequence[TagFilterTypeDef] = ..., # (2)
nextToken: str = ...,
) -> ListOnPremisesInstancesOutputTypeDef: # (3)
...
kwargs: ListOnPremisesInstancesInputRequestTypeDef = { # (1)
"registrationStatus": ...,
}
parent.list_on_premises_instances(**kwargs)
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
def list_tags_for_resource(
self,
*,
ResourceArn: str,
NextToken: str = ...,
) -> ListTagsForResourceOutputTypeDef: # (1)
...
kwargs: ListTagsForResourceInputRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
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
def put_lifecycle_event_hook_execution_status(
self,
*,
deploymentId: str = ...,
lifecycleEventHookExecutionId: str = ...,
status: LifecycleEventStatusType = ..., # (1)
) -> PutLifecycleEventHookExecutionStatusOutputTypeDef: # (2)
...
kwargs: PutLifecycleEventHookExecutionStatusInputRequestTypeDef = { # (1)
"deploymentId": ...,
}
parent.put_lifecycle_event_hook_execution_status(**kwargs)
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
def register_application_revision(
self,
*,
applicationName: str,
revision: RevisionLocationTypeDef, # (1)
description: str = ...,
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: RegisterApplicationRevisionInputRequestTypeDef = { # (1)
"applicationName": ...,
"revision": ...,
}
parent.register_application_revision(**kwargs)
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
def register_on_premises_instance(
self,
*,
instanceName: str,
iamSessionArn: str = ...,
iamUserArn: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: RegisterOnPremisesInstanceInputRequestTypeDef = { # (1)
"instanceName": ...,
}
parent.register_on_premises_instance(**kwargs)
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
def remove_tags_from_on_premises_instances(
self,
*,
tags: Sequence[TagTypeDef], # (1)
instanceNames: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: RemoveTagsFromOnPremisesInstancesInputRequestTypeDef = { # (1)
"tags": ...,
"instanceNames": ...,
}
parent.remove_tags_from_on_premises_instances(**kwargs)
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
def skip_wait_time_for_instance_termination(
self,
*,
deploymentId: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: SkipWaitTimeForInstanceTerminationInputRequestTypeDef = { # (1)
"deploymentId": ...,
}
parent.skip_wait_time_for_instance_termination(**kwargs)
stop_deployment
Attempts to stop an ongoing deployment.
Type annotations and code completion for boto3.client("codedeploy").stop_deployment
method.
boto3 documentation
def stop_deployment(
self,
*,
deploymentId: str,
autoRollbackEnabled: bool = ...,
) -> StopDeploymentOutputTypeDef: # (1)
...
kwargs: StopDeploymentInputRequestTypeDef = { # (1)
"deploymentId": ...,
}
parent.stop_deployment(**kwargs)
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
def tag_resource(
self,
*,
ResourceArn: str,
Tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
kwargs: TagResourceInputRequestTypeDef = { # (1)
"ResourceArn": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Disassociates a resource from a list of tags.
Type annotations and code completion for boto3.client("codedeploy").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
ResourceArn: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceInputRequestTypeDef = { # (1)
"ResourceArn": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
update_application
Changes the name of an application.
Type annotations and code completion for boto3.client("codedeploy").update_application
method.
boto3 documentation
def update_application(
self,
*,
applicationName: str = ...,
newApplicationName: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UpdateApplicationInputRequestTypeDef = { # (1)
"applicationName": ...,
}
parent.update_application(**kwargs)
update_deployment_group
Changes information about a deployment group.
Type annotations and code completion for boto3.client("codedeploy").update_deployment_group
method.
boto3 documentation
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)
...
- See EC2TagFilterTypeDef
- See TagFilterTypeDef
- See TriggerConfigTypeDef
- See AlarmConfigurationTypeDef
- See AutoRollbackConfigurationTypeDef
- See OutdatedInstancesStrategyType
- See DeploymentStyleTypeDef
- See BlueGreenDeploymentConfigurationTypeDef
- See LoadBalancerInfoTypeDef
- See EC2TagSetTypeDef
- See ECSServiceTypeDef
- See OnPremisesTagSetTypeDef
- See UpdateDeploymentGroupOutputTypeDef
kwargs: UpdateDeploymentGroupInputRequestTypeDef = { # (1)
"applicationName": ...,
"currentDeploymentGroupName": ...,
}
parent.update_deployment_group(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("codedeploy").get_paginator
method with overloads.
client.get_paginator("list_application_revisions")
-> ListApplicationRevisionsPaginatorclient.get_paginator("list_applications")
-> ListApplicationsPaginatorclient.get_paginator("list_deployment_configs")
-> ListDeploymentConfigsPaginatorclient.get_paginator("list_deployment_groups")
-> ListDeploymentGroupsPaginatorclient.get_paginator("list_deployment_instances")
-> ListDeploymentInstancesPaginatorclient.get_paginator("list_deployment_targets")
-> ListDeploymentTargetsPaginatorclient.get_paginator("list_deployments")
-> ListDeploymentsPaginatorclient.get_paginator("list_git_hub_account_token_names")
-> ListGitHubAccountTokenNamesPaginatorclient.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