Skip to content

Type definitions#

Index > OpenSearchServiceServerless > Type definitions

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

AccessPolicyDetailTypeDef#

# AccessPolicyDetailTypeDef definition

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

AccessPolicyStatsTypeDef#

# AccessPolicyStatsTypeDef definition

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

AccessPolicySummaryTypeDef#

# AccessPolicySummaryTypeDef definition

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

CapacityLimitsTypeDef#

# CapacityLimitsTypeDef definition

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

BatchGetCollectionRequestRequestTypeDef#

# BatchGetCollectionRequestRequestTypeDef definition

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

CollectionDetailTypeDef#

# CollectionDetailTypeDef definition

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

CollectionErrorDetailTypeDef#

# CollectionErrorDetailTypeDef definition

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

LifecyclePolicyResourceIdentifierTypeDef#

# LifecyclePolicyResourceIdentifierTypeDef definition

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

EffectiveLifecyclePolicyDetailTypeDef#

# EffectiveLifecyclePolicyDetailTypeDef definition

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