Type definitions

Index > OpenSearchServiceServerless > Type definitions

Auto-generated documentation for OpenSearchServiceServerless type annotations stubs module types-boto3-opensearchserverless.

AccessPolicyDetailTypeDef

# AccessPolicyDetailTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import AccessPolicyDetailTypeDef


def get_value() -> AccessPolicyDetailTypeDef:
    return {
        "type": ...,
    }


# AccessPolicyDetailTypeDef definition

class AccessPolicyDetailTypeDef(TypedDict):
    type: NotRequired[AccessPolicyTypeType],  # (1)
    name: NotRequired[str],
    policyVersion: NotRequired[str],
    description: NotRequired[str],
    policy: NotRequired[Dict[str, Any]],
    createdDate: NotRequired[int],
    lastModifiedDate: NotRequired[int],

1. See AccessPolicyTypeType

AccessPolicyStatsTypeDef

# AccessPolicyStatsTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import AccessPolicyStatsTypeDef


def get_value() -> AccessPolicyStatsTypeDef:
    return {
        "DataPolicyCount": ...,
    }


# AccessPolicyStatsTypeDef definition

class AccessPolicyStatsTypeDef(TypedDict):
    DataPolicyCount: NotRequired[int],

AccessPolicySummaryTypeDef

# AccessPolicySummaryTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import AccessPolicySummaryTypeDef


def get_value() -> AccessPolicySummaryTypeDef:
    return {
        "type": ...,
    }


# AccessPolicySummaryTypeDef definition

class AccessPolicySummaryTypeDef(TypedDict):
    type: NotRequired[AccessPolicyTypeType],  # (1)
    name: NotRequired[str],
    policyVersion: NotRequired[str],
    description: NotRequired[str],
    createdDate: NotRequired[int],
    lastModifiedDate: NotRequired[int],

1. See AccessPolicyTypeType

CapacityLimitsTypeDef

# CapacityLimitsTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import CapacityLimitsTypeDef


def get_value() -> CapacityLimitsTypeDef:
    return {
        "maxIndexingCapacityInOCU": ...,
    }


# CapacityLimitsTypeDef definition

class CapacityLimitsTypeDef(TypedDict):
    maxIndexingCapacityInOCU: NotRequired[int],
    maxSearchCapacityInOCU: NotRequired[int],

BatchGetCollectionRequestTypeDef

# BatchGetCollectionRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import BatchGetCollectionRequestTypeDef


def get_value() -> BatchGetCollectionRequestTypeDef:
    return {
        "ids": ...,
    }


# BatchGetCollectionRequestTypeDef definition

class BatchGetCollectionRequestTypeDef(TypedDict):
    ids: NotRequired[Sequence[str]],
    names: NotRequired[Sequence[str]],

CollectionErrorDetailTypeDef

# CollectionErrorDetailTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import CollectionErrorDetailTypeDef


def get_value() -> CollectionErrorDetailTypeDef:
    return {
        "id": ...,
    }


# CollectionErrorDetailTypeDef definition

class CollectionErrorDetailTypeDef(TypedDict):
    id: NotRequired[str],
    name: NotRequired[str],
    errorMessage: NotRequired[str],
    errorCode: NotRequired[str],

ResponseMetadataTypeDef

# ResponseMetadataTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

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

LifecyclePolicyResourceIdentifierTypeDef

# LifecyclePolicyResourceIdentifierTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import LifecyclePolicyResourceIdentifierTypeDef


def get_value() -> LifecyclePolicyResourceIdentifierTypeDef:
    return {
        "type": ...,
    }


# LifecyclePolicyResourceIdentifierTypeDef definition

class LifecyclePolicyResourceIdentifierTypeDef(TypedDict):
    type: LifecyclePolicyTypeType,  # (1)
    resource: str,

1. See LifecyclePolicyTypeType

EffectiveLifecyclePolicyDetailTypeDef

# EffectiveLifecyclePolicyDetailTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import EffectiveLifecyclePolicyDetailTypeDef


def get_value() -> EffectiveLifecyclePolicyDetailTypeDef:
    return {
        "type": ...,
    }


# EffectiveLifecyclePolicyDetailTypeDef definition

class EffectiveLifecyclePolicyDetailTypeDef(TypedDict):
    type: NotRequired[LifecyclePolicyTypeType],  # (1)
    resource: NotRequired[str],
    policyName: NotRequired[str],
    resourceType: NotRequired[ResourceTypeType],  # (2)
    retentionPeriod: NotRequired[str],
    noMinRetentionPeriod: NotRequired[bool],

1. See LifecyclePolicyTypeType
2. See ResourceTypeType

EffectiveLifecyclePolicyErrorDetailTypeDef

# EffectiveLifecyclePolicyErrorDetailTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import EffectiveLifecyclePolicyErrorDetailTypeDef


def get_value() -> EffectiveLifecyclePolicyErrorDetailTypeDef:
    return {
        "type": ...,
    }


# EffectiveLifecyclePolicyErrorDetailTypeDef definition

class EffectiveLifecyclePolicyErrorDetailTypeDef(TypedDict):
    type: NotRequired[LifecyclePolicyTypeType],  # (1)
    resource: NotRequired[str],
    errorMessage: NotRequired[str],
    errorCode: NotRequired[str],

1. See LifecyclePolicyTypeType

LifecyclePolicyIdentifierTypeDef

# LifecyclePolicyIdentifierTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import LifecyclePolicyIdentifierTypeDef


def get_value() -> LifecyclePolicyIdentifierTypeDef:
    return {
        "type": ...,
    }


# LifecyclePolicyIdentifierTypeDef definition

class LifecyclePolicyIdentifierTypeDef(TypedDict):
    type: LifecyclePolicyTypeType,  # (1)
    name: str,

1. See LifecyclePolicyTypeType

LifecyclePolicyDetailTypeDef

# LifecyclePolicyDetailTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import LifecyclePolicyDetailTypeDef


def get_value() -> LifecyclePolicyDetailTypeDef:
    return {
        "type": ...,
    }


# LifecyclePolicyDetailTypeDef definition

class LifecyclePolicyDetailTypeDef(TypedDict):
    type: NotRequired[LifecyclePolicyTypeType],  # (1)
    name: NotRequired[str],
    policyVersion: NotRequired[str],
    description: NotRequired[str],
    policy: NotRequired[Dict[str, Any]],
    createdDate: NotRequired[int],
    lastModifiedDate: NotRequired[int],

1. See LifecyclePolicyTypeType

LifecyclePolicyErrorDetailTypeDef

# LifecyclePolicyErrorDetailTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import LifecyclePolicyErrorDetailTypeDef


def get_value() -> LifecyclePolicyErrorDetailTypeDef:
    return {
        "type": ...,
    }


# LifecyclePolicyErrorDetailTypeDef definition

class LifecyclePolicyErrorDetailTypeDef(TypedDict):
    type: NotRequired[LifecyclePolicyTypeType],  # (1)
    name: NotRequired[str],
    errorMessage: NotRequired[str],
    errorCode: NotRequired[str],

1. See LifecyclePolicyTypeType

BatchGetVpcEndpointRequestTypeDef

# BatchGetVpcEndpointRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import BatchGetVpcEndpointRequestTypeDef


def get_value() -> BatchGetVpcEndpointRequestTypeDef:
    return {
        "ids": ...,
    }


# BatchGetVpcEndpointRequestTypeDef definition

class BatchGetVpcEndpointRequestTypeDef(TypedDict):
    ids: Sequence[str],

VpcEndpointDetailTypeDef

# VpcEndpointDetailTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import VpcEndpointDetailTypeDef


def get_value() -> VpcEndpointDetailTypeDef:
    return {
        "id": ...,
    }


