You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CloudSearch::Types::DescribeExpressionsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudSearch::Types::DescribeExpressionsRequest
- Defined in:
- (unknown)
Overview
When passing DescribeExpressionsRequest as input to an Aws::Client method, you can use a vanilla 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
-
#deployed ⇒ Boolean
Whether to display the deployed configuration (
true
) or include any pending changes (false
). -
#domain_name ⇒ String
The name of the domain you want to describe.
-
#expression_names ⇒ Array<String>
Limits the
DescribeExpressions
response to the specified expressions.
Instance Attribute Details
#deployed ⇒ Boolean
Whether to display the deployed configuration (true
) or include any
pending changes (false
). Defaults to false
.
#domain_name ⇒ String
The name of the domain you want to describe.
#expression_names ⇒ Array<String>
Limits the DescribeExpressions
response to the specified expressions.
If not specified, all expressions are shown.