Skip to content

Type definitions#

Index > MemoryDB > Type definitions

Auto-generated documentation for MemoryDB type annotations stubs module mypy-boto3-memorydb.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

ACLPendingChangesTypeDef#

# ACLPendingChangesTypeDef definition

class ACLPendingChangesTypeDef(TypedDict):
    UserNamesToRemove: NotRequired[List[str]],
    UserNamesToAdd: NotRequired[List[str]],

ACLsUpdateStatusTypeDef#

# ACLsUpdateStatusTypeDef definition

class ACLsUpdateStatusTypeDef(TypedDict):
    ACLToApply: NotRequired[str],

AuthenticationModeTypeDef#

# AuthenticationModeTypeDef definition

class AuthenticationModeTypeDef(TypedDict):
    Type: NotRequired[InputAuthenticationTypeType],  # (1)
    Passwords: NotRequired[Sequence[str]],
  1. See InputAuthenticationTypeType

AuthenticationTypeDef#

# AuthenticationTypeDef definition

class AuthenticationTypeDef(TypedDict):
    Type: NotRequired[AuthenticationTypeType],  # (1)
    PasswordCount: NotRequired[int],
  1. See AuthenticationTypeType

AvailabilityZoneTypeDef#

# AvailabilityZoneTypeDef definition

class AvailabilityZoneTypeDef(TypedDict):
    Name: NotRequired[str],

ServiceUpdateRequestTypeDef#

# ServiceUpdateRequestTypeDef definition

class ServiceUpdateRequestTypeDef(TypedDict):
    ServiceUpdateNameToApply: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

UnprocessedClusterTypeDef#

# UnprocessedClusterTypeDef definition

class UnprocessedClusterTypeDef(TypedDict):
    ClusterName: NotRequired[str],
    ErrorType: NotRequired[str],
    ErrorMessage: NotRequired[str],

PendingModifiedServiceUpdateTypeDef#

# PendingModifiedServiceUpdateTypeDef definition

class PendingModifiedServiceUpdateTypeDef(TypedDict):
    ServiceUpdateName: NotRequired[str],
    Status: NotRequired[ServiceUpdateStatusType],  # (1)
  1. See ServiceUpdateStatusType

EndpointTypeDef#

# EndpointTypeDef definition

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

SecurityGroupMembershipTypeDef#

# SecurityGroupMembershipTypeDef definition

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

TagTypeDef#

# TagTypeDef definition

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

ParameterGroupTypeDef#

# ParameterGroupTypeDef definition

class ParameterGroupTypeDef(TypedDict):
    Name: NotRequired[str],
    Family: NotRequired[str],
    Description: NotRequired[str],
    ARN: NotRequired[str],

DeleteACLRequestRequestTypeDef#

# DeleteACLRequestRequestTypeDef definition

class DeleteACLRequestRequestTypeDef(TypedDict):
    ACLName: str,

DeleteClusterRequestRequestTypeDef#

# DeleteClusterRequestRequestTypeDef definition

class DeleteClusterRequestRequestTypeDef(TypedDict):
    ClusterName: str,
    FinalSnapshotName: NotRequired[str],

DeleteParameterGroupRequestRequestTypeDef#

# DeleteParameterGroupRequestRequestTypeDef definition

class DeleteParameterGroupRequestRequestTypeDef(TypedDict):
    ParameterGroupName: str,

DeleteSnapshotRequestRequestTypeDef#

# DeleteSnapshotRequestRequestTypeDef definition

class DeleteSnapshotRequestRequestTypeDef(TypedDict):
    SnapshotName: str,

DeleteSubnetGroupRequestRequestTypeDef#

# DeleteSubnetGroupRequestRequestTypeDef definition

class DeleteSubnetGroupRequestRequestTypeDef(TypedDict):
    SubnetGroupName: str,

DeleteUserRequestRequestTypeDef#

# DeleteUserRequestRequestTypeDef definition

class DeleteUserRequestRequestTypeDef(TypedDict):
    UserName: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

DescribeACLsRequestRequestTypeDef#

# DescribeACLsRequestRequestTypeDef definition

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

DescribeClustersRequestRequestTypeDef#

# DescribeClustersRequestRequestTypeDef definition

class DescribeClustersRequestRequestTypeDef(TypedDict):
    ClusterName: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    ShowShardDetails: NotRequired[bool],

DescribeEngineVersionsRequestRequestTypeDef#

# DescribeEngineVersionsRequestRequestTypeDef definition

class DescribeEngineVersionsRequestRequestTypeDef(TypedDict):
    EngineVersion: NotRequired[str],
    ParameterGroupFamily: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    DefaultOnly: NotRequired[bool],

EngineVersionInfoTypeDef#

# EngineVersionInfoTypeDef definition

class EngineVersionInfoTypeDef(TypedDict):
    EngineVersion: NotRequired[str],
    EnginePatchVersion: NotRequired[str],
    ParameterGroupFamily: 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):
    ParameterGroupName: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

DescribeParametersRequestRequestTypeDef#

