Amazonka.CloudSearch.DescribeAnalysisSchemes

Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a text field. Can be limited to specific analysis schemes by name. By default, shows all analysis schemes 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 Analysis Schemes in the Amazon CloudSearch Developer Guide.

Creating a Request

data DescribeAnalysisSchemes

Container for the parameters to the DescribeAnalysisSchemes operation. Specifies the name of the domain you want to describe. To limit the response to particular analysis schemes, specify the names of the analysis schemes you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

See: newDescribeAnalysisSchemes smart constructor.

Constructors

DescribeAnalysisSchemes'

Fields

• analysisSchemeNames :: Maybe [Text]

  The analysis schemes you want to describe.

• deployed :: Maybe Bool

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

• domainName :: Text

  The name of the domain you want to describe.

Instances

ToHeaders DescribeAnalysisSchemes

Defined in Amazonka.CloudSearch.DescribeAnalysisSchemes

Methods

toHeaders :: DescribeAnalysisSchemes -> [Header]

ToPath DescribeAnalysisSchemes

Defined in Amazonka.CloudSearch.DescribeAnalysisSchemes

Methods

toPath :: DescribeAnalysisSchemes -> ByteString

ToQuery DescribeAnalysisSchemes

Defined in Amazonka.CloudSearch.DescribeAnalysisSchemes

Methods

toQuery :: DescribeAnalysisSchemes -> QueryString

AWSRequest DescribeAnalysisSchemes

Defined in Amazonka.CloudSearch.DescribeAnalysisSchemes

Associated Types

type AWSResponse DescribeAnalysisSchemes

Methods

request :: (Service -> Service) -> DescribeAnalysisSchemes -> Request DescribeAnalysisSchemes

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeAnalysisSchemes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeAnalysisSchemes)))

Generic DescribeAnalysisSchemes

Defined in Amazonka.CloudSearch.DescribeAnalysisSchemes

Associated Types

type Rep DescribeAnalysisSchemes :: Type -> Type

Methods

from :: DescribeAnalysisSchemes -> Rep DescribeAnalysisSchemes x

to :: Rep DescribeAnalysisSchemes x -> DescribeAnalysisSchemes

Read DescribeAnalysisSchemes

Defined in Amazonka.CloudSearch.DescribeAnalysisSchemes

Methods

readsPrec :: Int -> ReadS DescribeAnalysisSchemes

readList :: ReadS [DescribeAnalysisSchemes]

readPrec :: ReadPrec DescribeAnalysisSchemes

readListPrec :: ReadPrec [DescribeAnalysisSchemes]

Show DescribeAnalysisSchemes

Defined in Amazonka.CloudSearch.DescribeAnalysisSchemes

Methods

showsPrec :: Int -> DescribeAnalysisSchemes -> ShowS

show :: DescribeAnalysisSchemes -> String

showList :: [DescribeAnalysisSchemes] -> ShowS

NFData DescribeAnalysisSchemes

Defined in Amazonka.CloudSearch.DescribeAnalysisSchemes

Methods

rnf :: DescribeAnalysisSchemes -> ()

Eq DescribeAnalysisSchemes

Defined in Amazonka.CloudSearch.DescribeAnalysisSchemes

Methods

(==) :: DescribeAnalysisSchemes -> DescribeAnalysisSchemes -> Bool

(/=) :: DescribeAnalysisSchemes -> DescribeAnalysisSchemes -> Bool

Hashable DescribeAnalysisSchemes

Defined in Amazonka.CloudSearch.DescribeAnalysisSchemes

Methods

hashWithSalt :: Int -> DescribeAnalysisSchemes -> Int

hash :: DescribeAnalysisSchemes -> Int

type AWSResponse DescribeAnalysisSchemes

Defined in Amazonka.CloudSearch.DescribeAnalysisSchemes

type AWSResponse DescribeAnalysisSchemes = DescribeAnalysisSchemesResponse

type Rep DescribeAnalysisSchemes

Defined in Amazonka.CloudSearch.DescribeAnalysisSchemes