# VpcEndpointDetailTypeDef definition

class VpcEndpointDetailTypeDef(TypedDict):
    id: NotRequired[str],
    name: NotRequired[str],
    vpcId: NotRequired[str],
    subnetIds: NotRequired[List[str]],
    securityGroupIds: NotRequired[List[str]],
    status: NotRequired[VpcEndpointStatusType],  # (1)
    createdDate: NotRequired[int],
    failureCode: NotRequired[str],
    failureMessage: NotRequired[str],

1. See VpcEndpointStatusType

VpcEndpointErrorDetailTypeDef

# VpcEndpointErrorDetailTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import VpcEndpointErrorDetailTypeDef


def get_value() -> VpcEndpointErrorDetailTypeDef:
    return {
        "id": ...,
    }


# VpcEndpointErrorDetailTypeDef definition

class VpcEndpointErrorDetailTypeDef(TypedDict):
    id: NotRequired[str],
    errorMessage: NotRequired[str],
    errorCode: NotRequired[str],

FipsEndpointsTypeDef

# FipsEndpointsTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import FipsEndpointsTypeDef


def get_value() -> FipsEndpointsTypeDef:
    return {
        "collectionEndpoint": ...,
    }


# FipsEndpointsTypeDef definition

class FipsEndpointsTypeDef(TypedDict):
    collectionEndpoint: NotRequired[str],
    dashboardEndpoint: NotRequired[str],

CollectionFiltersTypeDef

# CollectionFiltersTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import CollectionFiltersTypeDef


def get_value() -> CollectionFiltersTypeDef:
    return {
        "name": ...,
    }


# CollectionFiltersTypeDef definition

class CollectionFiltersTypeDef(TypedDict):
    name: NotRequired[str],
    status: NotRequired[CollectionStatusType],  # (1)

1. See CollectionStatusType

CollectionSummaryTypeDef

# CollectionSummaryTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import CollectionSummaryTypeDef


def get_value() -> CollectionSummaryTypeDef:
    return {
        "id": ...,
    }


# CollectionSummaryTypeDef definition

class CollectionSummaryTypeDef(TypedDict):
    id: NotRequired[str],
    name: NotRequired[str],
    status: NotRequired[CollectionStatusType],  # (1)
    arn: NotRequired[str],

1. See CollectionStatusType

CreateAccessPolicyRequestTypeDef

# CreateAccessPolicyRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import CreateAccessPolicyRequestTypeDef


def get_value() -> CreateAccessPolicyRequestTypeDef:
    return {
        "type": ...,
    }


# CreateAccessPolicyRequestTypeDef definition

class CreateAccessPolicyRequestTypeDef(TypedDict):
    type: AccessPolicyTypeType,  # (1)
    name: str,
    policy: str,
    description: NotRequired[str],
    clientToken: NotRequired[str],

1. See AccessPolicyTypeType

CreateCollectionDetailTypeDef

# CreateCollectionDetailTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import CreateCollectionDetailTypeDef


def get_value() -> CreateCollectionDetailTypeDef:
    return {
        "id": ...,
    }


# CreateCollectionDetailTypeDef definition

class CreateCollectionDetailTypeDef(TypedDict):
    id: NotRequired[str],
    name: NotRequired[str],
    status: NotRequired[CollectionStatusType],  # (1)
    type: NotRequired[CollectionTypeType],  # (2)
    description: NotRequired[str],
    arn: NotRequired[str],
    kmsKeyArn: NotRequired[str],
    standbyReplicas: NotRequired[StandbyReplicasType],  # (3)
    createdDate: NotRequired[int],
    lastModifiedDate: NotRequired[int],

1. See CollectionStatusType
2. See CollectionTypeType
3. See StandbyReplicasType

TagTypeDef

# TagTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import TagTypeDef


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


# TagTypeDef definition

class TagTypeDef(TypedDict):
    key: str,
    value: str,

CreateIamIdentityCenterConfigOptionsTypeDef

# CreateIamIdentityCenterConfigOptionsTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import CreateIamIdentityCenterConfigOptionsTypeDef


def get_value() -> CreateIamIdentityCenterConfigOptionsTypeDef:
    return {
        "instanceArn": ...,
    }


# CreateIamIdentityCenterConfigOptionsTypeDef definition

class CreateIamIdentityCenterConfigOptionsTypeDef(TypedDict):
    instanceArn: str,
    userAttribute: NotRequired[IamIdentityCenterUserAttributeType],  # (1)
    groupAttribute: NotRequired[IamIdentityCenterGroupAttributeType],  # (2)

1. See IamIdentityCenterUserAttributeType
2. See IamIdentityCenterGroupAttributeType

CreateIndexRequestTypeDef

# CreateIndexRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import CreateIndexRequestTypeDef


def get_value() -> CreateIndexRequestTypeDef:
    return {
        "id": ...,
    }


# CreateIndexRequestTypeDef definition

class CreateIndexRequestTypeDef(TypedDict):
    id: str,
    indexName: str,
    indexSchema: NotRequired[Mapping[str, Any]],

CreateLifecyclePolicyRequestTypeDef

# CreateLifecyclePolicyRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import CreateLifecyclePolicyRequestTypeDef


def get_value() -> CreateLifecyclePolicyRequestTypeDef:
    return {
        "type": ...,
    }


# CreateLifecyclePolicyRequestTypeDef definition

class CreateLifecyclePolicyRequestTypeDef(TypedDict):
    type: LifecyclePolicyTypeType,  # (1)
    name: str,
    policy: str,
    description: NotRequired[str],
    clientToken: NotRequired[str],

1. See LifecyclePolicyTypeType

IamFederationConfigOptionsTypeDef

# IamFederationConfigOptionsTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import IamFederationConfigOptionsTypeDef


def get_value() -> IamFederationConfigOptionsTypeDef:
    return {
        "groupAttribute": ...,
    }


# IamFederationConfigOptionsTypeDef definition

class IamFederationConfigOptionsTypeDef(TypedDict):
    groupAttribute: NotRequired[str],
    userAttribute: NotRequired[str],

SamlConfigOptionsTypeDef

# SamlConfigOptionsTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import SamlConfigOptionsTypeDef


def get_value() -> SamlConfigOptionsTypeDef:
    return {
        "metadata": ...,
    }


# SamlConfigOptionsTypeDef definition

class SamlConfigOptionsTypeDef(TypedDict):
    metadata: str,
    userAttribute: NotRequired[str],
    groupAttribute: NotRequired[str],
    openSearchServerlessEntityId: NotRequired[str],
    sessionTimeout: NotRequired[int],

CreateSecurityPolicyRequestTypeDef

# CreateSecurityPolicyRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import CreateSecurityPolicyRequestTypeDef


def get_value() -> CreateSecurityPolicyRequestTypeDef:
    return {
        "type": ...,
    }


# CreateSecurityPolicyRequestTypeDef definition

class CreateSecurityPolicyRequestTypeDef(TypedDict):
    type: SecurityPolicyTypeType,  # (1)
    name: str,
    policy: str,
    description: NotRequired[str],
    clientToken: NotRequired[str],

1. See SecurityPolicyTypeType

SecurityPolicyDetailTypeDef

# SecurityPolicyDetailTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import SecurityPolicyDetailTypeDef


def get_value() -> SecurityPolicyDetailTypeDef:
    return {
        "type": ...,
    }


# SecurityPolicyDetailTypeDef definition

class SecurityPolicyDetailTypeDef(TypedDict):
    type: NotRequired[SecurityPolicyTypeType],  # (1)
    name: NotRequired[str],
    policyVersion: NotRequired[str],
    description: NotRequired[str],
    policy: NotRequired[Dict[str, Any]],
    createdDate: NotRequired[int],
    lastModifiedDate: NotRequired[int],

