Skip to content

Examples

Index > SSMIncidents > Examples

Auto-generated documentation for SSMIncidents type annotations stubs module types-aiobotocore-ssm-incidents.

Client

Implicit type annotations

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

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

Client usage example
from aioboto3.session import Session


session = Session()

async with session.client("ssm-incidents") as client:  # (1)
    result = await client.create_replication_set()  # (2)
  1. client: SSMIncidentsClient
  2. result: CreateReplicationSetOutputTypeDef
Paginator usage example
from aioboto3.session import Session


session = Session()

async with session.client("ssm-incidents") as client:  # (1)
    paginator = client.get_paginator("get_resource_policies")  # (2)
    async for item in paginator.paginate(...):
        print(item)  # (3)
  1. client: SSMIncidentsClient
  2. paginator: GetResourcePoliciesPaginator
  3. item: GetResourcePoliciesOutputTypeDef
Waiter usage example
from aioboto3.session import Session


session = Session()

async with session.client("ssm-incidents") as client:  # (1)
    waiter = client.get_waiter("wait_for_replication_set_active")  # (2)
    await waiter.wait()
  1. client: SSMIncidentsClient
  2. waiter: WaitForReplicationSetActiveWaiter

Explicit type annotations

With types-aioboto3-lite[ssm-incidents] or a standalone types_aiobotocore_ssm_incidents package, you have to explicitly specify client: SSMIncidentsClient 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.

Client usage example
from aioboto3.session import Session

from types_aiobotocore_ssm_incidents.client import SSMIncidentsClient
from types_aiobotocore_ssm_incidents.type_defs import CreateReplicationSetOutputTypeDef
from types_aiobotocore_ssm_incidents.type_defs import CreateReplicationSetInputRequestTypeDef


session = Session()

client: SSMIncidentsClient
async with session.client("ssm-incidents") as client:  # (1)
    kwargs: CreateReplicationSetInputRequestTypeDef = {...}  # (2)
    result: CreateReplicationSetOutputTypeDef = await client.create_replication_set(**kwargs)  # (3)
  1. client: SSMIncidentsClient
  2. kwargs: CreateReplicationSetInputRequestTypeDef
  3. result: CreateReplicationSetOutputTypeDef
Paginator usage example
from aioboto3.session import Session

from types_aiobotocore_ssm_incidents.client import SSMIncidentsClient
from types_aiobotocore_ssm_incidents.paginator import GetResourcePoliciesPaginator
from types_aiobotocore_ssm_incidents.type_defs import GetResourcePoliciesOutputTypeDef


session = Session()

client: SSMIncidentsClient
async with session.client("ssm-incidents") as client:  # (1)
    paginator: GetResourcePoliciesPaginator = client.get_paginator("get_resource_policies")  # (2)
    async for item in paginator.paginate(...):
        item: GetResourcePoliciesOutputTypeDef
        print(item)  # (3)
  1. client: SSMIncidentsClient
  2. paginator: GetResourcePoliciesPaginator
  3. item: GetResourcePoliciesOutputTypeDef
Waiter usage example
from aioboto3.session import Session

from types_aiobotocore_ssm_incidents.client import SSMIncidentsClient
from types_aiobotocore_ssm_incidents.waiter import WaitForReplicationSetActiveWaiter


session = Session()

async with session.client("ssm-incidents") as client:  # (1)
    waiter = client.get_waiter("wait_for_replication_set_active")  # (2)
    await waiter.wait()
  1. client: SSMIncidentsClient
  2. waiter: WaitForReplicationSetActiveWaiter