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

Class: Aws::CloudSearch::Types::DescribeExpressionsRequest

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 DescribeExpressionsRequest data as a hash:

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

Container for the parameters to the DescribeDomains operation. Specifies the name of the domain you want to describe. To restrict the response to particular expressions, specify the names of the expressions 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

#deployedBoolean

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

Returns:

  • (Boolean)


1002
1003
1004
1005
1006
1007
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1002

class DescribeExpressionsRequest < Struct.new(
  :domain_name,
  :expression_names,
  :deployed)
  include Aws::Structure
end

#domain_nameString

The name of the domain you want to describe.

Returns:

  • (String)


1002
1003
1004
1005
1006
1007
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1002

class DescribeExpressionsRequest < Struct.new(
  :domain_name,
  :expression_names,
  :deployed)
  include Aws::Structure
end

#expression_namesArray<String>

Limits the DescribeExpressions response to the specified expressions. If not specified, all expressions are shown.

Returns:

  • (Array<String>)


1002
1003
1004
1005
1006
1007
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1002

class DescribeExpressionsRequest < Struct.new(
  :domain_name,
  :expression_names,
  :deployed)
  include Aws::Structure
end