You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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.

Instance Attribute Summary collapse

Instance Attribute Details

#analysis_scheme_namesArray<String>

The analysis schemes you want to describe.

Returns:

  • (Array<String>)


879
880
881
882
883
884
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 879

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

#deployedBoolean

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

Returns:

  • (Boolean)


879
880
881
882
883
884
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 879

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

#domain_nameString

The name of the domain you want to describe.

Returns:

  • (String)


879
880
881
882
883
884
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 879

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