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

CloudSearchService overview

Added in v1.0.0


Table of contents


constructors

makeCloudSearchService

Signature

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

Added in v1.0.0

models

CloudSearchService (class)

Signature

export declare class CloudSearchService

Added in v1.0.0

CloudSearchService$ (interface)

Signature

export interface CloudSearchService$ {
  /**
   * @see {@link BuildSuggestersCommand}
   */
  buildSuggesters(
    args: BuildSuggestersCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    BuildSuggestersCommandOutput,
    Cause.TimeoutError | SdkError | BaseError | InternalError | ResourceNotFoundError | ValidationError
  >

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

  /**
   * @see {@link DefineAnalysisSchemeCommand}
   */
  defineAnalysisScheme(
    args: DefineAnalysisSchemeCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DefineAnalysisSchemeCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | InternalError
    | InvalidTypeError
    | LimitExceededError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link DefineExpressionCommand}
   */
  defineExpression(
    args: DefineExpressionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DefineExpressionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | InternalError
    | InvalidTypeError
    | LimitExceededError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link DefineIndexFieldCommand}
   */
  defineIndexField(
    args: DefineIndexFieldCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DefineIndexFieldCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | InternalError
    | InvalidTypeError
    | LimitExceededError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link DefineSuggesterCommand}
   */
  defineSuggester(
    args: DefineSuggesterCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DefineSuggesterCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | InternalError
    | InvalidTypeError
    | LimitExceededError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link DeleteAnalysisSchemeCommand}
   */
  deleteAnalysisScheme(
    args: DeleteAnalysisSchemeCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteAnalysisSchemeCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | InternalError
    | InvalidTypeError
    | ResourceNotFoundError
    | ValidationError
  >

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

  /**
   * @see {@link DeleteExpressionCommand}
   */
  deleteExpression(
    args: DeleteExpressionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteExpressionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | InternalError
    | InvalidTypeError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link DeleteIndexFieldCommand}
   */
  deleteIndexField(
    args: DeleteIndexFieldCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteIndexFieldCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | InternalError
    | InvalidTypeError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link DeleteSuggesterCommand}
   */
  deleteSuggester(
    args: DeleteSuggesterCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteSuggesterCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | InternalError
    | InvalidTypeError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link DescribeAnalysisSchemesCommand}
   */
  describeAnalysisSchemes(
    args: DescribeAnalysisSchemesCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeAnalysisSchemesCommandOutput,
    Cause.TimeoutError | SdkError | BaseError | InternalError | ResourceNotFoundError
  >

  /**
   * @see {@link DescribeAvailabilityOptionsCommand}
   */
  describeAvailabilityOptions(
    args: DescribeAvailabilityOptionsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeAvailabilityOptionsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | DisabledOperationError
    | InternalError
    | InvalidTypeError
    | LimitExceededError
    | ResourceNotFoundError
  >

  /**
   * @see {@link DescribeDomainEndpointOptionsCommand}
   */
  describeDomainEndpointOptions(
    args: DescribeDomainEndpointOptionsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeDomainEndpointOptionsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | DisabledOperationError
    | InternalError
    | LimitExceededError
    | ResourceNotFoundError
  >

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

  /**
   * @see {@link DescribeExpressionsCommand}
   */
  describeExpressions(
    args: DescribeExpressionsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeExpressionsCommandOutput,
    Cause.TimeoutError | SdkError | BaseError | InternalError | ResourceNotFoundError
  >

  /**
   * @see {@link DescribeIndexFieldsCommand}
   */
  describeIndexFields(
    args: DescribeIndexFieldsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeIndexFieldsCommandOutput,
    Cause.TimeoutError | SdkError | BaseError | InternalError | ResourceNotFoundError
  >

  /**
   * @see {@link DescribeScalingParametersCommand}
   */
  describeScalingParameters(
    args: DescribeScalingParametersCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeScalingParametersCommandOutput,
    Cause.TimeoutError | SdkError | BaseError | InternalError | ResourceNotFoundError
  >

  /**
   * @see {@link DescribeServiceAccessPoliciesCommand}
   */
  describeServiceAccessPolicies(
    args: DescribeServiceAccessPoliciesCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeServiceAccessPoliciesCommandOutput,
    Cause.TimeoutError | SdkError | BaseError | InternalError | ResourceNotFoundError
  >

  /**
   * @see {@link DescribeSuggestersCommand}
   */
  describeSuggesters(
    args: DescribeSuggestersCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeSuggestersCommandOutput,
    Cause.TimeoutError | SdkError | BaseError | InternalError | ResourceNotFoundError
  >

  /**
   * @see {@link IndexDocumentsCommand}
   */
  indexDocuments(
    args: IndexDocumentsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    IndexDocumentsCommandOutput,
    Cause.TimeoutError | SdkError | BaseError | InternalError | ResourceNotFoundError | ValidationError
  >

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

  /**
   * @see {@link UpdateAvailabilityOptionsCommand}
   */
  updateAvailabilityOptions(
    args: UpdateAvailabilityOptionsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateAvailabilityOptionsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | DisabledOperationError
    | InternalError
    | InvalidTypeError
    | LimitExceededError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link UpdateDomainEndpointOptionsCommand}
   */
  updateDomainEndpointOptions(
    args: UpdateDomainEndpointOptionsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateDomainEndpointOptionsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | DisabledOperationError
    | InternalError
    | InvalidTypeError
    | LimitExceededError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link UpdateScalingParametersCommand}
   */
  updateScalingParameters(
    args: UpdateScalingParametersCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateScalingParametersCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | InternalError
    | InvalidTypeError
    | LimitExceededError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link UpdateServiceAccessPoliciesCommand}
   */
  updateServiceAccessPolicies(
    args: UpdateServiceAccessPoliciesCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateServiceAccessPoliciesCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BaseError
    | InternalError
    | InvalidTypeError
    | LimitExceededError
    | ResourceNotFoundError
    | ValidationError
  >
}

Added in v1.0.0

utils

CloudSearchService (namespace)

Added in v1.0.0

Config (interface)

Signature

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

Added in v1.0.0

Type (type alias)

Signature

export type Type = CloudSearchService$

Added in v1.0.0