@aws-sdk/client-opensearchserverless

Description

Use the Amazon OpenSearch Serverless API to create, configure, and manage OpenSearch Serverless collections and security policies.

OpenSearch Serverless is an on-demand, pre-provisioned serverless configuration for Amazon OpenSearch Service. OpenSearch Serverless removes the operational complexities of provisioning, configuring, and tuning your OpenSearch clusters. It enables you to easily search and analyze petabytes of data without having to worry about the underlying infrastructure and data management.

To learn more about OpenSearch Serverless, see What is Amazon OpenSearch Serverless? 

Installation

NPM
npm install @aws-sdk/client-opensearchserverless
Yarn
yarn add @aws-sdk/client-opensearchserverless
pnpm
pnpm add @aws-sdk/client-opensearchserverless

Types

Type Name
Type
AccessPolicyDetailInterface
AccessPolicyStatsInterface
AccessPolicySummaryInterface
AccessPolicyTypeTypeAlias
AccessPolicyTypeenumVariable
AccountSettingsDetailInterface
BatchGetCollectionCommandClass
BatchGetCollectionCommandInputInterface
BatchGetCollectionCommandOutputInterface
BatchGetCollectionRequestInterface
BatchGetCollectionResponseInterface
BatchGetEffectiveLifecyclePolicyCommandClass
BatchGetEffectiveLifecyclePolicyCommandInputInterface
BatchGetEffectiveLifecyclePolicyCommandOutputInterface
BatchGetEffectiveLifecyclePolicyRequestInterface
BatchGetEffectiveLifecyclePolicyResponseInterface
BatchGetLifecyclePolicyCommandClass
BatchGetLifecyclePolicyCommandInputInterface
BatchGetLifecyclePolicyCommandOutputInterface
BatchGetLifecyclePolicyRequestInterface
BatchGetLifecyclePolicyResponseInterface
BatchGetVpcEndpointCommandClass
BatchGetVpcEndpointCommandInputInterface
BatchGetVpcEndpointCommandOutputInterface
BatchGetVpcEndpointRequestInterface
BatchGetVpcEndpointResponseInterface
CapacityLimitsInterface
ClientDefaultsInterface
ClientInputEndpointParametersInterface
CollectionDetailInterface
CollectionErrorDetailInterface
CollectionFiltersInterface
CollectionStatusTypeAlias
CollectionStatusenumVariable
CollectionSummaryInterface
CollectionTypeTypeAlias
CollectionTypeenumVariable
ConflictExceptionClass
CreateAccessPolicyCommandClass
CreateAccessPolicyCommandInputInterface
CreateAccessPolicyCommandOutputInterface
CreateAccessPolicyRequestInterface
CreateAccessPolicyResponseInterface
CreateCollectionCommandClass
CreateCollectionCommandInputInterface
CreateCollectionCommandOutputInterface
CreateCollectionDetailInterface
CreateCollectionRequestInterface
CreateCollectionResponseInterface
CreateIamIdentityCenterConfigOptionsInterface
CreateLifecyclePolicyCommandClass
CreateLifecyclePolicyCommandInputInterface
CreateLifecyclePolicyCommandOutputInterface
CreateLifecyclePolicyRequestInterface
CreateLifecyclePolicyResponseInterface
CreateSecurityConfigCommandClass
CreateSecurityConfigCommandInputInterface
CreateSecurityConfigCommandOutputInterface
CreateSecurityConfigRequestInterface
CreateSecurityConfigResponseInterface
CreateSecurityPolicyCommandClass
CreateSecurityPolicyCommandInputInterface
CreateSecurityPolicyCommandOutputInterface
CreateSecurityPolicyRequestInterface
CreateSecurityPolicyResponseInterface
CreateVpcEndpointCommandClass
CreateVpcEndpointCommandInputInterface
CreateVpcEndpointCommandOutputInterface
CreateVpcEndpointDetailInterface
CreateVpcEndpointRequestInterface
CreateVpcEndpointResponseInterface
DeleteAccessPolicyCommandClass
DeleteAccessPolicyCommandInputInterface
DeleteAccessPolicyCommandOutputInterface
DeleteAccessPolicyRequestInterface
DeleteAccessPolicyResponseInterface
DeleteCollectionCommandClass
DeleteCollectionCommandInputInterface
DeleteCollectionCommandOutputInterface
DeleteCollectionDetailInterface
DeleteCollectionRequestInterface
DeleteCollectionResponseInterface
DeleteLifecyclePolicyCommandClass
DeleteLifecyclePolicyCommandInputInterface
DeleteLifecyclePolicyCommandOutputInterface
DeleteLifecyclePolicyRequestInterface
DeleteLifecyclePolicyResponseInterface
DeleteSecurityConfigCommandClass
DeleteSecurityConfigCommandInputInterface
DeleteSecurityConfigCommandOutputInterface
DeleteSecurityConfigRequestInterface
DeleteSecurityConfigResponseInterface
DeleteSecurityPolicyCommandClass
DeleteSecurityPolicyCommandInputInterface
DeleteSecurityPolicyCommandOutputInterface
DeleteSecurityPolicyRequestInterface
DeleteSecurityPolicyResponseInterface
DeleteVpcEndpointCommandClass
DeleteVpcEndpointCommandInputInterface
DeleteVpcEndpointCommandOutputInterface
DeleteVpcEndpointDetailInterface
DeleteVpcEndpointRequestInterface
DeleteVpcEndpointResponseInterface
EffectiveLifecyclePolicyDetailInterface
EffectiveLifecyclePolicyErrorDetailInterface
GetAccessPolicyCommandClass
GetAccessPolicyCommandInputInterface
GetAccessPolicyCommandOutputInterface
GetAccessPolicyRequestInterface
GetAccessPolicyResponseInterface
GetAccountSettingsCommandClass
GetAccountSettingsCommandInputInterface
GetAccountSettingsCommandOutputInterface
GetAccountSettingsRequestInterface
GetAccountSettingsResponseInterface
GetPoliciesStatsCommandClass
GetPoliciesStatsCommandInputInterface
GetPoliciesStatsCommandOutputInterface
GetPoliciesStatsRequestInterface
GetPoliciesStatsResponseInterface
GetSecurityConfigCommandClass
GetSecurityConfigCommandInputInterface
GetSecurityConfigCommandOutputInterface
GetSecurityConfigRequestInterface
GetSecurityConfigResponseInterface
GetSecurityPolicyCommandClass
GetSecurityPolicyCommandInputInterface
GetSecurityPolicyCommandOutputInterface
GetSecurityPolicyRequestInterface
GetSecurityPolicyResponseInterface
IamIdentityCenterConfigOptionsInterface
IamIdentityCenterGroupAttributeTypeAlias
IamIdentityCenterGroupAttributeenumVariable
IamIdentityCenterUserAttributeTypeAlias
IamIdentityCenterUserAttributeenumVariable
InternalServerExceptionClass
LifecyclePolicyDetailInterface
LifecyclePolicyErrorDetailInterface
LifecyclePolicyIdentifierInterface
LifecyclePolicyResourceIdentifierInterface
LifecyclePolicyStatsInterface
LifecyclePolicySummaryInterface
LifecyclePolicyTypeTypeAlias
LifecyclePolicyTypeenumVariable
ListAccessPoliciesCommandClass
ListAccessPoliciesCommandInputInterface
ListAccessPoliciesCommandOutputInterface
ListAccessPoliciesRequestInterface
ListAccessPoliciesResponseInterface
ListCollectionsCommandClass
ListCollectionsCommandInputInterface
ListCollectionsCommandOutputInterface
ListCollectionsRequestInterface
ListCollectionsResponseInterface
ListLifecyclePoliciesCommandClass
ListLifecyclePoliciesCommandInputInterface
ListLifecyclePoliciesCommandOutputInterface
ListLifecyclePoliciesRequestInterface
ListLifecyclePoliciesResponseInterface
ListSecurityConfigsCommandClass
ListSecurityConfigsCommandInputInterface
ListSecurityConfigsCommandOutputInterface
ListSecurityConfigsRequestInterface
ListSecurityConfigsResponseInterface
ListSecurityPoliciesCommandClass
ListSecurityPoliciesCommandInputInterface
ListSecurityPoliciesCommandOutputInterface
ListSecurityPoliciesRequestInterface
ListSecurityPoliciesResponseInterface
ListTagsForResourceCommandClass
ListTagsForResourceCommandInputInterface
ListTagsForResourceCommandOutputInterface
ListTagsForResourceRequestInterface
ListTagsForResourceResponseInterface
ListVpcEndpointsCommandClass
ListVpcEndpointsCommandInputInterface
ListVpcEndpointsCommandOutputInterface
ListVpcEndpointsRequestInterface
ListVpcEndpointsResponseInterface
OcuLimitExceededExceptionClass
OpenSearchServerlessClass
OpenSearchServerlessInterface
OpenSearchServerlessClientClass
OpenSearchServerlessClientConfigInterface
OpenSearchServerlessClientConfigTypeTypeAlias
OpenSearchServerlessClientResolvedConfigInterface
OpenSearchServerlessClientResolvedConfigTypeTypeAlias
OpenSearchServerlessPaginationConfigurationInterface
OpenSearchServerlessServiceExceptionClass
paginateListAccessPoliciesVariable
paginateListCollectionsVariable
paginateListLifecyclePoliciesVariable
paginateListSecurityConfigsVariable
paginateListSecurityPoliciesVariable
paginateListVpcEndpointsVariable
ResourceNotFoundExceptionClass
ResourceTypeTypeAlias
ResourceTypeenumVariable
RuntimeExtensionInterface
SamlConfigOptionsInterface
SecurityConfigDetailInterface
SecurityConfigStatsInterface
SecurityConfigSummaryInterface
SecurityConfigTypeTypeAlias
SecurityConfigTypeenumVariable
SecurityPolicyDetailInterface
SecurityPolicyStatsInterface
SecurityPolicySummaryInterface
SecurityPolicyTypeTypeAlias
SecurityPolicyTypeenumVariable
ServiceInputTypesTypeAlias
ServiceOutputTypesTypeAlias
ServiceQuotaExceededExceptionClass
StandbyReplicasTypeAlias
StandbyReplicasenumVariable
TagInterface
TagResourceCommandClass
TagResourceCommandInputInterface
TagResourceCommandOutputInterface
TagResourceRequestInterface
TagResourceResponseInterface
UntagResourceCommandClass
UntagResourceCommandInputInterface
UntagResourceCommandOutputInterface
UntagResourceRequestInterface
UntagResourceResponseInterface
UpdateAccessPolicyCommandClass
UpdateAccessPolicyCommandInputInterface
UpdateAccessPolicyCommandOutputInterface
UpdateAccessPolicyRequestInterface
UpdateAccessPolicyResponseInterface
UpdateAccountSettingsCommandClass
UpdateAccountSettingsCommandInputInterface
UpdateAccountSettingsCommandOutputInterface
UpdateAccountSettingsRequestInterface
UpdateAccountSettingsResponseInterface
UpdateCollectionCommandClass
UpdateCollectionCommandInputInterface
UpdateCollectionCommandOutputInterface
UpdateCollectionDetailInterface
UpdateCollectionRequestInterface
UpdateCollectionResponseInterface
UpdateIamIdentityCenterConfigOptionsInterface
UpdateLifecyclePolicyCommandClass
UpdateLifecyclePolicyCommandInputInterface
UpdateLifecyclePolicyCommandOutputInterface
UpdateLifecyclePolicyRequestInterface
UpdateLifecyclePolicyResponseInterface
UpdateSecurityConfigCommandClass
UpdateSecurityConfigCommandInputInterface
UpdateSecurityConfigCommandOutputInterface
UpdateSecurityConfigRequestInterface
UpdateSecurityConfigResponseInterface
UpdateSecurityPolicyCommandClass
UpdateSecurityPolicyCommandInputInterface
UpdateSecurityPolicyCommandOutputInterface
UpdateSecurityPolicyRequestInterface
UpdateSecurityPolicyResponseInterface
UpdateVpcEndpointCommandClass
UpdateVpcEndpointCommandInputInterface
UpdateVpcEndpointCommandOutputInterface
UpdateVpcEndpointDetailInterface
UpdateVpcEndpointRequestInterface
UpdateVpcEndpointResponseInterface
ValidationExceptionClass
VpcEndpointDetailInterface
VpcEndpointErrorDetailInterface
VpcEndpointFiltersInterface
VpcEndpointStatusTypeAlias
VpcEndpointStatusenumVariable
VpcEndpointSummaryInterface