Class: Aws::CloudSearch::Types::DescribeAnalysisSchemesRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb

Overview

Note:

When making an API call, you may pass DescribeAnalysisSchemesRequest data as a hash:

{
  domain_name: "DomainName", # required
  analysis_scheme_names: ["StandardName"],
  deployed: false,
}

Container for the parameters to the DescribeAnalysisSchemes operation. Specifies the name of the domain you want to describe. To limit the response to particular analysis schemes, specify the names of the analysis schemes you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#analysis_scheme_namesArray<String>

The analysis schemes you want to describe.

Returns:

  • (Array<String>)


927
928
929
930
931
932
933
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 927

class DescribeAnalysisSchemesRequest < Struct.new(
  :domain_name,
  :analysis_scheme_names,
  :deployed)
  SENSITIVE = []
  include Aws::Structure
end

#deployedBoolean

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

Returns:

  • (Boolean)


927
928
929
930
931
932
933
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 927

class DescribeAnalysisSchemesRequest < Struct.new(
  :domain_name,
  :analysis_scheme_names,
  :deployed)
  SENSITIVE = []
  include Aws::Structure
end

#domain_nameString

The name of the domain you want to describe.

Returns:

  • (String)


927
928
929
930
931
932
933
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 927

class DescribeAnalysisSchemesRequest < Struct.new(
  :domain_name,
  :analysis_scheme_names,
  :deployed)
  SENSITIVE = []
  include Aws::Structure
end