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
Description
Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.
Synopsis
- data DescribeInstanceTypeLimits = DescribeInstanceTypeLimits' {}
- newDescribeInstanceTypeLimits :: OpenSearchPartitionInstanceType -> Text -> DescribeInstanceTypeLimits
- describeInstanceTypeLimits_domainName :: Lens' DescribeInstanceTypeLimits (Maybe Text)
- describeInstanceTypeLimits_instanceType :: Lens' DescribeInstanceTypeLimits OpenSearchPartitionInstanceType
- describeInstanceTypeLimits_engineVersion :: Lens' DescribeInstanceTypeLimits Text
- data DescribeInstanceTypeLimitsResponse = DescribeInstanceTypeLimitsResponse' {
- limitsByRole :: Maybe (HashMap Text Limits)
- httpStatus :: Int
- newDescribeInstanceTypeLimitsResponse :: Int -> DescribeInstanceTypeLimitsResponse
- describeInstanceTypeLimitsResponse_limitsByRole :: Lens' DescribeInstanceTypeLimitsResponse (Maybe (HashMap Text Limits))
- describeInstanceTypeLimitsResponse_httpStatus :: Lens' DescribeInstanceTypeLimitsResponse Int
Creating a Request
data DescribeInstanceTypeLimits Source #
Container for the parameters to the DescribeInstanceTypeLimits
operation.
See: newDescribeInstanceTypeLimits
smart constructor.
Constructors
DescribeInstanceTypeLimits' | |
Fields
|
Instances
newDescribeInstanceTypeLimits Source #
Arguments
:: OpenSearchPartitionInstanceType | |
-> Text | |
-> 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
|
Instances
newDescribeInstanceTypeLimitsResponse Source #
Arguments
:: Int | |
-> 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.