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