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 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],
    failureCode: NotRequired[str],
    failureMessage: NotRequired[str],
    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,

CreateIamIdentityCenterConfigOptionsTypeDef#

# CreateIamIdentityCenterConfigOptionsTypeDef definition

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

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

IamIdentityCenterConfigOptionsTypeDef#

# IamIdentityCenterConfigOptionsTypeDef definition

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

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 AccessPolicyTypeType

UpdateCollectionDetailTypeDef#

# 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)
  1. See CollectionStatusType
  2. See CollectionTypeType

UpdateCollectionRequestRequestTypeDef#

# UpdateCollectionRequestRequestTypeDef definition

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

UpdateIamIdentityCenterConfigOptionsTypeDef#

# UpdateIamIdentityCenterConfigOptionsTypeDef definition

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

UpdateLifecyclePolicyRequestRequestTypeDef#

# UpdateLifecyclePolicyRequestRequestTypeDef definition

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

UpdateSecurityPolicyRequestRequestTypeDef#

# UpdateSecurityPolicyRequestRequestTypeDef definition

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

UpdateVpcEndpointDetailTypeDef#

# 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]],
  1. See VpcEndpointStatusType

UpdateVpcEndpointRequestRequestTypeDef#

# 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 definition

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

UpdateAccountSettingsRequestRequestTypeDef#

# UpdateAccountSettingsRequestRequestTypeDef definition

class UpdateAccountSettingsRequestRequestTypeDef(TypedDict):
    capacityLimits: NotRequired[CapacityLimitsTypeDef],  # (1)
  1. See CapacityLimitsTypeDef

BatchGetCollectionResponseTypeDef#

# BatchGetCollectionResponseTypeDef definition

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

CreateAccessPolicyResponseTypeDef#

# CreateAccessPolicyResponseTypeDef definition

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

GetAccessPolicyResponseTypeDef#

# GetAccessPolicyResponseTypeDef definition

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

ListAccessPoliciesResponseTypeDef#

# ListAccessPoliciesResponseTypeDef definition

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

UpdateAccessPolicyResponseTypeDef#

# UpdateAccessPolicyResponseTypeDef definition

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

BatchGetEffectiveLifecyclePolicyRequestRequestTypeDef#

# BatchGetEffectiveLifecyclePolicyRequestRequestTypeDef definition

class BatchGetEffectiveLifecyclePolicyRequestRequestTypeDef(TypedDict):
    resourceIdentifiers: Sequence[LifecyclePolicyResourceIdentifierTypeDef],  # (1)
  1. See LifecyclePolicyResourceIdentifierTypeDef

BatchGetEffectiveLifecyclePolicyResponseTypeDef#

# BatchGetEffectiveLifecyclePolicyResponseTypeDef definition

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

BatchGetLifecyclePolicyRequestRequestTypeDef#

# BatchGetLifecyclePolicyRequestRequestTypeDef definition

class BatchGetLifecyclePolicyRequestRequestTypeDef(TypedDict):
    identifiers: Sequence[LifecyclePolicyIdentifierTypeDef],  # (1)
  1. See LifecyclePolicyIdentifierTypeDef

CreateLifecyclePolicyResponseTypeDef#

# CreateLifecyclePolicyResponseTypeDef definition

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

UpdateLifecyclePolicyResponseTypeDef#

# UpdateLifecyclePolicyResponseTypeDef definition

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

BatchGetLifecyclePolicyResponseTypeDef#

# BatchGetLifecyclePolicyResponseTypeDef definition

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

BatchGetVpcEndpointResponseTypeDef#

# BatchGetVpcEndpointResponseTypeDef definition

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

ListCollectionsRequestRequestTypeDef#

# ListCollectionsRequestRequestTypeDef definition

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

ListCollectionsResponseTypeDef#

# ListCollectionsResponseTypeDef definition

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

CreateCollectionResponseTypeDef#

# CreateCollectionResponseTypeDef definition

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

CreateCollectionRequestRequestTypeDef#

# CreateCollectionRequestRequestTypeDef definition

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

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

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

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CreateSecurityConfigRequestRequestTypeDef#

# CreateSecurityConfigRequestRequestTypeDef definition

class CreateSecurityConfigRequestRequestTypeDef(TypedDict):
    name: str,
    type: SecurityConfigTypeType,  # (1)
    clientToken: NotRequired[str],
    description: NotRequired[str],
    iamIdentityCenterOptions: NotRequired[CreateIamIdentityCenterConfigOptionsTypeDef],  # (2)
    samlOptions: NotRequired[SamlConfigOptionsTypeDef],  # (3)
  1. See SecurityConfigTypeType
  2. See CreateIamIdentityCenterConfigOptionsTypeDef
  3. See SamlConfigOptionsTypeDef

CreateSecurityPolicyResponseTypeDef#

# CreateSecurityPolicyResponseTypeDef definition

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

GetSecurityPolicyResponseTypeDef#

# GetSecurityPolicyResponseTypeDef definition

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

UpdateSecurityPolicyResponseTypeDef#

# UpdateSecurityPolicyResponseTypeDef definition

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

CreateVpcEndpointResponseTypeDef#

# CreateVpcEndpointResponseTypeDef definition

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

DeleteCollectionResponseTypeDef#

# DeleteCollectionResponseTypeDef definition

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

DeleteVpcEndpointResponseTypeDef#

# DeleteVpcEndpointResponseTypeDef definition

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

GetPoliciesStatsResponseTypeDef#

# GetPoliciesStatsResponseTypeDef definition

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

SecurityConfigDetailTypeDef#

# SecurityConfigDetailTypeDef definition

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

ListLifecyclePoliciesResponseTypeDef#

# ListLifecyclePoliciesResponseTypeDef definition

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

ListSecurityConfigsResponseTypeDef#

# ListSecurityConfigsResponseTypeDef definition

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

ListSecurityPoliciesResponseTypeDef#

# ListSecurityPoliciesResponseTypeDef definition

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

ListVpcEndpointsRequestRequestTypeDef#

# ListVpcEndpointsRequestRequestTypeDef definition

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

ListVpcEndpointsResponseTypeDef#

# ListVpcEndpointsResponseTypeDef definition

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

UpdateCollectionResponseTypeDef#

# UpdateCollectionResponseTypeDef definition

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

UpdateSecurityConfigRequestRequestTypeDef#

# UpdateSecurityConfigRequestRequestTypeDef definition

class UpdateSecurityConfigRequestRequestTypeDef(TypedDict):
    configVersion: str,
    id: str,
    clientToken: NotRequired[str],
    description: NotRequired[str],
    iamIdentityCenterOptionsUpdates: NotRequired[UpdateIamIdentityCenterConfigOptionsTypeDef],  # (1)
    samlOptions: NotRequired[SamlConfigOptionsTypeDef],  # (2)
  1. See UpdateIamIdentityCenterConfigOptionsTypeDef
  2. See SamlConfigOptionsTypeDef

UpdateVpcEndpointResponseTypeDef#

# UpdateVpcEndpointResponseTypeDef definition

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

GetAccountSettingsResponseTypeDef#

# GetAccountSettingsResponseTypeDef definition

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

UpdateAccountSettingsResponseTypeDef#

# UpdateAccountSettingsResponseTypeDef definition

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

CreateSecurityConfigResponseTypeDef#

# CreateSecurityConfigResponseTypeDef definition

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

GetSecurityConfigResponseTypeDef#

# GetSecurityConfigResponseTypeDef definition

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

UpdateSecurityConfigResponseTypeDef#

# UpdateSecurityConfigResponseTypeDef definition

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