1. See SecurityPolicyTypeType

CreateVpcEndpointDetailTypeDef

# CreateVpcEndpointDetailTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import CreateVpcEndpointDetailTypeDef


def get_value() -> CreateVpcEndpointDetailTypeDef:
    return {
        "id": ...,
    }


# CreateVpcEndpointDetailTypeDef definition

class CreateVpcEndpointDetailTypeDef(TypedDict):
    id: NotRequired[str],
    name: NotRequired[str],
    status: NotRequired[VpcEndpointStatusType],  # (1)

1. See VpcEndpointStatusType

CreateVpcEndpointRequestTypeDef

# CreateVpcEndpointRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import CreateVpcEndpointRequestTypeDef


def get_value() -> CreateVpcEndpointRequestTypeDef:
    return {
        "name": ...,
    }


# CreateVpcEndpointRequestTypeDef definition

class CreateVpcEndpointRequestTypeDef(TypedDict):
    name: str,
    vpcId: str,
    subnetIds: Sequence[str],
    securityGroupIds: NotRequired[Sequence[str]],
    clientToken: NotRequired[str],

DeleteAccessPolicyRequestTypeDef

# DeleteAccessPolicyRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import DeleteAccessPolicyRequestTypeDef


def get_value() -> DeleteAccessPolicyRequestTypeDef:
    return {
        "type": ...,
    }


# DeleteAccessPolicyRequestTypeDef definition

class DeleteAccessPolicyRequestTypeDef(TypedDict):
    type: AccessPolicyTypeType,  # (1)
    name: str,
    clientToken: NotRequired[str],

1. See AccessPolicyTypeType

DeleteCollectionDetailTypeDef

# DeleteCollectionDetailTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import DeleteCollectionDetailTypeDef


def get_value() -> DeleteCollectionDetailTypeDef:
    return {
        "id": ...,
    }


# DeleteCollectionDetailTypeDef definition

class DeleteCollectionDetailTypeDef(TypedDict):
    id: NotRequired[str],
    name: NotRequired[str],
    status: NotRequired[CollectionStatusType],  # (1)

1. See CollectionStatusType

DeleteCollectionRequestTypeDef

# DeleteCollectionRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import DeleteCollectionRequestTypeDef


def get_value() -> DeleteCollectionRequestTypeDef:
    return {
        "id": ...,
    }


# DeleteCollectionRequestTypeDef definition

class DeleteCollectionRequestTypeDef(TypedDict):
    id: str,
    clientToken: NotRequired[str],

DeleteIndexRequestTypeDef

# DeleteIndexRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import DeleteIndexRequestTypeDef


def get_value() -> DeleteIndexRequestTypeDef:
    return {
        "id": ...,
    }


# DeleteIndexRequestTypeDef definition

class DeleteIndexRequestTypeDef(TypedDict):
    id: str,
    indexName: str,

DeleteLifecyclePolicyRequestTypeDef

# DeleteLifecyclePolicyRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import DeleteLifecyclePolicyRequestTypeDef


def get_value() -> DeleteLifecyclePolicyRequestTypeDef:
    return {
        "type": ...,
    }


# DeleteLifecyclePolicyRequestTypeDef definition

class DeleteLifecyclePolicyRequestTypeDef(TypedDict):
    type: LifecyclePolicyTypeType,  # (1)
    name: str,
    clientToken: NotRequired[str],

1. See LifecyclePolicyTypeType

DeleteSecurityConfigRequestTypeDef

# DeleteSecurityConfigRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import DeleteSecurityConfigRequestTypeDef


def get_value() -> DeleteSecurityConfigRequestTypeDef:
    return {
        "id": ...,
    }


# DeleteSecurityConfigRequestTypeDef definition

class DeleteSecurityConfigRequestTypeDef(TypedDict):
    id: str,
    clientToken: NotRequired[str],

DeleteSecurityPolicyRequestTypeDef

# DeleteSecurityPolicyRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import DeleteSecurityPolicyRequestTypeDef


def get_value() -> DeleteSecurityPolicyRequestTypeDef:
    return {
        "type": ...,
    }


# DeleteSecurityPolicyRequestTypeDef definition

class DeleteSecurityPolicyRequestTypeDef(TypedDict):
    type: SecurityPolicyTypeType,  # (1)
    name: str,
    clientToken: NotRequired[str],

1. See SecurityPolicyTypeType

DeleteVpcEndpointDetailTypeDef

# DeleteVpcEndpointDetailTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import DeleteVpcEndpointDetailTypeDef


def get_value() -> DeleteVpcEndpointDetailTypeDef:
    return {
        "id": ...,
    }


# DeleteVpcEndpointDetailTypeDef definition

class DeleteVpcEndpointDetailTypeDef(TypedDict):
    id: NotRequired[str],
    name: NotRequired[str],
    status: NotRequired[VpcEndpointStatusType],  # (1)

1. See VpcEndpointStatusType

DeleteVpcEndpointRequestTypeDef

# DeleteVpcEndpointRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import DeleteVpcEndpointRequestTypeDef


def get_value() -> DeleteVpcEndpointRequestTypeDef:
    return {
        "id": ...,
    }


# DeleteVpcEndpointRequestTypeDef definition

class DeleteVpcEndpointRequestTypeDef(TypedDict):
    id: str,
    clientToken: NotRequired[str],

GetAccessPolicyRequestTypeDef

# GetAccessPolicyRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import GetAccessPolicyRequestTypeDef


def get_value() -> GetAccessPolicyRequestTypeDef:
    return {
        "type": ...,
    }


# GetAccessPolicyRequestTypeDef definition

class GetAccessPolicyRequestTypeDef(TypedDict):
    type: AccessPolicyTypeType,  # (1)
    name: str,

1. See AccessPolicyTypeType

GetIndexRequestTypeDef

# GetIndexRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import GetIndexRequestTypeDef


def get_value() -> GetIndexRequestTypeDef:
    return {
        "id": ...,
    }


# GetIndexRequestTypeDef definition

class GetIndexRequestTypeDef(TypedDict):
    id: str,
    indexName: str,

LifecyclePolicyStatsTypeDef

# LifecyclePolicyStatsTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import LifecyclePolicyStatsTypeDef


def get_value() -> LifecyclePolicyStatsTypeDef:
    return {
        "RetentionPolicyCount": ...,
    }


# LifecyclePolicyStatsTypeDef definition

class LifecyclePolicyStatsTypeDef(TypedDict):
    RetentionPolicyCount: NotRequired[int],

SecurityConfigStatsTypeDef

# SecurityConfigStatsTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import SecurityConfigStatsTypeDef


def get_value() -> SecurityConfigStatsTypeDef:
    return {
        "SamlConfigCount": ...,
    }


# SecurityConfigStatsTypeDef definition

class SecurityConfigStatsTypeDef(TypedDict):
    SamlConfigCount: NotRequired[int],

SecurityPolicyStatsTypeDef

# SecurityPolicyStatsTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import SecurityPolicyStatsTypeDef


def get_value() -> SecurityPolicyStatsTypeDef:
    return {
        "EncryptionPolicyCount": ...,
    }


# SecurityPolicyStatsTypeDef definition

class SecurityPolicyStatsTypeDef(TypedDict):
    EncryptionPolicyCount: NotRequired[int],
    NetworkPolicyCount: NotRequired[int],

GetSecurityConfigRequestTypeDef

# GetSecurityConfigRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import GetSecurityConfigRequestTypeDef


def get_value() -> GetSecurityConfigRequestTypeDef:
    return {
        "id": ...,
    }


# GetSecurityConfigRequestTypeDef definition

