Typed dictionaries

Index > SimpleDB > Typed dictionaries

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

AttributeTypeDef

Usage Example

from mypy_boto3_sdb.type_defs import AttributeTypeDef

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

Definition

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

CreateDomainRequestRequestTypeDef

Usage Example

from mypy_boto3_sdb.type_defs import CreateDomainRequestRequestTypeDef

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

Definition

class CreateDomainRequestRequestTypeDef(TypedDict):
    DomainName: str,

UpdateConditionTypeDef

Usage Example

from mypy_boto3_sdb.type_defs import UpdateConditionTypeDef

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

Definition

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

DeleteDomainRequestRequestTypeDef

Usage Example

from mypy_boto3_sdb.type_defs import DeleteDomainRequestRequestTypeDef

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

Definition

class DeleteDomainRequestRequestTypeDef(TypedDict):
    DomainName: str,

DomainMetadataRequestRequestTypeDef

Usage Example

from mypy_boto3_sdb.type_defs import DomainMetadataRequestRequestTypeDef

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

Definition

class DomainMetadataRequestRequestTypeDef(TypedDict):
    DomainName: str,

ResponseMetadataTypeDef

Usage Example

from mypy_boto3_sdb.type_defs import ResponseMetadataTypeDef

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

Definition

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

GetAttributesRequestRequestTypeDef

Usage Example

from mypy_boto3_sdb.type_defs import GetAttributesRequestRequestTypeDef

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

Definition

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

PaginatorConfigTypeDef

Usage Example

from mypy_boto3_sdb.type_defs import PaginatorConfigTypeDef

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

Definition

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

ListDomainsRequestRequestTypeDef

Usage Example

from mypy_boto3_sdb.type_defs import ListDomainsRequestRequestTypeDef

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

Definition

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

ReplaceableAttributeTypeDef

Usage Example

from mypy_boto3_sdb.type_defs import ReplaceableAttributeTypeDef

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

Definition

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

SelectRequestRequestTypeDef

Usage Example

from mypy_boto3_sdb.type_defs import SelectRequestRequestTypeDef

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

Definition

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

DeletableItemTypeDef

Usage Example

from mypy_boto3_sdb.type_defs import DeletableItemTypeDef

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

Definition

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

1. See AttributeTypeDef

ItemTypeDef

Usage Example

from mypy_boto3_sdb.type_defs import ItemTypeDef

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

Definition

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

1. See AttributeTypeDef

DeleteAttributesRequestRequestTypeDef

Usage Example

from mypy_boto3_sdb.type_defs import DeleteAttributesRequestRequestTypeDef

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

Definition

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

1. See AttributeTypeDef
2. See UpdateConditionTypeDef

DomainMetadataResultTypeDef

Usage Example

from mypy_boto3_sdb.type_defs import DomainMetadataResultTypeDef

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

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

Usage Example

from mypy_boto3_sdb.type_defs import EmptyResponseMetadataTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

GetAttributesResultTypeDef

Usage Example

from mypy_boto3_sdb.type_defs import GetAttributesResultTypeDef

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

Definition

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

1. See AttributeTypeDef
2. See ResponseMetadataTypeDef

ListDomainsResultTypeDef

Usage Example

from mypy_boto3_sdb.type_defs import ListDomainsResultTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

ListDomainsRequestListDomainsPaginateTypeDef

Usage Example

from mypy_boto3_sdb.type_defs import ListDomainsRequestListDomainsPaginateTypeDef

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

Definition

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

1. See PaginatorConfigTypeDef

SelectRequestSelectPaginateTypeDef

Usage Example

from mypy_boto3_sdb.type_defs import SelectRequestSelectPaginateTypeDef

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

Definition

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

1. See PaginatorConfigTypeDef

PutAttributesRequestRequestTypeDef

Usage Example

from mypy_boto3_sdb.type_defs import PutAttributesRequestRequestTypeDef

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

Definition

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

1. See ReplaceableAttributeTypeDef
2. See UpdateConditionTypeDef

ReplaceableItemTypeDef

Usage Example

from mypy_boto3_sdb.type_defs import ReplaceableItemTypeDef

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

Definition

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

1. See ReplaceableAttributeTypeDef

BatchDeleteAttributesRequestRequestTypeDef

Usage Example

from mypy_boto3_sdb.type_defs import BatchDeleteAttributesRequestRequestTypeDef

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

Definition

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

1. See DeletableItemTypeDef

SelectResultTypeDef

Usage Example

from mypy_boto3_sdb.type_defs import SelectResultTypeDef

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

Definition

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

1. See ItemTypeDef
2. See ResponseMetadataTypeDef

BatchPutAttributesRequestRequestTypeDef

Usage Example

from mypy_boto3_sdb.type_defs import BatchPutAttributesRequestRequestTypeDef

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

Definition

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

1. See ReplaceableItemTypeDef