Examples

Index > Glacier > Examples

Auto-generated documentation for Glacier type annotations stubs module types-aiobotocore-glacier.

Client

Implicit type annotations

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

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

# GlacierClient usage example

from aioboto3.session import Session


session = Session()

async with session.client("glacier") as client:  # (1)
    result = await client.abort_multipart_upload()  # (2)

1. client: GlacierClient
2. result: EmptyResponseMetadataTypeDef

# ListJobsPaginator usage example

from aioboto3.session import Session


session = Session()

async with session.client("glacier") as client:  # (1)
    paginator = client.get_paginator("list_jobs")  # (2)
    async for item in paginator.paginate(...):
        print(item)  # (3)

1. client: GlacierClient
2. paginator: ListJobsPaginator
3. item: ListJobsOutputTypeDef

# VaultExistsWaiter usage example

from aioboto3.session import Session


session = Session()

async with session.client("glacier") as client:  # (1)
    waiter = client.get_waiter("vault_exists")  # (2)
    await waiter.wait()

1. client: GlacierClient
2. waiter: VaultExistsWaiter

Explicit type annotations

With types-aioboto3-lite[glacier] or a standalone types_aiobotocore_glacier package, you have to explicitly specify client: GlacierClient 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.

# GlacierClient usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_glacier.client import GlacierClient
from types_aiobotocore_glacier.type_defs import EmptyResponseMetadataTypeDef
from types_aiobotocore_glacier.type_defs import AbortMultipartUploadInputRequestTypeDef


session = Session()

client: GlacierClient
async with session.client("glacier") as client:  # (1)
    kwargs: AbortMultipartUploadInputRequestTypeDef = {...}  # (2)
    result: EmptyResponseMetadataTypeDef = await client.abort_multipart_upload(**kwargs)  # (3)

1. client: GlacierClient
2. kwargs: AbortMultipartUploadInputRequestTypeDef
3. result: EmptyResponseMetadataTypeDef

# ListJobsPaginator usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_glacier.client import GlacierClient
from types_aiobotocore_glacier.paginator import ListJobsPaginator
from types_aiobotocore_glacier.type_defs import ListJobsOutputTypeDef


session = Session()

client: GlacierClient
async with session.client("glacier") as client:  # (1)
    paginator: ListJobsPaginator = client.get_paginator("list_jobs")  # (2)
    async for item in paginator.paginate(...):
        item: ListJobsOutputTypeDef
        print(item)  # (3)

1. client: GlacierClient
2. paginator: ListJobsPaginator
3. item: ListJobsOutputTypeDef

# VaultExistsWaiter usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_glacier.client import GlacierClient
from types_aiobotocore_glacier.waiter import VaultExistsWaiter


session = Session()

async with session.client("glacier") as client:  # (1)
    waiter = client.get_waiter("vault_exists")  # (2)
    await waiter.wait()

1. client: GlacierClient
2. waiter: VaultExistsWaiter

Service Resource

Implicit type annotations

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

# GlacierServiceResource usage example

from aioboto3.session import Session


session = Session()

async with session.resource("glacier") as resource:  # (1)
    result = resource.Account()  # (2)

1. resource: GlacierServiceResource
2. result:

# ServiceResourceVaultsCollection usage example

from aioboto3.session import Session


session = Session()
resource = session.resource("glacier")  # (1)

collection = resource.vaults  # (2)
for item in collection:
    print(item)  # (3)

1. resource: GlacierServiceResource
2. collection: GlacierServiceResource
3. item: Vault

Explicit type annotations

With types-aioboto3-lite[glacier] or a standalone types_aiobotocore_glacier package, you have to explicitly specify resource: GlacierServiceResource 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.

# GlacierServiceResource usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_glacier.service_resource import GlacierServiceResource
from types_aiobotocore_glacier.service_resource import Account


session = Session()

resource: GlacierServiceResource
async with session.resource("glacier") as resource:  # (1)
    result: Account = resource.Account() # (2)

1. resource: GlacierServiceResource
2. result:

# ServiceResourceVaultsCollection usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_glacier.service_resource import GlacierServiceResource
from types_aiobotocore_glacier.service_resource import ServiceResourceVaultsCollection
from types_aiobotocore_glacier.service_resource import Vault


session = Session()

resource: GlacierServiceResource
async with session.resource("glacier") as resource:  # (1)
    collection: ServiceResourceVaultsCollection = resource.vaults  # (2)
    for item in collection:
        item: Vault
        print(item)  # (3)

1. resource: GlacierServiceResource
2. collection: GlacierServiceResource
3. item: Vault