Typed dictionaries

Index > OpenSearchService > Typed dictionaries

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

AWSDomainInformationTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import AWSDomainInformationTypeDef

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

Definition

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

AcceptInboundConnectionRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import AcceptInboundConnectionRequestRequestTypeDef

def get_value() -> AcceptInboundConnectionRequestRequestTypeDef:
    return {
        "ConnectionId": ...,
    }

Definition

class AcceptInboundConnectionRequestRequestTypeDef(TypedDict):
    ConnectionId: str,

ResponseMetadataTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import ResponseMetadataTypeDef

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

Definition

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

OptionStatusTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import OptionStatusTypeDef

def get_value() -> OptionStatusTypeDef:
    return {
        "CreationDate": ...,
        "UpdateDate": ...,
        "State": ...,
    }

Definition

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

1. See OptionStateType

TagTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "Key": ...,
        "Value": ...,
    }

Definition

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

AdditionalLimitTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import AdditionalLimitTypeDef

def get_value() -> AdditionalLimitTypeDef:
    return {
        "LimitName": ...,
    }

Definition

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

MasterUserOptionsTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import MasterUserOptionsTypeDef

def get_value() -> MasterUserOptionsTypeDef:
    return {
        "MasterUserARN": ...,
    }

Definition

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

AssociatePackageRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import AssociatePackageRequestRequestTypeDef

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

Definition

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

AuthorizeVpcEndpointAccessRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import AuthorizeVpcEndpointAccessRequestRequestTypeDef

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

Definition

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

AuthorizedPrincipalTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import AuthorizedPrincipalTypeDef

def get_value() -> AuthorizedPrincipalTypeDef:
    return {
        "PrincipalType": ...,
    }

Definition

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

1. See PrincipalTypeType

ScheduledAutoTuneDetailsTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import ScheduledAutoTuneDetailsTypeDef

def get_value() -> ScheduledAutoTuneDetailsTypeDef:
    return {
        "Date": ...,
    }

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

Usage Example

from mypy_boto3_opensearch.type_defs import DurationTypeDef

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

Definition

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

1. See TimeUnitType

AutoTuneOptionsOutputTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import AutoTuneOptionsOutputTypeDef

def get_value() -> AutoTuneOptionsOutputTypeDef:
    return {
        "State": ...,
    }

Definition

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

1. See AutoTuneStateType

AutoTuneStatusTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import AutoTuneStatusTypeDef

def get_value() -> AutoTuneStatusTypeDef:
    return {
        "CreationDate": ...,
        "UpdateDate": ...,
        "State": ...,
    }

Definition

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

1. See AutoTuneStateType

CancelServiceSoftwareUpdateRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import CancelServiceSoftwareUpdateRequestRequestTypeDef

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

Definition

class CancelServiceSoftwareUpdateRequestRequestTypeDef(TypedDict):
    DomainName: str,

ServiceSoftwareOptionsTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import ServiceSoftwareOptionsTypeDef

def get_value() -> ServiceSoftwareOptionsTypeDef:
    return {
        "CurrentVersion": ...,
    }

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

Usage Example

from mypy_boto3_opensearch.type_defs import ChangeProgressDetailsTypeDef

def get_value() -> ChangeProgressDetailsTypeDef:
    return {
        "ChangeId": ...,
    }

Definition

class ChangeProgressDetailsTypeDef(TypedDict):
    ChangeId: NotRequired[str],
    Message: NotRequired[str],

ChangeProgressStageTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import ChangeProgressStageTypeDef

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

Definition

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

ColdStorageOptionsTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import ColdStorageOptionsTypeDef

def get_value() -> ColdStorageOptionsTypeDef:
    return {
        "Enabled": ...,
    }

Definition

class ColdStorageOptionsTypeDef(TypedDict):
    Enabled: bool,

ZoneAwarenessConfigTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import ZoneAwarenessConfigTypeDef

def get_value() -> ZoneAwarenessConfigTypeDef:
    return {
        "AvailabilityZoneCount": ...,
    }

Definition

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

CognitoOptionsTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import CognitoOptionsTypeDef

def get_value() -> CognitoOptionsTypeDef:
    return {
        "Enabled": ...,
    }

Definition

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

CompatibleVersionsMapTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import CompatibleVersionsMapTypeDef

def get_value() -> CompatibleVersionsMapTypeDef:
    return {
        "SourceVersion": ...,
    }

Definition

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

ConnectionPropertiesTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import ConnectionPropertiesTypeDef

def get_value() -> ConnectionPropertiesTypeDef:
    return {
        "Endpoint": ...,
    }

Definition

class ConnectionPropertiesTypeDef(TypedDict):
    Endpoint: NotRequired[str],

DomainEndpointOptionsTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DomainEndpointOptionsTypeDef

def get_value() -> DomainEndpointOptionsTypeDef:
    return {
        "EnforceHTTPS": ...,
    }

Definition

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

1. See TLSSecurityPolicyType

EBSOptionsTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import EBSOptionsTypeDef

def get_value() -> EBSOptionsTypeDef:
    return {
        "EBSEnabled": ...,
    }

Definition

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

1. See VolumeTypeType

EncryptionAtRestOptionsTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import EncryptionAtRestOptionsTypeDef

def get_value() -> EncryptionAtRestOptionsTypeDef:
    return {
        "Enabled": ...,
    }

Definition

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

LogPublishingOptionTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import LogPublishingOptionTypeDef

def get_value() -> LogPublishingOptionTypeDef:
    return {
        "CloudWatchLogsLogGroupArn": ...,
    }

Definition

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

NodeToNodeEncryptionOptionsTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import NodeToNodeEncryptionOptionsTypeDef

def get_value() -> NodeToNodeEncryptionOptionsTypeDef:
    return {
        "Enabled": ...,
    }

Definition

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

SnapshotOptionsTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import SnapshotOptionsTypeDef

def get_value() -> SnapshotOptionsTypeDef:
    return {
        "AutomatedSnapshotStartHour": ...,
    }

Definition

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

SoftwareUpdateOptionsTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import SoftwareUpdateOptionsTypeDef

def get_value() -> SoftwareUpdateOptionsTypeDef:
    return {
        "AutoSoftwareUpdateEnabled": ...,
    }

Definition

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

VPCOptionsTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import VPCOptionsTypeDef

def get_value() -> VPCOptionsTypeDef:
    return {
        "SubnetIds": ...,
    }

Definition

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

OutboundConnectionStatusTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import OutboundConnectionStatusTypeDef

def get_value() -> OutboundConnectionStatusTypeDef:
    return {
        "StatusCode": ...,
    }

Definition

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

1. See OutboundConnectionStatusCodeType

PackageSourceTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import PackageSourceTypeDef

def get_value() -> PackageSourceTypeDef:
    return {
        "S3BucketName": ...,
    }

Definition

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

DeleteDomainRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DeleteDomainRequestRequestTypeDef

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

Definition

class DeleteDomainRequestRequestTypeDef(TypedDict):
    DomainName: str,

DeleteInboundConnectionRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DeleteInboundConnectionRequestRequestTypeDef

def get_value() -> DeleteInboundConnectionRequestRequestTypeDef:
    return {
        "ConnectionId": ...,
    }

Definition

class DeleteInboundConnectionRequestRequestTypeDef(TypedDict):
    ConnectionId: str,

DeleteOutboundConnectionRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DeleteOutboundConnectionRequestRequestTypeDef

def get_value() -> DeleteOutboundConnectionRequestRequestTypeDef:
    return {
        "ConnectionId": ...,
    }

Definition

class DeleteOutboundConnectionRequestRequestTypeDef(TypedDict):
    ConnectionId: str,

DeletePackageRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DeletePackageRequestRequestTypeDef

def get_value() -> DeletePackageRequestRequestTypeDef:
    return {
        "PackageID": ...,
    }

Definition

class DeletePackageRequestRequestTypeDef(TypedDict):
    PackageID: str,

DeleteVpcEndpointRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DeleteVpcEndpointRequestRequestTypeDef

def get_value() -> DeleteVpcEndpointRequestRequestTypeDef:
    return {
        "VpcEndpointId": ...,
    }

Definition

class DeleteVpcEndpointRequestRequestTypeDef(TypedDict):
    VpcEndpointId: str,

VpcEndpointSummaryTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import VpcEndpointSummaryTypeDef

def get_value() -> VpcEndpointSummaryTypeDef:
    return {
        "VpcEndpointId": ...,
    }

Definition

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

1. See VpcEndpointStatusType

DescribeDomainAutoTunesRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DescribeDomainAutoTunesRequestRequestTypeDef

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

Definition

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

DescribeDomainChangeProgressRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DescribeDomainChangeProgressRequestRequestTypeDef

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

Definition

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

DescribeDomainConfigRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DescribeDomainConfigRequestRequestTypeDef

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

Definition

class DescribeDomainConfigRequestRequestTypeDef(TypedDict):
    DomainName: str,

DescribeDomainRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DescribeDomainRequestRequestTypeDef

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

Definition

class DescribeDomainRequestRequestTypeDef(TypedDict):
    DomainName: str,

DescribeDomainsRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DescribeDomainsRequestRequestTypeDef

def get_value() -> DescribeDomainsRequestRequestTypeDef:
    return {
        "DomainNames": ...,
    }

Definition

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

DescribeDryRunProgressRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DescribeDryRunProgressRequestRequestTypeDef

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

Definition

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

DryRunResultsTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DryRunResultsTypeDef

def get_value() -> DryRunResultsTypeDef:
    return {
        "DeploymentType": ...,
    }

Definition

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

FilterTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import FilterTypeDef

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

Definition

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

DescribeInstanceTypeLimitsRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DescribeInstanceTypeLimitsRequestRequestTypeDef

def get_value() -> DescribeInstanceTypeLimitsRequestRequestTypeDef:
    return {
        "InstanceType": ...,
        "EngineVersion": ...,
    }

Definition

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

1. See OpenSearchPartitionInstanceTypeType

DescribePackagesFilterTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DescribePackagesFilterTypeDef

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

Definition

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

1. See DescribePackagesFilterNameType

DescribeReservedInstanceOfferingsRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DescribeReservedInstanceOfferingsRequestRequestTypeDef

def get_value() -> DescribeReservedInstanceOfferingsRequestRequestTypeDef:
    return {
        "ReservedInstanceOfferingId": ...,
    }

Definition

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

DescribeReservedInstancesRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DescribeReservedInstancesRequestRequestTypeDef

def get_value() -> DescribeReservedInstancesRequestRequestTypeDef:
    return {
        "ReservedInstanceId": ...,
    }

Definition

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

DescribeVpcEndpointsRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DescribeVpcEndpointsRequestRequestTypeDef

def get_value() -> DescribeVpcEndpointsRequestRequestTypeDef:
    return {
        "VpcEndpointIds": ...,
    }

Definition

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

VpcEndpointErrorTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import VpcEndpointErrorTypeDef

def get_value() -> VpcEndpointErrorTypeDef:
    return {
        "VpcEndpointId": ...,
    }

Definition

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

1. See VpcEndpointErrorCodeType

DissociatePackageRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DissociatePackageRequestRequestTypeDef

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

Definition

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

DomainInfoTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DomainInfoTypeDef

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

Definition

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

1. See EngineTypeType

ErrorDetailsTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import ErrorDetailsTypeDef

def get_value() -> ErrorDetailsTypeDef:
    return {
        "ErrorType": ...,
    }

Definition

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

VPCDerivedInfoTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import VPCDerivedInfoTypeDef

def get_value() -> VPCDerivedInfoTypeDef:
    return {
        "VPCId": ...,
    }

Definition

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

ValidationFailureTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import ValidationFailureTypeDef

def get_value() -> ValidationFailureTypeDef:
    return {
        "Code": ...,
    }

Definition

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

GetCompatibleVersionsRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import GetCompatibleVersionsRequestRequestTypeDef

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

Definition

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

GetPackageVersionHistoryRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import GetPackageVersionHistoryRequestRequestTypeDef

def get_value() -> GetPackageVersionHistoryRequestRequestTypeDef:
    return {
        "PackageID": ...,
    }

Definition

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

PackageVersionHistoryTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import PackageVersionHistoryTypeDef

def get_value() -> PackageVersionHistoryTypeDef:
    return {
        "PackageVersion": ...,
    }

Definition

class PackageVersionHistoryTypeDef(TypedDict):
    PackageVersion: NotRequired[str],
    CommitMessage: NotRequired[str],
    CreatedAt: NotRequired[datetime],

GetUpgradeHistoryRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import GetUpgradeHistoryRequestRequestTypeDef

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

Definition

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

GetUpgradeStatusRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import GetUpgradeStatusRequestRequestTypeDef

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

Definition

class GetUpgradeStatusRequestRequestTypeDef(TypedDict):
    DomainName: str,

InboundConnectionStatusTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import InboundConnectionStatusTypeDef

def get_value() -> InboundConnectionStatusTypeDef:
    return {
        "StatusCode": ...,
    }

Definition

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

1. See InboundConnectionStatusCodeType

InstanceCountLimitsTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import InstanceCountLimitsTypeDef

def get_value() -> InstanceCountLimitsTypeDef:
    return {
        "MinimumInstanceCount": ...,
    }

Definition

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

InstanceTypeDetailsTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import InstanceTypeDetailsTypeDef

def get_value() -> InstanceTypeDetailsTypeDef:
    return {
        "InstanceType": ...,
    }

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

1. See OpenSearchPartitionInstanceTypeType

ListDomainNamesRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import ListDomainNamesRequestRequestTypeDef

def get_value() -> ListDomainNamesRequestRequestTypeDef:
    return {
        "EngineType": ...,
    }

Definition

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

1. See EngineTypeType

ListDomainsForPackageRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import ListDomainsForPackageRequestRequestTypeDef

def get_value() -> ListDomainsForPackageRequestRequestTypeDef:
    return {
        "PackageID": ...,
    }

Definition

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

ListInstanceTypeDetailsRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import ListInstanceTypeDetailsRequestRequestTypeDef

def get_value() -> ListInstanceTypeDetailsRequestRequestTypeDef:
    return {
        "EngineVersion": ...,
    }

Definition

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

ListPackagesForDomainRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import ListPackagesForDomainRequestRequestTypeDef

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

Definition

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

ListScheduledActionsRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import ListScheduledActionsRequestRequestTypeDef

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

Definition

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

ScheduledActionTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import ScheduledActionTypeDef

def get_value() -> ScheduledActionTypeDef:
    return {
        "Id": ...,
        "Type": ...,
        "Severity": ...,
        "ScheduledTime": ...,
    }

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

Usage Example

from mypy_boto3_opensearch.type_defs import ListTagsRequestRequestTypeDef

def get_value() -> ListTagsRequestRequestTypeDef:
    return {
        "ARN": ...,
    }

Definition

class ListTagsRequestRequestTypeDef(TypedDict):
    ARN: str,

ListVersionsRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import ListVersionsRequestRequestTypeDef

def get_value() -> ListVersionsRequestRequestTypeDef:
    return {
        "MaxResults": ...,
    }

Definition

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

ListVpcEndpointAccessRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import ListVpcEndpointAccessRequestRequestTypeDef

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

Definition

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

ListVpcEndpointsForDomainRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import ListVpcEndpointsForDomainRequestRequestTypeDef

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

Definition

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

ListVpcEndpointsRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import ListVpcEndpointsRequestRequestTypeDef

def get_value() -> ListVpcEndpointsRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }

Definition

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

WindowStartTimeTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import WindowStartTimeTypeDef

def get_value() -> WindowStartTimeTypeDef:
    return {
        "Hours": ...,
        "Minutes": ...,
    }

Definition

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

PurchaseReservedInstanceOfferingRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import PurchaseReservedInstanceOfferingRequestRequestTypeDef

def get_value() -> PurchaseReservedInstanceOfferingRequestRequestTypeDef:
    return {
        "ReservedInstanceOfferingId": ...,
        "ReservationName": ...,
    }

Definition

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

RecurringChargeTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import RecurringChargeTypeDef

def get_value() -> RecurringChargeTypeDef:
    return {
        "RecurringChargeAmount": ...,
    }

Definition

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

RejectInboundConnectionRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import RejectInboundConnectionRequestRequestTypeDef

def get_value() -> RejectInboundConnectionRequestRequestTypeDef:
    return {
        "ConnectionId": ...,
    }

Definition

class RejectInboundConnectionRequestRequestTypeDef(TypedDict):
    ConnectionId: str,

RemoveTagsRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import RemoveTagsRequestRequestTypeDef

def get_value() -> RemoveTagsRequestRequestTypeDef:
    return {
        "ARN": ...,
        "TagKeys": ...,
    }

Definition

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

RevokeVpcEndpointAccessRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import RevokeVpcEndpointAccessRequestRequestTypeDef

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

Definition

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

SAMLIdpTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import SAMLIdpTypeDef

def get_value() -> SAMLIdpTypeDef:
    return {
        "MetadataContent": ...,
        "EntityId": ...,
    }

Definition

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

StartServiceSoftwareUpdateRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import StartServiceSoftwareUpdateRequestRequestTypeDef

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

Definition

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

1. See ScheduleAtType

StorageTypeLimitTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import StorageTypeLimitTypeDef

def get_value() -> StorageTypeLimitTypeDef:
    return {
        "LimitName": ...,
    }

Definition

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

UpdateScheduledActionRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import UpdateScheduledActionRequestRequestTypeDef

def get_value() -> UpdateScheduledActionRequestRequestTypeDef:
    return {
        "DomainName": ...,
        "ActionID": ...,
        "ActionType": ...,
        "ScheduleAt": ...,
    }

Definition

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

1. See ActionTypeType
2. See ScheduleAtType

UpgradeDomainRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import UpgradeDomainRequestRequestTypeDef

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

Definition

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

UpgradeStepItemTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import UpgradeStepItemTypeDef

def get_value() -> UpgradeStepItemTypeDef:
    return {
        "UpgradeStep": ...,
    }

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

Usage Example

from mypy_boto3_opensearch.type_defs import DomainInformationContainerTypeDef

def get_value() -> DomainInformationContainerTypeDef:
    return {
        "AWSDomainInformation": ...,
    }

Definition

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

1. See AWSDomainInformationTypeDef

EmptyResponseMetadataTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import EmptyResponseMetadataTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

GetUpgradeStatusResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import GetUpgradeStatusResponseTypeDef

def get_value() -> GetUpgradeStatusResponseTypeDef:
    return {
        "UpgradeStep": ...,
        "StepStatus": ...,
        "UpgradeName": ...,
        "ResponseMetadata": ...,
    }

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

Usage Example

from mypy_boto3_opensearch.type_defs import ListVersionsResponseTypeDef

def get_value() -> ListVersionsResponseTypeDef:
    return {
        "Versions": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

PurchaseReservedInstanceOfferingResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import PurchaseReservedInstanceOfferingResponseTypeDef

def get_value() -> PurchaseReservedInstanceOfferingResponseTypeDef:
    return {
        "ReservedInstanceId": ...,
        "ReservationName": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

AccessPoliciesStatusTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import AccessPoliciesStatusTypeDef

def get_value() -> AccessPoliciesStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }

Definition

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

1. See OptionStatusTypeDef

AdvancedOptionsStatusTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import AdvancedOptionsStatusTypeDef

def get_value() -> AdvancedOptionsStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }

Definition

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

1. See OptionStatusTypeDef

VersionStatusTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import VersionStatusTypeDef

def get_value() -> VersionStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }

Definition

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

1. See OptionStatusTypeDef

AddTagsRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import AddTagsRequestRequestTypeDef

def get_value() -> AddTagsRequestRequestTypeDef:
    return {
        "ARN": ...,
        "TagList": ...,
    }

Definition

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

1. See TagTypeDef

ListTagsResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import ListTagsResponseTypeDef

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

Definition

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

1. See TagTypeDef
2. See ResponseMetadataTypeDef

AuthorizeVpcEndpointAccessResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import AuthorizeVpcEndpointAccessResponseTypeDef

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

Definition

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

1. See AuthorizedPrincipalTypeDef
2. See ResponseMetadataTypeDef

ListVpcEndpointAccessResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import ListVpcEndpointAccessResponseTypeDef

def get_value() -> ListVpcEndpointAccessResponseTypeDef:
    return {
        "AuthorizedPrincipalList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See AuthorizedPrincipalTypeDef
2. See ResponseMetadataTypeDef

AutoTuneDetailsTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import AutoTuneDetailsTypeDef

def get_value() -> AutoTuneDetailsTypeDef:
    return {
        "ScheduledAutoTuneDetails": ...,
    }

Definition

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

1. See ScheduledAutoTuneDetailsTypeDef

AutoTuneMaintenanceScheduleTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import AutoTuneMaintenanceScheduleTypeDef

def get_value() -> AutoTuneMaintenanceScheduleTypeDef:
    return {
        "StartAt": ...,
    }

Definition

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

1. See DurationTypeDef

CancelServiceSoftwareUpdateResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import CancelServiceSoftwareUpdateResponseTypeDef

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

Definition

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

1. See ServiceSoftwareOptionsTypeDef
2. See ResponseMetadataTypeDef

StartServiceSoftwareUpdateResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import StartServiceSoftwareUpdateResponseTypeDef

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

Definition

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

1. See ServiceSoftwareOptionsTypeDef
2. See ResponseMetadataTypeDef

UpgradeDomainResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import UpgradeDomainResponseTypeDef

def get_value() -> UpgradeDomainResponseTypeDef:
    return {
        "UpgradeId": ...,
        "DomainName": ...,
        "TargetVersion": ...,
        "PerformCheckOnly": ...,
        "AdvancedOptions": ...,
        "ChangeProgressDetails": ...,
        "ResponseMetadata": ...,
    }

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

Usage Example

from mypy_boto3_opensearch.type_defs import ChangeProgressStatusDetailsTypeDef

def get_value() -> ChangeProgressStatusDetailsTypeDef:
    return {
        "ChangeId": ...,
    }

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)

1. See OverallChangeStatusType
2. See ChangeProgressStageTypeDef

ClusterConfigTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import ClusterConfigTypeDef

def get_value() -> ClusterConfigTypeDef:
    return {
        "InstanceType": ...,
    }

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)

1. See OpenSearchPartitionInstanceTypeType
2. See ZoneAwarenessConfigTypeDef
3. See OpenSearchPartitionInstanceTypeType
4. See OpenSearchWarmPartitionInstanceTypeType
5. See ColdStorageOptionsTypeDef

CognitoOptionsStatusTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import CognitoOptionsStatusTypeDef

def get_value() -> CognitoOptionsStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }

Definition

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

1. See CognitoOptionsTypeDef
2. See OptionStatusTypeDef

GetCompatibleVersionsResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import GetCompatibleVersionsResponseTypeDef

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

Definition

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

1. See CompatibleVersionsMapTypeDef
2. See ResponseMetadataTypeDef

DomainEndpointOptionsStatusTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DomainEndpointOptionsStatusTypeDef

def get_value() -> DomainEndpointOptionsStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }

Definition

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

1. See DomainEndpointOptionsTypeDef
2. See OptionStatusTypeDef

EBSOptionsStatusTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import EBSOptionsStatusTypeDef

def get_value() -> EBSOptionsStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }

Definition

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

1. See EBSOptionsTypeDef
2. See OptionStatusTypeDef

EncryptionAtRestOptionsStatusTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import EncryptionAtRestOptionsStatusTypeDef

def get_value() -> EncryptionAtRestOptionsStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }

Definition

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

1. See EncryptionAtRestOptionsTypeDef
2. See OptionStatusTypeDef

LogPublishingOptionsStatusTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import LogPublishingOptionsStatusTypeDef

def get_value() -> LogPublishingOptionsStatusTypeDef:
    return {
        "Options": ...,
    }

Definition

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

1. See LogTypeType LogPublishingOptionTypeDef
2. See OptionStatusTypeDef

NodeToNodeEncryptionOptionsStatusTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import NodeToNodeEncryptionOptionsStatusTypeDef

def get_value() -> NodeToNodeEncryptionOptionsStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }

Definition

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

1. See NodeToNodeEncryptionOptionsTypeDef
2. See OptionStatusTypeDef

SnapshotOptionsStatusTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import SnapshotOptionsStatusTypeDef

def get_value() -> SnapshotOptionsStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }

Definition

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

1. See SnapshotOptionsTypeDef
2. See OptionStatusTypeDef

SoftwareUpdateOptionsStatusTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import SoftwareUpdateOptionsStatusTypeDef

def get_value() -> SoftwareUpdateOptionsStatusTypeDef:
    return {
        "Options": ...,
    }

Definition

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

1. See SoftwareUpdateOptionsTypeDef
2. See OptionStatusTypeDef

CreateVpcEndpointRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import CreateVpcEndpointRequestRequestTypeDef

def get_value() -> CreateVpcEndpointRequestRequestTypeDef:
    return {
        "DomainArn": ...,
        "VpcOptions": ...,
    }

Definition

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

1. See VPCOptionsTypeDef

UpdateVpcEndpointRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import UpdateVpcEndpointRequestRequestTypeDef

def get_value() -> UpdateVpcEndpointRequestRequestTypeDef:
    return {
        "VpcEndpointId": ...,
        "VpcOptions": ...,
    }

Definition

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

1. See VPCOptionsTypeDef

CreatePackageRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import CreatePackageRequestRequestTypeDef

def get_value() -> CreatePackageRequestRequestTypeDef:
    return {
        "PackageName": ...,
        "PackageType": ...,
        "PackageSource": ...,
    }

Definition

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

1. See PackageTypeType
2. See PackageSourceTypeDef

UpdatePackageRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import UpdatePackageRequestRequestTypeDef

def get_value() -> UpdatePackageRequestRequestTypeDef:
    return {
        "PackageID": ...,
        "PackageSource": ...,
    }

Definition

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

1. See PackageSourceTypeDef

DeleteVpcEndpointResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DeleteVpcEndpointResponseTypeDef

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

Definition

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

1. See VpcEndpointSummaryTypeDef
2. See ResponseMetadataTypeDef

ListVpcEndpointsForDomainResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import ListVpcEndpointsForDomainResponseTypeDef

def get_value() -> ListVpcEndpointsForDomainResponseTypeDef:
    return {
        "VpcEndpointSummaryList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See VpcEndpointSummaryTypeDef
2. See ResponseMetadataTypeDef

ListVpcEndpointsResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import ListVpcEndpointsResponseTypeDef

def get_value() -> ListVpcEndpointsResponseTypeDef:
    return {
        "VpcEndpointSummaryList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See VpcEndpointSummaryTypeDef
2. See ResponseMetadataTypeDef

DescribeInboundConnectionsRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DescribeInboundConnectionsRequestRequestTypeDef

def get_value() -> DescribeInboundConnectionsRequestRequestTypeDef:
    return {
        "Filters": ...,
    }

Definition

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

1. See FilterTypeDef

DescribeOutboundConnectionsRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DescribeOutboundConnectionsRequestRequestTypeDef

def get_value() -> DescribeOutboundConnectionsRequestRequestTypeDef:
    return {
        "Filters": ...,
    }

Definition

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

1. See FilterTypeDef

DescribePackagesRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DescribePackagesRequestRequestTypeDef

def get_value() -> DescribePackagesRequestRequestTypeDef:
    return {
        "Filters": ...,
    }

Definition

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

1. See DescribePackagesFilterTypeDef

ListDomainNamesResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import ListDomainNamesResponseTypeDef

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

Definition

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

1. See DomainInfoTypeDef
2. See ResponseMetadataTypeDef

DomainPackageDetailsTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DomainPackageDetailsTypeDef

def get_value() -> DomainPackageDetailsTypeDef:
    return {
        "PackageID": ...,
    }

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

PackageDetailsTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import PackageDetailsTypeDef

def get_value() -> PackageDetailsTypeDef:
    return {
        "PackageID": ...,
    }

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)

1. See PackageTypeType
2. See PackageStatusType
3. See ErrorDetailsTypeDef

VPCDerivedInfoStatusTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import VPCDerivedInfoStatusTypeDef

def get_value() -> VPCDerivedInfoStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }

Definition

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

1. See VPCDerivedInfoTypeDef
2. See OptionStatusTypeDef

VpcEndpointTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import VpcEndpointTypeDef

def get_value() -> VpcEndpointTypeDef:
    return {
        "VpcEndpointId": ...,
    }

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

Usage Example

from mypy_boto3_opensearch.type_defs import DryRunProgressStatusTypeDef

def get_value() -> DryRunProgressStatusTypeDef:
    return {
        "DryRunId": ...,
        "DryRunStatus": ...,
        "CreationDate": ...,
        "UpdateDate": ...,
    }

Definition

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

1. See ValidationFailureTypeDef

GetPackageVersionHistoryResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import GetPackageVersionHistoryResponseTypeDef

