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],
    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 ResourceTypeType
  2. See LifecyclePolicyTypeType

EffectiveLifecyclePolicyErrorDetailTypeDef#

# EffectiveLifecyclePolicyErrorDetailTypeDef definition

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

LifecyclePolicyIdentifierTypeDef#

# LifecyclePolicyIdentifierTypeDef definition

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

LifecyclePolicyDetailTypeDef#

# LifecyclePolicyDetailTypeDef definition

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

LifecyclePolicyErrorDetailTypeDef#

# LifecyclePolicyErrorDetailTypeDef definition

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

BatchGetVpcEndpointRequestRequestTypeDef#

# BatchGetVpcEndpointRequestRequestTypeDef definition

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

VpcEndpointDetailTypeDef#

# VpcEndpointDetailTypeDef definition

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

VpcEndpointErrorDetailTypeDef#

# VpcEndpointErrorDetailTypeDef definition

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

CollectionFiltersTypeDef#

# CollectionFiltersTypeDef definition

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

CollectionSummaryTypeDef#

# CollectionSummaryTypeDef definition

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

CreateAccessPolicyRequestRequestTypeDef#

# CreateAccessPolicyRequestRequestTypeDef definition

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

CreateCollectionDetailTypeDef#

# CreateCollectionDetailTypeDef definition

class CreateCollectionDetailTypeDef(TypedDict):
    arn: NotRequired[str],
    createdDate: NotRequired[int],
    description: 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

TagTypeDef#

# TagTypeDef definition

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

CreateLifecyclePolicyRequestRequestTypeDef#

# CreateLifecyclePolicyRequestRequestTypeDef definition

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

SamlConfigOptionsTypeDef#

# SamlConfigOptionsTypeDef definition

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

CreateSecurityPolicyRequestRequestTypeDef#

# CreateSecurityPolicyRequestRequestTypeDef definition

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

SecurityPolicyDetailTypeDef#

# SecurityPolicyDetailTypeDef definition

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

CreateVpcEndpointDetailTypeDef#

# CreateVpcEndpointDetailTypeDef definition

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

CreateVpcEndpointRequestRequestTypeDef#

# CreateVpcEndpointRequestRequestTypeDef definition

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

DeleteAccessPolicyRequestRequestTypeDef#

# DeleteAccessPolicyRequestRequestTypeDef definition

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

DeleteCollectionDetailTypeDef#

# DeleteCollectionDetailTypeDef definition

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

DeleteCollectionRequestRequestTypeDef#

# DeleteCollectionRequestRequestTypeDef definition

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

DeleteLifecyclePolicyRequestRequestTypeDef#

# DeleteLifecyclePolicyRequestRequestTypeDef definition

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

DeleteSecurityConfigRequestRequestTypeDef#

# DeleteSecurityConfigRequestRequestTypeDef definition

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

DeleteSecurityPolicyRequestRequestTypeDef#

# DeleteSecurityPolicyRequestRequestTypeDef definition

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

DeleteVpcEndpointDetailTypeDef#

# DeleteVpcEndpointDetailTypeDef definition

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

DeleteVpcEndpointRequestRequestTypeDef#

# DeleteVpcEndpointRequestRequestTypeDef definition

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

GetAccessPolicyRequestRequestTypeDef#

# GetAccessPolicyRequestRequestTypeDef definition

class GetAccessPolicyRequestRequestTypeDef(TypedDict):
    name: str,
    type: AccessPolicyTypeType,  # (1)
  1. See AccessPolicyTypeType

LifecyclePolicyStatsTypeDef#

# LifecyclePolicyStatsTypeDef definition

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

SecurityConfigStatsTypeDef#

# SecurityConfigStatsTypeDef definition

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

SecurityPolicyStatsTypeDef#

# SecurityPolicyStatsTypeDef definition

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

GetSecurityConfigRequestRequestTypeDef#

# GetSecurityConfigRequestRequestTypeDef definition

class GetSecurityConfigRequestRequestTypeDef(TypedDict):
    id: str,

GetSecurityPolicyRequestRequestTypeDef#

# GetSecurityPolicyRequestRequestTypeDef definition

class GetSecurityPolicyRequestRequestTypeDef(TypedDict):
    name: str,
    type: SecurityPolicyTypeType,  # (1)
  1. See SecurityPolicyTypeType

LifecyclePolicySummaryTypeDef#

# LifecyclePolicySummaryTypeDef definition

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

ListAccessPoliciesRequestRequestTypeDef#

# ListAccessPoliciesRequestRequestTypeDef definition

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

ListLifecyclePoliciesRequestRequestTypeDef#

# ListLifecyclePoliciesRequestRequestTypeDef definition

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

ListSecurityConfigsRequestRequestTypeDef#

# ListSecurityConfigsRequestRequestTypeDef definition

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

SecurityConfigSummaryTypeDef#

# SecurityConfigSummaryTypeDef definition

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

ListSecurityPoliciesRequestRequestTypeDef#

# ListSecurityPoliciesRequestRequestTypeDef definition

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

SecurityPolicySummaryTypeDef#

# SecurityPolicySummaryTypeDef definition

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

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

VpcEndpointFiltersTypeDef#

# VpcEndpointFiltersTypeDef definition

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

VpcEndpointSummaryTypeDef#

# VpcEndpointSummaryTypeDef definition

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

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

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

UpdateAccessPolicyRequestRequestTypeDef#

# UpdateAccessPolicyRequestRequestTypeDef definition

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