type Rep DescribeAnalysisSchemes = D1 ('MetaData "DescribeAnalysisSchemes" "Amazonka.CloudSearch.DescribeAnalysisSchemes" "amazonka-cloudsearch-2.0-A2SXRDW2ivUDvdOgQgoVJQ" 'False) (C1 ('MetaCons "DescribeAnalysisSchemes'" 'PrefixI 'True) (S1 ('MetaSel ('Just "analysisSchemeNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "deployed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDescribeAnalysisSchemes

Arguments

:: Text

DescribeAnalysisSchemes

-> DescribeAnalysisSchemes

Create a value of DescribeAnalysisSchemes 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:analysisSchemeNames:DescribeAnalysisSchemes', describeAnalysisSchemes_analysisSchemeNames - The analysis schemes you want to describe.

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

DescribeAnalysisSchemes, describeAnalysisSchemes_domainName - The name of the domain you want to describe.

Request Lenses

describeAnalysisSchemes_analysisSchemeNames :: Lens' DescribeAnalysisSchemes (Maybe [Text])

The analysis schemes you want to describe.

describeAnalysisSchemes_deployed :: Lens' DescribeAnalysisSchemes (Maybe Bool)

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

describeAnalysisSchemes_domainName :: Lens' DescribeAnalysisSchemes Text

The name of the domain you want to describe.

Destructuring the Response

data DescribeAnalysisSchemesResponse

The result of a DescribeAnalysisSchemes request. Contains the analysis schemes configured for the domain specified in the request.

See: newDescribeAnalysisSchemesResponse smart constructor.

Constructors

DescribeAnalysisSchemesResponse'

Fields

• httpStatus :: Int

  The response's http status code.

• analysisSchemes :: [AnalysisSchemeStatus]

  The analysis scheme descriptions.

Instances

Generic DescribeAnalysisSchemesResponse

Defined in Amazonka.CloudSearch.DescribeAnalysisSchemes

Associated Types

type Rep DescribeAnalysisSchemesResponse :: Type -> Type

Methods

from :: DescribeAnalysisSchemesResponse -> Rep DescribeAnalysisSchemesResponse x

to :: Rep DescribeAnalysisSchemesResponse x -> DescribeAnalysisSchemesResponse

Read DescribeAnalysisSchemesResponse

Defined in Amazonka.CloudSearch.DescribeAnalysisSchemes

Methods

readsPrec :: Int -> ReadS DescribeAnalysisSchemesResponse

readList :: ReadS [DescribeAnalysisSchemesResponse]

readPrec :: ReadPrec DescribeAnalysisSchemesResponse

readListPrec :: ReadPrec [DescribeAnalysisSchemesResponse]

Show DescribeAnalysisSchemesResponse

Defined in Amazonka.CloudSearch.DescribeAnalysisSchemes

Methods

showsPrec :: Int -> DescribeAnalysisSchemesResponse -> ShowS

show :: DescribeAnalysisSchemesResponse -> String

showList :: [DescribeAnalysisSchemesResponse] -> ShowS

NFData DescribeAnalysisSchemesResponse

Defined in Amazonka.CloudSearch.DescribeAnalysisSchemes

Methods

rnf :: DescribeAnalysisSchemesResponse -> ()

Eq DescribeAnalysisSchemesResponse

Defined in Amazonka.CloudSearch.DescribeAnalysisSchemes

Methods

(==) :: DescribeAnalysisSchemesResponse -> DescribeAnalysisSchemesResponse -> Bool

(/=) :: DescribeAnalysisSchemesResponse -> DescribeAnalysisSchemesResponse -> Bool

type Rep DescribeAnalysisSchemesResponse

Defined in Amazonka.CloudSearch.DescribeAnalysisSchemes

type Rep DescribeAnalysisSchemesResponse = D1 ('MetaData "DescribeAnalysisSchemesResponse" "Amazonka.CloudSearch.DescribeAnalysisSchemes" "amazonka-cloudsearch-2.0-A2SXRDW2ivUDvdOgQgoVJQ" 'False) (C1 ('MetaCons "DescribeAnalysisSchemesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "analysisSchemes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [AnalysisSchemeStatus])))

newDescribeAnalysisSchemesResponse

Arguments

:: Int

$sel:httpStatus:DescribeAnalysisSchemesResponse'

-> DescribeAnalysisSchemesResponse

Create a value of DescribeAnalysisSchemesResponse 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:DescribeAnalysisSchemesResponse', describeAnalysisSchemesResponse_httpStatus - The response's http status code.

$sel:analysisSchemes:DescribeAnalysisSchemesResponse', describeAnalysisSchemesResponse_analysisSchemes - The analysis scheme descriptions.

Response Lenses

describeAnalysisSchemesResponse_httpStatus :: Lens' DescribeAnalysisSchemesResponse Int

The response's http status code.

describeAnalysisSchemesResponse_analysisSchemes :: Lens' DescribeAnalysisSchemesResponse [AnalysisSchemeStatus]

The analysis scheme descriptions.