Skip to content

Type definitions#

Index > DAX > Type definitions

Auto-generated documentation for DAX type annotations stubs module types-boto3-dax.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

EndpointTypeDef#

# EndpointTypeDef definition

class EndpointTypeDef(TypedDict):
    Address: NotRequired[str],
    Port: NotRequired[int],
    URL: NotRequired[str],

NotificationConfigurationTypeDef#

# NotificationConfigurationTypeDef definition

class NotificationConfigurationTypeDef(TypedDict):
    TopicArn: NotRequired[str],
    TopicStatus: NotRequired[str],

ParameterGroupStatusTypeDef#

# ParameterGroupStatusTypeDef definition

class ParameterGroupStatusTypeDef(TypedDict):
    ParameterGroupName: NotRequired[str],
    ParameterApplyStatus: NotRequired[str],
    NodeIdsToReboot: NotRequired[list[str]],

SSEDescriptionTypeDef#

# SSEDescriptionTypeDef definition

class SSEDescriptionTypeDef(TypedDict):
    Status: NotRequired[SSEStatusType],  # (1)
  1. See SSEStatusType

SecurityGroupMembershipTypeDef#

# SecurityGroupMembershipTypeDef definition

class SecurityGroupMembershipTypeDef(TypedDict):
    SecurityGroupIdentifier: NotRequired[str],
    Status: NotRequired[str],

SSESpecificationTypeDef#

# SSESpecificationTypeDef definition

class SSESpecificationTypeDef(TypedDict):
    Enabled: bool,

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: NotRequired[str],
    Value: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

CreateParameterGroupRequestRequestTypeDef#

# CreateParameterGroupRequestRequestTypeDef definition

class CreateParameterGroupRequestRequestTypeDef(TypedDict):
    ParameterGroupName: str,
    Description: NotRequired[str],

ParameterGroupTypeDef#

# ParameterGroupTypeDef definition

class ParameterGroupTypeDef(TypedDict):
    ParameterGroupName: NotRequired[str],
    Description: NotRequired[str],

CreateSubnetGroupRequestRequestTypeDef#

# CreateSubnetGroupRequestRequestTypeDef definition

class CreateSubnetGroupRequestRequestTypeDef(TypedDict):
    SubnetGroupName: str,
    SubnetIds: Sequence[str],
    Description: NotRequired[str],

DecreaseReplicationFactorRequestRequestTypeDef#

# DecreaseReplicationFactorRequestRequestTypeDef definition

class DecreaseReplicationFactorRequestRequestTypeDef(TypedDict):
    ClusterName: str,
    NewReplicationFactor: int,
    AvailabilityZones: NotRequired[Sequence[str]],
    NodeIdsToRemove: NotRequired[Sequence[str]],

DeleteClusterRequestRequestTypeDef#

# DeleteClusterRequestRequestTypeDef definition

class DeleteClusterRequestRequestTypeDef(TypedDict):
    ClusterName: str,

DeleteParameterGroupRequestRequestTypeDef#

# DeleteParameterGroupRequestRequestTypeDef definition

class DeleteParameterGroupRequestRequestTypeDef(TypedDict):
    ParameterGroupName: str,

DeleteSubnetGroupRequestRequestTypeDef#

# DeleteSubnetGroupRequestRequestTypeDef definition

class DeleteSubnetGroupRequestRequestTypeDef(TypedDict):
    SubnetGroupName: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

DescribeClustersRequestRequestTypeDef#

# DescribeClustersRequestRequestTypeDef definition

class DescribeClustersRequestRequestTypeDef(TypedDict):
    ClusterNames: NotRequired[Sequence[str]],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

DescribeDefaultParametersRequestRequestTypeDef#

# DescribeDefaultParametersRequestRequestTypeDef definition

class DescribeDefaultParametersRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

EventTypeDef#

# EventTypeDef definition

class EventTypeDef(TypedDict):
    SourceName: NotRequired[str],
    SourceType: NotRequired[SourceTypeType],  # (1)
    Message: NotRequired[str],
    Date: NotRequired[datetime],
  1. See SourceTypeType

DescribeParameterGroupsRequestRequestTypeDef#

# DescribeParameterGroupsRequestRequestTypeDef definition

class DescribeParameterGroupsRequestRequestTypeDef(TypedDict):
    ParameterGroupNames: NotRequired[Sequence[str]],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

DescribeParametersRequestRequestTypeDef#

# DescribeParametersRequestRequestTypeDef definition

class DescribeParametersRequestRequestTypeDef(TypedDict):
    ParameterGroupName: str,
    Source: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

DescribeSubnetGroupsRequestRequestTypeDef#

# DescribeSubnetGroupsRequestRequestTypeDef definition

class DescribeSubnetGroupsRequestRequestTypeDef(TypedDict):
    SubnetGroupNames: NotRequired[Sequence[str]],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

