Skip to content

CodeDeploy module#

Index > CodeDeploy

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

How to install#

You can generate type annotations for boto3 package locally with mypy_boto3_builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.35.86' mypy_boto3_builder
  2. Select boto3-stubs AWS SDK.
  3. Add CodeDeploy service.
  4. Use provided commands to install generated packages.

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and CodeDeploy.

From PyPI with pip#

Install boto3-stubs for CodeDeploy service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[codedeploy]'

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[codedeploy]'

# standalone installation
python -m pip install mypy-boto3-codedeploy

How to uninstall#

python -m pip uninstall -y mypy-boto3-codedeploy

Usage#

Code samples can be found in Examples.

CodeDeployClient#

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

# CodeDeployClient usage example

from boto3.session import Session

from mypy_boto3_codedeploy.client import CodeDeployClient

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

Paginators#

Type annotations and code completion for paginators from boto3.client("codedeploy").get_paginator("...").

# ListApplicationRevisionsPaginator usage example

from boto3.session import Session

from mypy_boto3_codedeploy.paginator import ListApplicationRevisionsPaginator

def get_list_application_revisions_paginator() -> ListApplicationRevisionsPaginator:
    return Session().client("codedeploy").get_paginator("list_application_revisions"))

Waiters#

Type annotations and code completion for waiters from boto3.client("codedeploy").get_waiter("...").

# DeploymentSuccessfulWaiter usage example

from boto3.session import Session

from mypy_boto3_codedeploy.waiter import DeploymentSuccessfulWaiter

def get_deployment_successful_waiter() -> DeploymentSuccessfulWaiter:
    return Session().client("codedeploy").get_waiter("deployment_successful")

Literals#

Type annotations for literals used in methods and schema.

# ApplicationRevisionSortByType usage example

from mypy_boto3_codedeploy.literals import ApplicationRevisionSortByType

def get_value() -> ApplicationRevisionSortByType:
    return "firstUsedTime"

Type definitions#

Type annotations for type definitions used in methods and schema.