Skip to main content Link Search Menu Expand Document (external link)

OpenSearchServerlessService overview

Added in v1.0.0


Table of contents


constructors

makeOpenSearchServerlessService

Signature

export declare const makeOpenSearchServerlessService: Effect.Effect<any, unknown, unknown>

Added in v1.0.0

models

OpenSearchServerlessService (class)

Signature

export declare class OpenSearchServerlessService

Added in v1.0.0

OpenSearchServerlessService$ (interface)

Signature

export interface OpenSearchServerlessService$ {
  /**
   * @see {@link BatchGetCollectionCommand}
   */
  batchGetCollection(
    args: BatchGetCollectionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    BatchGetCollectionCommandOutput,
    Cause.TimeoutError | SdkError | InternalServerError | ValidationError
  >

  /**
   * @see {@link BatchGetCollectionGroupCommand}
   */
  batchGetCollectionGroup(
    args: BatchGetCollectionGroupCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    BatchGetCollectionGroupCommandOutput,
    Cause.TimeoutError | SdkError | InternalServerError | ValidationError
  >

  /**
   * @see {@link BatchGetEffectiveLifecyclePolicyCommand}
   */
  batchGetEffectiveLifecyclePolicy(
    args: BatchGetEffectiveLifecyclePolicyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    BatchGetEffectiveLifecyclePolicyCommandOutput,
    Cause.TimeoutError | SdkError | InternalServerError | ValidationError
  >

  /**
   * @see {@link BatchGetLifecyclePolicyCommand}
   */
  batchGetLifecyclePolicy(
    args: BatchGetLifecyclePolicyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    BatchGetLifecyclePolicyCommandOutput,
    Cause.TimeoutError | SdkError | InternalServerError | ValidationError
  >

  /**
   * @see {@link BatchGetVpcEndpointCommand}
   */
  batchGetVpcEndpoint(
    args: BatchGetVpcEndpointCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    BatchGetVpcEndpointCommandOutput,
    Cause.TimeoutError | SdkError | InternalServerError | ValidationError
  >

  /**
   * @see {@link CreateAccessPolicyCommand}
   */
  createAccessPolicy(
    args: CreateAccessPolicyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateAccessPolicyCommandOutput,
    Cause.TimeoutError | SdkError | ConflictError | InternalServerError | ServiceQuotaExceededError | ValidationError
  >

  /**
   * @see {@link CreateCollectionCommand}
   */
  createCollection(
    args: CreateCollectionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateCollectionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | ConflictError
    | InternalServerError
    | OcuLimitExceededError
    | ServiceQuotaExceededError
    | ValidationError
  >

  /**
   * @see {@link CreateCollectionGroupCommand}
   */
  createCollectionGroup(
    args: CreateCollectionGroupCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateCollectionGroupCommandOutput,
    Cause.TimeoutError | SdkError | ConflictError | InternalServerError | ServiceQuotaExceededError | ValidationError
  >

  /**
   * @see {@link CreateIndexCommand}
   */
  createIndex(
    args: CreateIndexCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateIndexCommandOutput,
    Cause.TimeoutError | SdkError | ConflictError | InternalServerError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link CreateLifecyclePolicyCommand}
   */
  createLifecyclePolicy(
    args: CreateLifecyclePolicyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateLifecyclePolicyCommandOutput,
    Cause.TimeoutError | SdkError | ConflictError | InternalServerError | ServiceQuotaExceededError | ValidationError
  >

  /**
   * @see {@link CreateSecurityConfigCommand}
   */
  createSecurityConfig(
    args: CreateSecurityConfigCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateSecurityConfigCommandOutput,
    Cause.TimeoutError | SdkError | ConflictError | InternalServerError | ServiceQuotaExceededError | ValidationError
  >

  /**
   * @see {@link CreateSecurityPolicyCommand}
   */
  createSecurityPolicy(
    args: CreateSecurityPolicyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateSecurityPolicyCommandOutput,
    Cause.TimeoutError | SdkError | ConflictError | InternalServerError | ServiceQuotaExceededError | ValidationError
  >

  /**
   * @see {@link CreateVpcEndpointCommand}
   */
  createVpcEndpoint(
    args: CreateVpcEndpointCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateVpcEndpointCommandOutput,
    Cause.TimeoutError | SdkError | ConflictError | InternalServerError | ServiceQuotaExceededError | ValidationError
  >

  /**
   * @see {@link DeleteAccessPolicyCommand}
   */
  deleteAccessPolicy(
    args: DeleteAccessPolicyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteAccessPolicyCommandOutput,
    Cause.TimeoutError | SdkError | ConflictError | InternalServerError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link DeleteCollectionCommand}
   */
  deleteCollection(
    args: DeleteCollectionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteCollectionCommandOutput,
    Cause.TimeoutError | SdkError | ConflictError | InternalServerError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link DeleteCollectionGroupCommand}
   */
  deleteCollectionGroup(
    args: DeleteCollectionGroupCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteCollectionGroupCommandOutput,
    Cause.TimeoutError | SdkError | ConflictError | InternalServerError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link DeleteIndexCommand}
   */
  deleteIndex(
    args: DeleteIndexCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteIndexCommandOutput,
    Cause.TimeoutError | SdkError | InternalServerError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link DeleteLifecyclePolicyCommand}
   */
  deleteLifecyclePolicy(
    args: DeleteLifecyclePolicyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteLifecyclePolicyCommandOutput,
    Cause.TimeoutError | SdkError | ConflictError | InternalServerError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link DeleteSecurityConfigCommand}
   */
  deleteSecurityConfig(
    args: DeleteSecurityConfigCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteSecurityConfigCommandOutput,
    Cause.TimeoutError | SdkError | ConflictError | InternalServerError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link DeleteSecurityPolicyCommand}
   */
  deleteSecurityPolicy(
    args: DeleteSecurityPolicyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteSecurityPolicyCommandOutput,
    Cause.TimeoutError | SdkError | ConflictError | InternalServerError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link DeleteVpcEndpointCommand}
   */
  deleteVpcEndpoint(
    args: DeleteVpcEndpointCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteVpcEndpointCommandOutput,
    Cause.TimeoutError | SdkError | ConflictError | InternalServerError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link GetAccessPolicyCommand}
   */
  getAccessPolicy(
    args: GetAccessPolicyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetAccessPolicyCommandOutput,
    Cause.TimeoutError | SdkError | InternalServerError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link GetAccountSettingsCommand}
   */
  getAccountSettings(
    args: GetAccountSettingsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetAccountSettingsCommandOutput,
    Cause.TimeoutError | SdkError | InternalServerError | ValidationError
  >

  /**
   * @see {@link GetIndexCommand}
   */
  getIndex(
    args: GetIndexCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetIndexCommandOutput,
    Cause.TimeoutError | SdkError | InternalServerError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link GetPoliciesStatsCommand}
   */
  getPoliciesStats(
    args: GetPoliciesStatsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<GetPoliciesStatsCommandOutput, Cause.TimeoutError | SdkError | InternalServerError>

  /**
   * @see {@link GetSecurityConfigCommand}
   */
  getSecurityConfig(
    args: GetSecurityConfigCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetSecurityConfigCommandOutput,
    Cause.TimeoutError | SdkError | InternalServerError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link GetSecurityPolicyCommand}
   */
  getSecurityPolicy(
    args: GetSecurityPolicyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetSecurityPolicyCommandOutput,
    Cause.TimeoutError | SdkError | InternalServerError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link ListAccessPoliciesCommand}
   */
  listAccessPolicies(
    args: ListAccessPoliciesCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListAccessPoliciesCommandOutput,
    Cause.TimeoutError | SdkError | InternalServerError | ValidationError
  >

  listAccessPoliciesStream(
    args: ListAccessPoliciesCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListAccessPoliciesCommandOutput,
    Cause.TimeoutError | SdkError | InternalServerError | ValidationError
  >

  /**
   * @see {@link ListCollectionGroupsCommand}
   */
  listCollectionGroups(
    args: ListCollectionGroupsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListCollectionGroupsCommandOutput,
    Cause.TimeoutError | SdkError | InternalServerError | ValidationError
  >

  listCollectionGroupsStream(
    args: ListCollectionGroupsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListCollectionGroupsCommandOutput,
    Cause.TimeoutError | SdkError | InternalServerError | ValidationError
  >

  /**
   * @see {@link ListCollectionsCommand}
   */
  listCollections(
    args: ListCollectionsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<ListCollectionsCommandOutput, Cause.TimeoutError | SdkError | InternalServerError | ValidationError>

  listCollectionsStream(
    args: ListCollectionsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<ListCollectionsCommandOutput, Cause.TimeoutError | SdkError | InternalServerError | ValidationError>

  /**
   * @see {@link ListLifecyclePoliciesCommand}
   */
  listLifecyclePolicies(
    args: ListLifecyclePoliciesCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListLifecyclePoliciesCommandOutput,
    Cause.TimeoutError | SdkError | InternalServerError | ValidationError
  >

  listLifecyclePoliciesStream(
    args: ListLifecyclePoliciesCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListLifecyclePoliciesCommandOutput,
    Cause.TimeoutError | SdkError | InternalServerError | ValidationError
  >

  /**
   * @see {@link ListSecurityConfigsCommand}
   */
  listSecurityConfigs(
    args: ListSecurityConfigsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListSecurityConfigsCommandOutput,
    Cause.TimeoutError | SdkError | InternalServerError | ValidationError
  >

  listSecurityConfigsStream(
    args: ListSecurityConfigsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListSecurityConfigsCommandOutput,
    Cause.TimeoutError | SdkError | InternalServerError | ValidationError
  >

  /**
   * @see {@link ListSecurityPoliciesCommand}
   */
  listSecurityPolicies(
    args: ListSecurityPoliciesCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListSecurityPoliciesCommandOutput,
    Cause.TimeoutError | SdkError | InternalServerError | ValidationError
  >

  listSecurityPoliciesStream(
    args: ListSecurityPoliciesCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListSecurityPoliciesCommandOutput,
    Cause.TimeoutError | SdkError | InternalServerError | ValidationError
  >

  /**
   * @see {@link ListTagsForResourceCommand}
   */
  listTagsForResource(
    args: ListTagsForResourceCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListTagsForResourceCommandOutput,
    Cause.TimeoutError | SdkError | InternalServerError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link ListVpcEndpointsCommand}
   */
  listVpcEndpoints(
    args: ListVpcEndpointsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<ListVpcEndpointsCommandOutput, Cause.TimeoutError | SdkError | InternalServerError | ValidationError>

  listVpcEndpointsStream(
    args: ListVpcEndpointsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<ListVpcEndpointsCommandOutput, Cause.TimeoutError | SdkError | InternalServerError | ValidationError>

  /**
   * @see {@link TagResourceCommand}
   */
  tagResource(
    args: TagResourceCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    TagResourceCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | ConflictError
    | InternalServerError
    | ResourceNotFoundError
    | ServiceQuotaExceededError
    | ValidationError
  >

  /**
   * @see {@link UntagResourceCommand}
   */
  untagResource(
    args: UntagResourceCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UntagResourceCommandOutput,
    Cause.TimeoutError | SdkError | ConflictError | InternalServerError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link UpdateAccessPolicyCommand}
   */
  updateAccessPolicy(
    args: UpdateAccessPolicyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateAccessPolicyCommandOutput,
    Cause.TimeoutError | SdkError | ConflictError | InternalServerError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link UpdateAccountSettingsCommand}
   */
  updateAccountSettings(
    args: UpdateAccountSettingsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateAccountSettingsCommandOutput,
    Cause.TimeoutError | SdkError | InternalServerError | ServiceQuotaExceededError | ValidationError
  >

  /**
   * @see {@link UpdateCollectionCommand}
   */
  updateCollection(
    args: UpdateCollectionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateCollectionCommandOutput,
    Cause.TimeoutError | SdkError | ConflictError | InternalServerError | ValidationError
  >

  /**
   * @see {@link UpdateCollectionGroupCommand}
   */
  updateCollectionGroup(
    args: UpdateCollectionGroupCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateCollectionGroupCommandOutput,
    Cause.TimeoutError | SdkError | ConflictError | InternalServerError | ServiceQuotaExceededError | ValidationError
  >

  /**
   * @see {@link UpdateIndexCommand}
   */
  updateIndex(
    args: UpdateIndexCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateIndexCommandOutput,
    Cause.TimeoutError | SdkError | InternalServerError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link UpdateLifecyclePolicyCommand}
   */
  updateLifecyclePolicy(
    args: UpdateLifecyclePolicyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateLifecyclePolicyCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | ConflictError
    | InternalServerError
    | ResourceNotFoundError
    | ServiceQuotaExceededError
    | ValidationError
  >

  /**
   * @see {@link UpdateSecurityConfigCommand}
   */
  updateSecurityConfig(
    args: UpdateSecurityConfigCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateSecurityConfigCommandOutput,
    Cause.TimeoutError | SdkError | ConflictError | InternalServerError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link UpdateSecurityPolicyCommand}
   */
  updateSecurityPolicy(
    args: UpdateSecurityPolicyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateSecurityPolicyCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | ConflictError
    | InternalServerError
    | ResourceNotFoundError
    | ServiceQuotaExceededError
    | ValidationError
  >

  /**
   * @see {@link UpdateVpcEndpointCommand}
   */
  updateVpcEndpoint(
    args: UpdateVpcEndpointCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateVpcEndpointCommandOutput,
    Cause.TimeoutError | SdkError | ConflictError | InternalServerError | ValidationError
  >
}

Added in v1.0.0

utils

OpenSearchServerlessService (namespace)

Added in v1.0.0

Config (interface)

Signature

export interface Config extends Omit<OpenSearchServerlessClientConfig, "logger"> {
  readonly logger?: ServiceLogger.ServiceLoggerConstructorProps | true
}

Added in v1.0.0

Type (type alias)

Signature

export type Type = OpenSearchServerlessService$

Added in v1.0.0