Skip to content

Examples#

Index > CodeDeploy > Examples

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

Client#

Implicit type annotations#

Can be used with types-aioboto3[codedeploy] package installed.

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

# CodeDeployClient usage example

from aioboto3.session import Session


session = Session()

async with session.client("codedeploy") as client:  # (1)
    result = await client.add_tags_to_on_premises_instances()  # (2)
  1. client: CodeDeployClient
  2. result: EmptyResponseMetadataTypeDef
# ListApplicationRevisionsPaginator usage example

from aioboto3.session import Session


session = Session()

async with session.client("codedeploy") as client:  # (1)
    paginator = client.get_paginator("list_application_revisions")  # (2)
    async for item in paginator.paginate(...):
        print(item)  # (3)
  1. client: CodeDeployClient
  2. paginator: ListApplicationRevisionsPaginator
  3. item: ListApplicationRevisionsOutputTypeDef
# DeploymentSuccessfulWaiter usage example

from aioboto3.session import Session


session = Session()

async with session.client("codedeploy") as client:  # (1)
    waiter = client.get_waiter("deployment_successful")  # (2)
    await waiter.wait()
  1. client: CodeDeployClient
  2. waiter: DeploymentSuccessfulWaiter

Explicit type annotations#

With types-aioboto3-lite[codedeploy] or a standalone types_aiobotocore_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 aioboto3.session import Session

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


session = Session()

client: CodeDeployClient
async with session.client("codedeploy") as client:  # (1)
    kwargs: AddTagsToOnPremisesInstancesInputRequestTypeDef = {...}  # (2)
    result: EmptyResponseMetadataTypeDef = await client.add_tags_to_on_premises_instances(**kwargs)  # (3)
  1. client: CodeDeployClient
  2. kwargs: AddTagsToOnPremisesInstancesInputRequestTypeDef
  3. result: EmptyResponseMetadataTypeDef
# ListApplicationRevisionsPaginator usage example with type annotations

from aioboto3.session import Session

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


session = Session()

client: CodeDeployClient
async with session.client("codedeploy") as client:  # (1)
    paginator: ListApplicationRevisionsPaginator = client.get_paginator("list_application_revisions")  # (2)
    async for item in paginator.paginate(...):
        item: ListApplicationRevisionsOutputTypeDef
        print(item)  # (3)
  1. client: CodeDeployClient
  2. paginator: ListApplicationRevisionsPaginator
  3. item: ListApplicationRevisionsOutputTypeDef
# DeploymentSuccessfulWaiter usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_codedeploy.client import CodeDeployClient
from types_aiobotocore_codedeploy.waiter import DeploymentSuccessfulWaiter


session = Session()

async with session.client("codedeploy") as client:  # (1)
    waiter = client.get_waiter("deployment_successful")  # (2)
    await waiter.wait()
  1. client: CodeDeployClient
  2. waiter: DeploymentSuccessfulWaiter