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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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`.

Constant Summary collapse

SENSITIVE =
[]

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)

1099
1100
1101
1102
1103
1104
1105
# File 'lib/aws-sdk-cloudsearch/types.rb', line 1099

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

#domain_nameString

The name of the domain you want to describe.

Returns:

  • (String)

1099
1100
1101
1102
1103
1104
1105
# File 'lib/aws-sdk-cloudsearch/types.rb', line 1099

class DescribeExpressionsRequest < Struct.new(
  :domain_name,
  :expression_names,
  :deployed)
  SENSITIVE = []
  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>)

1099
1100
1101
1102
1103
1104
1105
# File 'lib/aws-sdk-cloudsearch/types.rb', line 1099

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