class GetSecurityConfigRequestTypeDef(TypedDict):
    id: str,

GetSecurityPolicyRequestTypeDef

# GetSecurityPolicyRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import GetSecurityPolicyRequestTypeDef


def get_value() -> GetSecurityPolicyRequestTypeDef:
    return {
        "type": ...,
    }


# GetSecurityPolicyRequestTypeDef definition

class GetSecurityPolicyRequestTypeDef(TypedDict):
    type: SecurityPolicyTypeType,  # (1)
    name: str,

1. See SecurityPolicyTypeType

IamIdentityCenterConfigOptionsTypeDef

# IamIdentityCenterConfigOptionsTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import IamIdentityCenterConfigOptionsTypeDef


def get_value() -> IamIdentityCenterConfigOptionsTypeDef:
    return {
        "instanceArn": ...,
    }


# IamIdentityCenterConfigOptionsTypeDef definition

class IamIdentityCenterConfigOptionsTypeDef(TypedDict):
    instanceArn: NotRequired[str],
    applicationArn: NotRequired[str],
    applicationName: NotRequired[str],
    applicationDescription: NotRequired[str],
    userAttribute: NotRequired[IamIdentityCenterUserAttributeType],  # (1)
    groupAttribute: NotRequired[IamIdentityCenterGroupAttributeType],  # (2)

1. See IamIdentityCenterUserAttributeType
2. See IamIdentityCenterGroupAttributeType

LifecyclePolicySummaryTypeDef

# LifecyclePolicySummaryTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import LifecyclePolicySummaryTypeDef


def get_value() -> LifecyclePolicySummaryTypeDef:
    return {
        "type": ...,
    }


# LifecyclePolicySummaryTypeDef definition

class LifecyclePolicySummaryTypeDef(TypedDict):
    type: NotRequired[LifecyclePolicyTypeType],  # (1)
    name: NotRequired[str],
    policyVersion: NotRequired[str],
    description: NotRequired[str],
    createdDate: NotRequired[int],
    lastModifiedDate: NotRequired[int],

1. See LifecyclePolicyTypeType

ListAccessPoliciesRequestTypeDef

# ListAccessPoliciesRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import ListAccessPoliciesRequestTypeDef


def get_value() -> ListAccessPoliciesRequestTypeDef:
    return {
        "type": ...,
    }


# ListAccessPoliciesRequestTypeDef definition

class ListAccessPoliciesRequestTypeDef(TypedDict):
    type: AccessPolicyTypeType,  # (1)
    resource: NotRequired[Sequence[str]],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

1. See AccessPolicyTypeType

ListLifecyclePoliciesRequestTypeDef

# ListLifecyclePoliciesRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import ListLifecyclePoliciesRequestTypeDef


def get_value() -> ListLifecyclePoliciesRequestTypeDef:
    return {
        "type": ...,
    }


# ListLifecyclePoliciesRequestTypeDef definition

class ListLifecyclePoliciesRequestTypeDef(TypedDict):
    type: LifecyclePolicyTypeType,  # (1)
    resources: NotRequired[Sequence[str]],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

1. See LifecyclePolicyTypeType

ListSecurityConfigsRequestTypeDef

# ListSecurityConfigsRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import ListSecurityConfigsRequestTypeDef


def get_value() -> ListSecurityConfigsRequestTypeDef:
    return {
        "type": ...,
    }


# ListSecurityConfigsRequestTypeDef definition

class ListSecurityConfigsRequestTypeDef(TypedDict):
    type: SecurityConfigTypeType,  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

1. See SecurityConfigTypeType

SecurityConfigSummaryTypeDef

# SecurityConfigSummaryTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import SecurityConfigSummaryTypeDef


def get_value() -> SecurityConfigSummaryTypeDef:
    return {
        "id": ...,
    }


# SecurityConfigSummaryTypeDef definition

class SecurityConfigSummaryTypeDef(TypedDict):
    id: NotRequired[str],
    type: NotRequired[SecurityConfigTypeType],  # (1)
    configVersion: NotRequired[str],
    description: NotRequired[str],
    createdDate: NotRequired[int],
    lastModifiedDate: NotRequired[int],

1. See SecurityConfigTypeType

ListSecurityPoliciesRequestTypeDef

# ListSecurityPoliciesRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import ListSecurityPoliciesRequestTypeDef


def get_value() -> ListSecurityPoliciesRequestTypeDef:
    return {
        "type": ...,
    }


# ListSecurityPoliciesRequestTypeDef definition

class ListSecurityPoliciesRequestTypeDef(TypedDict):
    type: SecurityPolicyTypeType,  # (1)
    resource: NotRequired[Sequence[str]],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

1. See SecurityPolicyTypeType

SecurityPolicySummaryTypeDef

# SecurityPolicySummaryTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import SecurityPolicySummaryTypeDef


def get_value() -> SecurityPolicySummaryTypeDef:
    return {
        "type": ...,
    }


# SecurityPolicySummaryTypeDef definition

class SecurityPolicySummaryTypeDef(TypedDict):
    type: NotRequired[SecurityPolicyTypeType],  # (1)
    name: NotRequired[str],
    policyVersion: NotRequired[str],
    description: NotRequired[str],
    createdDate: NotRequired[int],
    lastModifiedDate: NotRequired[int],

1. See SecurityPolicyTypeType

ListTagsForResourceRequestTypeDef

# ListTagsForResourceRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import ListTagsForResourceRequestTypeDef


def get_value() -> ListTagsForResourceRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# ListTagsForResourceRequestTypeDef definition

class ListTagsForResourceRequestTypeDef(TypedDict):
    resourceArn: str,

VpcEndpointFiltersTypeDef

# VpcEndpointFiltersTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import VpcEndpointFiltersTypeDef


def get_value() -> VpcEndpointFiltersTypeDef:
    return {
        "status": ...,
    }


# VpcEndpointFiltersTypeDef definition

class VpcEndpointFiltersTypeDef(TypedDict):
    status: NotRequired[VpcEndpointStatusType],  # (1)

1. See VpcEndpointStatusType

VpcEndpointSummaryTypeDef

# VpcEndpointSummaryTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import VpcEndpointSummaryTypeDef


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


# VpcEndpointSummaryTypeDef definition

class VpcEndpointSummaryTypeDef(TypedDict):
    id: NotRequired[str],
    name: NotRequired[str],
    status: NotRequired[VpcEndpointStatusType],  # (1)

1. See VpcEndpointStatusType

UntagResourceRequestTypeDef

# UntagResourceRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import UntagResourceRequestTypeDef


def get_value() -> UntagResourceRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# UntagResourceRequestTypeDef definition

class UntagResourceRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

UpdateAccessPolicyRequestTypeDef

# UpdateAccessPolicyRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import UpdateAccessPolicyRequestTypeDef


def get_value() -> UpdateAccessPolicyRequestTypeDef:
    return {
        "type": ...,
    }


# UpdateAccessPolicyRequestTypeDef definition

class UpdateAccessPolicyRequestTypeDef(TypedDict):
    type: AccessPolicyTypeType,  # (1)
    name: str,
    policyVersion: str,
    description: NotRequired[str],
    policy: NotRequired[str],
    clientToken: NotRequired[str],

1. See AccessPolicyTypeType

UpdateCollectionDetailTypeDef

# UpdateCollectionDetailTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import UpdateCollectionDetailTypeDef


def get_value() -> UpdateCollectionDetailTypeDef:
    return {
        "id": ...,
    }


# UpdateCollectionDetailTypeDef definition

