Typed dictionaries
Index > OpenSearchServiceServerless > Typed dictionaries
Auto-generated documentation for OpenSearchServiceServerless type annotations stubs module mypy-boto3-opensearchserverless.
AccessPolicyDetailTypeDef
# AccessPolicyDetailTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import AccessPolicyDetailTypeDef
def get_value() -> AccessPolicyDetailTypeDef:
return {
"createdDate": ...,
}
# 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)
AccessPolicyStatsTypeDef
# AccessPolicyStatsTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import AccessPolicyStatsTypeDef
def get_value() -> AccessPolicyStatsTypeDef:
return {
"DataPolicyCount": ...,
}
# AccessPolicyStatsTypeDef definition
class AccessPolicyStatsTypeDef(TypedDict):
DataPolicyCount: NotRequired[int],
AccessPolicySummaryTypeDef
# AccessPolicySummaryTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import AccessPolicySummaryTypeDef
def get_value() -> AccessPolicySummaryTypeDef:
return {
"createdDate": ...,
}
# AccessPolicySummaryTypeDef definition
class AccessPolicySummaryTypeDef(TypedDict):
createdDate: NotRequired[int],
description: NotRequired[str],
lastModifiedDate: NotRequired[int],
name: NotRequired[str],
policyVersion: NotRequired[str],
type: NotRequired[AccessPolicyTypeType], # (1)
CapacityLimitsTypeDef
# CapacityLimitsTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import CapacityLimitsTypeDef
def get_value() -> CapacityLimitsTypeDef:
return {
"maxIndexingCapacityInOCU": ...,
}
# CapacityLimitsTypeDef definition
class CapacityLimitsTypeDef(TypedDict):
maxIndexingCapacityInOCU: NotRequired[int],
maxSearchCapacityInOCU: NotRequired[int],
BatchGetCollectionRequestRequestTypeDef
# BatchGetCollectionRequestRequestTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import BatchGetCollectionRequestRequestTypeDef
def get_value() -> BatchGetCollectionRequestRequestTypeDef:
return {
"ids": ...,
}
# BatchGetCollectionRequestRequestTypeDef definition
class BatchGetCollectionRequestRequestTypeDef(TypedDict):
ids: NotRequired[Sequence[str]],
names: NotRequired[Sequence[str]],
CollectionDetailTypeDef
# CollectionDetailTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import CollectionDetailTypeDef
def get_value() -> CollectionDetailTypeDef:
return {
"arn": ...,
}
# 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],
status: NotRequired[CollectionStatusType], # (1)
type: NotRequired[CollectionTypeType], # (2)
CollectionErrorDetailTypeDef
# CollectionErrorDetailTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import CollectionErrorDetailTypeDef
def get_value() -> CollectionErrorDetailTypeDef:
return {
"errorCode": ...,
}
# CollectionErrorDetailTypeDef definition
class CollectionErrorDetailTypeDef(TypedDict):
errorCode: NotRequired[str],
errorMessage: NotRequired[str],
id: NotRequired[str],
name: NotRequired[str],
ResponseMetadataTypeDef
# ResponseMetadataTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
BatchGetVpcEndpointRequestRequestTypeDef
# BatchGetVpcEndpointRequestRequestTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import BatchGetVpcEndpointRequestRequestTypeDef
def get_value() -> BatchGetVpcEndpointRequestRequestTypeDef:
return {
"ids": ...,
}
# BatchGetVpcEndpointRequestRequestTypeDef definition
class BatchGetVpcEndpointRequestRequestTypeDef(TypedDict):
ids: Sequence[str],
VpcEndpointDetailTypeDef
# VpcEndpointDetailTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import VpcEndpointDetailTypeDef
def get_value() -> VpcEndpointDetailTypeDef:
return {
"createdDate": ...,
}
# 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],
VpcEndpointErrorDetailTypeDef
# VpcEndpointErrorDetailTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import VpcEndpointErrorDetailTypeDef
def get_value() -> VpcEndpointErrorDetailTypeDef:
return {
"errorCode": ...,
}
# VpcEndpointErrorDetailTypeDef definition
class VpcEndpointErrorDetailTypeDef(TypedDict):
errorCode: NotRequired[str],
errorMessage: NotRequired[str],
id: NotRequired[str],
CollectionFiltersTypeDef
# CollectionFiltersTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import CollectionFiltersTypeDef
def get_value() -> CollectionFiltersTypeDef:
return {
"name": ...,
}
# CollectionFiltersTypeDef definition
class CollectionFiltersTypeDef(TypedDict):
name: NotRequired[str],
status: NotRequired[CollectionStatusType], # (1)
CollectionSummaryTypeDef
# CollectionSummaryTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import CollectionSummaryTypeDef
def get_value() -> CollectionSummaryTypeDef:
return {
"arn": ...,
}
# CollectionSummaryTypeDef definition
class CollectionSummaryTypeDef(TypedDict):
arn: NotRequired[str],
id: NotRequired[str],
name: NotRequired[str],
status: NotRequired[CollectionStatusType], # (1)
CreateAccessPolicyRequestRequestTypeDef
# CreateAccessPolicyRequestRequestTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import CreateAccessPolicyRequestRequestTypeDef
def get_value() -> CreateAccessPolicyRequestRequestTypeDef:
return {
"name": ...,
"policy": ...,
"type": ...,
}
# CreateAccessPolicyRequestRequestTypeDef definition
class CreateAccessPolicyRequestRequestTypeDef(TypedDict):
name: str,
policy: str,
type: AccessPolicyTypeType, # (1)
clientToken: NotRequired[str],
description: NotRequired[str],
CreateCollectionDetailTypeDef
# CreateCollectionDetailTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import CreateCollectionDetailTypeDef
def get_value() -> CreateCollectionDetailTypeDef:
return {
"arn": ...,
}
# 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],
status: NotRequired[CollectionStatusType], # (1)
type: NotRequired[CollectionTypeType], # (2)
TagTypeDef
# TagTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"key": ...,
"value": ...,
}
# TagTypeDef definition
class TagTypeDef(TypedDict):
key: str,
value: str,
SamlConfigOptionsTypeDef
# SamlConfigOptionsTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import SamlConfigOptionsTypeDef
def get_value() -> SamlConfigOptionsTypeDef:
return {
"metadata": ...,
}
# SamlConfigOptionsTypeDef definition
class SamlConfigOptionsTypeDef(TypedDict):
metadata: str,
groupAttribute: NotRequired[str],
sessionTimeout: NotRequired[int],
userAttribute: NotRequired[str],
CreateSecurityPolicyRequestRequestTypeDef
# CreateSecurityPolicyRequestRequestTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import CreateSecurityPolicyRequestRequestTypeDef
def get_value() -> CreateSecurityPolicyRequestRequestTypeDef:
return {
"name": ...,
"policy": ...,
"type": ...,
}
# CreateSecurityPolicyRequestRequestTypeDef definition
class CreateSecurityPolicyRequestRequestTypeDef(TypedDict):
name: str,
policy: str,
type: SecurityPolicyTypeType, # (1)
clientToken: NotRequired[str],
description: NotRequired[str],
SecurityPolicyDetailTypeDef
# SecurityPolicyDetailTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import SecurityPolicyDetailTypeDef
def get_value() -> SecurityPolicyDetailTypeDef:
return {
"createdDate": ...,
}
# 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)
CreateVpcEndpointDetailTypeDef
# CreateVpcEndpointDetailTypeDef usage example
from mypy_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)
CreateVpcEndpointRequestRequestTypeDef
# CreateVpcEndpointRequestRequestTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import CreateVpcEndpointRequestRequestTypeDef
def get_value() -> CreateVpcEndpointRequestRequestTypeDef:
return {
"name": ...,
"subnetIds": ...,
"vpcId": ...,
}
# CreateVpcEndpointRequestRequestTypeDef definition
class CreateVpcEndpointRequestRequestTypeDef(TypedDict):
name: str,
subnetIds: Sequence[str],
vpcId: str,
clientToken: NotRequired[str],
securityGroupIds: NotRequired[Sequence[str]],
DeleteAccessPolicyRequestRequestTypeDef
# DeleteAccessPolicyRequestRequestTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import DeleteAccessPolicyRequestRequestTypeDef
def get_value() -> DeleteAccessPolicyRequestRequestTypeDef:
return {
"name": ...,
"type": ...,
}
# DeleteAccessPolicyRequestRequestTypeDef definition
class DeleteAccessPolicyRequestRequestTypeDef(TypedDict):
name: str,
type: AccessPolicyTypeType, # (1)
clientToken: NotRequired[str],
DeleteCollectionDetailTypeDef
# DeleteCollectionDetailTypeDef usage example
from mypy_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)
DeleteCollectionRequestRequestTypeDef
# DeleteCollectionRequestRequestTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import DeleteCollectionRequestRequestTypeDef
def get_value() -> DeleteCollectionRequestRequestTypeDef:
return {
"id": ...,
}
# DeleteCollectionRequestRequestTypeDef definition
class DeleteCollectionRequestRequestTypeDef(TypedDict):
id: str,
clientToken: NotRequired[str],
DeleteSecurityConfigRequestRequestTypeDef
# DeleteSecurityConfigRequestRequestTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import DeleteSecurityConfigRequestRequestTypeDef
def get_value() -> DeleteSecurityConfigRequestRequestTypeDef:
return {
"id": ...,
}
# DeleteSecurityConfigRequestRequestTypeDef definition
class DeleteSecurityConfigRequestRequestTypeDef(TypedDict):
id: str,
clientToken: NotRequired[str],
DeleteSecurityPolicyRequestRequestTypeDef
# DeleteSecurityPolicyRequestRequestTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import DeleteSecurityPolicyRequestRequestTypeDef
def get_value() -> DeleteSecurityPolicyRequestRequestTypeDef:
return {
"name": ...,
"type": ...,
}
# DeleteSecurityPolicyRequestRequestTypeDef definition
class DeleteSecurityPolicyRequestRequestTypeDef(TypedDict):
name: str,
type: SecurityPolicyTypeType, # (1)
clientToken: NotRequired[str],
DeleteVpcEndpointDetailTypeDef
# DeleteVpcEndpointDetailTypeDef usage example
from mypy_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)
DeleteVpcEndpointRequestRequestTypeDef
# DeleteVpcEndpointRequestRequestTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import DeleteVpcEndpointRequestRequestTypeDef
def get_value() -> DeleteVpcEndpointRequestRequestTypeDef:
return {
"id": ...,
}
# DeleteVpcEndpointRequestRequestTypeDef definition
class DeleteVpcEndpointRequestRequestTypeDef(TypedDict):
id: str,
clientToken: NotRequired[str],
GetAccessPolicyRequestRequestTypeDef
# GetAccessPolicyRequestRequestTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import GetAccessPolicyRequestRequestTypeDef
def get_value() -> GetAccessPolicyRequestRequestTypeDef:
return {
"name": ...,
"type": ...,
}
# GetAccessPolicyRequestRequestTypeDef definition
class GetAccessPolicyRequestRequestTypeDef(TypedDict):
name: str,
type: AccessPolicyTypeType, # (1)
SecurityConfigStatsTypeDef
# SecurityConfigStatsTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import SecurityConfigStatsTypeDef
def get_value() -> SecurityConfigStatsTypeDef:
return {
"SamlConfigCount": ...,
}
# SecurityConfigStatsTypeDef definition
class SecurityConfigStatsTypeDef(TypedDict):
SamlConfigCount: NotRequired[int],
SecurityPolicyStatsTypeDef
# SecurityPolicyStatsTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import SecurityPolicyStatsTypeDef
def get_value() -> SecurityPolicyStatsTypeDef:
return {
"EncryptionPolicyCount": ...,
}
# SecurityPolicyStatsTypeDef definition
class SecurityPolicyStatsTypeDef(TypedDict):
EncryptionPolicyCount: NotRequired[int],
NetworkPolicyCount: NotRequired[int],
GetSecurityConfigRequestRequestTypeDef
# GetSecurityConfigRequestRequestTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import GetSecurityConfigRequestRequestTypeDef
def get_value() -> GetSecurityConfigRequestRequestTypeDef:
return {
"id": ...,
}
# GetSecurityConfigRequestRequestTypeDef definition
class GetSecurityConfigRequestRequestTypeDef(TypedDict):
id: str,
GetSecurityPolicyRequestRequestTypeDef
# GetSecurityPolicyRequestRequestTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import GetSecurityPolicyRequestRequestTypeDef
def get_value() -> GetSecurityPolicyRequestRequestTypeDef:
return {
"name": ...,
"type": ...,
}
# GetSecurityPolicyRequestRequestTypeDef definition
class GetSecurityPolicyRequestRequestTypeDef(TypedDict):
name: str,
type: SecurityPolicyTypeType, # (1)
ListAccessPoliciesRequestRequestTypeDef
# ListAccessPoliciesRequestRequestTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import ListAccessPoliciesRequestRequestTypeDef
def get_value() -> ListAccessPoliciesRequestRequestTypeDef:
return {
"type": ...,
}
# ListAccessPoliciesRequestRequestTypeDef definition
class ListAccessPoliciesRequestRequestTypeDef(TypedDict):
type: AccessPolicyTypeType, # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
resource: NotRequired[Sequence[str]],
ListSecurityConfigsRequestRequestTypeDef
# ListSecurityConfigsRequestRequestTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import ListSecurityConfigsRequestRequestTypeDef
def get_value() -> ListSecurityConfigsRequestRequestTypeDef:
return {
"type": ...,
}
# ListSecurityConfigsRequestRequestTypeDef definition
class ListSecurityConfigsRequestRequestTypeDef(TypedDict):
type: SecurityConfigTypeType, # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
SecurityConfigSummaryTypeDef
# SecurityConfigSummaryTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import SecurityConfigSummaryTypeDef
def get_value() -> SecurityConfigSummaryTypeDef:
return {
"configVersion": ...,
}
# SecurityConfigSummaryTypeDef definition
class SecurityConfigSummaryTypeDef(TypedDict):
configVersion: NotRequired[str],
createdDate: NotRequired[int],
description: NotRequired[str],
id: NotRequired[str],
lastModifiedDate: NotRequired[int],
type: NotRequired[SecurityConfigTypeType], # (1)
ListSecurityPoliciesRequestRequestTypeDef
# ListSecurityPoliciesRequestRequestTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import ListSecurityPoliciesRequestRequestTypeDef
def get_value() -> ListSecurityPoliciesRequestRequestTypeDef:
return {
"type": ...,
}
# ListSecurityPoliciesRequestRequestTypeDef definition
class ListSecurityPoliciesRequestRequestTypeDef(TypedDict):
type: SecurityPolicyTypeType, # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
resource: NotRequired[Sequence[str]],
SecurityPolicySummaryTypeDef
# SecurityPolicySummaryTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import SecurityPolicySummaryTypeDef
def get_value() -> SecurityPolicySummaryTypeDef:
return {
"createdDate": ...,
}
# SecurityPolicySummaryTypeDef definition
class SecurityPolicySummaryTypeDef(TypedDict):
createdDate: NotRequired[int],
description: NotRequired[str],
lastModifiedDate: NotRequired[int],
name: NotRequired[str],
policyVersion: NotRequired[str],
type: NotRequired[SecurityPolicyTypeType], # (1)
ListTagsForResourceRequestRequestTypeDef
# ListTagsForResourceRequestRequestTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
}
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
VpcEndpointFiltersTypeDef
# VpcEndpointFiltersTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import VpcEndpointFiltersTypeDef
def get_value() -> VpcEndpointFiltersTypeDef:
return {
"status": ...,
}
# VpcEndpointFiltersTypeDef definition
class VpcEndpointFiltersTypeDef(TypedDict):
status: NotRequired[VpcEndpointStatusType], # (1)
VpcEndpointSummaryTypeDef
# VpcEndpointSummaryTypeDef usage example
from mypy_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)
UntagResourceRequestRequestTypeDef
# UntagResourceRequestRequestTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
"tagKeys": ...,
}
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],
UpdateAccessPolicyRequestRequestTypeDef
# UpdateAccessPolicyRequestRequestTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import UpdateAccessPolicyRequestRequestTypeDef
def get_value() -> UpdateAccessPolicyRequestRequestTypeDef:
return {
"name": ...,
"policyVersion": ...,
"type": ...,
}
# UpdateAccessPolicyRequestRequestTypeDef definition
class UpdateAccessPolicyRequestRequestTypeDef(TypedDict):
name: str,
policyVersion: str,
type: AccessPolicyTypeType, # (1)
clientToken: NotRequired[str],
description: NotRequired[str],
policy: NotRequired[str],
UpdateCollectionDetailTypeDef
# UpdateCollectionDetailTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import UpdateCollectionDetailTypeDef
def get_value() -> UpdateCollectionDetailTypeDef:
return {
"arn": ...,
}
# UpdateCollectionDetailTypeDef definition
class UpdateCollectionDetailTypeDef(TypedDict):
arn: NotRequired[str],
createdDate: NotRequired[int],
description: NotRequired[str],
id: NotRequired[str],
lastModifiedDate: NotRequired[int],
name: NotRequired[str],
status: NotRequired[CollectionStatusType], # (1)
type: NotRequired[CollectionTypeType], # (2)
UpdateCollectionRequestRequestTypeDef
# UpdateCollectionRequestRequestTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import UpdateCollectionRequestRequestTypeDef
def get_value() -> UpdateCollectionRequestRequestTypeDef:
return {
"id": ...,
}
# UpdateCollectionRequestRequestTypeDef definition
class UpdateCollectionRequestRequestTypeDef(TypedDict):
id: str,
clientToken: NotRequired[str],
description: NotRequired[str],
UpdateSecurityPolicyRequestRequestTypeDef
# UpdateSecurityPolicyRequestRequestTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import UpdateSecurityPolicyRequestRequestTypeDef
def get_value() -> UpdateSecurityPolicyRequestRequestTypeDef:
return {
"name": ...,
"policyVersion": ...,
"type": ...,
}
# UpdateSecurityPolicyRequestRequestTypeDef definition
class UpdateSecurityPolicyRequestRequestTypeDef(TypedDict):
name: str,
policyVersion: str,
type: SecurityPolicyTypeType, # (1)
clientToken: NotRequired[str],
description: NotRequired[str],
policy: NotRequired[str],
UpdateVpcEndpointDetailTypeDef
# UpdateVpcEndpointDetailTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import UpdateVpcEndpointDetailTypeDef
def get_value() -> UpdateVpcEndpointDetailTypeDef:
return {
"id": ...,
}
# UpdateVpcEndpointDetailTypeDef definition
class UpdateVpcEndpointDetailTypeDef(TypedDict):
id: NotRequired[str],
lastModifiedDate: NotRequired[int],
name: NotRequired[str],
securityGroupIds: NotRequired[List[str]],
status: NotRequired[VpcEndpointStatusType], # (1)
subnetIds: NotRequired[List[str]],
UpdateVpcEndpointRequestRequestTypeDef
# UpdateVpcEndpointRequestRequestTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import UpdateVpcEndpointRequestRequestTypeDef
def get_value() -> UpdateVpcEndpointRequestRequestTypeDef:
return {
"id": ...,
}
# UpdateVpcEndpointRequestRequestTypeDef definition
class UpdateVpcEndpointRequestRequestTypeDef(TypedDict):
id: str,
addSecurityGroupIds: NotRequired[Sequence[str]],
addSubnetIds: NotRequired[Sequence[str]],
clientToken: NotRequired[str],
removeSecurityGroupIds: NotRequired[Sequence[str]],
removeSubnetIds: NotRequired[Sequence[str]],
AccountSettingsDetailTypeDef
# AccountSettingsDetailTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import AccountSettingsDetailTypeDef
def get_value() -> AccountSettingsDetailTypeDef:
return {
"capacityLimits": ...,
}
# AccountSettingsDetailTypeDef definition
class AccountSettingsDetailTypeDef(TypedDict):
capacityLimits: NotRequired[CapacityLimitsTypeDef], # (1)
UpdateAccountSettingsRequestRequestTypeDef
# UpdateAccountSettingsRequestRequestTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import UpdateAccountSettingsRequestRequestTypeDef
def get_value() -> UpdateAccountSettingsRequestRequestTypeDef:
return {
"capacityLimits": ...,
}
# UpdateAccountSettingsRequestRequestTypeDef definition
class UpdateAccountSettingsRequestRequestTypeDef(TypedDict):
capacityLimits: NotRequired[CapacityLimitsTypeDef], # (1)
BatchGetCollectionResponseTypeDef
# BatchGetCollectionResponseTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import BatchGetCollectionResponseTypeDef
def get_value() -> BatchGetCollectionResponseTypeDef:
return {
"collectionDetails": ...,
"collectionErrorDetails": ...,
"ResponseMetadata": ...,
}
# BatchGetCollectionResponseTypeDef definition
class BatchGetCollectionResponseTypeDef(TypedDict):
collectionDetails: List[CollectionDetailTypeDef], # (1)
collectionErrorDetails: List[CollectionErrorDetailTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
CreateAccessPolicyResponseTypeDef
# CreateAccessPolicyResponseTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import CreateAccessPolicyResponseTypeDef
def get_value() -> CreateAccessPolicyResponseTypeDef:
return {
"accessPolicyDetail": ...,
"ResponseMetadata": ...,
}
# CreateAccessPolicyResponseTypeDef definition
class CreateAccessPolicyResponseTypeDef(TypedDict):
accessPolicyDetail: AccessPolicyDetailTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetAccessPolicyResponseTypeDef
# GetAccessPolicyResponseTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import GetAccessPolicyResponseTypeDef
def get_value() -> GetAccessPolicyResponseTypeDef:
return {
"accessPolicyDetail": ...,
"ResponseMetadata": ...,
}
# GetAccessPolicyResponseTypeDef definition
class GetAccessPolicyResponseTypeDef(TypedDict):
accessPolicyDetail: AccessPolicyDetailTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListAccessPoliciesResponseTypeDef
# ListAccessPoliciesResponseTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import ListAccessPoliciesResponseTypeDef
def get_value() -> ListAccessPoliciesResponseTypeDef:
return {
"accessPolicySummaries": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# ListAccessPoliciesResponseTypeDef definition
class ListAccessPoliciesResponseTypeDef(TypedDict):
accessPolicySummaries: List[AccessPolicySummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateAccessPolicyResponseTypeDef
# UpdateAccessPolicyResponseTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import UpdateAccessPolicyResponseTypeDef
def get_value() -> UpdateAccessPolicyResponseTypeDef:
return {
"accessPolicyDetail": ...,
"ResponseMetadata": ...,
}
# UpdateAccessPolicyResponseTypeDef definition
class UpdateAccessPolicyResponseTypeDef(TypedDict):
accessPolicyDetail: AccessPolicyDetailTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BatchGetVpcEndpointResponseTypeDef
# BatchGetVpcEndpointResponseTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import BatchGetVpcEndpointResponseTypeDef
def get_value() -> BatchGetVpcEndpointResponseTypeDef:
return {
"vpcEndpointDetails": ...,
"vpcEndpointErrorDetails": ...,
"ResponseMetadata": ...,
}
# BatchGetVpcEndpointResponseTypeDef definition
class BatchGetVpcEndpointResponseTypeDef(TypedDict):
vpcEndpointDetails: List[VpcEndpointDetailTypeDef], # (1)
vpcEndpointErrorDetails: List[VpcEndpointErrorDetailTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
ListCollectionsRequestRequestTypeDef
# ListCollectionsRequestRequestTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import ListCollectionsRequestRequestTypeDef
def get_value() -> ListCollectionsRequestRequestTypeDef:
return {
"collectionFilters": ...,
}
# ListCollectionsRequestRequestTypeDef definition
class ListCollectionsRequestRequestTypeDef(TypedDict):
collectionFilters: NotRequired[CollectionFiltersTypeDef], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListCollectionsResponseTypeDef
# ListCollectionsResponseTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import ListCollectionsResponseTypeDef
def get_value() -> ListCollectionsResponseTypeDef:
return {
"collectionSummaries": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# ListCollectionsResponseTypeDef definition
class ListCollectionsResponseTypeDef(TypedDict):
collectionSummaries: List[CollectionSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateCollectionResponseTypeDef
# CreateCollectionResponseTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import CreateCollectionResponseTypeDef
def get_value() -> CreateCollectionResponseTypeDef:
return {
"createCollectionDetail": ...,
"ResponseMetadata": ...,
}
# CreateCollectionResponseTypeDef definition
class CreateCollectionResponseTypeDef(TypedDict):
createCollectionDetail: CreateCollectionDetailTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateCollectionRequestRequestTypeDef
# CreateCollectionRequestRequestTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import CreateCollectionRequestRequestTypeDef
def get_value() -> CreateCollectionRequestRequestTypeDef:
return {
"name": ...,
}
# CreateCollectionRequestRequestTypeDef definition
class CreateCollectionRequestRequestTypeDef(TypedDict):
name: str,
clientToken: NotRequired[str],
description: NotRequired[str],
tags: NotRequired[Sequence[TagTypeDef]], # (1)
type: NotRequired[CollectionTypeType], # (2)
- See TagTypeDef
- See CollectionTypeType
ListTagsForResourceResponseTypeDef
# ListTagsForResourceResponseTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"tags": ...,
"ResponseMetadata": ...,
}
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
TagResourceRequestRequestTypeDef
# TagResourceRequestRequestTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import TagResourceRequestRequestTypeDef
def get_value() -> TagResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
"tags": ...,
}
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
CreateSecurityConfigRequestRequestTypeDef
# CreateSecurityConfigRequestRequestTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import CreateSecurityConfigRequestRequestTypeDef
def get_value() -> CreateSecurityConfigRequestRequestTypeDef:
return {
"name": ...,
"type": ...,
}
# CreateSecurityConfigRequestRequestTypeDef definition
class CreateSecurityConfigRequestRequestTypeDef(TypedDict):
name: str,
type: SecurityConfigTypeType, # (1)
clientToken: NotRequired[str],
description: NotRequired[str],
samlOptions: NotRequired[SamlConfigOptionsTypeDef], # (2)
SecurityConfigDetailTypeDef
# SecurityConfigDetailTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import SecurityConfigDetailTypeDef
def get_value() -> SecurityConfigDetailTypeDef:
return {
"configVersion": ...,
}
# SecurityConfigDetailTypeDef definition
class SecurityConfigDetailTypeDef(TypedDict):
configVersion: NotRequired[str],
createdDate: NotRequired[int],
description: NotRequired[str],
id: NotRequired[str],
lastModifiedDate: NotRequired[int],
samlOptions: NotRequired[SamlConfigOptionsTypeDef], # (1)
type: NotRequired[SecurityConfigTypeType], # (2)
UpdateSecurityConfigRequestRequestTypeDef
# UpdateSecurityConfigRequestRequestTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import UpdateSecurityConfigRequestRequestTypeDef
def get_value() -> UpdateSecurityConfigRequestRequestTypeDef:
return {
"configVersion": ...,
"id": ...,
}
# UpdateSecurityConfigRequestRequestTypeDef definition
class UpdateSecurityConfigRequestRequestTypeDef(TypedDict):
configVersion: str,
id: str,
clientToken: NotRequired[str],
description: NotRequired[str],
samlOptions: NotRequired[SamlConfigOptionsTypeDef], # (1)
CreateSecurityPolicyResponseTypeDef
# CreateSecurityPolicyResponseTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import CreateSecurityPolicyResponseTypeDef
def get_value() -> CreateSecurityPolicyResponseTypeDef:
return {
"securityPolicyDetail": ...,
"ResponseMetadata": ...,
}
# CreateSecurityPolicyResponseTypeDef definition
class CreateSecurityPolicyResponseTypeDef(TypedDict):
securityPolicyDetail: SecurityPolicyDetailTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetSecurityPolicyResponseTypeDef
# GetSecurityPolicyResponseTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import GetSecurityPolicyResponseTypeDef
def get_value() -> GetSecurityPolicyResponseTypeDef:
return {
"securityPolicyDetail": ...,
"ResponseMetadata": ...,
}
# GetSecurityPolicyResponseTypeDef definition
class GetSecurityPolicyResponseTypeDef(TypedDict):
securityPolicyDetail: SecurityPolicyDetailTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateSecurityPolicyResponseTypeDef
# UpdateSecurityPolicyResponseTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import UpdateSecurityPolicyResponseTypeDef
def get_value() -> UpdateSecurityPolicyResponseTypeDef:
return {
"securityPolicyDetail": ...,
"ResponseMetadata": ...,
}
# UpdateSecurityPolicyResponseTypeDef definition
class UpdateSecurityPolicyResponseTypeDef(TypedDict):
securityPolicyDetail: SecurityPolicyDetailTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateVpcEndpointResponseTypeDef
# CreateVpcEndpointResponseTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import CreateVpcEndpointResponseTypeDef
def get_value() -> CreateVpcEndpointResponseTypeDef:
return {
"createVpcEndpointDetail": ...,
"ResponseMetadata": ...,
}
# CreateVpcEndpointResponseTypeDef definition
class CreateVpcEndpointResponseTypeDef(TypedDict):
createVpcEndpointDetail: CreateVpcEndpointDetailTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteCollectionResponseTypeDef
# DeleteCollectionResponseTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import DeleteCollectionResponseTypeDef
def get_value() -> DeleteCollectionResponseTypeDef:
return {
"deleteCollectionDetail": ...,
"ResponseMetadata": ...,
}
# DeleteCollectionResponseTypeDef definition
class DeleteCollectionResponseTypeDef(TypedDict):
deleteCollectionDetail: DeleteCollectionDetailTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteVpcEndpointResponseTypeDef
# DeleteVpcEndpointResponseTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import DeleteVpcEndpointResponseTypeDef
def get_value() -> DeleteVpcEndpointResponseTypeDef:
return {
"deleteVpcEndpointDetail": ...,
"ResponseMetadata": ...,
}
# DeleteVpcEndpointResponseTypeDef definition
class DeleteVpcEndpointResponseTypeDef(TypedDict):
deleteVpcEndpointDetail: DeleteVpcEndpointDetailTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetPoliciesStatsResponseTypeDef
# GetPoliciesStatsResponseTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import GetPoliciesStatsResponseTypeDef
def get_value() -> GetPoliciesStatsResponseTypeDef:
return {
"AccessPolicyStats": ...,
"SecurityConfigStats": ...,
"SecurityPolicyStats": ...,
"TotalPolicyCount": ...,
"ResponseMetadata": ...,
}
# GetPoliciesStatsResponseTypeDef definition
class GetPoliciesStatsResponseTypeDef(TypedDict):
AccessPolicyStats: AccessPolicyStatsTypeDef, # (1)
SecurityConfigStats: SecurityConfigStatsTypeDef, # (2)
SecurityPolicyStats: SecurityPolicyStatsTypeDef, # (3)
TotalPolicyCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See AccessPolicyStatsTypeDef
- See SecurityConfigStatsTypeDef
- See SecurityPolicyStatsTypeDef
- See ResponseMetadataTypeDef
ListSecurityConfigsResponseTypeDef
# ListSecurityConfigsResponseTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import ListSecurityConfigsResponseTypeDef
def get_value() -> ListSecurityConfigsResponseTypeDef:
return {
"nextToken": ...,
"securityConfigSummaries": ...,
"ResponseMetadata": ...,
}
# ListSecurityConfigsResponseTypeDef definition
class ListSecurityConfigsResponseTypeDef(TypedDict):
nextToken: str,
securityConfigSummaries: List[SecurityConfigSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListSecurityPoliciesResponseTypeDef
# ListSecurityPoliciesResponseTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import ListSecurityPoliciesResponseTypeDef
def get_value() -> ListSecurityPoliciesResponseTypeDef:
return {
"nextToken": ...,
"securityPolicySummaries": ...,
"ResponseMetadata": ...,
}
# ListSecurityPoliciesResponseTypeDef definition
class ListSecurityPoliciesResponseTypeDef(TypedDict):
nextToken: str,
securityPolicySummaries: List[SecurityPolicySummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListVpcEndpointsRequestRequestTypeDef
# ListVpcEndpointsRequestRequestTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import ListVpcEndpointsRequestRequestTypeDef
def get_value() -> ListVpcEndpointsRequestRequestTypeDef:
return {
"maxResults": ...,
}
# ListVpcEndpointsRequestRequestTypeDef definition
class ListVpcEndpointsRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
vpcEndpointFilters: NotRequired[VpcEndpointFiltersTypeDef], # (1)
ListVpcEndpointsResponseTypeDef
# ListVpcEndpointsResponseTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import ListVpcEndpointsResponseTypeDef
def get_value() -> ListVpcEndpointsResponseTypeDef:
return {
"nextToken": ...,
"vpcEndpointSummaries": ...,
"ResponseMetadata": ...,
}
# ListVpcEndpointsResponseTypeDef definition
class ListVpcEndpointsResponseTypeDef(TypedDict):
nextToken: str,
vpcEndpointSummaries: List[VpcEndpointSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateCollectionResponseTypeDef
# UpdateCollectionResponseTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import UpdateCollectionResponseTypeDef
def get_value() -> UpdateCollectionResponseTypeDef:
return {
"updateCollectionDetail": ...,
"ResponseMetadata": ...,
}
# UpdateCollectionResponseTypeDef definition
class UpdateCollectionResponseTypeDef(TypedDict):
updateCollectionDetail: UpdateCollectionDetailTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateVpcEndpointResponseTypeDef
# UpdateVpcEndpointResponseTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import UpdateVpcEndpointResponseTypeDef
def get_value() -> UpdateVpcEndpointResponseTypeDef:
return {
"UpdateVpcEndpointDetail": ...,
"ResponseMetadata": ...,
}
# UpdateVpcEndpointResponseTypeDef definition
class UpdateVpcEndpointResponseTypeDef(TypedDict):
UpdateVpcEndpointDetail: UpdateVpcEndpointDetailTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetAccountSettingsResponseTypeDef
# GetAccountSettingsResponseTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import GetAccountSettingsResponseTypeDef
def get_value() -> GetAccountSettingsResponseTypeDef:
return {
"accountSettingsDetail": ...,
"ResponseMetadata": ...,
}
# GetAccountSettingsResponseTypeDef definition
class GetAccountSettingsResponseTypeDef(TypedDict):
accountSettingsDetail: AccountSettingsDetailTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateAccountSettingsResponseTypeDef
# UpdateAccountSettingsResponseTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import UpdateAccountSettingsResponseTypeDef
def get_value() -> UpdateAccountSettingsResponseTypeDef:
return {
"accountSettingsDetail": ...,
"ResponseMetadata": ...,
}
# UpdateAccountSettingsResponseTypeDef definition
class UpdateAccountSettingsResponseTypeDef(TypedDict):
accountSettingsDetail: AccountSettingsDetailTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateSecurityConfigResponseTypeDef
# CreateSecurityConfigResponseTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import CreateSecurityConfigResponseTypeDef
def get_value() -> CreateSecurityConfigResponseTypeDef:
return {
"securityConfigDetail": ...,
"ResponseMetadata": ...,
}
# CreateSecurityConfigResponseTypeDef definition
class CreateSecurityConfigResponseTypeDef(TypedDict):
securityConfigDetail: SecurityConfigDetailTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetSecurityConfigResponseTypeDef
# GetSecurityConfigResponseTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import GetSecurityConfigResponseTypeDef
def get_value() -> GetSecurityConfigResponseTypeDef:
return {
"securityConfigDetail": ...,
"ResponseMetadata": ...,
}
# GetSecurityConfigResponseTypeDef definition
class GetSecurityConfigResponseTypeDef(TypedDict):
securityConfigDetail: SecurityConfigDetailTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateSecurityConfigResponseTypeDef
# UpdateSecurityConfigResponseTypeDef usage example
from mypy_boto3_opensearchserverless.type_defs import UpdateSecurityConfigResponseTypeDef
def get_value() -> UpdateSecurityConfigResponseTypeDef:
return {
"securityConfigDetail": ...,
"ResponseMetadata": ...,
}
# UpdateSecurityConfigResponseTypeDef definition
class UpdateSecurityConfigResponseTypeDef(TypedDict):
securityConfigDetail: SecurityConfigDetailTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)