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.DescribeInstanceTypeLimits

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.

Synopsis

Creating a Request

data DescribeInstanceTypeLimits Source #

Container for the parameters to the DescribeInstanceTypeLimits operation.

See: newDescribeInstanceTypeLimits smart constructor.

Constructors

DescribeInstanceTypeLimits'
Fields domainName :: Maybe Text The name of the domain. Only specify if you need the limits for an existing domain. instanceType :: OpenSearchPartitionInstanceType The OpenSearch Service instance type for which you need limit information. engineVersion :: Text Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

Instances

Instances details

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

newDescribeInstanceTypeLimits Source #

Arguments

:: OpenSearchPartitionInstanceType	`DescribeInstanceTypeLimits`
-> Text	`DescribeInstanceTypeLimits`
-> DescribeInstanceTypeLimits

Create a value of DescribeInstanceTypeLimits 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:

DescribeInstanceTypeLimits, describeInstanceTypeLimits_domainName - The name of the domain. Only specify if you need the limits for an existing domain.

DescribeInstanceTypeLimits, describeInstanceTypeLimits_instanceType - The OpenSearch Service instance type for which you need limit information.

DescribeInstanceTypeLimits, describeInstanceTypeLimits_engineVersion - Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

Request Lenses

describeInstanceTypeLimits_domainName :: Lens' DescribeInstanceTypeLimits (Maybe Text) Source #

The name of the domain. Only specify if you need the limits for an existing domain.

describeInstanceTypeLimits_instanceType :: Lens' DescribeInstanceTypeLimits OpenSearchPartitionInstanceType Source #

The OpenSearch Service instance type for which you need limit information.

describeInstanceTypeLimits_engineVersion :: Lens' DescribeInstanceTypeLimits Text Source #

Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

Destructuring the Response

data DescribeInstanceTypeLimitsResponse Source #

Container for the parameters received from the DescribeInstanceTypeLimits operation.

See: newDescribeInstanceTypeLimitsResponse smart constructor.

Constructors

DescribeInstanceTypeLimitsResponse'
Fields limitsByRole :: Maybe (HashMap Text Limits) Map that contains all applicable instance type limits.`data` refers to data nodes.`master` refers to dedicated master nodes. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeInstanceTypeLimitsResponse Source #

Arguments

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

Create a value of DescribeInstanceTypeLimitsResponse 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:limitsByRole:DescribeInstanceTypeLimitsResponse', describeInstanceTypeLimitsResponse_limitsByRole - Map that contains all applicable instance type limits.data refers to data nodes.master refers to dedicated master nodes.

$sel:httpStatus:DescribeInstanceTypeLimitsResponse', describeInstanceTypeLimitsResponse_httpStatus - The response's http status code.

Response Lenses

describeInstanceTypeLimitsResponse_limitsByRole :: Lens' DescribeInstanceTypeLimitsResponse (Maybe (HashMap Text Limits)) Source #

Map that contains all applicable instance type limits.data refers to data nodes.master refers to dedicated master nodes.

describeInstanceTypeLimitsResponse_httpStatus :: Lens' DescribeInstanceTypeLimitsResponse Int Source #

The response's http status code.