class UpdateCollectionDetailTypeDef(TypedDict):
    id: NotRequired[str],
    name: NotRequired[str],
    status: NotRequired[CollectionStatusType],  # (1)
    type: NotRequired[CollectionTypeType],  # (2)
    description: NotRequired[str],
    arn: NotRequired[str],
    createdDate: NotRequired[int],
    lastModifiedDate: NotRequired[int],

1. See CollectionStatusType
2. See CollectionTypeType

UpdateCollectionRequestTypeDef

# UpdateCollectionRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import UpdateCollectionRequestTypeDef


def get_value() -> UpdateCollectionRequestTypeDef:
    return {
        "id": ...,
    }


# UpdateCollectionRequestTypeDef definition

class UpdateCollectionRequestTypeDef(TypedDict):
    id: str,
    description: NotRequired[str],
    clientToken: NotRequired[str],

UpdateIamIdentityCenterConfigOptionsTypeDef

# UpdateIamIdentityCenterConfigOptionsTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import UpdateIamIdentityCenterConfigOptionsTypeDef


def get_value() -> UpdateIamIdentityCenterConfigOptionsTypeDef:
    return {
        "userAttribute": ...,
    }


# UpdateIamIdentityCenterConfigOptionsTypeDef definition

class UpdateIamIdentityCenterConfigOptionsTypeDef(TypedDict):
    userAttribute: NotRequired[IamIdentityCenterUserAttributeType],  # (1)
    groupAttribute: NotRequired[IamIdentityCenterGroupAttributeType],  # (2)

1. See IamIdentityCenterUserAttributeType
2. See IamIdentityCenterGroupAttributeType

UpdateIndexRequestTypeDef

# UpdateIndexRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import UpdateIndexRequestTypeDef


def get_value() -> UpdateIndexRequestTypeDef:
    return {
        "id": ...,
    }


# UpdateIndexRequestTypeDef definition

class UpdateIndexRequestTypeDef(TypedDict):
    id: str,
    indexName: str,
    indexSchema: NotRequired[Mapping[str, Any]],

UpdateLifecyclePolicyRequestTypeDef

# UpdateLifecyclePolicyRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import UpdateLifecyclePolicyRequestTypeDef


def get_value() -> UpdateLifecyclePolicyRequestTypeDef:
    return {
        "type": ...,
    }


# UpdateLifecyclePolicyRequestTypeDef definition

class UpdateLifecyclePolicyRequestTypeDef(TypedDict):
    type: LifecyclePolicyTypeType,  # (1)
    name: str,
    policyVersion: str,
    description: NotRequired[str],
    policy: NotRequired[str],
    clientToken: NotRequired[str],

1. See LifecyclePolicyTypeType

UpdateSecurityPolicyRequestTypeDef

# UpdateSecurityPolicyRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import UpdateSecurityPolicyRequestTypeDef


def get_value() -> UpdateSecurityPolicyRequestTypeDef:
    return {
        "type": ...,
    }


# UpdateSecurityPolicyRequestTypeDef definition

class UpdateSecurityPolicyRequestTypeDef(TypedDict):
    type: SecurityPolicyTypeType,  # (1)
    name: str,
    policyVersion: str,
    description: NotRequired[str],
    policy: NotRequired[str],
    clientToken: NotRequired[str],

1. See SecurityPolicyTypeType

UpdateVpcEndpointDetailTypeDef

# UpdateVpcEndpointDetailTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import UpdateVpcEndpointDetailTypeDef


def get_value() -> UpdateVpcEndpointDetailTypeDef:
    return {
        "id": ...,
    }


# UpdateVpcEndpointDetailTypeDef definition

class UpdateVpcEndpointDetailTypeDef(TypedDict):
    id: NotRequired[str],
    name: NotRequired[str],
    status: NotRequired[VpcEndpointStatusType],  # (1)
    subnetIds: NotRequired[List[str]],
    securityGroupIds: NotRequired[List[str]],
    lastModifiedDate: NotRequired[int],

1. See VpcEndpointStatusType

UpdateVpcEndpointRequestTypeDef

# UpdateVpcEndpointRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import UpdateVpcEndpointRequestTypeDef


def get_value() -> UpdateVpcEndpointRequestTypeDef:
    return {
        "id": ...,
    }


# UpdateVpcEndpointRequestTypeDef definition

class UpdateVpcEndpointRequestTypeDef(TypedDict):
    id: str,
    addSubnetIds: NotRequired[Sequence[str]],
    removeSubnetIds: NotRequired[Sequence[str]],
    addSecurityGroupIds: NotRequired[Sequence[str]],
    removeSecurityGroupIds: NotRequired[Sequence[str]],
    clientToken: NotRequired[str],

AccountSettingsDetailTypeDef

# AccountSettingsDetailTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import AccountSettingsDetailTypeDef


def get_value() -> AccountSettingsDetailTypeDef:
    return {
        "capacityLimits": ...,
    }


# AccountSettingsDetailTypeDef definition

class AccountSettingsDetailTypeDef(TypedDict):
    capacityLimits: NotRequired[CapacityLimitsTypeDef],  # (1)

1. See CapacityLimitsTypeDef

UpdateAccountSettingsRequestTypeDef

# UpdateAccountSettingsRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import UpdateAccountSettingsRequestTypeDef


def get_value() -> UpdateAccountSettingsRequestTypeDef:
    return {
        "capacityLimits": ...,
    }


# UpdateAccountSettingsRequestTypeDef definition

class UpdateAccountSettingsRequestTypeDef(TypedDict):
    capacityLimits: NotRequired[CapacityLimitsTypeDef],  # (1)

1. See CapacityLimitsTypeDef

CreateAccessPolicyResponseTypeDef

# CreateAccessPolicyResponseTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import CreateAccessPolicyResponseTypeDef


def get_value() -> CreateAccessPolicyResponseTypeDef:
    return {
        "accessPolicyDetail": ...,
    }


# CreateAccessPolicyResponseTypeDef definition

class CreateAccessPolicyResponseTypeDef(TypedDict):
    accessPolicyDetail: AccessPolicyDetailTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See AccessPolicyDetailTypeDef
2. See ResponseMetadataTypeDef

GetAccessPolicyResponseTypeDef

# GetAccessPolicyResponseTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import GetAccessPolicyResponseTypeDef


def get_value() -> GetAccessPolicyResponseTypeDef:
    return {
        "accessPolicyDetail": ...,
    }


# GetAccessPolicyResponseTypeDef definition

class GetAccessPolicyResponseTypeDef(TypedDict):
    accessPolicyDetail: AccessPolicyDetailTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See AccessPolicyDetailTypeDef
2. See ResponseMetadataTypeDef

GetIndexResponseTypeDef

# GetIndexResponseTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import GetIndexResponseTypeDef


def get_value() -> GetIndexResponseTypeDef:
    return {
        "indexSchema": ...,
    }


# GetIndexResponseTypeDef definition

class GetIndexResponseTypeDef(TypedDict):
    indexSchema: Dict[str, Any],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

ListAccessPoliciesResponseTypeDef

# ListAccessPoliciesResponseTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import ListAccessPoliciesResponseTypeDef


def get_value() -> ListAccessPoliciesResponseTypeDef:
    return {
        "accessPolicySummaries": ...,
    }


# ListAccessPoliciesResponseTypeDef definition

class ListAccessPoliciesResponseTypeDef(TypedDict):
    accessPolicySummaries: List[AccessPolicySummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],

1. See List[AccessPolicySummaryTypeDef]
2. See ResponseMetadataTypeDef

UpdateAccessPolicyResponseTypeDef

# UpdateAccessPolicyResponseTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import UpdateAccessPolicyResponseTypeDef


def get_value() -> UpdateAccessPolicyResponseTypeDef:
    return {
        "accessPolicyDetail": ...,
    }


# UpdateAccessPolicyResponseTypeDef definition

