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.OpenSearch.DescribeDomainAutoTunes

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain. For more information, see Auto-Tune for Amazon OpenSearch Service.

Synopsis

Creating a Request

data DescribeDomainAutoTunes Source #

Container for the parameters to the DescribeDomainAutoTunes operation.

See: newDescribeDomainAutoTunes smart constructor.

Constructors

DescribeDomainAutoTunes'

Fields

maxResults :: Maybe Int
An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
nextToken :: Maybe Text
If your initial DescribeDomainAutoTunes operation returns a nextToken, you can include the returned nextToken in subsequent DescribeDomainAutoTunes operations, which returns results in the next page.
domainName :: Text
Name of the domain that you want Auto-Tune details about.

Instances

Instances details

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

newDescribeDomainAutoTunes Source #

Arguments

:: Text	`DescribeDomainAutoTunes`
-> DescribeDomainAutoTunes

Create a value of DescribeDomainAutoTunes 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:maxResults:DescribeDomainAutoTunes', describeDomainAutoTunes_maxResults - An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

DescribeDomainAutoTunes, describeDomainAutoTunes_nextToken - If your initial DescribeDomainAutoTunes operation returns a nextToken, you can include the returned nextToken in subsequent DescribeDomainAutoTunes operations, which returns results in the next page.

DescribeDomainAutoTunes, describeDomainAutoTunes_domainName - Name of the domain that you want Auto-Tune details about.

Request Lenses

describeDomainAutoTunes_maxResults :: Lens' DescribeDomainAutoTunes (Maybe Int) Source #

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

describeDomainAutoTunes_nextToken :: Lens' DescribeDomainAutoTunes (Maybe Text) Source #

If your initial DescribeDomainAutoTunes operation returns a nextToken, you can include the returned nextToken in subsequent DescribeDomainAutoTunes operations, which returns results in the next page.

describeDomainAutoTunes_domainName :: Lens' DescribeDomainAutoTunes Text Source #

Name of the domain that you want Auto-Tune details about.

Destructuring the Response

data DescribeDomainAutoTunesResponse Source #

The result of a DescribeDomainAutoTunes request.

See: newDescribeDomainAutoTunesResponse smart constructor.

Constructors

DescribeDomainAutoTunesResponse'
Fields autoTunes :: Maybe [AutoTune] The list of setting adjustments that Auto-Tune has made to the domain. nextToken :: Maybe Text When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeDomainAutoTunesResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribeDomainAutoTunes Associated Types type Rep DescribeDomainAutoTunesResponse :: Type -> Type # Methods from :: DescribeDomainAutoTunesResponse -> Rep DescribeDomainAutoTunesResponse x # to :: Rep DescribeDomainAutoTunesResponse x -> DescribeDomainAutoTunesResponse #
Read DescribeDomainAutoTunesResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribeDomainAutoTunes Methods readsPrec :: Int -> ReadS DescribeDomainAutoTunesResponse # readList :: ReadS [DescribeDomainAutoTunesResponse] # readPrec :: ReadPrec DescribeDomainAutoTunesResponse # readListPrec :: ReadPrec [DescribeDomainAutoTunesResponse] #
Show DescribeDomainAutoTunesResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribeDomainAutoTunes Methods showsPrec :: Int -> DescribeDomainAutoTunesResponse -> ShowS # show :: DescribeDomainAutoTunesResponse -> String # showList :: [DescribeDomainAutoTunesResponse] -> ShowS #
NFData DescribeDomainAutoTunesResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribeDomainAutoTunes Methods rnf :: DescribeDomainAutoTunesResponse -> () #
Eq DescribeDomainAutoTunesResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribeDomainAutoTunes Methods (==) :: DescribeDomainAutoTunesResponse -> DescribeDomainAutoTunesResponse -> Bool # (/=) :: DescribeDomainAutoTunesResponse -> DescribeDomainAutoTunesResponse -> Bool #
type Rep DescribeDomainAutoTunesResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribeDomainAutoTunes type Rep DescribeDomainAutoTunesResponse = D1 ('MetaData "DescribeDomainAutoTunesResponse" "Amazonka.OpenSearch.DescribeDomainAutoTunes" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "DescribeDomainAutoTunesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "autoTunes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AutoTune])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeDomainAutoTunesResponse Source #

Arguments

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

Create a value of DescribeDomainAutoTunesResponse 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:autoTunes:DescribeDomainAutoTunesResponse', describeDomainAutoTunesResponse_autoTunes - The list of setting adjustments that Auto-Tune has made to the domain.

DescribeDomainAutoTunes, describeDomainAutoTunesResponse_nextToken - When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

$sel:httpStatus:DescribeDomainAutoTunesResponse', describeDomainAutoTunesResponse_httpStatus - The response's http status code.

Response Lenses

describeDomainAutoTunesResponse_autoTunes :: Lens' DescribeDomainAutoTunesResponse (Maybe [AutoTune]) Source #

The list of setting adjustments that Auto-Tune has made to the domain.

describeDomainAutoTunesResponse_nextToken :: Lens' DescribeDomainAutoTunesResponse (Maybe Text) Source #

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

describeDomainAutoTunesResponse_httpStatus :: Lens' DescribeDomainAutoTunesResponse Int Source #

The response's http status code.