describe_reserved_instances async ¶

async def describe_reserved_instances(
    self,
    *,
    config_overrides: Optional[AsyncOpenSearchClientConfig] = None,
    reserved_instance_id: Optional["capo_opensearch.types.guid.GUID"] = None,
    max_results: Optional["capo_opensearch.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_opensearch.types.next_token.NextToken"] = None,
) -> "capo_opensearch.types.describe_reserved_instances_response.DescribeReservedInstancesResponse":
    """<p>Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ri.html">Reserved Instances in Amazon OpenSearch Service</a>.</p>

    Args:
        reserved_instance_id: <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: <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: <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>

    Raises:
        capo_opensearch.errors.disabled_operation_exception.DisabledOperationException: <p>An error occured because the client wanted to access an unsupported operation.</p>
        capo_opensearch.errors.internal_exception.InternalException: <p>Request processing failed because of an unknown error, exception, or internal failure.</p>
        capo_opensearch.errors.resource_not_found_exception.ResourceNotFoundException: <p>An exception for accessing or deleting a resource that doesn't exist.</p>
        capo_opensearch.errors.validation_exception.ValidationException: <p>An exception for accessing or deleting a resource that doesn't exist.</p>
        capo_opensearch.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_opensearch.types.describe_reserved_instances_request.DescribeReservedInstancesRequest]",
    ) -> AsyncOperationResponse[
        "capo_opensearch.types.describe_reserved_instances_response.DescribeReservedInstancesResponse"
    ]:
        import capo_opensearch._operations.amazon_open_search_service.describe_reserved_instances

        (
            output,
            http_response,
        ) = await capo_opensearch._operations.amazon_open_search_service.describe_reserved_instances.async_describe_reserved_instances(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeReservedInstances")
    )
    input_: capo_opensearch.types.describe_reserved_instances_request.DescribeReservedInstancesRequest = {}
    if reserved_instance_id is not None:
        input_["reserved_instance_id"] = reserved_instance_id
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output