Typed dictionaries

Index > SimpleDB > Typed dictionaries

Auto-generated documentation for SimpleDB type annotations stubs module mypy-boto3-sdb.

AttributeTypeDef

# AttributeTypeDef usage example

from mypy_boto3_sdb.type_defs import AttributeTypeDef

def get_value() -> AttributeTypeDef:
    return {
        "Name": ...,
        "Value": ...,
    }

# AttributeTypeDef definition

class AttributeTypeDef(TypedDict):
    Name: str,
    Value: str,
    AlternateNameEncoding: NotRequired[str],
    AlternateValueEncoding: NotRequired[str],

CreateDomainRequestRequestTypeDef

# CreateDomainRequestRequestTypeDef usage example

from mypy_boto3_sdb.type_defs import CreateDomainRequestRequestTypeDef

def get_value() -> CreateDomainRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }

# CreateDomainRequestRequestTypeDef definition

class CreateDomainRequestRequestTypeDef(TypedDict):
    DomainName: str,

UpdateConditionTypeDef

# UpdateConditionTypeDef usage example

from mypy_boto3_sdb.type_defs import UpdateConditionTypeDef

def get_value() -> UpdateConditionTypeDef:
    return {
        "Name": ...,
    }

# UpdateConditionTypeDef definition

class UpdateConditionTypeDef(TypedDict):
    Name: NotRequired[str],
    Value: NotRequired[str],
    Exists: NotRequired[bool],

DeleteDomainRequestRequestTypeDef

# DeleteDomainRequestRequestTypeDef usage example

from mypy_boto3_sdb.type_defs import DeleteDomainRequestRequestTypeDef

def get_value() -> DeleteDomainRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }

# DeleteDomainRequestRequestTypeDef definition

class DeleteDomainRequestRequestTypeDef(TypedDict):
    DomainName: str,

DomainMetadataRequestRequestTypeDef

# DomainMetadataRequestRequestTypeDef usage example

from mypy_boto3_sdb.type_defs import DomainMetadataRequestRequestTypeDef

def get_value() -> DomainMetadataRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }

# DomainMetadataRequestRequestTypeDef definition

class DomainMetadataRequestRequestTypeDef(TypedDict):
    DomainName: str,

DomainMetadataResultTypeDef

# DomainMetadataResultTypeDef usage example

from mypy_boto3_sdb.type_defs import DomainMetadataResultTypeDef

def get_value() -> DomainMetadataResultTypeDef:
    return {
        "ItemCount": ...,
        "ItemNamesSizeBytes": ...,
        "AttributeNameCount": ...,
        "AttributeNamesSizeBytes": ...,
        "AttributeValueCount": ...,
        "AttributeValuesSizeBytes": ...,
        "Timestamp": ...,
        "ResponseMetadata": ...,
    }

# DomainMetadataResultTypeDef definition

class DomainMetadataResultTypeDef(TypedDict):
    ItemCount: int,
    ItemNamesSizeBytes: int,
    AttributeNameCount: int,
    AttributeNamesSizeBytes: int,
    AttributeValueCount: int,
    AttributeValuesSizeBytes: int,
    Timestamp: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef

# EmptyResponseMetadataTypeDef usage example

from mypy_boto3_sdb.type_defs import EmptyResponseMetadataTypeDef

def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

GetAttributesRequestRequestTypeDef

# GetAttributesRequestRequestTypeDef usage example

from mypy_boto3_sdb.type_defs import GetAttributesRequestRequestTypeDef

def get_value() -> GetAttributesRequestRequestTypeDef:
    return {
        "DomainName": ...,
        "ItemName": ...,
    }

# GetAttributesRequestRequestTypeDef definition

class GetAttributesRequestRequestTypeDef(TypedDict):
    DomainName: str,
    ItemName: str,
    AttributeNames: NotRequired[Sequence[str]],
    ConsistentRead: NotRequired[bool],

ListDomainsRequestListDomainsPaginateTypeDef

# ListDomainsRequestListDomainsPaginateTypeDef usage example

