Skip to content

Type definitions#

Index > OpenSearchService > Type definitions

Auto-generated documentation for OpenSearchService type annotations stubs module mypy-boto3-opensearch.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

AWSDomainInformationTypeDef#

# AWSDomainInformationTypeDef definition

class AWSDomainInformationTypeDef(TypedDict):
    DomainName: str,
    OwnerId: NotRequired[str],
    Region: NotRequired[str],

AcceptInboundConnectionRequestRequestTypeDef#

# AcceptInboundConnectionRequestRequestTypeDef definition

class AcceptInboundConnectionRequestRequestTypeDef(TypedDict):
    ConnectionId: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

OptionStatusTypeDef#

# OptionStatusTypeDef definition

class OptionStatusTypeDef(TypedDict):
    CreationDate: datetime,
    UpdateDate: datetime,
    State: OptionStateType,  # (1)
    UpdateVersion: NotRequired[int],
    PendingDeletion: NotRequired[bool],
  1. See OptionStateType

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

AdditionalLimitTypeDef#

# AdditionalLimitTypeDef definition

class AdditionalLimitTypeDef(TypedDict):
    LimitName: NotRequired[str],
    LimitValues: NotRequired[List[str]],

MasterUserOptionsTypeDef#

# MasterUserOptionsTypeDef definition

class MasterUserOptionsTypeDef(TypedDict):
    MasterUserARN: NotRequired[str],
    MasterUserName: NotRequired[str],
    MasterUserPassword: NotRequired[str],

AssociatePackageRequestRequestTypeDef#

# AssociatePackageRequestRequestTypeDef definition

class AssociatePackageRequestRequestTypeDef(TypedDict):
    PackageID: str,
    DomainName: str,

AuthorizeVpcEndpointAccessRequestRequestTypeDef#

# AuthorizeVpcEndpointAccessRequestRequestTypeDef definition

class AuthorizeVpcEndpointAccessRequestRequestTypeDef(TypedDict):
    DomainName: str,
    Account: str,

AuthorizedPrincipalTypeDef#

# AuthorizedPrincipalTypeDef definition

class AuthorizedPrincipalTypeDef(TypedDict):
    PrincipalType: NotRequired[PrincipalTypeType],  # (1)
    Principal: NotRequired[str],
  1. See PrincipalTypeType

ScheduledAutoTuneDetailsTypeDef#

# ScheduledAutoTuneDetailsTypeDef definition

class ScheduledAutoTuneDetailsTypeDef(TypedDict):
    Date: NotRequired[datetime],
    ActionType: NotRequired[ScheduledAutoTuneActionTypeType],  # (1)
    Action: NotRequired[str],
    Severity: NotRequired[ScheduledAutoTuneSeverityTypeType],  # (2)
  1. See ScheduledAutoTuneActionTypeType
  2. See ScheduledAutoTuneSeverityTypeType

DurationTypeDef#

# DurationTypeDef definition

class DurationTypeDef(TypedDict):
    Value: NotRequired[int],
    Unit: NotRequired[TimeUnitType],  # (1)
  1. See TimeUnitType

AutoTuneOptionsOutputTypeDef#

# AutoTuneOptionsOutputTypeDef definition

class AutoTuneOptionsOutputTypeDef(TypedDict):
    State: NotRequired[AutoTuneStateType],  # (1)
    ErrorMessage: NotRequired[str],
    UseOffPeakWindow: NotRequired[bool],
  1. See AutoTuneStateType

AutoTuneStatusTypeDef#

# AutoTuneStatusTypeDef definition

class AutoTuneStatusTypeDef(TypedDict):
    CreationDate: datetime,
    UpdateDate: datetime,
    State: AutoTuneStateType,  # (1)
    UpdateVersion: NotRequired[int],
    ErrorMessage: NotRequired[str],
    PendingDeletion: NotRequired[bool],
  1. See AutoTuneStateType

AvailabilityZoneInfoTypeDef#

# AvailabilityZoneInfoTypeDef definition

class AvailabilityZoneInfoTypeDef(TypedDict):
    AvailabilityZoneName: NotRequired[str],
    ZoneStatus: NotRequired[ZoneStatusType],  # (1)
    ConfiguredDataNodeCount: NotRequired[str],
    AvailableDataNodeCount: NotRequired[str],
    TotalShards: NotRequired[str],
    TotalUnAssignedShards: NotRequired[str],
  1. See ZoneStatusType

CancelDomainConfigChangeRequestRequestTypeDef#

# CancelDomainConfigChangeRequestRequestTypeDef definition

class CancelDomainConfigChangeRequestRequestTypeDef(TypedDict):
    DomainName: str,
    DryRun: NotRequired[bool],

CancelledChangePropertyTypeDef#

# CancelledChangePropertyTypeDef definition

class CancelledChangePropertyTypeDef(TypedDict):
    PropertyName: NotRequired[str],
    CancelledValue: NotRequired[str],
    ActiveValue: NotRequired[str],

CancelServiceSoftwareUpdateRequestRequestTypeDef#

# CancelServiceSoftwareUpdateRequestRequestTypeDef definition

class CancelServiceSoftwareUpdateRequestRequestTypeDef(TypedDict):
    DomainName: str,

ServiceSoftwareOptionsTypeDef#

# ServiceSoftwareOptionsTypeDef definition

class ServiceSoftwareOptionsTypeDef(TypedDict):
    CurrentVersion: NotRequired[str],
    NewVersion: NotRequired[str],
    UpdateAvailable: NotRequired[bool],
    Cancellable: NotRequired[bool],
    UpdateStatus: NotRequired[DeploymentStatusType],  # (1)
    Description: NotRequired[str],
    AutomatedUpdateDate: NotRequired[datetime],
    OptionalDeployment: NotRequired[bool],
  1. See DeploymentStatusType

ChangeProgressDetailsTypeDef#

# ChangeProgressDetailsTypeDef definition

class ChangeProgressDetailsTypeDef(TypedDict):
    ChangeId: NotRequired[str],
    Message: NotRequired[str],
    ConfigChangeStatus: NotRequired[ConfigChangeStatusType],  # (1)
    InitiatedBy: NotRequired[InitiatedByType],  # (2)
    StartTime: NotRequired[datetime],
    LastUpdatedTime: NotRequired[datetime],
  1. See ConfigChangeStatusType
  2. See InitiatedByType

ChangeProgressStageTypeDef#

# ChangeProgressStageTypeDef definition

class ChangeProgressStageTypeDef(TypedDict):
    Name: NotRequired[str],
    Status: NotRequired[str],
    Description: NotRequired[str],
    LastUpdated: NotRequired[datetime],

ColdStorageOptionsTypeDef#

# ColdStorageOptionsTypeDef definition

class ColdStorageOptionsTypeDef(TypedDict):
    Enabled: bool,

ZoneAwarenessConfigTypeDef#

# ZoneAwarenessConfigTypeDef definition

class ZoneAwarenessConfigTypeDef(TypedDict):
    AvailabilityZoneCount: NotRequired[int],

CognitoOptionsTypeDef#

# CognitoOptionsTypeDef definition

class CognitoOptionsTypeDef(TypedDict):
    Enabled: NotRequired[bool],
    UserPoolId: NotRequired[str],
    IdentityPoolId: NotRequired[str],
    RoleArn: NotRequired[str],

CompatibleVersionsMapTypeDef#

# CompatibleVersionsMapTypeDef definition

class CompatibleVersionsMapTypeDef(TypedDict):
    SourceVersion: NotRequired[str],
    TargetVersions: NotRequired[List[str]],

CrossClusterSearchConnectionPropertiesTypeDef#

# CrossClusterSearchConnectionPropertiesTypeDef definition

class CrossClusterSearchConnectionPropertiesTypeDef(TypedDict):
    SkipUnavailable: NotRequired[SkipUnavailableStatusType],  # (1)
  1. See SkipUnavailableStatusType

DomainEndpointOptionsTypeDef#

# DomainEndpointOptionsTypeDef definition

class DomainEndpointOptionsTypeDef(TypedDict):
    EnforceHTTPS: NotRequired[bool],
    TLSSecurityPolicy: NotRequired[TLSSecurityPolicyType],  # (1)
    CustomEndpointEnabled: NotRequired[bool],
    CustomEndpoint: NotRequired[str],
    CustomEndpointCertificateArn: NotRequired[str],
  1. See TLSSecurityPolicyType

EBSOptionsTypeDef#

# EBSOptionsTypeDef definition

class EBSOptionsTypeDef(TypedDict):
    EBSEnabled: NotRequired[bool],
    VolumeType: NotRequired[VolumeTypeType],  # (1)
    VolumeSize: NotRequired[int],
    Iops: NotRequired[int],
    Throughput: NotRequired[int],
  1. See VolumeTypeType

EncryptionAtRestOptionsTypeDef#

# EncryptionAtRestOptionsTypeDef definition

class EncryptionAtRestOptionsTypeDef(TypedDict):
    Enabled: NotRequired[bool],
    KmsKeyId: NotRequired[str],

LogPublishingOptionTypeDef#

# LogPublishingOptionTypeDef definition

class LogPublishingOptionTypeDef(TypedDict):
    CloudWatchLogsLogGroupArn: NotRequired[str],
    Enabled: NotRequired[bool],

NodeToNodeEncryptionOptionsTypeDef#

# NodeToNodeEncryptionOptionsTypeDef definition

class NodeToNodeEncryptionOptionsTypeDef(TypedDict):
    Enabled: NotRequired[bool],

SnapshotOptionsTypeDef#

# SnapshotOptionsTypeDef definition

class SnapshotOptionsTypeDef(TypedDict):
    AutomatedSnapshotStartHour: NotRequired[int],

SoftwareUpdateOptionsTypeDef#

# SoftwareUpdateOptionsTypeDef definition

class SoftwareUpdateOptionsTypeDef(TypedDict):
    AutoSoftwareUpdateEnabled: NotRequired[bool],

VPCOptionsTypeDef#

# VPCOptionsTypeDef definition

class VPCOptionsTypeDef(TypedDict):
    SubnetIds: NotRequired[Sequence[str]],
    SecurityGroupIds: NotRequired[Sequence[str]],

OutboundConnectionStatusTypeDef#

# OutboundConnectionStatusTypeDef definition

class OutboundConnectionStatusTypeDef(TypedDict):
    StatusCode: NotRequired[OutboundConnectionStatusCodeType],  # (1)
    Message: NotRequired[str],
  1. See OutboundConnectionStatusCodeType

PackageSourceTypeDef#

# PackageSourceTypeDef definition

class PackageSourceTypeDef(TypedDict):
    S3BucketName: NotRequired[str],
    S3Key: NotRequired[str],

S3GlueDataCatalogTypeDef#

# S3GlueDataCatalogTypeDef definition

class S3GlueDataCatalogTypeDef(TypedDict):
    RoleArn: NotRequired[str],