IncreaseReplicationFactorRequestRequestTypeDef#

# IncreaseReplicationFactorRequestRequestTypeDef definition

class IncreaseReplicationFactorRequestRequestTypeDef(TypedDict):
    ClusterName: str,
    NewReplicationFactor: int,
    AvailabilityZones: NotRequired[Sequence[str]],

ListTagsRequestRequestTypeDef#

# ListTagsRequestRequestTypeDef definition

class ListTagsRequestRequestTypeDef(TypedDict):
    ResourceName: str,
    NextToken: NotRequired[str],

NodeTypeSpecificValueTypeDef#

# NodeTypeSpecificValueTypeDef definition

class NodeTypeSpecificValueTypeDef(TypedDict):
    NodeType: NotRequired[str],
    Value: NotRequired[str],

ParameterNameValueTypeDef#

# ParameterNameValueTypeDef definition

class ParameterNameValueTypeDef(TypedDict):
    ParameterName: NotRequired[str],
    ParameterValue: NotRequired[str],

RebootNodeRequestRequestTypeDef#

# RebootNodeRequestRequestTypeDef definition

class RebootNodeRequestRequestTypeDef(TypedDict):
    ClusterName: str,
    NodeId: str,

SubnetTypeDef#

# SubnetTypeDef definition

class SubnetTypeDef(TypedDict):
    SubnetIdentifier: NotRequired[str],
    SubnetAvailabilityZone: NotRequired[str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceName: str,
    TagKeys: Sequence[str],

UpdateClusterRequestRequestTypeDef#

# UpdateClusterRequestRequestTypeDef definition

class UpdateClusterRequestRequestTypeDef(TypedDict):
    ClusterName: str,
    Description: NotRequired[str],
    PreferredMaintenanceWindow: NotRequired[str],
    NotificationTopicArn: NotRequired[str],
    NotificationTopicStatus: NotRequired[str],
    ParameterGroupName: NotRequired[str],
    SecurityGroupIds: NotRequired[Sequence[str]],

UpdateSubnetGroupRequestRequestTypeDef#

# UpdateSubnetGroupRequestRequestTypeDef definition

class UpdateSubnetGroupRequestRequestTypeDef(TypedDict):
    SubnetGroupName: str,
    Description: NotRequired[str],
    SubnetIds: NotRequired[Sequence[str]],

NodeTypeDef#

# NodeTypeDef definition

class NodeTypeDef(TypedDict):
    NodeId: NotRequired[str],
    Endpoint: NotRequired[EndpointTypeDef],  # (1)
    NodeCreateTime: NotRequired[datetime],
    AvailabilityZone: NotRequired[str],
    NodeStatus: NotRequired[str],
    ParameterGroupStatus: NotRequired[str],
  1. See EndpointTypeDef

CreateClusterRequestRequestTypeDef#

# CreateClusterRequestRequestTypeDef definition

class CreateClusterRequestRequestTypeDef(TypedDict):
    ClusterName: str,
    NodeType: str,
    ReplicationFactor: int,
    IamRoleArn: str,
    Description: NotRequired[str],
    AvailabilityZones: NotRequired[Sequence[str]],
    SubnetGroupName: NotRequired[str],
    SecurityGroupIds: NotRequired[Sequence[str]],
    PreferredMaintenanceWindow: NotRequired[str],
    NotificationTopicArn: NotRequired[str],
    ParameterGroupName: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
    SSESpecification: NotRequired[SSESpecificationTypeDef],  # (2)
    ClusterEndpointEncryptionType: NotRequired[ClusterEndpointEncryptionTypeType],  # (3)
  1. See TagTypeDef
  2. See SSESpecificationTypeDef
  3. See ClusterEndpointEncryptionTypeType

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceName: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

DeleteParameterGroupResponseTypeDef#

# DeleteParameterGroupResponseTypeDef definition

class DeleteParameterGroupResponseTypeDef(TypedDict):
    DeletionMessage: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteSubnetGroupResponseTypeDef#

# DeleteSubnetGroupResponseTypeDef definition

class DeleteSubnetGroupResponseTypeDef(TypedDict):
    DeletionMessage: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsResponseTypeDef#

# ListTagsResponseTypeDef definition

class ListTagsResponseTypeDef(TypedDict):
    Tags: list[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

TagResourceResponseTypeDef#

# TagResourceResponseTypeDef definition

class TagResourceResponseTypeDef(TypedDict):
    Tags: list[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

UntagResourceResponseTypeDef#

# UntagResourceResponseTypeDef definition

class UntagResourceResponseTypeDef(TypedDict):
    Tags: list[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

CreateParameterGroupResponseTypeDef#

# CreateParameterGroupResponseTypeDef definition

class CreateParameterGroupResponseTypeDef(TypedDict):
    ParameterGroup: ParameterGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ParameterGroupTypeDef
  2. See ResponseMetadataTypeDef

DescribeParameterGroupsResponseTypeDef#

# DescribeParameterGroupsResponseTypeDef definition

class DescribeParameterGroupsResponseTypeDef(TypedDict):
    ParameterGroups: list[ParameterGroupTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ParameterGroupTypeDef
  2. See ResponseMetadataTypeDef

UpdateParameterGroupResponseTypeDef#

# UpdateParameterGroupResponseTypeDef definition

class UpdateParameterGroupResponseTypeDef(TypedDict):
    ParameterGroup: ParameterGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ParameterGroupTypeDef
  2. See ResponseMetadataTypeDef

DescribeClustersRequestPaginateTypeDef#

# DescribeClustersRequestPaginateTypeDef definition

class DescribeClustersRequestPaginateTypeDef(TypedDict):
    ClusterNames: NotRequired[Sequence[str]],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeDefaultParametersRequestPaginateTypeDef#

# DescribeDefaultParametersRequestPaginateTypeDef definition

class DescribeDefaultParametersRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeParameterGroupsRequestPaginateTypeDef#

# DescribeParameterGroupsRequestPaginateTypeDef definition

class DescribeParameterGroupsRequestPaginateTypeDef(TypedDict):
    ParameterGroupNames: NotRequired[Sequence[str]],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeParametersRequestPaginateTypeDef#

# DescribeParametersRequestPaginateTypeDef definition

class DescribeParametersRequestPaginateTypeDef(TypedDict):
    ParameterGroupName: str,
    Source: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeSubnetGroupsRequestPaginateTypeDef#

# DescribeSubnetGroupsRequestPaginateTypeDef definition

class DescribeSubnetGroupsRequestPaginateTypeDef(TypedDict):
    SubnetGroupNames: NotRequired[Sequence[str]],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTagsRequestPaginateTypeDef#

# ListTagsRequestPaginateTypeDef definition

class ListTagsRequestPaginateTypeDef(TypedDict):
    ResourceName: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeEventsRequestPaginateTypeDef#

# DescribeEventsRequestPaginateTypeDef definition

class DescribeEventsRequestPaginateTypeDef(TypedDict):
    SourceName: NotRequired[str],
    SourceType: NotRequired[SourceTypeType],  # (1)
    StartTime: NotRequired[TimestampTypeDef],
    EndTime: NotRequired[TimestampTypeDef],
    Duration: NotRequired[int],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See SourceTypeType
  2. See PaginatorConfigTypeDef

DescribeEventsRequestRequestTypeDef#

# DescribeEventsRequestRequestTypeDef definition

class DescribeEventsRequestRequestTypeDef(TypedDict):
    SourceName: NotRequired[str],
    SourceType: NotRequired[SourceTypeType],  # (1)
    StartTime: NotRequired[TimestampTypeDef],
    EndTime: NotRequired[TimestampTypeDef],
    Duration: NotRequired[int],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See SourceTypeType

DescribeEventsResponseTypeDef#

# DescribeEventsResponseTypeDef definition

class DescribeEventsResponseTypeDef(TypedDict):
    Events: list[EventTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See EventTypeDef
  2. See ResponseMetadataTypeDef

ParameterTypeDef#

# ParameterTypeDef definition

class ParameterTypeDef(TypedDict):
    ParameterName: NotRequired[str],
    ParameterType: NotRequired[ParameterTypeType],  # (1)
    ParameterValue: NotRequired[str],
    NodeTypeSpecificValues: NotRequired[list[NodeTypeSpecificValueTypeDef]],  # (2)
    Description: NotRequired[str],
    Source: NotRequired[str],
    DataType: NotRequired[str],
    AllowedValues: NotRequired[str],
    IsModifiable: NotRequired[IsModifiableType],  # (3)
    ChangeType: NotRequired[ChangeTypeType],  # (4)
  1. See ParameterTypeType
  2. See NodeTypeSpecificValueTypeDef
  3. See IsModifiableType
  4. See ChangeTypeType

UpdateParameterGroupRequestRequestTypeDef#

# UpdateParameterGroupRequestRequestTypeDef definition

class UpdateParameterGroupRequestRequestTypeDef(TypedDict):
    ParameterGroupName: str,
    ParameterNameValues: Sequence[ParameterNameValueTypeDef],  # (1)
  1. See ParameterNameValueTypeDef

SubnetGroupTypeDef#

# SubnetGroupTypeDef definition

class SubnetGroupTypeDef(TypedDict):
    SubnetGroupName: NotRequired[str],
    Description: NotRequired[str],
    VpcId: NotRequired[str],
    Subnets: NotRequired[list[SubnetTypeDef]],  # (1)
  1. See SubnetTypeDef

ClusterTypeDef#

# ClusterTypeDef definition

class ClusterTypeDef(TypedDict):
    ClusterName: NotRequired[str],
    Description: NotRequired[str],
    ClusterArn: NotRequired[str],
    TotalNodes: NotRequired[int],
    ActiveNodes: NotRequired[int],
    NodeType: NotRequired[str],
    Status: NotRequired[str],
    ClusterDiscoveryEndpoint: NotRequired[EndpointTypeDef],  # (1)
    NodeIdsToRemove: NotRequired[list[str]],
    Nodes: NotRequired[list[NodeTypeDef]],  # (2)
    PreferredMaintenanceWindow: NotRequired[str],
    NotificationConfiguration: NotRequired[NotificationConfigurationTypeDef],  # (3)
    SubnetGroup: NotRequired[str],
    SecurityGroups: NotRequired[list[SecurityGroupMembershipTypeDef]],  # (4)
    IamRoleArn: NotRequired[str],
    ParameterGroup: NotRequired[ParameterGroupStatusTypeDef],  # (5)
    SSEDescription: NotRequired[SSEDescriptionTypeDef],  # (6)
    ClusterEndpointEncryptionType: NotRequired[ClusterEndpointEncryptionTypeType],  # (7)
  1. See EndpointTypeDef
  2. See NodeTypeDef
  3. See NotificationConfigurationTypeDef
  4. See SecurityGroupMembershipTypeDef
  5. See ParameterGroupStatusTypeDef
  6. See SSEDescriptionTypeDef
  7. See ClusterEndpointEncryptionTypeType

DescribeDefaultParametersResponseTypeDef#

# DescribeDefaultParametersResponseTypeDef definition

class DescribeDefaultParametersResponseTypeDef(TypedDict):
    Parameters: list[ParameterTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ParameterTypeDef
  2. See ResponseMetadataTypeDef

DescribeParametersResponseTypeDef#

# DescribeParametersResponseTypeDef definition

class DescribeParametersResponseTypeDef(TypedDict):
    Parameters: list[ParameterTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ParameterTypeDef
  2. See ResponseMetadataTypeDef

CreateSubnetGroupResponseTypeDef#

# CreateSubnetGroupResponseTypeDef definition

class CreateSubnetGroupResponseTypeDef(TypedDict):
    SubnetGroup: SubnetGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SubnetGroupTypeDef
  2. See ResponseMetadataTypeDef

DescribeSubnetGroupsResponseTypeDef#

# DescribeSubnetGroupsResponseTypeDef definition

class DescribeSubnetGroupsResponseTypeDef(TypedDict):
    SubnetGroups: list[SubnetGroupTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See SubnetGroupTypeDef
  2. See ResponseMetadataTypeDef

UpdateSubnetGroupResponseTypeDef#

# UpdateSubnetGroupResponseTypeDef definition

class UpdateSubnetGroupResponseTypeDef(TypedDict):
    SubnetGroup: SubnetGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SubnetGroupTypeDef
  2. See ResponseMetadataTypeDef

CreateClusterResponseTypeDef#

# CreateClusterResponseTypeDef definition

class CreateClusterResponseTypeDef(TypedDict):
    Cluster: ClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterTypeDef
  2. See ResponseMetadataTypeDef

DecreaseReplicationFactorResponseTypeDef#

# DecreaseReplicationFactorResponseTypeDef definition

class DecreaseReplicationFactorResponseTypeDef(TypedDict):
    Cluster: ClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterTypeDef
  2. See ResponseMetadataTypeDef

DeleteClusterResponseTypeDef#

# DeleteClusterResponseTypeDef definition

class DeleteClusterResponseTypeDef(TypedDict):
    Cluster: ClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterTypeDef
  2. See ResponseMetadataTypeDef

DescribeClustersResponseTypeDef#

# DescribeClustersResponseTypeDef definition

class DescribeClustersResponseTypeDef(TypedDict):
    Clusters: list[ClusterTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ClusterTypeDef
  2. See ResponseMetadataTypeDef

IncreaseReplicationFactorResponseTypeDef#

# IncreaseReplicationFactorResponseTypeDef definition

class IncreaseReplicationFactorResponseTypeDef(TypedDict):
    Cluster: ClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterTypeDef
  2. See ResponseMetadataTypeDef

RebootNodeResponseTypeDef#

# RebootNodeResponseTypeDef definition

class RebootNodeResponseTypeDef(TypedDict):
    Cluster: ClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterTypeDef
  2. See ResponseMetadataTypeDef

UpdateClusterResponseTypeDef#

# UpdateClusterResponseTypeDef definition

class UpdateClusterResponseTypeDef(TypedDict):
    Cluster: ClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterTypeDef
  2. See ResponseMetadataTypeDef