class UpdateAccessPolicyResponseTypeDef(TypedDict):
    accessPolicyDetail: AccessPolicyDetailTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See AccessPolicyDetailTypeDef
2. See ResponseMetadataTypeDef

BatchGetEffectiveLifecyclePolicyRequestTypeDef

# BatchGetEffectiveLifecyclePolicyRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import BatchGetEffectiveLifecyclePolicyRequestTypeDef


def get_value() -> BatchGetEffectiveLifecyclePolicyRequestTypeDef:
    return {
        "resourceIdentifiers": ...,
    }


# BatchGetEffectiveLifecyclePolicyRequestTypeDef definition

class BatchGetEffectiveLifecyclePolicyRequestTypeDef(TypedDict):
    resourceIdentifiers: Sequence[LifecyclePolicyResourceIdentifierTypeDef],  # (1)

1. See Sequence[LifecyclePolicyResourceIdentifierTypeDef]

BatchGetEffectiveLifecyclePolicyResponseTypeDef

# BatchGetEffectiveLifecyclePolicyResponseTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import BatchGetEffectiveLifecyclePolicyResponseTypeDef


def get_value() -> BatchGetEffectiveLifecyclePolicyResponseTypeDef:
    return {
        "effectiveLifecyclePolicyDetails": ...,
    }


# BatchGetEffectiveLifecyclePolicyResponseTypeDef definition