# DescribeParametersRequestRequestTypeDef definition

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

ParameterTypeDef#

# ParameterTypeDef definition

class ParameterTypeDef(TypedDict):
    Name: NotRequired[str],
    Value: NotRequired[str],
    Description: NotRequired[str],
    DataType: NotRequired[str],
    AllowedValues: NotRequired[str],
    MinimumEngineVersion: NotRequired[str],

DescribeReservedNodesOfferingsRequestRequestTypeDef#

# DescribeReservedNodesOfferingsRequestRequestTypeDef definition

class DescribeReservedNodesOfferingsRequestRequestTypeDef(TypedDict):
    ReservedNodesOfferingId: NotRequired[str],
    NodeType: NotRequired[str],
    Duration: NotRequired[str],
    OfferingType: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

DescribeReservedNodesRequestRequestTypeDef#

# DescribeReservedNodesRequestRequestTypeDef definition

class DescribeReservedNodesRequestRequestTypeDef(TypedDict):
    ReservationId: NotRequired[str],
    ReservedNodesOfferingId: NotRequired[str],
    NodeType: NotRequired[str],
    Duration: NotRequired[str],
    OfferingType: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

DescribeServiceUpdatesRequestRequestTypeDef#

# DescribeServiceUpdatesRequestRequestTypeDef definition

class DescribeServiceUpdatesRequestRequestTypeDef(TypedDict):
    ServiceUpdateName: NotRequired[str],
    ClusterNames: NotRequired[Sequence[str]],
    Status: NotRequired[Sequence[ServiceUpdateStatusType]],  # (1)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See ServiceUpdateStatusType

ServiceUpdateTypeDef#

# ServiceUpdateTypeDef definition

class ServiceUpdateTypeDef(TypedDict):
    ClusterName: NotRequired[str],
    ServiceUpdateName: NotRequired[str],
    ReleaseDate: NotRequired[datetime],
    Description: NotRequired[str],
    Status: NotRequired[ServiceUpdateStatusType],  # (1)
    Type: NotRequired[ServiceUpdateTypeType],  # (2)
    NodesUpdated: NotRequired[str],
    AutoUpdateStartDate: NotRequired[datetime],
  1. See ServiceUpdateStatusType
  2. See ServiceUpdateTypeType

DescribeSnapshotsRequestRequestTypeDef#

# DescribeSnapshotsRequestRequestTypeDef definition

