Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CloudSearch.DescribeIndexFields

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

Creating a Request

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: newDescribeIndexFields smart constructor.

Constructors

DescribeIndexFields'
Fields deployed :: Maybe Bool Whether to display the deployed configuration (`true`) or include any pending changes (`false`). Defaults to `false`. fieldNames :: Maybe [Text] A list of the index fields you want to describe. If not specified, information is returned for all configured index fields. domainName :: Text The name of the domain you want to describe.

Instances

Instances details

ToHeaders DescribeIndexFields Source #
Instance details Defined in Amazonka.CloudSearch.DescribeIndexFields Methods toHeaders :: DescribeIndexFields -> [Header] #
ToPath DescribeIndexFields Source #
Instance details Defined in Amazonka.CloudSearch.DescribeIndexFields Methods toPath :: DescribeIndexFields -> ByteString #
ToQuery DescribeIndexFields Source #
Instance details Defined in Amazonka.CloudSearch.DescribeIndexFields Methods toQuery :: DescribeIndexFields -> QueryString #
AWSRequest DescribeIndexFields Source #
Instance details Defined in Amazonka.CloudSearch.DescribeIndexFields Associated Types type AWSResponse DescribeIndexFields # Methods request :: (Service -> Service) -> DescribeIndexFields -> Request DescribeIndexFields # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeIndexFields -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeIndexFields))) #
Generic DescribeIndexFields Source #
Instance details Defined in Amazonka.CloudSearch.DescribeIndexFields Associated Types type Rep DescribeIndexFields :: Type -> Type # Methods from :: DescribeIndexFields -> Rep DescribeIndexFields x # to :: Rep DescribeIndexFields x -> DescribeIndexFields #
Read DescribeIndexFields Source #
Instance details Defined in Amazonka.CloudSearch.DescribeIndexFields Methods readsPrec :: Int -> ReadS DescribeIndexFields # readList :: ReadS [DescribeIndexFields] # readPrec :: ReadPrec DescribeIndexFields # readListPrec :: ReadPrec [DescribeIndexFields] #
Show DescribeIndexFields Source #
Instance details Defined in Amazonka.CloudSearch.DescribeIndexFields Methods showsPrec :: Int -> DescribeIndexFields -> ShowS # show :: DescribeIndexFields -> String # showList :: [DescribeIndexFields] -> ShowS #
NFData DescribeIndexFields Source #
Instance details Defined in Amazonka.CloudSearch.DescribeIndexFields Methods rnf :: DescribeIndexFields -> () #
Eq DescribeIndexFields Source #
Instance details Defined in Amazonka.CloudSearch.DescribeIndexFields Methods (==) :: DescribeIndexFields -> DescribeIndexFields -> Bool # (/=) :: DescribeIndexFields -> DescribeIndexFields -> Bool #
Hashable DescribeIndexFields Source #
Instance details Defined in Amazonka.CloudSearch.DescribeIndexFields Methods hashWithSalt :: Int -> DescribeIndexFields -> Int # hash :: DescribeIndexFields -> Int #
type AWSResponse DescribeIndexFields Source #
Instance details Defined in Amazonka.CloudSearch.DescribeIndexFields type AWSResponse DescribeIndexFields = DescribeIndexFieldsResponse
type Rep DescribeIndexFields Source #
Instance details Defined in Amazonka.CloudSearch.DescribeIndexFields type Rep DescribeIndexFields = D1 ('MetaData "DescribeIndexFields" "Amazonka.CloudSearch.DescribeIndexFields" "amazonka-cloudsearch-2.0-A2SXRDW2ivUDvdOgQgoVJQ" 'False) (C1 ('MetaCons "DescribeIndexFields'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deployed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "fieldNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDescribeIndexFields Source #

Arguments

:: Text	`DescribeIndexFields`
-> DescribeIndexFields

Create a value of DescribeIndexFields with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:deployed:DescribeIndexFields', describeIndexFields_deployed - Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

$sel:fieldNames:DescribeIndexFields', describeIndexFields_fieldNames - A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.

DescribeIndexFields, describeIndexFields_domainName - The name of the domain you want to describe.

Request Lenses

describeIndexFields_deployed :: Lens' DescribeIndexFields (Maybe Bool) Source #

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

describeIndexFields_fieldNames :: Lens' DescribeIndexFields (Maybe [Text]) Source #

A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.

describeIndexFields_domainName :: Lens' DescribeIndexFields Text Source #

The name of the domain you want to describe.

Destructuring the Response

data DescribeIndexFieldsResponse Source #

The result of a DescribeIndexFields request. Contains the index fields configured for the domain specified in the request.

See: newDescribeIndexFieldsResponse smart constructor.

Constructors

DescribeIndexFieldsResponse'
Fields httpStatus :: Int The response's http status code. indexFields :: [IndexFieldStatus] The index fields configured for the domain.

Instances

Instances details

Generic DescribeIndexFieldsResponse Source #
Instance details Defined in Amazonka.CloudSearch.DescribeIndexFields Associated Types type Rep DescribeIndexFieldsResponse :: Type -> Type # Methods from :: DescribeIndexFieldsResponse -> Rep DescribeIndexFieldsResponse x # to :: Rep DescribeIndexFieldsResponse x -> DescribeIndexFieldsResponse #
Read DescribeIndexFieldsResponse Source #
Instance details Defined in Amazonka.CloudSearch.DescribeIndexFields Methods readsPrec :: Int -> ReadS DescribeIndexFieldsResponse # readList :: ReadS [DescribeIndexFieldsResponse] # readPrec :: ReadPrec DescribeIndexFieldsResponse # readListPrec :: ReadPrec [DescribeIndexFieldsResponse] #
Show DescribeIndexFieldsResponse Source #
Instance details Defined in Amazonka.CloudSearch.DescribeIndexFields Methods showsPrec :: Int -> DescribeIndexFieldsResponse -> ShowS # show :: DescribeIndexFieldsResponse -> String # showList :: [DescribeIndexFieldsResponse] -> ShowS #
NFData DescribeIndexFieldsResponse Source #
Instance details Defined in Amazonka.CloudSearch.DescribeIndexFields Methods rnf :: DescribeIndexFieldsResponse -> () #
Eq DescribeIndexFieldsResponse Source #
Instance details Defined in Amazonka.CloudSearch.DescribeIndexFields Methods (==) :: DescribeIndexFieldsResponse -> DescribeIndexFieldsResponse -> Bool # (/=) :: DescribeIndexFieldsResponse -> DescribeIndexFieldsResponse -> Bool #
type Rep DescribeIndexFieldsResponse Source #
Instance details Defined in Amazonka.CloudSearch.DescribeIndexFields type Rep DescribeIndexFieldsResponse = D1 ('MetaData "DescribeIndexFieldsResponse" "Amazonka.CloudSearch.DescribeIndexFields" "amazonka-cloudsearch-2.0-A2SXRDW2ivUDvdOgQgoVJQ" 'False) (C1 ('MetaCons "DescribeIndexFieldsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "indexFields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [IndexFieldStatus])))

newDescribeIndexFieldsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeIndexFieldsResponse'`
-> DescribeIndexFieldsResponse

Create a value of DescribeIndexFieldsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DescribeIndexFieldsResponse', describeIndexFieldsResponse_httpStatus - The response's http status code.

$sel:indexFields:DescribeIndexFieldsResponse', describeIndexFieldsResponse_indexFields - The index fields configured for the domain.

Response Lenses

describeIndexFieldsResponse_httpStatus :: Lens' DescribeIndexFieldsResponse Int Source #

The response's http status code.

describeIndexFieldsResponse_indexFields :: Lens' DescribeIndexFieldsResponse [IndexFieldStatus] Source #

The index fields configured for the domain.