DeleteDataSourceRequestRequestTypeDef#

# DeleteDataSourceRequestRequestTypeDef definition

class DeleteDataSourceRequestRequestTypeDef(TypedDict):
    DomainName: str,
    Name: str,

DeleteDomainRequestRequestTypeDef#

# DeleteDomainRequestRequestTypeDef definition

class DeleteDomainRequestRequestTypeDef(TypedDict):
    DomainName: str,

DeleteInboundConnectionRequestRequestTypeDef#

# DeleteInboundConnectionRequestRequestTypeDef definition

class DeleteInboundConnectionRequestRequestTypeDef(TypedDict):
    ConnectionId: str,

DeleteOutboundConnectionRequestRequestTypeDef#

# DeleteOutboundConnectionRequestRequestTypeDef definition

class DeleteOutboundConnectionRequestRequestTypeDef(TypedDict):
    ConnectionId: str,

DeletePackageRequestRequestTypeDef#

# DeletePackageRequestRequestTypeDef definition

class DeletePackageRequestRequestTypeDef(TypedDict):
    PackageID: str,

DeleteVpcEndpointRequestRequestTypeDef#

# DeleteVpcEndpointRequestRequestTypeDef definition

class DeleteVpcEndpointRequestRequestTypeDef(TypedDict):
    VpcEndpointId: str,

VpcEndpointSummaryTypeDef#

# VpcEndpointSummaryTypeDef definition

class VpcEndpointSummaryTypeDef(TypedDict):
    VpcEndpointId: NotRequired[str],
    VpcEndpointOwner: NotRequired[str],
    DomainArn: NotRequired[str],
    Status: NotRequired[VpcEndpointStatusType],  # (1)
  1. See VpcEndpointStatusType

DescribeDomainAutoTunesRequestRequestTypeDef#

# DescribeDomainAutoTunesRequestRequestTypeDef definition

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

DescribeDomainChangeProgressRequestRequestTypeDef#

# DescribeDomainChangeProgressRequestRequestTypeDef definition

class DescribeDomainChangeProgressRequestRequestTypeDef(TypedDict):
    DomainName: str,
    ChangeId: NotRequired[str],

DescribeDomainConfigRequestRequestTypeDef#

# DescribeDomainConfigRequestRequestTypeDef definition

class DescribeDomainConfigRequestRequestTypeDef(TypedDict):
    DomainName: str,

DescribeDomainHealthRequestRequestTypeDef#

# DescribeDomainHealthRequestRequestTypeDef definition

class DescribeDomainHealthRequestRequestTypeDef(TypedDict):
    DomainName: str,

DescribeDomainNodesRequestRequestTypeDef#

# DescribeDomainNodesRequestRequestTypeDef definition

class DescribeDomainNodesRequestRequestTypeDef(TypedDict):
    DomainName: str,

DomainNodesStatusTypeDef#

# DomainNodesStatusTypeDef definition

class DomainNodesStatusTypeDef(TypedDict):
    NodeId: NotRequired[str],
    NodeType: NotRequired[NodeTypeType],  # (1)
    AvailabilityZone: NotRequired[str],
    InstanceType: NotRequired[OpenSearchPartitionInstanceTypeType],  # (2)
    NodeStatus: NotRequired[NodeStatusType],  # (3)
    StorageType: NotRequired[str],
    StorageVolumeType: NotRequired[VolumeTypeType],  # (4)
    StorageSize: NotRequired[str],
  1. See NodeTypeType
  2. See OpenSearchPartitionInstanceTypeType
  3. See NodeStatusType
  4. See VolumeTypeType

DescribeDomainRequestRequestTypeDef#

# DescribeDomainRequestRequestTypeDef definition

class DescribeDomainRequestRequestTypeDef(TypedDict):
    DomainName: str,

DescribeDomainsRequestRequestTypeDef#

# DescribeDomainsRequestRequestTypeDef definition

class DescribeDomainsRequestRequestTypeDef(TypedDict):
    DomainNames: Sequence[str],

DescribeDryRunProgressRequestRequestTypeDef#

# DescribeDryRunProgressRequestRequestTypeDef definition

class DescribeDryRunProgressRequestRequestTypeDef(TypedDict):
    DomainName: str,
    DryRunId: NotRequired[str],
    LoadDryRunConfig: NotRequired[bool],

DryRunResultsTypeDef#

# DryRunResultsTypeDef definition

class DryRunResultsTypeDef(TypedDict):
    DeploymentType: NotRequired[str],
    Message: NotRequired[str],

FilterTypeDef#

# FilterTypeDef definition

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

DescribeInstanceTypeLimitsRequestRequestTypeDef#

# DescribeInstanceTypeLimitsRequestRequestTypeDef definition

class DescribeInstanceTypeLimitsRequestRequestTypeDef(TypedDict):
    InstanceType: OpenSearchPartitionInstanceTypeType,  # (1)
    EngineVersion: str,
    DomainName: NotRequired[str],
  1. See OpenSearchPartitionInstanceTypeType

DescribePackagesFilterTypeDef#

# DescribePackagesFilterTypeDef definition

class DescribePackagesFilterTypeDef(TypedDict):
    Name: NotRequired[DescribePackagesFilterNameType],  # (1)
    Value: NotRequired[Sequence[str]],
  1. See DescribePackagesFilterNameType

DescribeReservedInstanceOfferingsRequestRequestTypeDef#

# DescribeReservedInstanceOfferingsRequestRequestTypeDef definition

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

DescribeReservedInstancesRequestRequestTypeDef#

# DescribeReservedInstancesRequestRequestTypeDef definition

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

DescribeVpcEndpointsRequestRequestTypeDef#

# DescribeVpcEndpointsRequestRequestTypeDef definition

class DescribeVpcEndpointsRequestRequestTypeDef(TypedDict):
    VpcEndpointIds: Sequence[str],

VpcEndpointErrorTypeDef#

# VpcEndpointErrorTypeDef definition

class VpcEndpointErrorTypeDef(TypedDict):
    VpcEndpointId: NotRequired[str],
    ErrorCode: NotRequired[VpcEndpointErrorCodeType],  # (1)
    ErrorMessage: NotRequired[str],
  1. See VpcEndpointErrorCodeType

DissociatePackageRequestRequestTypeDef#

# DissociatePackageRequestRequestTypeDef definition

class DissociatePackageRequestRequestTypeDef(TypedDict):
    PackageID: str,
    DomainName: str,

ModifyingPropertiesTypeDef#

# ModifyingPropertiesTypeDef definition

class ModifyingPropertiesTypeDef(TypedDict):
    Name: NotRequired[str],
    ActiveValue: NotRequired[str],
    PendingValue: NotRequired[str],
    ValueType: NotRequired[PropertyValueTypeType],  # (1)
  1. See PropertyValueTypeType

DomainInfoTypeDef#

# DomainInfoTypeDef definition

class DomainInfoTypeDef(TypedDict):
    DomainName: NotRequired[str],
    EngineType: NotRequired[EngineTypeType],  # (1)
  1. See EngineTypeType

DomainMaintenanceDetailsTypeDef#

# DomainMaintenanceDetailsTypeDef definition

class DomainMaintenanceDetailsTypeDef(TypedDict):
    MaintenanceId: NotRequired[str],
    DomainName: NotRequired[str],
    Action: NotRequired[MaintenanceTypeType],  # (1)
    NodeId: NotRequired[str],
    Status: NotRequired[MaintenanceStatusType],  # (2)
    StatusMessage: NotRequired[str],
    CreatedAt: NotRequired[datetime],
    UpdatedAt: NotRequired[datetime],
  1. See MaintenanceTypeType
  2. See MaintenanceStatusType

ErrorDetailsTypeDef#

# ErrorDetailsTypeDef definition

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

VPCDerivedInfoTypeDef#

# VPCDerivedInfoTypeDef definition

class VPCDerivedInfoTypeDef(TypedDict):
    VPCId: NotRequired[str],
    SubnetIds: NotRequired[List[str]],
    AvailabilityZones: NotRequired[List[str]],
    SecurityGroupIds: NotRequired[List[str]],

ValidationFailureTypeDef#

# ValidationFailureTypeDef definition

class ValidationFailureTypeDef(TypedDict):
    Code: NotRequired[str],
    Message: NotRequired[str],

GetCompatibleVersionsRequestRequestTypeDef#

# GetCompatibleVersionsRequestRequestTypeDef definition

class GetCompatibleVersionsRequestRequestTypeDef(TypedDict):
    DomainName: NotRequired[str],

GetDataSourceRequestRequestTypeDef#

# GetDataSourceRequestRequestTypeDef definition

class GetDataSourceRequestRequestTypeDef(TypedDict):
    DomainName: str,
    Name: str,

GetDomainMaintenanceStatusRequestRequestTypeDef#

# GetDomainMaintenanceStatusRequestRequestTypeDef definition

class GetDomainMaintenanceStatusRequestRequestTypeDef(TypedDict):
    DomainName: str,
    MaintenanceId: str,

GetPackageVersionHistoryRequestRequestTypeDef#

# GetPackageVersionHistoryRequestRequestTypeDef definition

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

GetUpgradeHistoryRequestRequestTypeDef#

# GetUpgradeHistoryRequestRequestTypeDef definition

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

GetUpgradeStatusRequestRequestTypeDef#

# GetUpgradeStatusRequestRequestTypeDef definition

class GetUpgradeStatusRequestRequestTypeDef(TypedDict):
    DomainName: str,

InboundConnectionStatusTypeDef#

# InboundConnectionStatusTypeDef definition

class InboundConnectionStatusTypeDef(TypedDict):
    StatusCode: NotRequired[InboundConnectionStatusCodeType],  # (1)
    Message: NotRequired[str],
  1. See InboundConnectionStatusCodeType

InstanceCountLimitsTypeDef#

# InstanceCountLimitsTypeDef definition

class InstanceCountLimitsTypeDef(TypedDict):
    MinimumInstanceCount: NotRequired[int],
    MaximumInstanceCount: NotRequired[int],

InstanceTypeDetailsTypeDef#

# InstanceTypeDetailsTypeDef definition

class InstanceTypeDetailsTypeDef(TypedDict):
    InstanceType: NotRequired[OpenSearchPartitionInstanceTypeType],  # (1)
    EncryptionEnabled: NotRequired[bool],
    CognitoEnabled: NotRequired[bool],
    AppLogsEnabled: NotRequired[bool],
    AdvancedSecurityEnabled: NotRequired[bool],
    WarmEnabled: NotRequired[bool],
    InstanceRole: NotRequired[List[str]],
    AvailabilityZones: NotRequired[List[str]],
  1. See OpenSearchPartitionInstanceTypeType

ListDataSourcesRequestRequestTypeDef#

# ListDataSourcesRequestRequestTypeDef definition

