| 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.DescribeReservedInstances
Description
Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.
Synopsis
- data DescribeReservedInstances = DescribeReservedInstances' {}
- newDescribeReservedInstances :: DescribeReservedInstances
- describeReservedInstances_maxResults :: Lens' DescribeReservedInstances (Maybe Int)
- describeReservedInstances_nextToken :: Lens' DescribeReservedInstances (Maybe Text)
- describeReservedInstances_reservedInstanceId :: Lens' DescribeReservedInstances (Maybe Text)
- data DescribeReservedInstancesResponse = DescribeReservedInstancesResponse' {}
- newDescribeReservedInstancesResponse :: Int -> DescribeReservedInstancesResponse
- describeReservedInstancesResponse_nextToken :: Lens' DescribeReservedInstancesResponse (Maybe Text)
- describeReservedInstancesResponse_reservedInstances :: Lens' DescribeReservedInstancesResponse (Maybe [ReservedInstance])
- describeReservedInstancesResponse_httpStatus :: Lens' DescribeReservedInstancesResponse Int
Creating a Request
data DescribeReservedInstances Source #
Container for the request parameters to the DescribeReservedInstances
operation.
See: newDescribeReservedInstances smart constructor.
Constructors
| DescribeReservedInstances' | |
Fields
| |
Instances
newDescribeReservedInstances :: DescribeReservedInstances Source #
Create a value of DescribeReservedInstances 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:DescribeReservedInstances', describeReservedInstances_maxResults - An optional parameter that specifies the maximum number of results to
return. You can use nextToken to get the next page of results.
DescribeReservedInstances, describeReservedInstances_nextToken - If your initial DescribeReservedInstances operation returns a
nextToken, you can include the returned nextToken in subsequent
DescribeReservedInstances operations, which returns results in the
next page.
DescribeReservedInstances, describeReservedInstances_reservedInstanceId - The reserved instance identifier filter value. Use this parameter to
show only the reservation that matches the specified reserved OpenSearch
instance ID.
Request Lenses
describeReservedInstances_maxResults :: Lens' DescribeReservedInstances (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.
describeReservedInstances_nextToken :: Lens' DescribeReservedInstances (Maybe Text) Source #
If your initial DescribeReservedInstances operation returns a
nextToken, you can include the returned nextToken in subsequent
DescribeReservedInstances operations, which returns results in the
next page.
describeReservedInstances_reservedInstanceId :: Lens' DescribeReservedInstances (Maybe Text) Source #
The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved OpenSearch instance ID.
Destructuring the Response
data DescribeReservedInstancesResponse Source #
Container for results from DescribeReservedInstances
See: newDescribeReservedInstancesResponse smart constructor.
Constructors
| DescribeReservedInstancesResponse' | |
Fields
| |
Instances
newDescribeReservedInstancesResponse Source #
Arguments
| :: Int | |
| -> DescribeReservedInstancesResponse |
Create a value of DescribeReservedInstancesResponse 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:
DescribeReservedInstances, describeReservedInstancesResponse_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:reservedInstances:DescribeReservedInstancesResponse', describeReservedInstancesResponse_reservedInstances - List of Reserved Instances in the current Region.
$sel:httpStatus:DescribeReservedInstancesResponse', describeReservedInstancesResponse_httpStatus - The response's http status code.
Response Lenses
describeReservedInstancesResponse_nextToken :: Lens' DescribeReservedInstancesResponse (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.
describeReservedInstancesResponse_reservedInstances :: Lens' DescribeReservedInstancesResponse (Maybe [ReservedInstance]) Source #
List of Reserved Instances in the current Region.
describeReservedInstancesResponse_httpStatus :: Lens' DescribeReservedInstancesResponse Int Source #
The response's http status code.