Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions and includes any pending changes to the configuration. Set the Deployed
option to true
to show the active configuration and exclude pending changes. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide .
- describeExpressions :: Text -> DescribeExpressions
- data DescribeExpressions
- deDeployed :: Lens' DescribeExpressions (Maybe Bool)
- deExpressionNames :: Lens' DescribeExpressions [Text]
- deDomainName :: Lens' DescribeExpressions Text
- describeExpressionsResponse :: Int -> DescribeExpressionsResponse
- data DescribeExpressionsResponse
- drsResponseStatus :: Lens' DescribeExpressionsResponse Int
- drsExpressions :: Lens' DescribeExpressionsResponse [ExpressionStatus]
Creating a Request
Creates a value of DescribeExpressions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
deDeployed
- Whether to display the deployed configuration (true
) or include any pending changes (false
). Defaults tofalse
.deExpressionNames
- Limits the
response to the specified expressions. If not specified, all expressions are shown.DescribeExpressions
deDomainName
- The name of the domain you want to describe.
data DescribeExpressions Source #
Container for the parameters to the
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 DescribeDomains
Deployed
option to true
.
See: describeExpressions
smart constructor.
Request Lenses
deDeployed :: Lens' DescribeExpressions (Maybe Bool) Source #
Whether to display the deployed configuration (true
) or include any pending changes (false
). Defaults to false
.
deExpressionNames :: Lens' DescribeExpressions [Text] Source #
Limits the
response to the specified expressions. If not specified, all expressions are shown.DescribeExpressions
deDomainName :: Lens' DescribeExpressions Text Source #
The name of the domain you want to describe.
Destructuring the Response
describeExpressionsResponse Source #
Creates a value of DescribeExpressionsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
drsResponseStatus
- -- | The response status code.drsExpressions
- The expressions configured for the domain.
data DescribeExpressionsResponse Source #
The result of a DescribeExpressions
request. Contains the expressions configured for the domain specified in the request.
See: describeExpressionsResponse
smart constructor.
Response Lenses
drsResponseStatus :: Lens' DescribeExpressionsResponse Int Source #
- - | The response status code.
drsExpressions :: Lens' DescribeExpressionsResponse [ExpressionStatus] Source #
The expressions configured for the domain.