class ListDataSourcesRequestRequestTypeDef(TypedDict):
    DomainName: str,

ListDomainMaintenancesRequestRequestTypeDef#

# ListDomainMaintenancesRequestRequestTypeDef definition

class ListDomainMaintenancesRequestRequestTypeDef(TypedDict):
    DomainName: str,
    Action: NotRequired[MaintenanceTypeType],  # (1)
    Status: NotRequired[MaintenanceStatusType],  # (2)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See MaintenanceTypeType
  2. See MaintenanceStatusType

ListDomainNamesRequestRequestTypeDef#

# ListDomainNamesRequestRequestTypeDef definition

class ListDomainNamesRequestRequestTypeDef(TypedDict):
    EngineType: NotRequired[EngineTypeType],  # (1)
  1. See EngineTypeType

ListDomainsForPackageRequestRequestTypeDef#

# ListDomainsForPackageRequestRequestTypeDef definition

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

ListInstanceTypeDetailsRequestRequestTypeDef#

# ListInstanceTypeDetailsRequestRequestTypeDef definition

class ListInstanceTypeDetailsRequestRequestTypeDef(TypedDict):
    EngineVersion: str,
    DomainName: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    RetrieveAZs: NotRequired[bool],
    InstanceType: NotRequired[str],

ListPackagesForDomainRequestRequestTypeDef#

# ListPackagesForDomainRequestRequestTypeDef definition

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

ListScheduledActionsRequestRequestTypeDef#

# ListScheduledActionsRequestRequestTypeDef definition

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

ScheduledActionTypeDef#

# ScheduledActionTypeDef definition

class ScheduledActionTypeDef(TypedDict):
    Id: str,
    Type: ActionTypeType,  # (1)
    Severity: ActionSeverityType,  # (2)
    ScheduledTime: int,
    Description: NotRequired[str],
    ScheduledBy: NotRequired[ScheduledByType],  # (3)
    Status: NotRequired[ActionStatusType],  # (4)
    Mandatory: NotRequired[bool],
    Cancellable: NotRequired[bool],
  1. See ActionTypeType
  2. See ActionSeverityType
  3. See ScheduledByType
  4. See ActionStatusType

ListTagsRequestRequestTypeDef#

# ListTagsRequestRequestTypeDef definition

class ListTagsRequestRequestTypeDef(TypedDict):
    ARN: str,

ListVersionsRequestRequestTypeDef#

# ListVersionsRequestRequestTypeDef definition

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

ListVpcEndpointAccessRequestRequestTypeDef#

# ListVpcEndpointAccessRequestRequestTypeDef definition

class ListVpcEndpointAccessRequestRequestTypeDef(TypedDict):
    DomainName: str,
    NextToken: NotRequired[str],

ListVpcEndpointsForDomainRequestRequestTypeDef#

# ListVpcEndpointsForDomainRequestRequestTypeDef definition

class ListVpcEndpointsForDomainRequestRequestTypeDef(TypedDict):
    DomainName: str,
    NextToken: NotRequired[str],

ListVpcEndpointsRequestRequestTypeDef#

# ListVpcEndpointsRequestRequestTypeDef definition

class ListVpcEndpointsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],

WindowStartTimeTypeDef#

# WindowStartTimeTypeDef definition

class WindowStartTimeTypeDef(TypedDict):
    Hours: int,
    Minutes: int,

PluginPropertiesTypeDef#

# PluginPropertiesTypeDef definition

class PluginPropertiesTypeDef(TypedDict):
    Name: NotRequired[str],
    Description: NotRequired[str],
    Version: NotRequired[str],
    ClassName: NotRequired[str],
    UncompressedSizeInBytes: NotRequired[int],

PurchaseReservedInstanceOfferingRequestRequestTypeDef#

# PurchaseReservedInstanceOfferingRequestRequestTypeDef definition

class PurchaseReservedInstanceOfferingRequestRequestTypeDef(TypedDict):
    ReservedInstanceOfferingId: str,
    ReservationName: str,
    InstanceCount: NotRequired[int],

RecurringChargeTypeDef#

# RecurringChargeTypeDef definition

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

RejectInboundConnectionRequestRequestTypeDef#

# RejectInboundConnectionRequestRequestTypeDef definition

class RejectInboundConnectionRequestRequestTypeDef(TypedDict):
    ConnectionId: str,

RemoveTagsRequestRequestTypeDef#

# RemoveTagsRequestRequestTypeDef definition

class RemoveTagsRequestRequestTypeDef(TypedDict):
    ARN: str,
    TagKeys: Sequence[str],

RevokeVpcEndpointAccessRequestRequestTypeDef#

# RevokeVpcEndpointAccessRequestRequestTypeDef definition

class RevokeVpcEndpointAccessRequestRequestTypeDef(TypedDict):
    DomainName: str,
    Account: str,

SAMLIdpTypeDef#

# SAMLIdpTypeDef definition

class SAMLIdpTypeDef(TypedDict):
    MetadataContent: str,
    EntityId: str,

StartDomainMaintenanceRequestRequestTypeDef#

# StartDomainMaintenanceRequestRequestTypeDef definition

class StartDomainMaintenanceRequestRequestTypeDef(TypedDict):
    DomainName: str,
    Action: MaintenanceTypeType,  # (1)
    NodeId: NotRequired[str],
  1. See MaintenanceTypeType

StartServiceSoftwareUpdateRequestRequestTypeDef#

# StartServiceSoftwareUpdateRequestRequestTypeDef definition

class StartServiceSoftwareUpdateRequestRequestTypeDef(TypedDict):
    DomainName: str,
    ScheduleAt: NotRequired[ScheduleAtType],  # (1)
    DesiredStartTime: NotRequired[int],
  1. See ScheduleAtType

StorageTypeLimitTypeDef#

# StorageTypeLimitTypeDef definition

class StorageTypeLimitTypeDef(TypedDict):
    LimitName: NotRequired[str],
    LimitValues: NotRequired[List[str]],

UpdateScheduledActionRequestRequestTypeDef#

# UpdateScheduledActionRequestRequestTypeDef definition

class UpdateScheduledActionRequestRequestTypeDef(TypedDict):
    DomainName: str,
    ActionID: str,
    ActionType: ActionTypeType,  # (1)
    ScheduleAt: ScheduleAtType,  # (2)
    DesiredStartTime: NotRequired[int],
  1. See ActionTypeType
  2. See ScheduleAtType

UpgradeDomainRequestRequestTypeDef#

# UpgradeDomainRequestRequestTypeDef definition

class UpgradeDomainRequestRequestTypeDef(TypedDict):
    DomainName: str,
    TargetVersion: str,
    PerformCheckOnly: NotRequired[bool],
    AdvancedOptions: NotRequired[Mapping[str, str]],

UpgradeStepItemTypeDef#

# UpgradeStepItemTypeDef definition

class UpgradeStepItemTypeDef(TypedDict):
    UpgradeStep: NotRequired[UpgradeStepType],  # (1)
    UpgradeStepStatus: NotRequired[UpgradeStatusType],  # (2)
    Issues: NotRequired[List[str]],
    ProgressPercent: NotRequired[float],
  1. See UpgradeStepType
  2. See UpgradeStatusType

DomainInformationContainerTypeDef#

# DomainInformationContainerTypeDef definition

class DomainInformationContainerTypeDef(TypedDict):
    AWSDomainInformation: NotRequired[AWSDomainInformationTypeDef],  # (1)
  1. See AWSDomainInformationTypeDef

AddDataSourceResponseTypeDef#

# AddDataSourceResponseTypeDef definition

class AddDataSourceResponseTypeDef(TypedDict):
    Message: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteDataSourceResponseTypeDef#

# DeleteDataSourceResponseTypeDef definition

class DeleteDataSourceResponseTypeDef(TypedDict):
    Message: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

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

GetDomainMaintenanceStatusResponseTypeDef#

# GetDomainMaintenanceStatusResponseTypeDef definition

class GetDomainMaintenanceStatusResponseTypeDef(TypedDict):
    Status: MaintenanceStatusType,  # (1)
    StatusMessage: str,
    NodeId: str,
    Action: MaintenanceTypeType,  # (2)
    CreatedAt: datetime,
    UpdatedAt: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See MaintenanceStatusType
  2. See MaintenanceTypeType
  3. See ResponseMetadataTypeDef

GetUpgradeStatusResponseTypeDef#

# GetUpgradeStatusResponseTypeDef definition

class GetUpgradeStatusResponseTypeDef(TypedDict):
    UpgradeStep: UpgradeStepType,  # (1)
    StepStatus: UpgradeStatusType,  # (2)
    UpgradeName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See UpgradeStepType
  2. See UpgradeStatusType
  3. See ResponseMetadataTypeDef

ListVersionsResponseTypeDef#

# ListVersionsResponseTypeDef definition

class ListVersionsResponseTypeDef(TypedDict):
    Versions: List[str],
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PurchaseReservedInstanceOfferingResponseTypeDef#

# PurchaseReservedInstanceOfferingResponseTypeDef definition

class PurchaseReservedInstanceOfferingResponseTypeDef(TypedDict):
    ReservedInstanceId: str,
    ReservationName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartDomainMaintenanceResponseTypeDef#

# StartDomainMaintenanceResponseTypeDef definition

class StartDomainMaintenanceResponseTypeDef(TypedDict):
    MaintenanceId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateDataSourceResponseTypeDef#

# UpdateDataSourceResponseTypeDef definition

class UpdateDataSourceResponseTypeDef(TypedDict):
    Message: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

AccessPoliciesStatusTypeDef#

# AccessPoliciesStatusTypeDef definition

class AccessPoliciesStatusTypeDef(TypedDict):
    Options: str,
    Status: OptionStatusTypeDef,  # (1)
  1. See OptionStatusTypeDef

AdvancedOptionsStatusTypeDef#

# AdvancedOptionsStatusTypeDef definition

class AdvancedOptionsStatusTypeDef(TypedDict):
    Options: Dict[str, str],
    Status: OptionStatusTypeDef,  # (1)
  1. See OptionStatusTypeDef

IPAddressTypeStatusTypeDef#

# IPAddressTypeStatusTypeDef definition

class IPAddressTypeStatusTypeDef(TypedDict):
    Options: IPAddressTypeType,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See IPAddressTypeType
  2. See OptionStatusTypeDef

VersionStatusTypeDef#

# VersionStatusTypeDef definition

class VersionStatusTypeDef(TypedDict):
    Options: str,
    Status: OptionStatusTypeDef,  # (1)
  1. See OptionStatusTypeDef

AddTagsRequestRequestTypeDef#

# AddTagsRequestRequestTypeDef definition

class AddTagsRequestRequestTypeDef(TypedDict):
    ARN: str,
    TagList: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

ListTagsResponseTypeDef#

# ListTagsResponseTypeDef definition

class ListTagsResponseTypeDef(TypedDict):
    TagList: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

