| Copyright | (c) 2013-2015 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 |
Network.AWS.CloudSearch.DescribeIndexFields
Description
Gets information about the index fields configured for the search
domain. Can be limited to specific fields by name. By default, shows all
fields 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
Getting Domain Information
in the Amazon CloudSearch Developer Guide.
See: AWS API Reference for DescribeIndexFields.
- describeIndexFields :: Text -> DescribeIndexFields
- data DescribeIndexFields
- difDeployed :: Lens' DescribeIndexFields (Maybe Bool)
- difFieldNames :: Lens' DescribeIndexFields [Text]
- difDomainName :: Lens' DescribeIndexFields Text
- describeIndexFieldsResponse :: Int -> DescribeIndexFieldsResponse
- data DescribeIndexFieldsResponse
- difsrsResponseStatus :: Lens' DescribeIndexFieldsResponse Int
- difsrsIndexFields :: Lens' DescribeIndexFieldsResponse [IndexFieldStatus]
Creating a Request
Arguments
| :: Text | |
| -> DescribeIndexFields |
Creates a value of DescribeIndexFields with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeIndexFields Source
Container for the parameters to the DescribeIndexFields operation.
Specifies the name of the domain you want to describe. To restrict the
response to particular index fields, specify the names of the index
fields you want to describe. To show the active configuration and
exclude any pending changes, set the Deployed option to true.
See: describeIndexFields smart constructor.
Instances
Request Lenses
difDeployed :: Lens' DescribeIndexFields (Maybe Bool) Source
Whether to display the deployed configuration (true) or include any
pending changes (false). Defaults to false.
difFieldNames :: Lens' DescribeIndexFields [Text] Source
A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.
difDomainName :: Lens' DescribeIndexFields Text Source
The name of the domain you want to describe.
Destructuring the Response
describeIndexFieldsResponse Source
Arguments
| :: Int | |
| -> DescribeIndexFieldsResponse |
Creates a value of DescribeIndexFieldsResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeIndexFieldsResponse Source
The result of a DescribeIndexFields request. Contains the index fields
configured for the domain specified in the request.
See: describeIndexFieldsResponse smart constructor.
Response Lenses
difsrsResponseStatus :: Lens' DescribeIndexFieldsResponse Int Source
The response status code.
difsrsIndexFields :: Lens' DescribeIndexFieldsResponse [IndexFieldStatus] Source
The index fields configured for the domain.