class DescribeSnapshotsRequestRequestTypeDef(TypedDict):
    ClusterName: NotRequired[str],
    SnapshotName: NotRequired[str],
    Source: NotRequired[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    ShowDetail: NotRequired[bool],

DescribeSubnetGroupsRequestRequestTypeDef#

# DescribeSubnetGroupsRequestRequestTypeDef definition

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

FilterTypeDef#

# FilterTypeDef definition

class FilterTypeDef(TypedDict):
    Name: str,
    Values: Sequence[str],

FailoverShardRequestRequestTypeDef#

# FailoverShardRequestRequestTypeDef definition

class FailoverShardRequestRequestTypeDef(TypedDict):
    ClusterName: str,
    ShardName: str,

ListAllowedNodeTypeUpdatesRequestRequestTypeDef#

# ListAllowedNodeTypeUpdatesRequestRequestTypeDef definition

class ListAllowedNodeTypeUpdatesRequestRequestTypeDef(TypedDict):
    ClusterName: str,

ListTagsRequestRequestTypeDef#

# ListTagsRequestRequestTypeDef definition

class ListTagsRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

ParameterNameValueTypeDef#

# ParameterNameValueTypeDef definition

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

RecurringChargeTypeDef#

# RecurringChargeTypeDef definition

class RecurringChargeTypeDef(TypedDict):
    RecurringChargeAmount: NotRequired[float],
    RecurringChargeFrequency: NotRequired[str],

ReplicaConfigurationRequestTypeDef#

# ReplicaConfigurationRequestTypeDef definition

class ReplicaConfigurationRequestTypeDef(TypedDict):
    ReplicaCount: NotRequired[int],

ResetParameterGroupRequestRequestTypeDef#

# ResetParameterGroupRequestRequestTypeDef definition

class ResetParameterGroupRequestRequestTypeDef(TypedDict):
    ParameterGroupName: str,
    AllParameters: NotRequired[bool],
    ParameterNames: NotRequired[Sequence[str]],

SlotMigrationTypeDef#

# SlotMigrationTypeDef definition

class SlotMigrationTypeDef(TypedDict):
    ProgressPercentage: NotRequired[float],

ShardConfigurationRequestTypeDef#

# ShardConfigurationRequestTypeDef definition

class ShardConfigurationRequestTypeDef(TypedDict):
    ShardCount: NotRequired[int],

ShardConfigurationTypeDef#

# ShardConfigurationTypeDef definition

class ShardConfigurationTypeDef(TypedDict):
    Slots: NotRequired[str],
    ReplicaCount: NotRequired[int],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

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

UpdateACLRequestRequestTypeDef#

# UpdateACLRequestRequestTypeDef definition

class UpdateACLRequestRequestTypeDef(TypedDict):
    ACLName: str,
    UserNamesToAdd: NotRequired[Sequence[str]],
    UserNamesToRemove: NotRequired[Sequence[str]],

UpdateSubnetGroupRequestRequestTypeDef#

# UpdateSubnetGroupRequestRequestTypeDef definition

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

ACLTypeDef#

# ACLTypeDef definition

class ACLTypeDef(TypedDict):
    Name: NotRequired[str],
    Status: NotRequired[str],
    UserNames: NotRequired[List[str]],
    MinimumEngineVersion: NotRequired[str],
    PendingChanges: NotRequired[ACLPendingChangesTypeDef],  # (1)
    Clusters: NotRequired[List[str]],
    ARN: NotRequired[str],
  1. See ACLPendingChangesTypeDef

UpdateUserRequestRequestTypeDef#

# UpdateUserRequestRequestTypeDef definition

class UpdateUserRequestRequestTypeDef(TypedDict):
    UserName: str,
    AuthenticationMode: NotRequired[AuthenticationModeTypeDef],  # (1)
    AccessString: NotRequired[str],
  1. See AuthenticationModeTypeDef

UserTypeDef#

# UserTypeDef definition

class UserTypeDef(TypedDict):
    Name: NotRequired[str],
    Status: NotRequired[str],
    AccessString: NotRequired[str],
    ACLNames: NotRequired[List[str]],
    MinimumEngineVersion: NotRequired[str],
    Authentication: NotRequired[AuthenticationTypeDef],  # (1)
    ARN: NotRequired[str],
  1. See AuthenticationTypeDef

SubnetTypeDef#

# SubnetTypeDef definition

class SubnetTypeDef(TypedDict):
    Identifier: NotRequired[str],
    AvailabilityZone: NotRequired[AvailabilityZoneTypeDef],  # (1)
  1. See AvailabilityZoneTypeDef

BatchUpdateClusterRequestRequestTypeDef#

# BatchUpdateClusterRequestRequestTypeDef definition

class BatchUpdateClusterRequestRequestTypeDef(TypedDict):
    ClusterNames: Sequence[str],
    ServiceUpdate: NotRequired[ServiceUpdateRequestTypeDef],  # (1)
  1. See ServiceUpdateRequestTypeDef

ListAllowedNodeTypeUpdatesResponseTypeDef#

# ListAllowedNodeTypeUpdatesResponseTypeDef definition

class ListAllowedNodeTypeUpdatesResponseTypeDef(TypedDict):
    ScaleUpNodeTypes: List[str],
    ScaleDownNodeTypes: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

NodeTypeDef#

# NodeTypeDef definition

class NodeTypeDef(TypedDict):
    Name: NotRequired[str],
    Status: NotRequired[str],
    AvailabilityZone: NotRequired[str],
    CreateTime: NotRequired[datetime],
    Endpoint: NotRequired[EndpointTypeDef],  # (1)
  1. See EndpointTypeDef

CopySnapshotRequestRequestTypeDef#

# CopySnapshotRequestRequestTypeDef definition

class CopySnapshotRequestRequestTypeDef(TypedDict):
    SourceSnapshotName: str,
    TargetSnapshotName: str,
    TargetBucket: NotRequired[str],
    KmsKeyId: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CreateACLRequestRequestTypeDef#

# CreateACLRequestRequestTypeDef definition

class CreateACLRequestRequestTypeDef(TypedDict):
    ACLName: str,
    UserNames: NotRequired[Sequence[str]],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CreateClusterRequestRequestTypeDef#

# CreateClusterRequestRequestTypeDef definition

class CreateClusterRequestRequestTypeDef(TypedDict):
    ClusterName: str,
    NodeType: str,
    ACLName: str,
    ParameterGroupName: NotRequired[str],
    Description: NotRequired[str],
    NumShards: NotRequired[int],
    NumReplicasPerShard: NotRequired[int],
    SubnetGroupName: NotRequired[str],
    SecurityGroupIds: NotRequired[Sequence[str]],
    MaintenanceWindow: NotRequired[str],
    Port: NotRequired[int],
    SnsTopicArn: NotRequired[str],
    TLSEnabled: NotRequired[bool],
    KmsKeyId: NotRequired[str],
    SnapshotArns: NotRequired[Sequence[str]],
    SnapshotName: NotRequired[str],
    SnapshotRetentionLimit: NotRequired[int],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
    SnapshotWindow: NotRequired[str],
    EngineVersion: NotRequired[str],
    AutoMinorVersionUpgrade: NotRequired[bool],
    DataTiering: NotRequired[bool],
  1. See TagTypeDef

CreateParameterGroupRequestRequestTypeDef#

# CreateParameterGroupRequestRequestTypeDef definition

class CreateParameterGroupRequestRequestTypeDef(TypedDict):
    ParameterGroupName: str,
    Family: str,
    Description: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)