AuthorizeVpcEndpointAccessResponseTypeDef#

# AuthorizeVpcEndpointAccessResponseTypeDef definition

class AuthorizeVpcEndpointAccessResponseTypeDef(TypedDict):
    AuthorizedPrincipal: AuthorizedPrincipalTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AuthorizedPrincipalTypeDef
  2. See ResponseMetadataTypeDef

ListVpcEndpointAccessResponseTypeDef#

# ListVpcEndpointAccessResponseTypeDef definition

class ListVpcEndpointAccessResponseTypeDef(TypedDict):
    AuthorizedPrincipalList: List[AuthorizedPrincipalTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AuthorizedPrincipalTypeDef
  2. See ResponseMetadataTypeDef

AutoTuneDetailsTypeDef#

# AutoTuneDetailsTypeDef definition

class AutoTuneDetailsTypeDef(TypedDict):
    ScheduledAutoTuneDetails: NotRequired[ScheduledAutoTuneDetailsTypeDef],  # (1)
  1. See ScheduledAutoTuneDetailsTypeDef

AutoTuneMaintenanceScheduleTypeDef#

# AutoTuneMaintenanceScheduleTypeDef definition

class AutoTuneMaintenanceScheduleTypeDef(TypedDict):
    StartAt: NotRequired[Union[datetime, str]],
    Duration: NotRequired[DurationTypeDef],  # (1)
    CronExpressionForRecurrence: NotRequired[str],
  1. See DurationTypeDef

EnvironmentInfoTypeDef#

# EnvironmentInfoTypeDef definition

class EnvironmentInfoTypeDef(TypedDict):
    AvailabilityZoneInformation: NotRequired[List[AvailabilityZoneInfoTypeDef]],  # (1)
  1. See AvailabilityZoneInfoTypeDef

CancelDomainConfigChangeResponseTypeDef#

# CancelDomainConfigChangeResponseTypeDef definition

class CancelDomainConfigChangeResponseTypeDef(TypedDict):
    CancelledChangeIds: List[str],
    CancelledChangeProperties: List[CancelledChangePropertyTypeDef],  # (1)
    DryRun: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CancelledChangePropertyTypeDef
  2. See ResponseMetadataTypeDef

CancelServiceSoftwareUpdateResponseTypeDef#

# CancelServiceSoftwareUpdateResponseTypeDef definition

class CancelServiceSoftwareUpdateResponseTypeDef(TypedDict):
    ServiceSoftwareOptions: ServiceSoftwareOptionsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ServiceSoftwareOptionsTypeDef
  2. See ResponseMetadataTypeDef

StartServiceSoftwareUpdateResponseTypeDef#

# StartServiceSoftwareUpdateResponseTypeDef definition

class StartServiceSoftwareUpdateResponseTypeDef(TypedDict):
    ServiceSoftwareOptions: ServiceSoftwareOptionsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ServiceSoftwareOptionsTypeDef
  2. See ResponseMetadataTypeDef

UpgradeDomainResponseTypeDef#

# UpgradeDomainResponseTypeDef definition

class UpgradeDomainResponseTypeDef(TypedDict):
    UpgradeId: str,
    DomainName: str,
    TargetVersion: str,
    PerformCheckOnly: bool,
    AdvancedOptions: Dict[str, str],
    ChangeProgressDetails: ChangeProgressDetailsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ChangeProgressDetailsTypeDef
  2. See ResponseMetadataTypeDef

ChangeProgressStatusDetailsTypeDef#

# ChangeProgressStatusDetailsTypeDef definition

class ChangeProgressStatusDetailsTypeDef(TypedDict):
    ChangeId: NotRequired[str],
    StartTime: NotRequired[datetime],
    Status: NotRequired[OverallChangeStatusType],  # (1)
    PendingProperties: NotRequired[List[str]],
    CompletedProperties: NotRequired[List[str]],
    TotalNumberOfStages: NotRequired[int],
    ChangeProgressStages: NotRequired[List[ChangeProgressStageTypeDef]],  # (2)
    LastUpdatedTime: NotRequired[datetime],
    ConfigChangeStatus: NotRequired[ConfigChangeStatusType],  # (3)
    InitiatedBy: NotRequired[InitiatedByType],  # (4)
  1. See OverallChangeStatusType
  2. See ChangeProgressStageTypeDef
  3. See ConfigChangeStatusType
  4. See InitiatedByType

ClusterConfigTypeDef#

# ClusterConfigTypeDef definition

class ClusterConfigTypeDef(TypedDict):
    InstanceType: NotRequired[OpenSearchPartitionInstanceTypeType],  # (1)
    InstanceCount: NotRequired[int],
    DedicatedMasterEnabled: NotRequired[bool],
    ZoneAwarenessEnabled: NotRequired[bool],
    ZoneAwarenessConfig: NotRequired[ZoneAwarenessConfigTypeDef],  # (2)
    DedicatedMasterType: NotRequired[OpenSearchPartitionInstanceTypeType],  # (1)
    DedicatedMasterCount: NotRequired[int],
    WarmEnabled: NotRequired[bool],
    WarmType: NotRequired[OpenSearchWarmPartitionInstanceTypeType],  # (4)
    WarmCount: NotRequired[int],
    ColdStorageOptions: NotRequired[ColdStorageOptionsTypeDef],  # (5)
    MultiAZWithStandbyEnabled: NotRequired[bool],
  1. See OpenSearchPartitionInstanceTypeType
  2. See ZoneAwarenessConfigTypeDef
  3. See OpenSearchPartitionInstanceTypeType
  4. See OpenSearchWarmPartitionInstanceTypeType
  5. See ColdStorageOptionsTypeDef

CognitoOptionsStatusTypeDef#

# CognitoOptionsStatusTypeDef definition

class CognitoOptionsStatusTypeDef(TypedDict):
    Options: CognitoOptionsTypeDef,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See CognitoOptionsTypeDef
  2. See OptionStatusTypeDef

GetCompatibleVersionsResponseTypeDef#

# GetCompatibleVersionsResponseTypeDef definition

class GetCompatibleVersionsResponseTypeDef(TypedDict):
    CompatibleVersions: List[CompatibleVersionsMapTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CompatibleVersionsMapTypeDef
  2. See ResponseMetadataTypeDef

ConnectionPropertiesTypeDef#

# ConnectionPropertiesTypeDef definition

class ConnectionPropertiesTypeDef(TypedDict):
    Endpoint: NotRequired[str],
    CrossClusterSearch: NotRequired[CrossClusterSearchConnectionPropertiesTypeDef],  # (1)
  1. See CrossClusterSearchConnectionPropertiesTypeDef

DomainEndpointOptionsStatusTypeDef#

# DomainEndpointOptionsStatusTypeDef definition

class DomainEndpointOptionsStatusTypeDef(TypedDict):
    Options: DomainEndpointOptionsTypeDef,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See DomainEndpointOptionsTypeDef
  2. See OptionStatusTypeDef

EBSOptionsStatusTypeDef#

# EBSOptionsStatusTypeDef definition

class EBSOptionsStatusTypeDef(TypedDict):
    Options: EBSOptionsTypeDef,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See EBSOptionsTypeDef
  2. See OptionStatusTypeDef

EncryptionAtRestOptionsStatusTypeDef#

# EncryptionAtRestOptionsStatusTypeDef definition

class EncryptionAtRestOptionsStatusTypeDef(TypedDict):
    Options: EncryptionAtRestOptionsTypeDef,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See EncryptionAtRestOptionsTypeDef
  2. See OptionStatusTypeDef

LogPublishingOptionsStatusTypeDef#

# LogPublishingOptionsStatusTypeDef definition

class LogPublishingOptionsStatusTypeDef(TypedDict):
    Options: NotRequired[Dict[LogTypeType, LogPublishingOptionTypeDef]],  # (1)
    Status: NotRequired[OptionStatusTypeDef],  # (2)
  1. See LogTypeType LogPublishingOptionTypeDef
  2. See OptionStatusTypeDef

NodeToNodeEncryptionOptionsStatusTypeDef#

# NodeToNodeEncryptionOptionsStatusTypeDef definition

class NodeToNodeEncryptionOptionsStatusTypeDef(TypedDict):
    Options: NodeToNodeEncryptionOptionsTypeDef,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See NodeToNodeEncryptionOptionsTypeDef
  2. See OptionStatusTypeDef

SnapshotOptionsStatusTypeDef#

# SnapshotOptionsStatusTypeDef definition

class SnapshotOptionsStatusTypeDef(TypedDict):
    Options: SnapshotOptionsTypeDef,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See SnapshotOptionsTypeDef
  2. See OptionStatusTypeDef

SoftwareUpdateOptionsStatusTypeDef#

# SoftwareUpdateOptionsStatusTypeDef definition

class SoftwareUpdateOptionsStatusTypeDef(TypedDict):
    Options: NotRequired[SoftwareUpdateOptionsTypeDef],  # (1)
    Status: NotRequired[OptionStatusTypeDef],  # (2)
  1. See SoftwareUpdateOptionsTypeDef
  2. See OptionStatusTypeDef

CreateVpcEndpointRequestRequestTypeDef#

# CreateVpcEndpointRequestRequestTypeDef definition

class CreateVpcEndpointRequestRequestTypeDef(TypedDict):
    DomainArn: str,
    VpcOptions: VPCOptionsTypeDef,  # (1)
    ClientToken: NotRequired[str],
  1. See VPCOptionsTypeDef

UpdateVpcEndpointRequestRequestTypeDef#

# UpdateVpcEndpointRequestRequestTypeDef definition

class UpdateVpcEndpointRequestRequestTypeDef(TypedDict):
    VpcEndpointId: str,
    VpcOptions: VPCOptionsTypeDef,  # (1)
  1. See VPCOptionsTypeDef

CreatePackageRequestRequestTypeDef#

# CreatePackageRequestRequestTypeDef definition

class CreatePackageRequestRequestTypeDef(TypedDict):
    PackageName: str,
    PackageType: PackageTypeType,  # (1)
    PackageSource: PackageSourceTypeDef,  # (2)
    PackageDescription: NotRequired[str],
  1. See PackageTypeType
  2. See PackageSourceTypeDef

UpdatePackageRequestRequestTypeDef#

# UpdatePackageRequestRequestTypeDef definition

class UpdatePackageRequestRequestTypeDef(TypedDict):
    PackageID: str,
    PackageSource: PackageSourceTypeDef,  # (1)
    PackageDescription: NotRequired[str],
    CommitMessage: NotRequired[str],
  1. See PackageSourceTypeDef

DataSourceTypeTypeDef#

# DataSourceTypeTypeDef definition

class DataSourceTypeTypeDef(TypedDict):
    S3GlueDataCatalog: NotRequired[S3GlueDataCatalogTypeDef],  # (1)
  1. See S3GlueDataCatalogTypeDef

DeleteVpcEndpointResponseTypeDef#

# DeleteVpcEndpointResponseTypeDef definition

class DeleteVpcEndpointResponseTypeDef(TypedDict):
    VpcEndpointSummary: VpcEndpointSummaryTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See VpcEndpointSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListVpcEndpointsForDomainResponseTypeDef#

# ListVpcEndpointsForDomainResponseTypeDef definition

class ListVpcEndpointsForDomainResponseTypeDef(TypedDict):
    VpcEndpointSummaryList: List[VpcEndpointSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See VpcEndpointSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListVpcEndpointsResponseTypeDef#

# ListVpcEndpointsResponseTypeDef definition

class ListVpcEndpointsResponseTypeDef(TypedDict):
    VpcEndpointSummaryList: List[VpcEndpointSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See VpcEndpointSummaryTypeDef
  2. See ResponseMetadataTypeDef

DescribeDomainNodesResponseTypeDef#

# DescribeDomainNodesResponseTypeDef definition

class DescribeDomainNodesResponseTypeDef(TypedDict):
    DomainNodesStatusList: List[DomainNodesStatusTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainNodesStatusTypeDef
  2. See ResponseMetadataTypeDef

DescribeInboundConnectionsRequestRequestTypeDef#

# DescribeInboundConnectionsRequestRequestTypeDef definition

class DescribeInboundConnectionsRequestRequestTypeDef(TypedDict):
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See FilterTypeDef

DescribeOutboundConnectionsRequestRequestTypeDef#

# DescribeOutboundConnectionsRequestRequestTypeDef definition

class DescribeOutboundConnectionsRequestRequestTypeDef(TypedDict):
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See FilterTypeDef

DescribePackagesRequestRequestTypeDef#

# DescribePackagesRequestRequestTypeDef definition

class DescribePackagesRequestRequestTypeDef(TypedDict):
    Filters: NotRequired[Sequence[DescribePackagesFilterTypeDef]],  # (1)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See DescribePackagesFilterTypeDef

ListDomainNamesResponseTypeDef#

# ListDomainNamesResponseTypeDef definition

class ListDomainNamesResponseTypeDef(TypedDict):
    DomainNames: List[DomainInfoTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainInfoTypeDef
  2. See ResponseMetadataTypeDef

ListDomainMaintenancesResponseTypeDef#

# ListDomainMaintenancesResponseTypeDef definition

class ListDomainMaintenancesResponseTypeDef(TypedDict):
    DomainMaintenances: List[DomainMaintenanceDetailsTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainMaintenanceDetailsTypeDef
  2. See ResponseMetadataTypeDef

DomainPackageDetailsTypeDef#

# DomainPackageDetailsTypeDef definition

class DomainPackageDetailsTypeDef(TypedDict):
    PackageID: NotRequired[str],
    PackageName: NotRequired[str],
    PackageType: NotRequired[PackageTypeType],  # (1)
    LastUpdated: NotRequired[datetime],
    DomainName: NotRequired[str],
    DomainPackageStatus: NotRequired[DomainPackageStatusType],  # (2)
    PackageVersion: NotRequired[str],
    ReferencePath: NotRequired[str],
    ErrorDetails: NotRequired[ErrorDetailsTypeDef],  # (3)
  1. See PackageTypeType
  2. See DomainPackageStatusType
  3. See ErrorDetailsTypeDef

VPCDerivedInfoStatusTypeDef#

# VPCDerivedInfoStatusTypeDef definition

class VPCDerivedInfoStatusTypeDef(TypedDict):
    Options: VPCDerivedInfoTypeDef,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See VPCDerivedInfoTypeDef
  2. See OptionStatusTypeDef

VpcEndpointTypeDef#

# VpcEndpointTypeDef definition

class VpcEndpointTypeDef(TypedDict):
    VpcEndpointId: NotRequired[str],
    VpcEndpointOwner: NotRequired[str],
    DomainArn: NotRequired[str],
    VpcOptions: NotRequired[VPCDerivedInfoTypeDef],  # (1)
    Status: NotRequired[VpcEndpointStatusType],  # (2)
    Endpoint: NotRequired[str],
  1. See VPCDerivedInfoTypeDef
  2. See VpcEndpointStatusType

DryRunProgressStatusTypeDef#

# DryRunProgressStatusTypeDef definition

class DryRunProgressStatusTypeDef(TypedDict):
    DryRunId: str,
    DryRunStatus: str,
    CreationDate: str,
    UpdateDate: str,
    ValidationFailures: NotRequired[List[ValidationFailureTypeDef]],  # (1)
  1. See ValidationFailureTypeDef

InstanceLimitsTypeDef#

# InstanceLimitsTypeDef definition

class InstanceLimitsTypeDef(TypedDict):
    InstanceCountLimits: NotRequired[InstanceCountLimitsTypeDef],  # (1)
  1. See InstanceCountLimitsTypeDef

ListInstanceTypeDetailsResponseTypeDef#

# ListInstanceTypeDetailsResponseTypeDef definition

class ListInstanceTypeDetailsResponseTypeDef(TypedDict):
    InstanceTypeDetails: List[InstanceTypeDetailsTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See InstanceTypeDetailsTypeDef
  2. See ResponseMetadataTypeDef

ListScheduledActionsResponseTypeDef#

# ListScheduledActionsResponseTypeDef definition

class ListScheduledActionsResponseTypeDef(TypedDict):
    ScheduledActions: List[ScheduledActionTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ScheduledActionTypeDef
  2. See ResponseMetadataTypeDef

UpdateScheduledActionResponseTypeDef#

# UpdateScheduledActionResponseTypeDef definition

class UpdateScheduledActionResponseTypeDef(TypedDict):
    ScheduledAction: ScheduledActionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ScheduledActionTypeDef
  2. See ResponseMetadataTypeDef

OffPeakWindowTypeDef#

# OffPeakWindowTypeDef definition

class OffPeakWindowTypeDef(TypedDict):
    WindowStartTime: NotRequired[WindowStartTimeTypeDef],  # (1)
  1. See WindowStartTimeTypeDef

PackageDetailsTypeDef#

# PackageDetailsTypeDef definition

class PackageDetailsTypeDef(TypedDict):
    PackageID: NotRequired[str],
    PackageName: NotRequired[str],
    PackageType: NotRequired[PackageTypeType],  # (1)
    PackageDescription: NotRequired[str],
    PackageStatus: NotRequired[PackageStatusType],  # (2)
    CreatedAt: NotRequired[datetime],
    LastUpdatedAt: NotRequired[datetime],
    AvailablePackageVersion: NotRequired[str],
    ErrorDetails: NotRequired[ErrorDetailsTypeDef],  # (3)
    EngineVersion: NotRequired[str],
    AvailablePluginProperties: NotRequired[PluginPropertiesTypeDef],  # (4)
  1. See PackageTypeType
  2. See PackageStatusType
  3. See ErrorDetailsTypeDef
  4. See PluginPropertiesTypeDef

PackageVersionHistoryTypeDef#

# PackageVersionHistoryTypeDef definition

class PackageVersionHistoryTypeDef(TypedDict):
    PackageVersion: NotRequired[str],
    CommitMessage: NotRequired[str],
    CreatedAt: NotRequired[datetime],
    PluginProperties: NotRequired[PluginPropertiesTypeDef],  # (1)
  1. See PluginPropertiesTypeDef

ReservedInstanceOfferingTypeDef#

# ReservedInstanceOfferingTypeDef definition

class ReservedInstanceOfferingTypeDef(TypedDict):
    ReservedInstanceOfferingId: NotRequired[str],
    InstanceType: NotRequired[OpenSearchPartitionInstanceTypeType],  # (1)
    Duration: NotRequired[int],
    FixedPrice: NotRequired[float],
    UsagePrice: NotRequired[float],
    CurrencyCode: NotRequired[str],
    PaymentOption: NotRequired[ReservedInstancePaymentOptionType],  # (2)
    RecurringCharges: NotRequired[List[RecurringChargeTypeDef]],  # (3)
  1. See OpenSearchPartitionInstanceTypeType
  2. See ReservedInstancePaymentOptionType
  3. See RecurringChargeTypeDef

ReservedInstanceTypeDef#

# ReservedInstanceTypeDef definition

class ReservedInstanceTypeDef(TypedDict):
    ReservationName: NotRequired[str],
    ReservedInstanceId: NotRequired[str],
    BillingSubscriptionId: NotRequired[int],
    ReservedInstanceOfferingId: NotRequired[str],
    InstanceType: NotRequired[OpenSearchPartitionInstanceTypeType],  # (1)
    StartTime: NotRequired[datetime],
    Duration: NotRequired[int],
    FixedPrice: NotRequired[float],
    UsagePrice: NotRequired[float],
    CurrencyCode: NotRequired[str],
    InstanceCount: NotRequired[int],
    State: NotRequired[str],
    PaymentOption: NotRequired[ReservedInstancePaymentOptionType],  # (2)
    RecurringCharges: NotRequired[List[RecurringChargeTypeDef]],  # (3)
  1. See OpenSearchPartitionInstanceTypeType
  2. See ReservedInstancePaymentOptionType
  3. See RecurringChargeTypeDef

SAMLOptionsInputTypeDef#

# SAMLOptionsInputTypeDef definition

class SAMLOptionsInputTypeDef(TypedDict):
    Enabled: NotRequired[bool],
    Idp: NotRequired[SAMLIdpTypeDef],  # (1)
    MasterUserName: NotRequired[str],
    MasterBackendRole: NotRequired[str],
    SubjectKey: NotRequired[str],
    RolesKey: NotRequired[str],
    SessionTimeoutMinutes: NotRequired[int],
  1. See SAMLIdpTypeDef

SAMLOptionsOutputTypeDef#

# SAMLOptionsOutputTypeDef definition

class SAMLOptionsOutputTypeDef(TypedDict):
    Enabled: NotRequired[bool],
    Idp: NotRequired[SAMLIdpTypeDef],  # (1)
    SubjectKey: NotRequired[str],
    RolesKey: NotRequired[str],
    SessionTimeoutMinutes: NotRequired[int],
  1. See SAMLIdpTypeDef

StorageTypeTypeDef#

# StorageTypeTypeDef definition

class StorageTypeTypeDef(TypedDict):
    StorageTypeName: NotRequired[str],
    StorageSubTypeName: NotRequired[str],
    StorageTypeLimits: NotRequired[List[StorageTypeLimitTypeDef]],  # (1)
  1. See StorageTypeLimitTypeDef

UpgradeHistoryTypeDef#

# UpgradeHistoryTypeDef definition

class UpgradeHistoryTypeDef(TypedDict):
    UpgradeName: NotRequired[str],
    StartTimestamp: NotRequired[datetime],
    UpgradeStatus: NotRequired[UpgradeStatusType],  # (1)
    StepsList: NotRequired[List[UpgradeStepItemTypeDef]],  # (2)
  1. See UpgradeStatusType
  2. See UpgradeStepItemTypeDef

InboundConnectionTypeDef#

# InboundConnectionTypeDef definition

class InboundConnectionTypeDef(TypedDict):
    LocalDomainInfo: NotRequired[DomainInformationContainerTypeDef],  # (1)
    RemoteDomainInfo: NotRequired[DomainInformationContainerTypeDef],  # (1)
    ConnectionId: NotRequired[str],
    ConnectionStatus: NotRequired[InboundConnectionStatusTypeDef],  # (3)
    ConnectionMode: NotRequired[ConnectionModeType],  # (4)
  1. See DomainInformationContainerTypeDef
  2. See DomainInformationContainerTypeDef
  3. See InboundConnectionStatusTypeDef
  4. See ConnectionModeType

AutoTuneTypeDef#

# AutoTuneTypeDef definition

class AutoTuneTypeDef(TypedDict):
    AutoTuneType: NotRequired[AutoTuneTypeType],  # (1)
    AutoTuneDetails: NotRequired[AutoTuneDetailsTypeDef],  # (2)
  1. See AutoTuneTypeType
  2. See AutoTuneDetailsTypeDef

AutoTuneOptionsInputTypeDef#

# AutoTuneOptionsInputTypeDef definition

class AutoTuneOptionsInputTypeDef(TypedDict):
    DesiredState: NotRequired[AutoTuneDesiredStateType],  # (1)
    MaintenanceSchedules: NotRequired[Sequence[AutoTuneMaintenanceScheduleTypeDef]],  # (2)
    UseOffPeakWindow: NotRequired[bool],
  1. See AutoTuneDesiredStateType
  2. See AutoTuneMaintenanceScheduleTypeDef

AutoTuneOptionsTypeDef#

# AutoTuneOptionsTypeDef definition

class AutoTuneOptionsTypeDef(TypedDict):
    DesiredState: NotRequired[AutoTuneDesiredStateType],  # (1)
    RollbackOnDisable: NotRequired[RollbackOnDisableType],  # (2)
    MaintenanceSchedules: NotRequired[List[AutoTuneMaintenanceScheduleTypeDef]],  # (3)
    UseOffPeakWindow: NotRequired[bool],
  1. See AutoTuneDesiredStateType
  2. See RollbackOnDisableType
  3. See AutoTuneMaintenanceScheduleTypeDef

DescribeDomainHealthResponseTypeDef#

# DescribeDomainHealthResponseTypeDef definition

class DescribeDomainHealthResponseTypeDef(TypedDict):
    DomainState: DomainStateType,  # (1)
    AvailabilityZoneCount: str,
    ActiveAvailabilityZoneCount: str,
    StandByAvailabilityZoneCount: str,
    DataNodeCount: str,
    DedicatedMaster: bool,
    MasterEligibleNodeCount: str,
    WarmNodeCount: str,
    MasterNode: MasterNodeStatusType,  # (2)
    ClusterHealth: DomainHealthType,  # (3)
    TotalShards: str,
    TotalUnAssignedShards: str,
    EnvironmentInformation: List[EnvironmentInfoTypeDef],  # (4)
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See DomainStateType
  2. See MasterNodeStatusType
  3. See DomainHealthType
  4. See EnvironmentInfoTypeDef
  5. See ResponseMetadataTypeDef

DescribeDomainChangeProgressResponseTypeDef#

# DescribeDomainChangeProgressResponseTypeDef definition

class DescribeDomainChangeProgressResponseTypeDef(TypedDict):
    ChangeProgressStatus: ChangeProgressStatusDetailsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ChangeProgressStatusDetailsTypeDef
  2. See ResponseMetadataTypeDef

ClusterConfigStatusTypeDef#

# ClusterConfigStatusTypeDef definition

class ClusterConfigStatusTypeDef(TypedDict):
    Options: ClusterConfigTypeDef,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See ClusterConfigTypeDef
  2. See OptionStatusTypeDef

CreateOutboundConnectionRequestRequestTypeDef#

# CreateOutboundConnectionRequestRequestTypeDef definition

class CreateOutboundConnectionRequestRequestTypeDef(TypedDict):
    LocalDomainInfo: DomainInformationContainerTypeDef,  # (1)
    RemoteDomainInfo: DomainInformationContainerTypeDef,  # (1)
    ConnectionAlias: str,
    ConnectionMode: NotRequired[ConnectionModeType],  # (3)
    ConnectionProperties: NotRequired[ConnectionPropertiesTypeDef],  # (4)
  1. See DomainInformationContainerTypeDef
  2. See DomainInformationContainerTypeDef
  3. See ConnectionModeType
  4. See ConnectionPropertiesTypeDef

CreateOutboundConnectionResponseTypeDef#

# CreateOutboundConnectionResponseTypeDef definition

class CreateOutboundConnectionResponseTypeDef(TypedDict):
    LocalDomainInfo: DomainInformationContainerTypeDef,  # (1)
    RemoteDomainInfo: DomainInformationContainerTypeDef,  # (1)
    ConnectionAlias: str,
    ConnectionStatus: OutboundConnectionStatusTypeDef,  # (3)
    ConnectionId: str,
    ConnectionMode: ConnectionModeType,  # (4)
    ConnectionProperties: ConnectionPropertiesTypeDef,  # (5)
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See DomainInformationContainerTypeDef
  2. See DomainInformationContainerTypeDef
  3. See OutboundConnectionStatusTypeDef
  4. See ConnectionModeType
  5. See ConnectionPropertiesTypeDef
  6. See ResponseMetadataTypeDef

OutboundConnectionTypeDef#

# OutboundConnectionTypeDef definition

class OutboundConnectionTypeDef(TypedDict):
    LocalDomainInfo: NotRequired[DomainInformationContainerTypeDef],  # (1)
    RemoteDomainInfo: NotRequired[DomainInformationContainerTypeDef],  # (1)
    ConnectionId: NotRequired[str],
    ConnectionAlias: NotRequired[str],
    ConnectionStatus: NotRequired[OutboundConnectionStatusTypeDef],  # (3)
    ConnectionMode: NotRequired[ConnectionModeType],  # (4)
    ConnectionProperties: NotRequired[ConnectionPropertiesTypeDef],  # (5)
  1. See DomainInformationContainerTypeDef
  2. See DomainInformationContainerTypeDef
  3. See OutboundConnectionStatusTypeDef
  4. See ConnectionModeType
  5. See ConnectionPropertiesTypeDef

AddDataSourceRequestRequestTypeDef#

# AddDataSourceRequestRequestTypeDef definition

class AddDataSourceRequestRequestTypeDef(TypedDict):
    DomainName: str,
    Name: str,
    DataSourceType: DataSourceTypeTypeDef,  # (1)
    Description: NotRequired[str],
  1. See DataSourceTypeTypeDef

DataSourceDetailsTypeDef#

# DataSourceDetailsTypeDef definition

class DataSourceDetailsTypeDef(TypedDict):
    DataSourceType: NotRequired[DataSourceTypeTypeDef],  # (1)
    Name: NotRequired[str],
    Description: NotRequired[str],
  1. See DataSourceTypeTypeDef

GetDataSourceResponseTypeDef#

# GetDataSourceResponseTypeDef definition

class GetDataSourceResponseTypeDef(TypedDict):
    DataSourceType: DataSourceTypeTypeDef,  # (1)
    Name: str,
    Description: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DataSourceTypeTypeDef
  2. See ResponseMetadataTypeDef

UpdateDataSourceRequestRequestTypeDef#

# UpdateDataSourceRequestRequestTypeDef definition

class UpdateDataSourceRequestRequestTypeDef(TypedDict):
    DomainName: str,
    Name: str,
    DataSourceType: DataSourceTypeTypeDef,  # (1)
    Description: NotRequired[str],
  1. See DataSourceTypeTypeDef

AssociatePackageResponseTypeDef#

# AssociatePackageResponseTypeDef definition

class AssociatePackageResponseTypeDef(TypedDict):
    DomainPackageDetails: DomainPackageDetailsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainPackageDetailsTypeDef
  2. See ResponseMetadataTypeDef

DissociatePackageResponseTypeDef#

# DissociatePackageResponseTypeDef definition

class DissociatePackageResponseTypeDef(TypedDict):
    DomainPackageDetails: DomainPackageDetailsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainPackageDetailsTypeDef
  2. See ResponseMetadataTypeDef

ListDomainsForPackageResponseTypeDef#

# ListDomainsForPackageResponseTypeDef definition

class ListDomainsForPackageResponseTypeDef(TypedDict):
    DomainPackageDetailsList: List[DomainPackageDetailsTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainPackageDetailsTypeDef
  2. See ResponseMetadataTypeDef

ListPackagesForDomainResponseTypeDef#

# ListPackagesForDomainResponseTypeDef definition

class ListPackagesForDomainResponseTypeDef(TypedDict):
    DomainPackageDetailsList: List[DomainPackageDetailsTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainPackageDetailsTypeDef
  2. See ResponseMetadataTypeDef

CreateVpcEndpointResponseTypeDef#

# CreateVpcEndpointResponseTypeDef definition

class CreateVpcEndpointResponseTypeDef(TypedDict):
    VpcEndpoint: VpcEndpointTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See VpcEndpointTypeDef
  2. See ResponseMetadataTypeDef

DescribeVpcEndpointsResponseTypeDef#

# DescribeVpcEndpointsResponseTypeDef definition

class DescribeVpcEndpointsResponseTypeDef(TypedDict):
    VpcEndpoints: List[VpcEndpointTypeDef],  # (1)
    VpcEndpointErrors: List[VpcEndpointErrorTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See VpcEndpointTypeDef
  2. See VpcEndpointErrorTypeDef
  3. See ResponseMetadataTypeDef

UpdateVpcEndpointResponseTypeDef#

# UpdateVpcEndpointResponseTypeDef definition

class UpdateVpcEndpointResponseTypeDef(TypedDict):
    VpcEndpoint: VpcEndpointTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See VpcEndpointTypeDef
  2. See ResponseMetadataTypeDef

OffPeakWindowOptionsTypeDef#

# OffPeakWindowOptionsTypeDef definition

class OffPeakWindowOptionsTypeDef(TypedDict):
    Enabled: NotRequired[bool],
    OffPeakWindow: NotRequired[OffPeakWindowTypeDef],  # (1)
  1. See OffPeakWindowTypeDef

CreatePackageResponseTypeDef#

# CreatePackageResponseTypeDef definition

class CreatePackageResponseTypeDef(TypedDict):
    PackageDetails: PackageDetailsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PackageDetailsTypeDef
  2. See ResponseMetadataTypeDef

DeletePackageResponseTypeDef#

# DeletePackageResponseTypeDef definition

class DeletePackageResponseTypeDef(TypedDict):
    PackageDetails: PackageDetailsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PackageDetailsTypeDef
  2. See ResponseMetadataTypeDef

DescribePackagesResponseTypeDef#

# DescribePackagesResponseTypeDef definition

class DescribePackagesResponseTypeDef(TypedDict):
    PackageDetailsList: List[PackageDetailsTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PackageDetailsTypeDef
  2. See ResponseMetadataTypeDef

UpdatePackageResponseTypeDef#

# UpdatePackageResponseTypeDef definition

class UpdatePackageResponseTypeDef(TypedDict):
    PackageDetails: PackageDetailsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PackageDetailsTypeDef
  2. See ResponseMetadataTypeDef

GetPackageVersionHistoryResponseTypeDef#

# GetPackageVersionHistoryResponseTypeDef definition

class GetPackageVersionHistoryResponseTypeDef(TypedDict):
    PackageID: str,
    PackageVersionHistoryList: List[PackageVersionHistoryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PackageVersionHistoryTypeDef
  2. See ResponseMetadataTypeDef

DescribeReservedInstanceOfferingsResponseTypeDef#

# DescribeReservedInstanceOfferingsResponseTypeDef definition

class DescribeReservedInstanceOfferingsResponseTypeDef(TypedDict):
    NextToken: str,
    ReservedInstanceOfferings: List[ReservedInstanceOfferingTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ReservedInstanceOfferingTypeDef
  2. See ResponseMetadataTypeDef

DescribeReservedInstancesResponseTypeDef#

# DescribeReservedInstancesResponseTypeDef definition

class DescribeReservedInstancesResponseTypeDef(TypedDict):
    NextToken: str,
    ReservedInstances: List[ReservedInstanceTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ReservedInstanceTypeDef
  2. See ResponseMetadataTypeDef

AdvancedSecurityOptionsInputTypeDef#

# AdvancedSecurityOptionsInputTypeDef definition

class AdvancedSecurityOptionsInputTypeDef(TypedDict):
    Enabled: NotRequired[bool],
    InternalUserDatabaseEnabled: NotRequired[bool],
    MasterUserOptions: NotRequired[MasterUserOptionsTypeDef],  # (1)
    SAMLOptions: NotRequired[SAMLOptionsInputTypeDef],  # (2)
    AnonymousAuthEnabled: NotRequired[bool],
  1. See MasterUserOptionsTypeDef
  2. See SAMLOptionsInputTypeDef

AdvancedSecurityOptionsTypeDef#

# AdvancedSecurityOptionsTypeDef definition

class AdvancedSecurityOptionsTypeDef(TypedDict):
    Enabled: NotRequired[bool],
    InternalUserDatabaseEnabled: NotRequired[bool],
    SAMLOptions: NotRequired[SAMLOptionsOutputTypeDef],  # (1)
    AnonymousAuthDisableDate: NotRequired[datetime],
    AnonymousAuthEnabled: NotRequired[bool],
  1. See SAMLOptionsOutputTypeDef

LimitsTypeDef#

# LimitsTypeDef definition

class LimitsTypeDef(TypedDict):
    StorageTypes: NotRequired[List[StorageTypeTypeDef]],  # (1)
    InstanceLimits: NotRequired[InstanceLimitsTypeDef],  # (2)
    AdditionalLimits: NotRequired[List[AdditionalLimitTypeDef]],  # (3)
  1. See StorageTypeTypeDef
  2. See InstanceLimitsTypeDef
  3. See AdditionalLimitTypeDef

GetUpgradeHistoryResponseTypeDef#

# GetUpgradeHistoryResponseTypeDef definition

class GetUpgradeHistoryResponseTypeDef(TypedDict):
    UpgradeHistories: List[UpgradeHistoryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UpgradeHistoryTypeDef
  2. See ResponseMetadataTypeDef

AcceptInboundConnectionResponseTypeDef#

# AcceptInboundConnectionResponseTypeDef definition

class AcceptInboundConnectionResponseTypeDef(TypedDict):
    Connection: InboundConnectionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See InboundConnectionTypeDef
  2. See ResponseMetadataTypeDef

DeleteInboundConnectionResponseTypeDef#

# DeleteInboundConnectionResponseTypeDef definition

class DeleteInboundConnectionResponseTypeDef(TypedDict):
    Connection: InboundConnectionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See InboundConnectionTypeDef
  2. See ResponseMetadataTypeDef

DescribeInboundConnectionsResponseTypeDef#

# DescribeInboundConnectionsResponseTypeDef definition

class DescribeInboundConnectionsResponseTypeDef(TypedDict):
    Connections: List[InboundConnectionTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See InboundConnectionTypeDef
  2. See ResponseMetadataTypeDef

RejectInboundConnectionResponseTypeDef#

# RejectInboundConnectionResponseTypeDef definition

class RejectInboundConnectionResponseTypeDef(TypedDict):
    Connection: InboundConnectionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See InboundConnectionTypeDef
  2. See ResponseMetadataTypeDef

DescribeDomainAutoTunesResponseTypeDef#

# DescribeDomainAutoTunesResponseTypeDef definition

class DescribeDomainAutoTunesResponseTypeDef(TypedDict):
    AutoTunes: List[AutoTuneTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AutoTuneTypeDef
  2. See ResponseMetadataTypeDef

AutoTuneOptionsStatusTypeDef#

# AutoTuneOptionsStatusTypeDef definition

class AutoTuneOptionsStatusTypeDef(TypedDict):
    Options: NotRequired[AutoTuneOptionsTypeDef],  # (1)
    Status: NotRequired[AutoTuneStatusTypeDef],  # (2)
  1. See AutoTuneOptionsTypeDef
  2. See AutoTuneStatusTypeDef

DeleteOutboundConnectionResponseTypeDef#

# DeleteOutboundConnectionResponseTypeDef definition

class DeleteOutboundConnectionResponseTypeDef(TypedDict):
    Connection: OutboundConnectionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See OutboundConnectionTypeDef
  2. See ResponseMetadataTypeDef

DescribeOutboundConnectionsResponseTypeDef#

# DescribeOutboundConnectionsResponseTypeDef definition

class DescribeOutboundConnectionsResponseTypeDef(TypedDict):
    Connections: List[OutboundConnectionTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See OutboundConnectionTypeDef
  2. See ResponseMetadataTypeDef

ListDataSourcesResponseTypeDef#

# ListDataSourcesResponseTypeDef definition

class ListDataSourcesResponseTypeDef(TypedDict):
    DataSources: List[DataSourceDetailsTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DataSourceDetailsTypeDef
  2. See ResponseMetadataTypeDef

OffPeakWindowOptionsStatusTypeDef#

# OffPeakWindowOptionsStatusTypeDef definition

class OffPeakWindowOptionsStatusTypeDef(TypedDict):
    Options: NotRequired[OffPeakWindowOptionsTypeDef],  # (1)
    Status: NotRequired[OptionStatusTypeDef],  # (2)
  1. See OffPeakWindowOptionsTypeDef
  2. See OptionStatusTypeDef

CreateDomainRequestRequestTypeDef#

# CreateDomainRequestRequestTypeDef definition

class CreateDomainRequestRequestTypeDef(TypedDict):
    DomainName: str,
    EngineVersion: NotRequired[str],
    ClusterConfig: NotRequired[ClusterConfigTypeDef],  # (1)
    EBSOptions: NotRequired[EBSOptionsTypeDef],  # (2)
    AccessPolicies: NotRequired[str],
    IPAddressType: NotRequired[IPAddressTypeType],  # (3)
    SnapshotOptions: NotRequired[SnapshotOptionsTypeDef],  # (4)
    VPCOptions: NotRequired[VPCOptionsTypeDef],  # (5)
    CognitoOptions: NotRequired[CognitoOptionsTypeDef],  # (6)
    EncryptionAtRestOptions: NotRequired[EncryptionAtRestOptionsTypeDef],  # (7)
    NodeToNodeEncryptionOptions: NotRequired[NodeToNodeEncryptionOptionsTypeDef],  # (8)
    AdvancedOptions: NotRequired[Mapping[str, str]],
    LogPublishingOptions: NotRequired[Mapping[LogTypeType, LogPublishingOptionTypeDef]],  # (9)
    DomainEndpointOptions: NotRequired[DomainEndpointOptionsTypeDef],  # (10)
    AdvancedSecurityOptions: NotRequired[AdvancedSecurityOptionsInputTypeDef],  # (11)
    TagList: NotRequired[Sequence[TagTypeDef]],  # (12)
    AutoTuneOptions: NotRequired[AutoTuneOptionsInputTypeDef],  # (13)
    OffPeakWindowOptions: NotRequired[OffPeakWindowOptionsTypeDef],  # (14)
    SoftwareUpdateOptions: NotRequired[SoftwareUpdateOptionsTypeDef],  # (15)
  1. See ClusterConfigTypeDef
  2. See EBSOptionsTypeDef
  3. See IPAddressTypeType
  4. See SnapshotOptionsTypeDef
  5. See VPCOptionsTypeDef
  6. See CognitoOptionsTypeDef
  7. See EncryptionAtRestOptionsTypeDef
  8. See NodeToNodeEncryptionOptionsTypeDef
  9. See LogTypeType LogPublishingOptionTypeDef
  10. See DomainEndpointOptionsTypeDef
  11. See AdvancedSecurityOptionsInputTypeDef
  12. See TagTypeDef
  13. See AutoTuneOptionsInputTypeDef
  14. See OffPeakWindowOptionsTypeDef
  15. See SoftwareUpdateOptionsTypeDef

UpdateDomainConfigRequestRequestTypeDef#

# UpdateDomainConfigRequestRequestTypeDef definition

class UpdateDomainConfigRequestRequestTypeDef(TypedDict):
    DomainName: str,
    ClusterConfig: NotRequired[ClusterConfigTypeDef],  # (1)
    EBSOptions: NotRequired[EBSOptionsTypeDef],  # (2)
    SnapshotOptions: NotRequired[SnapshotOptionsTypeDef],  # (3)
    VPCOptions: NotRequired[VPCOptionsTypeDef],  # (4)
    CognitoOptions: NotRequired[CognitoOptionsTypeDef],  # (5)
    AdvancedOptions: NotRequired[Mapping[str, str]],
    AccessPolicies: NotRequired[str],
    IPAddressType: NotRequired[IPAddressTypeType],  # (6)
    LogPublishingOptions: NotRequired[Mapping[LogTypeType, LogPublishingOptionTypeDef]],  # (7)
    EncryptionAtRestOptions: NotRequired[EncryptionAtRestOptionsTypeDef],  # (8)
    DomainEndpointOptions: NotRequired[DomainEndpointOptionsTypeDef],  # (9)
    NodeToNodeEncryptionOptions: NotRequired[NodeToNodeEncryptionOptionsTypeDef],  # (10)
    AdvancedSecurityOptions: NotRequired[AdvancedSecurityOptionsInputTypeDef],  # (11)
    AutoTuneOptions: NotRequired[AutoTuneOptionsTypeDef],  # (12)
    DryRun: NotRequired[bool],
    DryRunMode: NotRequired[DryRunModeType],  # (13)
    OffPeakWindowOptions: NotRequired[OffPeakWindowOptionsTypeDef],  # (14)
    SoftwareUpdateOptions: NotRequired[SoftwareUpdateOptionsTypeDef],  # (15)
  1. See ClusterConfigTypeDef
  2. See EBSOptionsTypeDef
  3. See SnapshotOptionsTypeDef
  4. See VPCOptionsTypeDef
  5. See CognitoOptionsTypeDef
  6. See IPAddressTypeType
  7. See LogTypeType LogPublishingOptionTypeDef
  8. See EncryptionAtRestOptionsTypeDef
  9. See DomainEndpointOptionsTypeDef
  10. See NodeToNodeEncryptionOptionsTypeDef
  11. See AdvancedSecurityOptionsInputTypeDef
  12. See AutoTuneOptionsTypeDef
  13. See DryRunModeType
  14. See OffPeakWindowOptionsTypeDef
  15. See SoftwareUpdateOptionsTypeDef

AdvancedSecurityOptionsStatusTypeDef#

# AdvancedSecurityOptionsStatusTypeDef definition

class AdvancedSecurityOptionsStatusTypeDef(TypedDict):
    Options: AdvancedSecurityOptionsTypeDef,  # (1)
    Status: OptionStatusTypeDef,  # (2)
  1. See AdvancedSecurityOptionsTypeDef
  2. See OptionStatusTypeDef

DomainStatusTypeDef#

# DomainStatusTypeDef definition

class DomainStatusTypeDef(TypedDict):
    DomainId: str,
    DomainName: str,
    ARN: str,
    ClusterConfig: ClusterConfigTypeDef,  # (1)
    Created: NotRequired[bool],
    Deleted: NotRequired[bool],
    Endpoint: NotRequired[str],
    EndpointV2: NotRequired[str],
    Endpoints: NotRequired[Dict[str, str]],
    Processing: NotRequired[bool],
    UpgradeProcessing: NotRequired[bool],
    EngineVersion: NotRequired[str],
    EBSOptions: NotRequired[EBSOptionsTypeDef],  # (2)
    AccessPolicies: NotRequired[str],
    IPAddressType: NotRequired[IPAddressTypeType],  # (3)
    SnapshotOptions: NotRequired[SnapshotOptionsTypeDef],  # (4)
    VPCOptions: NotRequired[VPCDerivedInfoTypeDef],  # (5)
    CognitoOptions: NotRequired[CognitoOptionsTypeDef],  # (6)
    EncryptionAtRestOptions: NotRequired[EncryptionAtRestOptionsTypeDef],  # (7)
    NodeToNodeEncryptionOptions: NotRequired[NodeToNodeEncryptionOptionsTypeDef],  # (8)
    AdvancedOptions: NotRequired[Dict[str, str]],
    LogPublishingOptions: NotRequired[Dict[LogTypeType, LogPublishingOptionTypeDef]],  # (9)
    ServiceSoftwareOptions: NotRequired[ServiceSoftwareOptionsTypeDef],  # (10)
    DomainEndpointOptions: NotRequired[DomainEndpointOptionsTypeDef],  # (11)
    AdvancedSecurityOptions: NotRequired[AdvancedSecurityOptionsTypeDef],  # (12)
    AutoTuneOptions: NotRequired[AutoTuneOptionsOutputTypeDef],  # (13)
    ChangeProgressDetails: NotRequired[ChangeProgressDetailsTypeDef],  # (14)
    OffPeakWindowOptions: NotRequired[OffPeakWindowOptionsTypeDef],  # (15)
    SoftwareUpdateOptions: NotRequired[SoftwareUpdateOptionsTypeDef],  # (16)
    DomainProcessingStatus: NotRequired[DomainProcessingStatusTypeType],  # (17)
    ModifyingProperties: NotRequired[List[ModifyingPropertiesTypeDef]],  # (18)
  1. See ClusterConfigTypeDef
  2. See EBSOptionsTypeDef
  3. See IPAddressTypeType
  4. See SnapshotOptionsTypeDef
  5. See VPCDerivedInfoTypeDef
  6. See CognitoOptionsTypeDef
  7. See EncryptionAtRestOptionsTypeDef
  8. See NodeToNodeEncryptionOptionsTypeDef
  9. See LogTypeType LogPublishingOptionTypeDef
  10. See ServiceSoftwareOptionsTypeDef
  11. See DomainEndpointOptionsTypeDef
  12. See AdvancedSecurityOptionsTypeDef
  13. See AutoTuneOptionsOutputTypeDef
  14. See ChangeProgressDetailsTypeDef
  15. See OffPeakWindowOptionsTypeDef
  16. See SoftwareUpdateOptionsTypeDef
  17. See DomainProcessingStatusTypeType
  18. See ModifyingPropertiesTypeDef

DescribeInstanceTypeLimitsResponseTypeDef#

# DescribeInstanceTypeLimitsResponseTypeDef definition

class DescribeInstanceTypeLimitsResponseTypeDef(TypedDict):
    LimitsByRole: Dict[str, LimitsTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See LimitsTypeDef
  2. See ResponseMetadataTypeDef

DomainConfigTypeDef#

# DomainConfigTypeDef definition

class DomainConfigTypeDef(TypedDict):
    EngineVersion: NotRequired[VersionStatusTypeDef],  # (1)
    ClusterConfig: NotRequired[ClusterConfigStatusTypeDef],  # (2)
    EBSOptions: NotRequired[EBSOptionsStatusTypeDef],  # (3)
    AccessPolicies: NotRequired[AccessPoliciesStatusTypeDef],  # (4)
    IPAddressType: NotRequired[IPAddressTypeStatusTypeDef],  # (5)
    SnapshotOptions: NotRequired[SnapshotOptionsStatusTypeDef],  # (6)
    VPCOptions: NotRequired[VPCDerivedInfoStatusTypeDef],  # (7)
    CognitoOptions: NotRequired[CognitoOptionsStatusTypeDef],  # (8)
    EncryptionAtRestOptions: NotRequired[EncryptionAtRestOptionsStatusTypeDef],  # (9)
    NodeToNodeEncryptionOptions: NotRequired[NodeToNodeEncryptionOptionsStatusTypeDef],  # (10)
    AdvancedOptions: NotRequired[AdvancedOptionsStatusTypeDef],  # (11)
    LogPublishingOptions: NotRequired[LogPublishingOptionsStatusTypeDef],  # (12)
    DomainEndpointOptions: NotRequired[DomainEndpointOptionsStatusTypeDef],  # (13)
    AdvancedSecurityOptions: NotRequired[AdvancedSecurityOptionsStatusTypeDef],  # (14)
    AutoTuneOptions: NotRequired[AutoTuneOptionsStatusTypeDef],  # (15)
    ChangeProgressDetails: NotRequired[ChangeProgressDetailsTypeDef],  # (16)
    OffPeakWindowOptions: NotRequired[OffPeakWindowOptionsStatusTypeDef],  # (17)
    SoftwareUpdateOptions: NotRequired[SoftwareUpdateOptionsStatusTypeDef],  # (18)
    ModifyingProperties: NotRequired[List[ModifyingPropertiesTypeDef]],  # (19)
  1. See VersionStatusTypeDef
  2. See ClusterConfigStatusTypeDef
  3. See EBSOptionsStatusTypeDef
  4. See AccessPoliciesStatusTypeDef
  5. See IPAddressTypeStatusTypeDef
  6. See SnapshotOptionsStatusTypeDef
  7. See VPCDerivedInfoStatusTypeDef
  8. See CognitoOptionsStatusTypeDef
  9. See EncryptionAtRestOptionsStatusTypeDef
  10. See NodeToNodeEncryptionOptionsStatusTypeDef
  11. See AdvancedOptionsStatusTypeDef
  12. See LogPublishingOptionsStatusTypeDef
  13. See DomainEndpointOptionsStatusTypeDef
  14. See AdvancedSecurityOptionsStatusTypeDef
  15. See AutoTuneOptionsStatusTypeDef
  16. See ChangeProgressDetailsTypeDef
  17. See OffPeakWindowOptionsStatusTypeDef
  18. See SoftwareUpdateOptionsStatusTypeDef
  19. See ModifyingPropertiesTypeDef

CreateDomainResponseTypeDef#

# CreateDomainResponseTypeDef definition

class CreateDomainResponseTypeDef(TypedDict):
    DomainStatus: DomainStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainStatusTypeDef
  2. See ResponseMetadataTypeDef

DeleteDomainResponseTypeDef#

# DeleteDomainResponseTypeDef definition

class DeleteDomainResponseTypeDef(TypedDict):
    DomainStatus: DomainStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainStatusTypeDef
  2. See ResponseMetadataTypeDef

DescribeDomainResponseTypeDef#

# DescribeDomainResponseTypeDef definition

class DescribeDomainResponseTypeDef(TypedDict):
    DomainStatus: DomainStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainStatusTypeDef
  2. See ResponseMetadataTypeDef

DescribeDomainsResponseTypeDef#

# DescribeDomainsResponseTypeDef definition

class DescribeDomainsResponseTypeDef(TypedDict):
    DomainStatusList: List[DomainStatusTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainStatusTypeDef
  2. See ResponseMetadataTypeDef

DescribeDryRunProgressResponseTypeDef#

# DescribeDryRunProgressResponseTypeDef definition

class DescribeDryRunProgressResponseTypeDef(TypedDict):
    DryRunProgressStatus: DryRunProgressStatusTypeDef,  # (1)
    DryRunConfig: DomainStatusTypeDef,  # (2)
    DryRunResults: DryRunResultsTypeDef,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See DryRunProgressStatusTypeDef
  2. See DomainStatusTypeDef
  3. See DryRunResultsTypeDef
  4. See ResponseMetadataTypeDef

DescribeDomainConfigResponseTypeDef#

# DescribeDomainConfigResponseTypeDef definition

class DescribeDomainConfigResponseTypeDef(TypedDict):
    DomainConfig: DomainConfigTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainConfigTypeDef
  2. See ResponseMetadataTypeDef

UpdateDomainConfigResponseTypeDef#

# UpdateDomainConfigResponseTypeDef definition

class UpdateDomainConfigResponseTypeDef(TypedDict):
    DomainConfig: DomainConfigTypeDef,  # (1)
    DryRunResults: DryRunResultsTypeDef,  # (2)
    DryRunProgressStatus: DryRunProgressStatusTypeDef,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See DomainConfigTypeDef
  2. See DryRunResultsTypeDef
  3. See DryRunProgressStatusTypeDef
  4. See ResponseMetadataTypeDef