def get_value() -> GetPackageVersionHistoryResponseTypeDef:
    return {
        "PackageID": ...,
        "PackageVersionHistoryList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See PackageVersionHistoryTypeDef
2. See ResponseMetadataTypeDef

InstanceLimitsTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import InstanceLimitsTypeDef

def get_value() -> InstanceLimitsTypeDef:
    return {
        "InstanceCountLimits": ...,
    }

Definition

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

1. See InstanceCountLimitsTypeDef

ListInstanceTypeDetailsResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import ListInstanceTypeDetailsResponseTypeDef

def get_value() -> ListInstanceTypeDetailsResponseTypeDef:
    return {
        "InstanceTypeDetails": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See InstanceTypeDetailsTypeDef
2. See ResponseMetadataTypeDef

ListScheduledActionsResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import ListScheduledActionsResponseTypeDef

def get_value() -> ListScheduledActionsResponseTypeDef:
    return {
        "ScheduledActions": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ScheduledActionTypeDef
2. See ResponseMetadataTypeDef

UpdateScheduledActionResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import UpdateScheduledActionResponseTypeDef

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

Definition

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

1. See ScheduledActionTypeDef
2. See ResponseMetadataTypeDef

OffPeakWindowTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import OffPeakWindowTypeDef

def get_value() -> OffPeakWindowTypeDef:
    return {
        "WindowStartTime": ...,
    }

Definition

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

1. See WindowStartTimeTypeDef

ReservedInstanceOfferingTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import ReservedInstanceOfferingTypeDef

def get_value() -> ReservedInstanceOfferingTypeDef:
    return {
        "ReservedInstanceOfferingId": ...,
    }

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

Usage Example

from mypy_boto3_opensearch.type_defs import ReservedInstanceTypeDef

def get_value() -> ReservedInstanceTypeDef:
    return {
        "ReservationName": ...,
    }

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

Usage Example

from mypy_boto3_opensearch.type_defs import SAMLOptionsInputTypeDef

def get_value() -> SAMLOptionsInputTypeDef:
    return {
        "Enabled": ...,
    }

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

Usage Example

from mypy_boto3_opensearch.type_defs import SAMLOptionsOutputTypeDef

def get_value() -> SAMLOptionsOutputTypeDef:
    return {
        "Enabled": ...,
    }

Definition

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

1. See SAMLIdpTypeDef

StorageTypeTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import StorageTypeTypeDef

def get_value() -> StorageTypeTypeDef:
    return {
        "StorageTypeName": ...,
    }

Definition

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

1. See StorageTypeLimitTypeDef

UpgradeHistoryTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import UpgradeHistoryTypeDef

def get_value() -> UpgradeHistoryTypeDef:
    return {
        "UpgradeName": ...,
    }

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

CreateOutboundConnectionRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import CreateOutboundConnectionRequestRequestTypeDef

def get_value() -> CreateOutboundConnectionRequestRequestTypeDef:
    return {
        "LocalDomainInfo": ...,
        "RemoteDomainInfo": ...,
        "ConnectionAlias": ...,
    }

Definition

class CreateOutboundConnectionRequestRequestTypeDef(TypedDict):
    LocalDomainInfo: DomainInformationContainerTypeDef,  # (1)
    RemoteDomainInfo: DomainInformationContainerTypeDef,  # (1)
    ConnectionAlias: str,
    ConnectionMode: NotRequired[ConnectionModeType],  # (3)

1. See DomainInformationContainerTypeDef
2. See DomainInformationContainerTypeDef
3. See ConnectionModeType

CreateOutboundConnectionResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import CreateOutboundConnectionResponseTypeDef

def get_value() -> CreateOutboundConnectionResponseTypeDef:
    return {
        "LocalDomainInfo": ...,
        "RemoteDomainInfo": ...,
        "ConnectionAlias": ...,
        "ConnectionStatus": ...,
        "ConnectionId": ...,
        "ConnectionMode": ...,
        "ConnectionProperties": ...,
        "ResponseMetadata": ...,
    }

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

InboundConnectionTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import InboundConnectionTypeDef

def get_value() -> InboundConnectionTypeDef:
    return {
        "LocalDomainInfo": ...,
    }

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

OutboundConnectionTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import OutboundConnectionTypeDef

def get_value() -> OutboundConnectionTypeDef:
    return {
        "LocalDomainInfo": ...,
    }

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

AutoTuneTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import AutoTuneTypeDef

def get_value() -> AutoTuneTypeDef:
    return {
        "AutoTuneType": ...,
    }

Definition

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

1. See AutoTuneTypeType
2. See AutoTuneDetailsTypeDef

AutoTuneOptionsInputTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import AutoTuneOptionsInputTypeDef

def get_value() -> AutoTuneOptionsInputTypeDef:
    return {
        "DesiredState": ...,
    }

Definition

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

1. See AutoTuneDesiredStateType
2. See AutoTuneMaintenanceScheduleTypeDef

AutoTuneOptionsTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import AutoTuneOptionsTypeDef

def get_value() -> AutoTuneOptionsTypeDef:
    return {
        "DesiredState": ...,
    }

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

DescribeDomainChangeProgressResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DescribeDomainChangeProgressResponseTypeDef

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

Definition

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

1. See ChangeProgressStatusDetailsTypeDef
2. See ResponseMetadataTypeDef

ClusterConfigStatusTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import ClusterConfigStatusTypeDef

def get_value() -> ClusterConfigStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }

Definition

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

1. See ClusterConfigTypeDef
2. See OptionStatusTypeDef

AssociatePackageResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import AssociatePackageResponseTypeDef

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

Definition

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

1. See DomainPackageDetailsTypeDef
2. See ResponseMetadataTypeDef

DissociatePackageResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DissociatePackageResponseTypeDef

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

Definition

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

1. See DomainPackageDetailsTypeDef
2. See ResponseMetadataTypeDef

ListDomainsForPackageResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import ListDomainsForPackageResponseTypeDef

def get_value() -> ListDomainsForPackageResponseTypeDef:
    return {
        "DomainPackageDetailsList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See DomainPackageDetailsTypeDef
2. See ResponseMetadataTypeDef

ListPackagesForDomainResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import ListPackagesForDomainResponseTypeDef

def get_value() -> ListPackagesForDomainResponseTypeDef:
    return {
        "DomainPackageDetailsList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See DomainPackageDetailsTypeDef
2. See ResponseMetadataTypeDef

CreatePackageResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import CreatePackageResponseTypeDef

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

Definition

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

1. See PackageDetailsTypeDef
2. See ResponseMetadataTypeDef

DeletePackageResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DeletePackageResponseTypeDef

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

Definition

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

1. See PackageDetailsTypeDef
2. See ResponseMetadataTypeDef

DescribePackagesResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DescribePackagesResponseTypeDef

def get_value() -> DescribePackagesResponseTypeDef:
    return {
        "PackageDetailsList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See PackageDetailsTypeDef
2. See ResponseMetadataTypeDef

UpdatePackageResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import UpdatePackageResponseTypeDef

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

Definition

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

1. See PackageDetailsTypeDef
2. See ResponseMetadataTypeDef

CreateVpcEndpointResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import CreateVpcEndpointResponseTypeDef

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

Definition

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

1. See VpcEndpointTypeDef
2. See ResponseMetadataTypeDef

DescribeVpcEndpointsResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DescribeVpcEndpointsResponseTypeDef

def get_value() -> DescribeVpcEndpointsResponseTypeDef:
    return {
        "VpcEndpoints": ...,
        "VpcEndpointErrors": ...,
        "ResponseMetadata": ...,
    }

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

Usage Example

from mypy_boto3_opensearch.type_defs import UpdateVpcEndpointResponseTypeDef

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

Definition

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

1. See VpcEndpointTypeDef
2. See ResponseMetadataTypeDef

OffPeakWindowOptionsTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import OffPeakWindowOptionsTypeDef

def get_value() -> OffPeakWindowOptionsTypeDef:
    return {
        "Enabled": ...,
    }

Definition

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

1. See OffPeakWindowTypeDef

DescribeReservedInstanceOfferingsResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DescribeReservedInstanceOfferingsResponseTypeDef

def get_value() -> DescribeReservedInstanceOfferingsResponseTypeDef:
    return {
        "NextToken": ...,
        "ReservedInstanceOfferings": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ReservedInstanceOfferingTypeDef
2. See ResponseMetadataTypeDef

DescribeReservedInstancesResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DescribeReservedInstancesResponseTypeDef

def get_value() -> DescribeReservedInstancesResponseTypeDef:
    return {
        "NextToken": ...,
        "ReservedInstances": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ReservedInstanceTypeDef
2. See ResponseMetadataTypeDef

AdvancedSecurityOptionsInputTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import AdvancedSecurityOptionsInputTypeDef

def get_value() -> AdvancedSecurityOptionsInputTypeDef:
    return {
        "Enabled": ...,
    }

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

Usage Example

from mypy_boto3_opensearch.type_defs import AdvancedSecurityOptionsTypeDef

def get_value() -> AdvancedSecurityOptionsTypeDef:
    return {
        "Enabled": ...,
    }

Definition

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

1. See SAMLOptionsOutputTypeDef

LimitsTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import LimitsTypeDef

def get_value() -> LimitsTypeDef:
    return {
        "StorageTypes": ...,
    }

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

Usage Example

from mypy_boto3_opensearch.type_defs import GetUpgradeHistoryResponseTypeDef

def get_value() -> GetUpgradeHistoryResponseTypeDef:
    return {
        "UpgradeHistories": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See UpgradeHistoryTypeDef
2. See ResponseMetadataTypeDef

AcceptInboundConnectionResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import AcceptInboundConnectionResponseTypeDef

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

Definition

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

1. See InboundConnectionTypeDef
2. See ResponseMetadataTypeDef

DeleteInboundConnectionResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DeleteInboundConnectionResponseTypeDef

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

Definition

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

1. See InboundConnectionTypeDef
2. See ResponseMetadataTypeDef

DescribeInboundConnectionsResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DescribeInboundConnectionsResponseTypeDef

def get_value() -> DescribeInboundConnectionsResponseTypeDef:
    return {
        "Connections": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See InboundConnectionTypeDef
2. See ResponseMetadataTypeDef

RejectInboundConnectionResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import RejectInboundConnectionResponseTypeDef

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

Definition

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

1. See InboundConnectionTypeDef
2. See ResponseMetadataTypeDef

DeleteOutboundConnectionResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DeleteOutboundConnectionResponseTypeDef

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

Definition

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

1. See OutboundConnectionTypeDef
2. See ResponseMetadataTypeDef

DescribeOutboundConnectionsResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DescribeOutboundConnectionsResponseTypeDef

def get_value() -> DescribeOutboundConnectionsResponseTypeDef:
    return {
        "Connections": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See OutboundConnectionTypeDef
2. See ResponseMetadataTypeDef

DescribeDomainAutoTunesResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DescribeDomainAutoTunesResponseTypeDef

def get_value() -> DescribeDomainAutoTunesResponseTypeDef:
    return {
        "AutoTunes": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See AutoTuneTypeDef
2. See ResponseMetadataTypeDef

AutoTuneOptionsStatusTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import AutoTuneOptionsStatusTypeDef

def get_value() -> AutoTuneOptionsStatusTypeDef:
    return {
        "Options": ...,
    }

Definition

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

1. See AutoTuneOptionsTypeDef
2. See AutoTuneStatusTypeDef

OffPeakWindowOptionsStatusTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import OffPeakWindowOptionsStatusTypeDef

def get_value() -> OffPeakWindowOptionsStatusTypeDef:
    return {
        "Options": ...,
    }

Definition

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

1. See OffPeakWindowOptionsTypeDef
2. See OptionStatusTypeDef

CreateDomainRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import CreateDomainRequestRequestTypeDef

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

Definition

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

1. See ClusterConfigTypeDef
2. See EBSOptionsTypeDef
3. See SnapshotOptionsTypeDef
4. See VPCOptionsTypeDef
5. See CognitoOptionsTypeDef
6. See EncryptionAtRestOptionsTypeDef
7. See NodeToNodeEncryptionOptionsTypeDef
8. See LogTypeType LogPublishingOptionTypeDef
9. See DomainEndpointOptionsTypeDef
10. See AdvancedSecurityOptionsInputTypeDef
11. See TagTypeDef
12. See AutoTuneOptionsInputTypeDef
13. See OffPeakWindowOptionsTypeDef
14. See SoftwareUpdateOptionsTypeDef

UpdateDomainConfigRequestRequestTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import UpdateDomainConfigRequestRequestTypeDef

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

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],
    LogPublishingOptions: NotRequired[Mapping[LogTypeType, LogPublishingOptionTypeDef]],  # (6)
    EncryptionAtRestOptions: NotRequired[EncryptionAtRestOptionsTypeDef],  # (7)
    DomainEndpointOptions: NotRequired[DomainEndpointOptionsTypeDef],  # (8)
    NodeToNodeEncryptionOptions: NotRequired[NodeToNodeEncryptionOptionsTypeDef],  # (9)
    AdvancedSecurityOptions: NotRequired[AdvancedSecurityOptionsInputTypeDef],  # (10)
    AutoTuneOptions: NotRequired[AutoTuneOptionsTypeDef],  # (11)
    DryRun: NotRequired[bool],
    DryRunMode: NotRequired[DryRunModeType],  # (12)
    OffPeakWindowOptions: NotRequired[OffPeakWindowOptionsTypeDef],  # (13)
    SoftwareUpdateOptions: NotRequired[SoftwareUpdateOptionsTypeDef],  # (14)

1. See ClusterConfigTypeDef
2. See EBSOptionsTypeDef
3. See SnapshotOptionsTypeDef
4. See VPCOptionsTypeDef
5. See CognitoOptionsTypeDef
6. See LogTypeType LogPublishingOptionTypeDef
7. See EncryptionAtRestOptionsTypeDef
8. See DomainEndpointOptionsTypeDef
9. See NodeToNodeEncryptionOptionsTypeDef
10. See AdvancedSecurityOptionsInputTypeDef
11. See AutoTuneOptionsTypeDef
12. See DryRunModeType
13. See OffPeakWindowOptionsTypeDef
14. See SoftwareUpdateOptionsTypeDef

AdvancedSecurityOptionsStatusTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import AdvancedSecurityOptionsStatusTypeDef

def get_value() -> AdvancedSecurityOptionsStatusTypeDef:
    return {
        "Options": ...,
        "Status": ...,
    }

Definition

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

1. See AdvancedSecurityOptionsTypeDef
2. See OptionStatusTypeDef

DomainStatusTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DomainStatusTypeDef

def get_value() -> DomainStatusTypeDef:
    return {
        "DomainId": ...,
        "DomainName": ...,
        "ARN": ...,
        "ClusterConfig": ...,
    }

Definition

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

1. See ClusterConfigTypeDef
2. See EBSOptionsTypeDef
3. See SnapshotOptionsTypeDef
4. See VPCDerivedInfoTypeDef
5. See CognitoOptionsTypeDef
6. See EncryptionAtRestOptionsTypeDef
7. See NodeToNodeEncryptionOptionsTypeDef
8. See LogTypeType LogPublishingOptionTypeDef
9. See ServiceSoftwareOptionsTypeDef
10. See DomainEndpointOptionsTypeDef
11. See AdvancedSecurityOptionsTypeDef
12. See AutoTuneOptionsOutputTypeDef
13. See ChangeProgressDetailsTypeDef
14. See OffPeakWindowOptionsTypeDef
15. See SoftwareUpdateOptionsTypeDef

DescribeInstanceTypeLimitsResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DescribeInstanceTypeLimitsResponseTypeDef

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

Definition

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

1. See LimitsTypeDef
2. See ResponseMetadataTypeDef

DomainConfigTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DomainConfigTypeDef

def get_value() -> DomainConfigTypeDef:
    return {
        "EngineVersion": ...,
    }

Definition

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

1. See VersionStatusTypeDef
2. See ClusterConfigStatusTypeDef
3. See EBSOptionsStatusTypeDef
4. See AccessPoliciesStatusTypeDef
5. See SnapshotOptionsStatusTypeDef
6. See VPCDerivedInfoStatusTypeDef
7. See CognitoOptionsStatusTypeDef
8. See EncryptionAtRestOptionsStatusTypeDef
9. See NodeToNodeEncryptionOptionsStatusTypeDef
10. See AdvancedOptionsStatusTypeDef
11. See LogPublishingOptionsStatusTypeDef
12. See DomainEndpointOptionsStatusTypeDef
13. See AdvancedSecurityOptionsStatusTypeDef
14. See AutoTuneOptionsStatusTypeDef
15. See ChangeProgressDetailsTypeDef
16. See OffPeakWindowOptionsStatusTypeDef
17. See SoftwareUpdateOptionsStatusTypeDef

CreateDomainResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import CreateDomainResponseTypeDef

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

Definition

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

1. See DomainStatusTypeDef
2. See ResponseMetadataTypeDef

DeleteDomainResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DeleteDomainResponseTypeDef

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

Definition

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

1. See DomainStatusTypeDef
2. See ResponseMetadataTypeDef

DescribeDomainResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DescribeDomainResponseTypeDef

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

Definition

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

1. See DomainStatusTypeDef
2. See ResponseMetadataTypeDef

DescribeDomainsResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DescribeDomainsResponseTypeDef

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

Definition

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

1. See DomainStatusTypeDef
2. See ResponseMetadataTypeDef

DescribeDryRunProgressResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import DescribeDryRunProgressResponseTypeDef

def get_value() -> DescribeDryRunProgressResponseTypeDef:
    return {
        "DryRunProgressStatus": ...,
        "DryRunConfig": ...,
        "DryRunResults": ...,
        "ResponseMetadata": ...,
    }

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

Usage Example

from mypy_boto3_opensearch.type_defs import DescribeDomainConfigResponseTypeDef

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

Definition

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

1. See DomainConfigTypeDef
2. See ResponseMetadataTypeDef

UpdateDomainConfigResponseTypeDef

Usage Example

from mypy_boto3_opensearch.type_defs import UpdateDomainConfigResponseTypeDef

def get_value() -> UpdateDomainConfigResponseTypeDef:
    return {
        "DomainConfig": ...,
        "DryRunResults": ...,
        "DryRunProgressStatus": ...,
        "ResponseMetadata": ...,
    }

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