Skip to content

DescribeReservedInstancesRequest

Source code in docs_src/capo_opensearch/types/describe_reserved_instances_request.py 
13
14
15
16
17
18
19
class DescribeReservedInstancesRequest(TypedDict, closed=True):
    reserved_instance_id: NotRequired["capo_opensearch.types.guid.GUID"]
    """<p>The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved OpenSearch instance ID.</p>"""
    max_results: "capo_opensearch.types.max_results.MaxResults"
    """<p>An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to get the next page of results.</p>"""
    next_token: NotRequired["capo_opensearch.types.next_token.NextToken"]
    """<p>If your initial <code>DescribeReservedInstances</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>DescribeReservedInstances</code> operations, which returns results in the next page.</p>"""

max_results instance-attribute 

max_results: MaxResults

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

next_token instance-attribute 

next_token: NotRequired[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.

reserved_instance_id instance-attribute 

reserved_instance_id: NotRequired[GUID]

The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved OpenSearch instance ID.