from mypy_boto3_sdb.type_defs import ListDomainsRequestListDomainsPaginateTypeDef

def get_value() -> ListDomainsRequestListDomainsPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }

# ListDomainsRequestListDomainsPaginateTypeDef definition

class ListDomainsRequestListDomainsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

ListDomainsRequestRequestTypeDef

# ListDomainsRequestRequestTypeDef usage example

from mypy_boto3_sdb.type_defs import ListDomainsRequestRequestTypeDef

def get_value() -> ListDomainsRequestRequestTypeDef:
    return {
        "MaxNumberOfDomains": ...,
    }

# ListDomainsRequestRequestTypeDef definition

class ListDomainsRequestRequestTypeDef(TypedDict):
    MaxNumberOfDomains: NotRequired[int],
    NextToken: NotRequired[str],

ListDomainsResultTypeDef

# ListDomainsResultTypeDef usage example

from mypy_boto3_sdb.type_defs import ListDomainsResultTypeDef

def get_value() -> ListDomainsResultTypeDef:
    return {
        "DomainNames": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

# ListDomainsResultTypeDef definition

class ListDomainsResultTypeDef(TypedDict):
    DomainNames: List[str],
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

PaginatorConfigTypeDef

# PaginatorConfigTypeDef usage example

from mypy_boto3_sdb.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ReplaceableAttributeTypeDef

# ReplaceableAttributeTypeDef usage example

from mypy_boto3_sdb.type_defs import ReplaceableAttributeTypeDef

def get_value() -> ReplaceableAttributeTypeDef:
    return {
        "Name": ...,
        "Value": ...,
    }

# ReplaceableAttributeTypeDef definition

class ReplaceableAttributeTypeDef(TypedDict):
    Name: str,
    Value: str,
    Replace: NotRequired[bool],

ResponseMetadataTypeDef

# ResponseMetadataTypeDef usage example

from mypy_boto3_sdb.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

SelectRequestRequestTypeDef

# SelectRequestRequestTypeDef usage example

from mypy_boto3_sdb.type_defs import SelectRequestRequestTypeDef

def get_value() -> SelectRequestRequestTypeDef:
    return {
        "SelectExpression": ...,
    }

# SelectRequestRequestTypeDef definition

class SelectRequestRequestTypeDef(TypedDict):
    SelectExpression: str,
    NextToken: NotRequired[str],
    ConsistentRead: NotRequired[bool],

SelectRequestSelectPaginateTypeDef

# SelectRequestSelectPaginateTypeDef usage example

from mypy_boto3_sdb.type_defs import SelectRequestSelectPaginateTypeDef

def get_value() -> SelectRequestSelectPaginateTypeDef:
    return {
        "SelectExpression": ...,
    }

# SelectRequestSelectPaginateTypeDef definition

class SelectRequestSelectPaginateTypeDef(TypedDict):
    SelectExpression: str,
    ConsistentRead: NotRequired[bool],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

DeletableItemTypeDef

# DeletableItemTypeDef usage example

from mypy_boto3_sdb.type_defs import DeletableItemTypeDef

def get_value() -> DeletableItemTypeDef:
    return {
        "Name": ...,
    }

# DeletableItemTypeDef definition

class DeletableItemTypeDef(TypedDict):
    Name: str,
    Attributes: NotRequired[Sequence[AttributeTypeDef]],  # (1)

1. See AttributeTypeDef

GetAttributesResultTypeDef

# GetAttributesResultTypeDef usage example

from mypy_boto3_sdb.type_defs import GetAttributesResultTypeDef

def get_value() -> GetAttributesResultTypeDef:
    return {
        "Attributes": ...,
        "ResponseMetadata": ...,
    }

# GetAttributesResultTypeDef definition

class GetAttributesResultTypeDef(TypedDict):
    Attributes: List[AttributeTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See AttributeTypeDef
2. See ResponseMetadataTypeDef

ItemTypeDef

# ItemTypeDef usage example

from mypy_boto3_sdb.type_defs import ItemTypeDef

def get_value() -> ItemTypeDef:
    return {
        "Name": ...,
        "Attributes": ...,
    }

# ItemTypeDef definition

class ItemTypeDef(TypedDict):
    Name: str,
    Attributes: List[AttributeTypeDef],  # (1)
    AlternateNameEncoding: NotRequired[str],

1. See AttributeTypeDef

DeleteAttributesRequestRequestTypeDef

# DeleteAttributesRequestRequestTypeDef usage example

from mypy_boto3_sdb.type_defs import DeleteAttributesRequestRequestTypeDef

def get_value() -> DeleteAttributesRequestRequestTypeDef:
    return {
        "DomainName": ...,
        "ItemName": ...,
    }

# DeleteAttributesRequestRequestTypeDef definition

class DeleteAttributesRequestRequestTypeDef(TypedDict):
    DomainName: str,
    ItemName: str,
    Attributes: NotRequired[Sequence[AttributeTypeDef]],  # (1)
    Expected: NotRequired[UpdateConditionTypeDef],  # (2)

1. See AttributeTypeDef
2. See UpdateConditionTypeDef

PutAttributesRequestRequestTypeDef

# PutAttributesRequestRequestTypeDef usage example

from mypy_boto3_sdb.type_defs import PutAttributesRequestRequestTypeDef

def get_value() -> PutAttributesRequestRequestTypeDef:
    return {
        "DomainName": ...,
        "ItemName": ...,
        "Attributes": ...,
    }

# PutAttributesRequestRequestTypeDef definition

class PutAttributesRequestRequestTypeDef(TypedDict):
    DomainName: str,
    ItemName: str,
    Attributes: Sequence[ReplaceableAttributeTypeDef],  # (1)
    Expected: NotRequired[UpdateConditionTypeDef],  # (2)

1. See ReplaceableAttributeTypeDef
2. See UpdateConditionTypeDef

ReplaceableItemTypeDef

# ReplaceableItemTypeDef usage example

from mypy_boto3_sdb.type_defs import ReplaceableItemTypeDef

def get_value() -> ReplaceableItemTypeDef:
    return {
        "Name": ...,
        "Attributes": ...,
    }

# ReplaceableItemTypeDef definition

class ReplaceableItemTypeDef(TypedDict):
    Name: str,
    Attributes: Sequence[ReplaceableAttributeTypeDef],  # (1)

1. See ReplaceableAttributeTypeDef

BatchDeleteAttributesRequestRequestTypeDef

# BatchDeleteAttributesRequestRequestTypeDef usage example

from mypy_boto3_sdb.type_defs import BatchDeleteAttributesRequestRequestTypeDef

def get_value() -> BatchDeleteAttributesRequestRequestTypeDef:
    return {
        "DomainName": ...,
        "Items": ...,
    }

# BatchDeleteAttributesRequestRequestTypeDef definition

class BatchDeleteAttributesRequestRequestTypeDef(TypedDict):
    DomainName: str,
    Items: Sequence[DeletableItemTypeDef],  # (1)

1. See DeletableItemTypeDef

SelectResultTypeDef

# SelectResultTypeDef usage example

from mypy_boto3_sdb.type_defs import SelectResultTypeDef

def get_value() -> SelectResultTypeDef:
    return {
        "Items": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

# SelectResultTypeDef definition

class SelectResultTypeDef(TypedDict):
    Items: List[ItemTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ItemTypeDef
2. See ResponseMetadataTypeDef

BatchPutAttributesRequestRequestTypeDef

# BatchPutAttributesRequestRequestTypeDef usage example

from mypy_boto3_sdb.type_defs import BatchPutAttributesRequestRequestTypeDef

def get_value() -> BatchPutAttributesRequestRequestTypeDef:
    return {
        "DomainName": ...,
        "Items": ...,
    }

# BatchPutAttributesRequestRequestTypeDef definition

class BatchPutAttributesRequestRequestTypeDef(TypedDict):
    DomainName: str,
    Items: Sequence[ReplaceableItemTypeDef],  # (1)

1. See ReplaceableItemTypeDef