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

OpenSearchService overview

Added in v1.0.0


Table of contents


constructors

makeOpenSearchService

Signature

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

Added in v1.0.0

models

OpenSearchService (class)

Signature

export declare class OpenSearchService

Added in v1.0.0

OpenSearchService$ (interface)

Signature

export interface OpenSearchService$ {
  /**
   * @see {@link AcceptInboundConnectionCommand}
   */
  acceptInboundConnection(
    args: AcceptInboundConnectionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    AcceptInboundConnectionCommandOutput,
    Cause.TimeoutError | SdkError | DisabledOperationError | LimitExceededError | ResourceNotFoundError
  >

  /**
   * @see {@link AddDataSourceCommand}
   */
  addDataSource(
    args: AddDataSourceCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    AddDataSourceCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | DependencyFailureError
    | DisabledOperationError
    | InternalError
    | LimitExceededError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link AddDirectQueryDataSourceCommand}
   */
  addDirectQueryDataSource(
    args: AddDirectQueryDataSourceCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    AddDirectQueryDataSourceCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | DisabledOperationError
    | InternalError
    | LimitExceededError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link AddTagsCommand}
   */
  addTags(
    args: AddTagsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    AddTagsCommandOutput,
    Cause.TimeoutError | SdkError | BaseError | InternalError | LimitExceededError | ValidationError
  >

  /**
   * @see {@link AssociatePackageCommand}
   */
  associatePackage(
    args: AssociatePackageCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    AssociatePackageCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | BaseError
    | ConflictError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link AssociatePackagesCommand}
   */
  associatePackages(
    args: AssociatePackagesCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    AssociatePackagesCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | ConflictError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link AttachDataSourceCommand}
   */
  attachDataSource(
    args: AttachDataSourceCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    AttachDataSourceCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | ConflictError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link AuthorizeVpcEndpointAccessCommand}
   */
  authorizeVpcEndpointAccess(
    args: AuthorizeVpcEndpointAccessCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    AuthorizeVpcEndpointAccessCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | DisabledOperationError
    | InternalError
    | LimitExceededError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link CancelDomainConfigChangeCommand}
   */
  cancelDomainConfigChange(
    args: CancelDomainConfigChangeCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CancelDomainConfigChangeCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link CancelServiceSoftwareUpdateCommand}
   */
  cancelServiceSoftwareUpdate(
    args: CancelServiceSoftwareUpdateCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CancelServiceSoftwareUpdateCommandOutput,
    Cause.TimeoutError | SdkError | BaseError | InternalError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link CreateApplicationCommand}
   */
  createApplication(
    args: CreateApplicationCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateApplicationCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | BaseError
    | ConflictError
    | DisabledOperationError
    | InternalError
    | ValidationError
  >

  /**
   * @see {@link CreateDomainCommand}
   */
  createDomain(
    args: CreateDomainCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateDomainCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | DisabledOperationError
    | InternalError
    | InvalidTypeError
    | LimitExceededError
    | ResourceAlreadyExistsError
    | ValidationError
  >

  /**
   * @see {@link CreateIndexCommand}
   */
  createIndex(
    args: CreateIndexCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateIndexCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | DependencyFailureError
    | DisabledOperationError
    | InternalError
    | ResourceAlreadyExistsError
    | ResourceNotFoundError
    | ThrottlingError
    | ValidationError
  >

  /**
   * @see {@link CreateOutboundConnectionCommand}
   */
  createOutboundConnection(
    args: CreateOutboundConnectionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateOutboundConnectionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DisabledOperationError
    | InternalError
    | LimitExceededError
    | ResourceAlreadyExistsError
  >

  /**
   * @see {@link CreatePackageCommand}
   */
  createPackage(
    args: CreatePackageCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreatePackageCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | BaseError
    | InternalError
    | InvalidTypeError
    | LimitExceededError
    | ResourceAlreadyExistsError
    | ValidationError
  >

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

  /**
   * @see {@link DeleteApplicationCommand}
   */
  deleteApplication(
    args: DeleteApplicationCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteApplicationCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | BaseError
    | ConflictError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link DeleteDataSourceCommand}
   */
  deleteDataSource(
    args: DeleteDataSourceCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteDataSourceCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | DependencyFailureError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link DeleteDirectQueryDataSourceCommand}
   */
  deleteDirectQueryDataSource(
    args: DeleteDirectQueryDataSourceCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteDirectQueryDataSourceCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link DeleteDomainCommand}
   */
  deleteDomain(
    args: DeleteDomainCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteDomainCommandOutput,
    Cause.TimeoutError | SdkError | BaseError | InternalError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link DeleteInboundConnectionCommand}
   */
  deleteInboundConnection(
    args: DeleteInboundConnectionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteInboundConnectionCommandOutput,
    Cause.TimeoutError | SdkError | DisabledOperationError | ResourceNotFoundError
  >

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

  /**
   * @see {@link DeleteOutboundConnectionCommand}
   */
  deleteOutboundConnection(
    args: DeleteOutboundConnectionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteOutboundConnectionCommandOutput,
    Cause.TimeoutError | SdkError | DisabledOperationError | ResourceNotFoundError
  >

  /**
   * @see {@link DeletePackageCommand}
   */
  deletePackage(
    args: DeletePackageCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeletePackageCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | BaseError
    | ConflictError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

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

  /**
   * @see {@link DeregisterCapabilityCommand}
   */
  deregisterCapability(
    args: DeregisterCapabilityCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeregisterCapabilityCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | ConflictError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link DescribeDataSourceAttachmentCommand}
   */
  describeDataSourceAttachment(
    args: DescribeDataSourceAttachmentCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeDataSourceAttachmentCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link DescribeDomainCommand}
   */
  describeDomain(
    args: DescribeDomainCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeDomainCommandOutput,
    Cause.TimeoutError | SdkError | BaseError | InternalError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link DescribeDomainAutoTunesCommand}
   */
  describeDomainAutoTunes(
    args: DescribeDomainAutoTunesCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeDomainAutoTunesCommandOutput,
    Cause.TimeoutError | SdkError | BaseError | InternalError | ResourceNotFoundError | ValidationError
  >

  describeDomainAutoTunesStream(
    args: DescribeDomainAutoTunesCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    DescribeDomainAutoTunesCommandOutput,
    Cause.TimeoutError | SdkError | BaseError | InternalError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link DescribeDomainChangeProgressCommand}
   */
  describeDomainChangeProgress(
    args: DescribeDomainChangeProgressCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeDomainChangeProgressCommandOutput,
    Cause.TimeoutError | SdkError | BaseError | InternalError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link DescribeDomainConfigCommand}
   */
  describeDomainConfig(
    args: DescribeDomainConfigCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeDomainConfigCommandOutput,
    Cause.TimeoutError | SdkError | BaseError | InternalError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link DescribeDomainHealthCommand}
   */
  describeDomainHealth(
    args: DescribeDomainHealthCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeDomainHealthCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link DescribeDomainNodesCommand}
   */
  describeDomainNodes(
    args: DescribeDomainNodesCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeDomainNodesCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | DependencyFailureError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link DescribeDomainsCommand}
   */
  describeDomains(
    args: DescribeDomainsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeDomainsCommandOutput,
    Cause.TimeoutError | SdkError | BaseError | InternalError | ValidationError
  >

  /**
   * @see {@link DescribeDryRunProgressCommand}
   */
  describeDryRunProgress(
    args: DescribeDryRunProgressCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeDryRunProgressCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link DescribeInboundConnectionsCommand}
   */
  describeInboundConnections(
    args: DescribeInboundConnectionsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeInboundConnectionsCommandOutput,
    Cause.TimeoutError | SdkError | DisabledOperationError | InvalidPaginationTokenError
  >

  describeInboundConnectionsStream(
    args: DescribeInboundConnectionsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    DescribeInboundConnectionsCommandOutput,
    Cause.TimeoutError | SdkError | DisabledOperationError | InvalidPaginationTokenError
  >

  /**
   * @see {@link DescribeInsightDetailsCommand}
   */
  describeInsightDetails(
    args: DescribeInsightDetailsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeInsightDetailsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | DisabledOperationError
    | InternalError
    | LimitExceededError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link DescribeInstanceTypeLimitsCommand}
   */
  describeInstanceTypeLimits(
    args: DescribeInstanceTypeLimitsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeInstanceTypeLimitsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | InternalError
    | InvalidTypeError
    | LimitExceededError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link DescribeOutboundConnectionsCommand}
   */
  describeOutboundConnections(
    args: DescribeOutboundConnectionsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeOutboundConnectionsCommandOutput,
    Cause.TimeoutError | SdkError | DisabledOperationError | InvalidPaginationTokenError
  >

  describeOutboundConnectionsStream(
    args: DescribeOutboundConnectionsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    DescribeOutboundConnectionsCommandOutput,
    Cause.TimeoutError | SdkError | DisabledOperationError | InvalidPaginationTokenError
  >

  /**
   * @see {@link DescribePackagesCommand}
   */
  describePackages(
    args: DescribePackagesCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribePackagesCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | BaseError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  describePackagesStream(
    args: DescribePackagesCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    DescribePackagesCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | BaseError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link DescribeReservedInstanceOfferingsCommand}
   */
  describeReservedInstanceOfferings(
    args: DescribeReservedInstanceOfferingsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeReservedInstanceOfferingsCommandOutput,
    Cause.TimeoutError | SdkError | DisabledOperationError | InternalError | ResourceNotFoundError | ValidationError
  >

  describeReservedInstanceOfferingsStream(
    args: DescribeReservedInstanceOfferingsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    DescribeReservedInstanceOfferingsCommandOutput,
    Cause.TimeoutError | SdkError | DisabledOperationError | InternalError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link DescribeReservedInstancesCommand}
   */
  describeReservedInstances(
    args: DescribeReservedInstancesCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeReservedInstancesCommandOutput,
    Cause.TimeoutError | SdkError | DisabledOperationError | InternalError | ResourceNotFoundError | ValidationError
  >

  describeReservedInstancesStream(
    args: DescribeReservedInstancesCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    DescribeReservedInstancesCommandOutput,
    Cause.TimeoutError | SdkError | DisabledOperationError | InternalError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link DescribeVpcEndpointsCommand}
   */
  describeVpcEndpoints(
    args: DescribeVpcEndpointsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeVpcEndpointsCommandOutput,
    Cause.TimeoutError | SdkError | BaseError | DisabledOperationError | InternalError | ValidationError
  >

  /**
   * @see {@link DetachDataSourceCommand}
   */
  detachDataSource(
    args: DetachDataSourceCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DetachDataSourceCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | ConflictError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link DissociatePackageCommand}
   */
  dissociatePackage(
    args: DissociatePackageCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DissociatePackageCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | BaseError
    | ConflictError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link DissociatePackagesCommand}
   */
  dissociatePackages(
    args: DissociatePackagesCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DissociatePackagesCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | ConflictError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link GetApplicationCommand}
   */
  getApplication(
    args: GetApplicationCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetApplicationCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | BaseError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link GetCapabilityCommand}
   */
  getCapability(
    args: GetCapabilityCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetCapabilityCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link GetCompatibleVersionsCommand}
   */
  getCompatibleVersions(
    args: GetCompatibleVersionsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetCompatibleVersionsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link GetDataSourceCommand}
   */
  getDataSource(
    args: GetDataSourceCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetDataSourceCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | DependencyFailureError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link GetDefaultApplicationSettingCommand}
   */
  getDefaultApplicationSetting(
    args: GetDefaultApplicationSettingCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetDefaultApplicationSettingCommandOutput,
    Cause.TimeoutError | SdkError | AccessDeniedError | InternalError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link GetDirectQueryDataSourceCommand}
   */
  getDirectQueryDataSource(
    args: GetDirectQueryDataSourceCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetDirectQueryDataSourceCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link GetDomainMaintenanceStatusCommand}
   */
  getDomainMaintenanceStatus(
    args: GetDomainMaintenanceStatusCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetDomainMaintenanceStatusCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

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

  /**
   * @see {@link GetMigrationCommand}
   */
  getMigration(
    args: GetMigrationCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetMigrationCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link GetPackageVersionHistoryCommand}
   */
  getPackageVersionHistory(
    args: GetPackageVersionHistoryCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetPackageVersionHistoryCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | BaseError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  getPackageVersionHistoryStream(
    args: GetPackageVersionHistoryCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    GetPackageVersionHistoryCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | BaseError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link GetUpgradeHistoryCommand}
   */
  getUpgradeHistory(
    args: GetUpgradeHistoryCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetUpgradeHistoryCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  getUpgradeHistoryStream(
    args: GetUpgradeHistoryCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    GetUpgradeHistoryCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link GetUpgradeStatusCommand}
   */
  getUpgradeStatus(
    args: GetUpgradeStatusCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetUpgradeStatusCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link InsightFeedbackCommand}
   */
  insightFeedback(
    args: InsightFeedbackCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    InsightFeedbackCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | DisabledOperationError
    | InternalError
    | LimitExceededError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link ListApplicationsCommand}
   */
  listApplications(
    args: ListApplicationsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListApplicationsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | BaseError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  listApplicationsStream(
    args: ListApplicationsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListApplicationsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | BaseError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link ListDataSourceAttachmentsCommand}
   */
  listDataSourceAttachments(
    args: ListDataSourceAttachmentsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListDataSourceAttachmentsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link ListDataSourcesCommand}
   */
  listDataSources(
    args: ListDataSourcesCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListDataSourcesCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | DependencyFailureError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link ListDirectQueryDataSourcesCommand}
   */
  listDirectQueryDataSources(
    args: ListDirectQueryDataSourcesCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListDirectQueryDataSourcesCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link ListDomainMaintenancesCommand}
   */
  listDomainMaintenances(
    args: ListDomainMaintenancesCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListDomainMaintenancesCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  listDomainMaintenancesStream(
    args: ListDomainMaintenancesCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListDomainMaintenancesCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link ListDomainNamesCommand}
   */
  listDomainNames(
    args: ListDomainNamesCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<ListDomainNamesCommandOutput, Cause.TimeoutError | SdkError | BaseError | ValidationError>

  /**
   * @see {@link ListDomainsForPackageCommand}
   */
  listDomainsForPackage(
    args: ListDomainsForPackageCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListDomainsForPackageCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | BaseError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  listDomainsForPackageStream(
    args: ListDomainsForPackageCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListDomainsForPackageCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | BaseError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link ListInsightsCommand}
   */
  listInsights(
    args: ListInsightsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListInsightsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | DisabledOperationError
    | InternalError
    | LimitExceededError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link ListInstanceTypeDetailsCommand}
   */
  listInstanceTypeDetails(
    args: ListInstanceTypeDetailsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListInstanceTypeDetailsCommandOutput,
    Cause.TimeoutError | SdkError | BaseError | InternalError | ResourceNotFoundError | ValidationError
  >

  listInstanceTypeDetailsStream(
    args: ListInstanceTypeDetailsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListInstanceTypeDetailsCommandOutput,
    Cause.TimeoutError | SdkError | BaseError | InternalError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link ListMigrationsCommand}
   */
  listMigrations(
    args: ListMigrationsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListMigrationsCommandOutput,
    Cause.TimeoutError | SdkError | AccessDeniedError | DisabledOperationError | InternalError | ValidationError
  >

  /**
   * @see {@link ListPackagesForDomainCommand}
   */
  listPackagesForDomain(
    args: ListPackagesForDomainCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListPackagesForDomainCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | BaseError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  listPackagesForDomainStream(
    args: ListPackagesForDomainCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListPackagesForDomainCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | BaseError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link ListScheduledActionsCommand}
   */
  listScheduledActions(
    args: ListScheduledActionsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListScheduledActionsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | InternalError
    | InvalidPaginationTokenError
    | ResourceNotFoundError
    | ValidationError
  >

  listScheduledActionsStream(
    args: ListScheduledActionsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListScheduledActionsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | InternalError
    | InvalidPaginationTokenError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link ListTagsCommand}
   */
  listTags(
    args: ListTagsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListTagsCommandOutput,
    Cause.TimeoutError | SdkError | BaseError | InternalError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link ListVersionsCommand}
   */
  listVersions(
    args: ListVersionsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListVersionsCommandOutput,
    Cause.TimeoutError | SdkError | BaseError | InternalError | ResourceNotFoundError | ValidationError
  >

  listVersionsStream(
    args: ListVersionsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListVersionsCommandOutput,
    Cause.TimeoutError | SdkError | BaseError | InternalError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link ListVpcEndpointAccessCommand}
   */
  listVpcEndpointAccess(
    args: ListVpcEndpointAccessCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListVpcEndpointAccessCommandOutput,
    Cause.TimeoutError | SdkError | BaseError | DisabledOperationError | InternalError | ResourceNotFoundError
  >

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

  /**
   * @see {@link ListVpcEndpointsForDomainCommand}
   */
  listVpcEndpointsForDomain(
    args: ListVpcEndpointsForDomainCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListVpcEndpointsForDomainCommandOutput,
    Cause.TimeoutError | SdkError | BaseError | DisabledOperationError | InternalError | ResourceNotFoundError
  >

  /**
   * @see {@link PurchaseReservedInstanceOfferingCommand}
   */
  purchaseReservedInstanceOffering(
    args: PurchaseReservedInstanceOfferingCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    PurchaseReservedInstanceOfferingCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DisabledOperationError
    | InternalError
    | LimitExceededError
    | ResourceAlreadyExistsError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link PutDefaultApplicationSettingCommand}
   */
  putDefaultApplicationSetting(
    args: PutDefaultApplicationSettingCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    PutDefaultApplicationSettingCommandOutput,
    Cause.TimeoutError | SdkError | AccessDeniedError | InternalError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link RegisterCapabilityCommand}
   */
  registerCapability(
    args: RegisterCapabilityCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    RegisterCapabilityCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | ConflictError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ServiceQuotaExceededError
    | ValidationError
  >

  /**
   * @see {@link RejectInboundConnectionCommand}
   */
  rejectInboundConnection(
    args: RejectInboundConnectionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    RejectInboundConnectionCommandOutput,
    Cause.TimeoutError | SdkError | DisabledOperationError | ResourceNotFoundError
  >

  /**
   * @see {@link RemoveTagsCommand}
   */
  removeTags(
    args: RemoveTagsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<RemoveTagsCommandOutput, Cause.TimeoutError | SdkError | BaseError | InternalError | ValidationError>

  /**
   * @see {@link RevokeVpcEndpointAccessCommand}
   */
  revokeVpcEndpointAccess(
    args: RevokeVpcEndpointAccessCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    RevokeVpcEndpointAccessCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link RollbackServiceSoftwareUpdateCommand}
   */
  rollbackServiceSoftwareUpdate(
    args: RollbackServiceSoftwareUpdateCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    RollbackServiceSoftwareUpdateCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link StartDomainMaintenanceCommand}
   */
  startDomainMaintenance(
    args: StartDomainMaintenanceCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    StartDomainMaintenanceCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link StartMigrationCommand}
   */
  startMigration(
    args: StartMigrationCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    StartMigrationCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | ConflictError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link StartServiceSoftwareUpdateCommand}
   */
  startServiceSoftwareUpdate(
    args: StartServiceSoftwareUpdateCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    StartServiceSoftwareUpdateCommandOutput,
    Cause.TimeoutError | SdkError | BaseError | InternalError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link UpdateApplicationCommand}
   */
  updateApplication(
    args: UpdateApplicationCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateApplicationCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | BaseError
    | ConflictError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link UpdateDataSourceCommand}
   */
  updateDataSource(
    args: UpdateDataSourceCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateDataSourceCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | DependencyFailureError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link UpdateDirectQueryDataSourceCommand}
   */
  updateDirectQueryDataSource(
    args: UpdateDirectQueryDataSourceCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateDirectQueryDataSourceCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | DisabledOperationError
    | InternalError
    | LimitExceededError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link UpdateDomainConfigCommand}
   */
  updateDomainConfig(
    args: UpdateDomainConfigCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateDomainConfigCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | InternalError
    | InvalidTypeError
    | LimitExceededError
    | ResourceNotFoundError
    | ValidationError
  >

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

  /**
   * @see {@link UpdatePackageCommand}
   */
  updatePackage(
    args: UpdatePackageCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdatePackageCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | BaseError
    | InternalError
    | LimitExceededError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link UpdatePackageScopeCommand}
   */
  updatePackageScope(
    args: UpdatePackageScopeCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdatePackageScopeCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | DisabledOperationError
    | InternalError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link UpdateScheduledActionCommand}
   */
  updateScheduledAction(
    args: UpdateScheduledActionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateScheduledActionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | ConflictError
    | InternalError
    | LimitExceededError
    | ResourceNotFoundError
    | SlotNotAvailableError
    | ValidationError
  >

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

  /**
   * @see {@link UpgradeDomainCommand}
   */
  upgradeDomain(
    args: UpgradeDomainCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpgradeDomainCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | DisabledOperationError
    | InternalError
    | ResourceAlreadyExistsError
    | ResourceNotFoundError
    | ValidationError
  >
}

Added in v1.0.0

utils

OpenSearchService (namespace)

Added in v1.0.0

Config (interface)

Signature

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

Added in v1.0.0

Type (type alias)

Signature

export type Type = OpenSearchService$

Added in v1.0.0