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,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

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

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],

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],

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