class BatchGetEffectiveLifecyclePolicyResponseTypeDef(TypedDict):
    effectiveLifecyclePolicyDetails: List[EffectiveLifecyclePolicyDetailTypeDef],  # (1)
    effectiveLifecyclePolicyErrorDetails: List[EffectiveLifecyclePolicyErrorDetailTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

1. See List[EffectiveLifecyclePolicyDetailTypeDef]
2. See List[EffectiveLifecyclePolicyErrorDetailTypeDef]
3. See ResponseMetadataTypeDef

BatchGetLifecyclePolicyRequestTypeDef

# BatchGetLifecyclePolicyRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import BatchGetLifecyclePolicyRequestTypeDef


def get_value() -> BatchGetLifecyclePolicyRequestTypeDef:
    return {
        "identifiers": ...,
    }


# BatchGetLifecyclePolicyRequestTypeDef definition

class BatchGetLifecyclePolicyRequestTypeDef(TypedDict):
    identifiers: Sequence[LifecyclePolicyIdentifierTypeDef],  # (1)

1. See Sequence[LifecyclePolicyIdentifierTypeDef]

CreateLifecyclePolicyResponseTypeDef

# CreateLifecyclePolicyResponseTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import CreateLifecyclePolicyResponseTypeDef


def get_value() -> CreateLifecyclePolicyResponseTypeDef:
    return {
        "lifecyclePolicyDetail": ...,
    }


# CreateLifecyclePolicyResponseTypeDef definition

class CreateLifecyclePolicyResponseTypeDef(TypedDict):
    lifecyclePolicyDetail: LifecyclePolicyDetailTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See LifecyclePolicyDetailTypeDef
2. See ResponseMetadataTypeDef

UpdateLifecyclePolicyResponseTypeDef

# UpdateLifecyclePolicyResponseTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import UpdateLifecyclePolicyResponseTypeDef


def get_value() -> UpdateLifecyclePolicyResponseTypeDef:
    return {
        "lifecyclePolicyDetail": ...,
    }


# UpdateLifecyclePolicyResponseTypeDef definition

class UpdateLifecyclePolicyResponseTypeDef(TypedDict):
    lifecyclePolicyDetail: LifecyclePolicyDetailTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See LifecyclePolicyDetailTypeDef
2. See ResponseMetadataTypeDef

BatchGetLifecyclePolicyResponseTypeDef

# BatchGetLifecyclePolicyResponseTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import BatchGetLifecyclePolicyResponseTypeDef


def get_value() -> BatchGetLifecyclePolicyResponseTypeDef:
    return {
        "lifecyclePolicyDetails": ...,
    }


# BatchGetLifecyclePolicyResponseTypeDef definition

class BatchGetLifecyclePolicyResponseTypeDef(TypedDict):
    lifecyclePolicyDetails: List[LifecyclePolicyDetailTypeDef],  # (1)
    lifecyclePolicyErrorDetails: List[LifecyclePolicyErrorDetailTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

1. See List[LifecyclePolicyDetailTypeDef]
2. See List[LifecyclePolicyErrorDetailTypeDef]
3. See ResponseMetadataTypeDef

BatchGetVpcEndpointResponseTypeDef

# BatchGetVpcEndpointResponseTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import BatchGetVpcEndpointResponseTypeDef


def get_value() -> BatchGetVpcEndpointResponseTypeDef:
    return {
        "vpcEndpointDetails": ...,
    }


# BatchGetVpcEndpointResponseTypeDef definition

class BatchGetVpcEndpointResponseTypeDef(TypedDict):
    vpcEndpointDetails: List[VpcEndpointDetailTypeDef],  # (1)
    vpcEndpointErrorDetails: List[VpcEndpointErrorDetailTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

1. See List[VpcEndpointDetailTypeDef]
2. See List[VpcEndpointErrorDetailTypeDef]
3. See ResponseMetadataTypeDef

CollectionDetailTypeDef

# CollectionDetailTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import CollectionDetailTypeDef


def get_value() -> CollectionDetailTypeDef:
    return {
        "id": ...,
    }


# CollectionDetailTypeDef definition

class CollectionDetailTypeDef(TypedDict):
    id: NotRequired[str],
    name: NotRequired[str],
    status: NotRequired[CollectionStatusType],  # (1)
    type: NotRequired[CollectionTypeType],  # (2)
    description: NotRequired[str],
    arn: NotRequired[str],
    kmsKeyArn: NotRequired[str],
    standbyReplicas: NotRequired[StandbyReplicasType],  # (3)
    createdDate: NotRequired[int],
    lastModifiedDate: NotRequired[int],
    collectionEndpoint: NotRequired[str],
    dashboardEndpoint: NotRequired[str],
    fipsEndpoints: NotRequired[FipsEndpointsTypeDef],  # (4)
    failureCode: NotRequired[str],
    failureMessage: NotRequired[str],

1. See CollectionStatusType
2. See CollectionTypeType
3. See StandbyReplicasType
4. See FipsEndpointsTypeDef

ListCollectionsRequestTypeDef

# ListCollectionsRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import ListCollectionsRequestTypeDef


def get_value() -> ListCollectionsRequestTypeDef:
    return {
        "collectionFilters": ...,
    }


# ListCollectionsRequestTypeDef definition

class ListCollectionsRequestTypeDef(TypedDict):
    collectionFilters: NotRequired[CollectionFiltersTypeDef],  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

1. See CollectionFiltersTypeDef

ListCollectionsResponseTypeDef

# ListCollectionsResponseTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import ListCollectionsResponseTypeDef


def get_value() -> ListCollectionsResponseTypeDef:
    return {
        "collectionSummaries": ...,
    }


# ListCollectionsResponseTypeDef definition

class ListCollectionsResponseTypeDef(TypedDict):
    collectionSummaries: List[CollectionSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],

1. See List[CollectionSummaryTypeDef]
2. See ResponseMetadataTypeDef

CreateCollectionResponseTypeDef

# CreateCollectionResponseTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import CreateCollectionResponseTypeDef


def get_value() -> CreateCollectionResponseTypeDef:
    return {
        "createCollectionDetail": ...,
    }


# CreateCollectionResponseTypeDef definition

class CreateCollectionResponseTypeDef(TypedDict):
    createCollectionDetail: CreateCollectionDetailTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See CreateCollectionDetailTypeDef
2. See ResponseMetadataTypeDef

CreateCollectionRequestTypeDef

# CreateCollectionRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import CreateCollectionRequestTypeDef


def get_value() -> CreateCollectionRequestTypeDef:
    return {
        "name": ...,
    }


# CreateCollectionRequestTypeDef definition

class CreateCollectionRequestTypeDef(TypedDict):
    name: str,
    type: NotRequired[CollectionTypeType],  # (1)
    description: NotRequired[str],
    tags: NotRequired[Sequence[TagTypeDef]],  # (2)
    standbyReplicas: NotRequired[StandbyReplicasType],  # (3)
    clientToken: NotRequired[str],

1. See CollectionTypeType
2. See Sequence[TagTypeDef]
3. See StandbyReplicasType

ListTagsForResourceResponseTypeDef

# ListTagsForResourceResponseTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import ListTagsForResourceResponseTypeDef


def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "tags": ...,
    }


# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See List[TagTypeDef]
2. See ResponseMetadataTypeDef

TagResourceRequestTypeDef

# TagResourceRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import TagResourceRequestTypeDef


def get_value() -> TagResourceRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# TagResourceRequestTypeDef definition

class TagResourceRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Sequence[TagTypeDef],  # (1)

1. See Sequence[TagTypeDef]

CreateSecurityConfigRequestTypeDef

# CreateSecurityConfigRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import CreateSecurityConfigRequestTypeDef


def get_value() -> CreateSecurityConfigRequestTypeDef:
    return {
        "type": ...,
    }


# CreateSecurityConfigRequestTypeDef definition

class CreateSecurityConfigRequestTypeDef(TypedDict):
    type: SecurityConfigTypeType,  # (1)
    name: str,
    description: NotRequired[str],
    samlOptions: NotRequired[SamlConfigOptionsTypeDef],  # (2)
    iamIdentityCenterOptions: NotRequired[CreateIamIdentityCenterConfigOptionsTypeDef],  # (3)
    iamFederationOptions: NotRequired[IamFederationConfigOptionsTypeDef],  # (4)
    clientToken: NotRequired[str],

1. See SecurityConfigTypeType
2. See SamlConfigOptionsTypeDef
3. See CreateIamIdentityCenterConfigOptionsTypeDef
4. See IamFederationConfigOptionsTypeDef

CreateSecurityPolicyResponseTypeDef

# CreateSecurityPolicyResponseTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import CreateSecurityPolicyResponseTypeDef


def get_value() -> CreateSecurityPolicyResponseTypeDef:
    return {
        "securityPolicyDetail": ...,
    }


# CreateSecurityPolicyResponseTypeDef definition

class CreateSecurityPolicyResponseTypeDef(TypedDict):
    securityPolicyDetail: SecurityPolicyDetailTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See SecurityPolicyDetailTypeDef
2. See ResponseMetadataTypeDef

GetSecurityPolicyResponseTypeDef

# GetSecurityPolicyResponseTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import GetSecurityPolicyResponseTypeDef


def get_value() -> GetSecurityPolicyResponseTypeDef:
    return {
        "securityPolicyDetail": ...,
    }


# GetSecurityPolicyResponseTypeDef definition

class GetSecurityPolicyResponseTypeDef(TypedDict):
    securityPolicyDetail: SecurityPolicyDetailTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See SecurityPolicyDetailTypeDef
2. See ResponseMetadataTypeDef

UpdateSecurityPolicyResponseTypeDef

# UpdateSecurityPolicyResponseTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import UpdateSecurityPolicyResponseTypeDef


def get_value() -> UpdateSecurityPolicyResponseTypeDef:
    return {
        "securityPolicyDetail": ...,
    }


# UpdateSecurityPolicyResponseTypeDef definition

class UpdateSecurityPolicyResponseTypeDef(TypedDict):
    securityPolicyDetail: SecurityPolicyDetailTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See SecurityPolicyDetailTypeDef
2. See ResponseMetadataTypeDef

CreateVpcEndpointResponseTypeDef

# CreateVpcEndpointResponseTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import CreateVpcEndpointResponseTypeDef


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


# CreateVpcEndpointResponseTypeDef definition

class CreateVpcEndpointResponseTypeDef(TypedDict):
    createVpcEndpointDetail: CreateVpcEndpointDetailTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See CreateVpcEndpointDetailTypeDef
2. See ResponseMetadataTypeDef

DeleteCollectionResponseTypeDef

# DeleteCollectionResponseTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import DeleteCollectionResponseTypeDef


def get_value() -> DeleteCollectionResponseTypeDef:
    return {
        "deleteCollectionDetail": ...,
    }


# DeleteCollectionResponseTypeDef definition

class DeleteCollectionResponseTypeDef(TypedDict):
    deleteCollectionDetail: DeleteCollectionDetailTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See DeleteCollectionDetailTypeDef
2. See ResponseMetadataTypeDef

DeleteVpcEndpointResponseTypeDef

# DeleteVpcEndpointResponseTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import DeleteVpcEndpointResponseTypeDef


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


# DeleteVpcEndpointResponseTypeDef definition

class DeleteVpcEndpointResponseTypeDef(TypedDict):
    deleteVpcEndpointDetail: DeleteVpcEndpointDetailTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See DeleteVpcEndpointDetailTypeDef
2. See ResponseMetadataTypeDef

GetPoliciesStatsResponseTypeDef

# GetPoliciesStatsResponseTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import GetPoliciesStatsResponseTypeDef


def get_value() -> GetPoliciesStatsResponseTypeDef:
    return {
        "AccessPolicyStats": ...,
    }


# GetPoliciesStatsResponseTypeDef definition

class GetPoliciesStatsResponseTypeDef(TypedDict):
    AccessPolicyStats: AccessPolicyStatsTypeDef,  # (1)
    SecurityPolicyStats: SecurityPolicyStatsTypeDef,  # (2)
    SecurityConfigStats: SecurityConfigStatsTypeDef,  # (3)
    LifecyclePolicyStats: LifecyclePolicyStatsTypeDef,  # (4)
    TotalPolicyCount: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)

1. See AccessPolicyStatsTypeDef
2. See SecurityPolicyStatsTypeDef
3. See SecurityConfigStatsTypeDef
4. See LifecyclePolicyStatsTypeDef
5. See ResponseMetadataTypeDef

SecurityConfigDetailTypeDef

# SecurityConfigDetailTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import SecurityConfigDetailTypeDef


def get_value() -> SecurityConfigDetailTypeDef:
    return {
        "id": ...,
    }


# SecurityConfigDetailTypeDef definition

class SecurityConfigDetailTypeDef(TypedDict):
    id: NotRequired[str],
    type: NotRequired[SecurityConfigTypeType],  # (1)
    configVersion: NotRequired[str],
    description: NotRequired[str],
    samlOptions: NotRequired[SamlConfigOptionsTypeDef],  # (2)
    iamIdentityCenterOptions: NotRequired[IamIdentityCenterConfigOptionsTypeDef],  # (3)
    iamFederationOptions: NotRequired[IamFederationConfigOptionsTypeDef],  # (4)
    createdDate: NotRequired[int],
    lastModifiedDate: NotRequired[int],

1. See SecurityConfigTypeType
2. See SamlConfigOptionsTypeDef
3. See IamIdentityCenterConfigOptionsTypeDef
4. See IamFederationConfigOptionsTypeDef

ListLifecyclePoliciesResponseTypeDef

# ListLifecyclePoliciesResponseTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import ListLifecyclePoliciesResponseTypeDef


def get_value() -> ListLifecyclePoliciesResponseTypeDef:
    return {
        "lifecyclePolicySummaries": ...,
    }


# ListLifecyclePoliciesResponseTypeDef definition

class ListLifecyclePoliciesResponseTypeDef(TypedDict):
    lifecyclePolicySummaries: List[LifecyclePolicySummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],

1. See List[LifecyclePolicySummaryTypeDef]
2. See ResponseMetadataTypeDef

ListSecurityConfigsResponseTypeDef

# ListSecurityConfigsResponseTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import ListSecurityConfigsResponseTypeDef


def get_value() -> ListSecurityConfigsResponseTypeDef:
    return {
        "securityConfigSummaries": ...,
    }


# ListSecurityConfigsResponseTypeDef definition

class ListSecurityConfigsResponseTypeDef(TypedDict):
    securityConfigSummaries: List[SecurityConfigSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],

1. See List[SecurityConfigSummaryTypeDef]
2. See ResponseMetadataTypeDef

ListSecurityPoliciesResponseTypeDef

# ListSecurityPoliciesResponseTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import ListSecurityPoliciesResponseTypeDef


def get_value() -> ListSecurityPoliciesResponseTypeDef:
    return {
        "securityPolicySummaries": ...,
    }


# ListSecurityPoliciesResponseTypeDef definition

class ListSecurityPoliciesResponseTypeDef(TypedDict):
    securityPolicySummaries: List[SecurityPolicySummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],

1. See List[SecurityPolicySummaryTypeDef]
2. See ResponseMetadataTypeDef

ListVpcEndpointsRequestTypeDef

# ListVpcEndpointsRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import ListVpcEndpointsRequestTypeDef


def get_value() -> ListVpcEndpointsRequestTypeDef:
    return {
        "vpcEndpointFilters": ...,
    }


# ListVpcEndpointsRequestTypeDef definition

class ListVpcEndpointsRequestTypeDef(TypedDict):
    vpcEndpointFilters: NotRequired[VpcEndpointFiltersTypeDef],  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

1. See VpcEndpointFiltersTypeDef

ListVpcEndpointsResponseTypeDef

# ListVpcEndpointsResponseTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import ListVpcEndpointsResponseTypeDef


def get_value() -> ListVpcEndpointsResponseTypeDef:
    return {
        "vpcEndpointSummaries": ...,
    }


# ListVpcEndpointsResponseTypeDef definition

class ListVpcEndpointsResponseTypeDef(TypedDict):
    vpcEndpointSummaries: List[VpcEndpointSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],

1. See List[VpcEndpointSummaryTypeDef]
2. See ResponseMetadataTypeDef

UpdateCollectionResponseTypeDef

# UpdateCollectionResponseTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import UpdateCollectionResponseTypeDef


def get_value() -> UpdateCollectionResponseTypeDef:
    return {
        "updateCollectionDetail": ...,
    }


# UpdateCollectionResponseTypeDef definition

class UpdateCollectionResponseTypeDef(TypedDict):
    updateCollectionDetail: UpdateCollectionDetailTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See UpdateCollectionDetailTypeDef
2. See ResponseMetadataTypeDef

UpdateSecurityConfigRequestTypeDef

# UpdateSecurityConfigRequestTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import UpdateSecurityConfigRequestTypeDef


def get_value() -> UpdateSecurityConfigRequestTypeDef:
    return {
        "id": ...,
    }


# UpdateSecurityConfigRequestTypeDef definition

class UpdateSecurityConfigRequestTypeDef(TypedDict):
    id: str,
    configVersion: str,
    description: NotRequired[str],
    samlOptions: NotRequired[SamlConfigOptionsTypeDef],  # (1)
    iamIdentityCenterOptionsUpdates: NotRequired[UpdateIamIdentityCenterConfigOptionsTypeDef],  # (2)
    iamFederationOptions: NotRequired[IamFederationConfigOptionsTypeDef],  # (3)
    clientToken: NotRequired[str],

1. See SamlConfigOptionsTypeDef
2. See UpdateIamIdentityCenterConfigOptionsTypeDef
3. See IamFederationConfigOptionsTypeDef

UpdateVpcEndpointResponseTypeDef

# UpdateVpcEndpointResponseTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import UpdateVpcEndpointResponseTypeDef


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


# UpdateVpcEndpointResponseTypeDef definition

class UpdateVpcEndpointResponseTypeDef(TypedDict):
    UpdateVpcEndpointDetail: UpdateVpcEndpointDetailTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See UpdateVpcEndpointDetailTypeDef
2. See ResponseMetadataTypeDef

GetAccountSettingsResponseTypeDef

# GetAccountSettingsResponseTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import GetAccountSettingsResponseTypeDef


def get_value() -> GetAccountSettingsResponseTypeDef:
    return {
        "accountSettingsDetail": ...,
    }


# GetAccountSettingsResponseTypeDef definition

class GetAccountSettingsResponseTypeDef(TypedDict):
    accountSettingsDetail: AccountSettingsDetailTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See AccountSettingsDetailTypeDef
2. See ResponseMetadataTypeDef

UpdateAccountSettingsResponseTypeDef

# UpdateAccountSettingsResponseTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import UpdateAccountSettingsResponseTypeDef


def get_value() -> UpdateAccountSettingsResponseTypeDef:
    return {
        "accountSettingsDetail": ...,
    }


# UpdateAccountSettingsResponseTypeDef definition

class UpdateAccountSettingsResponseTypeDef(TypedDict):
    accountSettingsDetail: AccountSettingsDetailTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See AccountSettingsDetailTypeDef
2. See ResponseMetadataTypeDef

BatchGetCollectionResponseTypeDef

# BatchGetCollectionResponseTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import BatchGetCollectionResponseTypeDef


def get_value() -> BatchGetCollectionResponseTypeDef:
    return {
        "collectionDetails": ...,
    }


# BatchGetCollectionResponseTypeDef definition

class BatchGetCollectionResponseTypeDef(TypedDict):
    collectionDetails: List[CollectionDetailTypeDef],  # (1)
    collectionErrorDetails: List[CollectionErrorDetailTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

1. See List[CollectionDetailTypeDef]
2. See List[CollectionErrorDetailTypeDef]
3. See ResponseMetadataTypeDef

CreateSecurityConfigResponseTypeDef

# CreateSecurityConfigResponseTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import CreateSecurityConfigResponseTypeDef


def get_value() -> CreateSecurityConfigResponseTypeDef:
    return {
        "securityConfigDetail": ...,
    }


# CreateSecurityConfigResponseTypeDef definition

class CreateSecurityConfigResponseTypeDef(TypedDict):
    securityConfigDetail: SecurityConfigDetailTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See SecurityConfigDetailTypeDef
2. See ResponseMetadataTypeDef

GetSecurityConfigResponseTypeDef

# GetSecurityConfigResponseTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import GetSecurityConfigResponseTypeDef


def get_value() -> GetSecurityConfigResponseTypeDef:
    return {
        "securityConfigDetail": ...,
    }


# GetSecurityConfigResponseTypeDef definition

class GetSecurityConfigResponseTypeDef(TypedDict):
    securityConfigDetail: SecurityConfigDetailTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See SecurityConfigDetailTypeDef
2. See ResponseMetadataTypeDef

UpdateSecurityConfigResponseTypeDef

# UpdateSecurityConfigResponseTypeDef TypedDict usage example

from types_boto3_opensearchserverless.type_defs import UpdateSecurityConfigResponseTypeDef


def get_value() -> UpdateSecurityConfigResponseTypeDef:
    return {
        "securityConfigDetail": ...,
    }


# UpdateSecurityConfigResponseTypeDef definition

class UpdateSecurityConfigResponseTypeDef(TypedDict):
    securityConfigDetail: SecurityConfigDetailTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See SecurityConfigDetailTypeDef
2. See ResponseMetadataTypeDef