Examples

Index > CodeDeploy > Examples

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

Client

Implicit type annotations

Can be used with boto3-stubs[codedeploy] package installed.

Write your CodeDeploy code as usual, type checking and code completion should work out of the box.

# CodeDeployClient usage example

from boto3.session import Session


session = Session()

client = session.client("codedeploy")  # (1)
result = client.add_tags_to_on_premises_instances()  # (2)

1. client: CodeDeployClient
2. result: EmptyResponseMetadataTypeDef

# ListApplicationRevisionsPaginator usage example

from boto3.session import Session


session = Session()
client = session.client("codedeploy")  # (1)

paginator = client.get_paginator("list_application_revisions")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: CodeDeployClient
2. paginator: ListApplicationRevisionsPaginator
3. item: ListApplicationRevisionsOutputTypeDef

# DeploymentSuccessfulWaiter usage example

from boto3.session import Session


session = Session()
client = session.client("codedeploy")  # (1)

waiter = client.get_waiter("deployment_successful")  # (2)
waiter.wait()

1. client: CodeDeployClient
2. waiter: DeploymentSuccessfulWaiter

Explicit type annotations

With boto3-stubs-lite[codedeploy] or a standalone mypy_boto3_codedeploy package, you have to explicitly specify client: CodeDeployClient type annotation.

All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.

# CodeDeployClient usage example with type annotations

from boto3.session import Session

from mypy_boto3_codedeploy.client import CodeDeployClient
from mypy_boto3_codedeploy.type_defs import EmptyResponseMetadataTypeDef
from mypy_boto3_codedeploy.type_defs import AddTagsToOnPremisesInstancesInputRequestTypeDef


session = Session()

client: CodeDeployClient = session.client("codedeploy")

kwargs: AddTagsToOnPremisesInstancesInputRequestTypeDef = {...}
result: EmptyResponseMetadataTypeDef = client.add_tags_to_on_premises_instances(**kwargs)

# ListApplicationRevisionsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_codedeploy.client import CodeDeployClient
from mypy_boto3_codedeploy.paginator import ListApplicationRevisionsPaginator
from mypy_boto3_codedeploy.type_defs import ListApplicationRevisionsOutputTypeDef


session = Session()
client: CodeDeployClient = session.client("codedeploy")

paginator: ListApplicationRevisionsPaginator = client.get_paginator("list_application_revisions")
for item in paginator.paginate(...):
    item: ListApplicationRevisionsOutputTypeDef
    print(item)

# DeploymentSuccessfulWaiter usage example with type annotations

from boto3.session import Session

from mypy_boto3_codedeploy.client import CodeDeployClient
from mypy_boto3_codedeploy.waiter import DeploymentSuccessfulWaiter

session = Session()
client: CodeDeployClient = session.client("codedeploy")

waiter: DeploymentSuccessfulWaiter = client.get_waiter("deployment_successful")
waiter.wait()