get_index `async` ¶

get_index(
    *, config_overrides: Optional[AsyncResourceExplorer2ClientConfig] = None
) -> GetIndexOutput

Retrieves details about the Amazon Web Services Resource Explorer index in the Amazon Web Services Region in which you invoked the operation.

Raises:

AccessDeniedException –

The credentials that you used to call this operation don't have the minimum required permissions.
InternalServerException –

The request failed because of internal service error. Try your request again later.
ResourceNotFoundException –

You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
ThrottlingException –

The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
ValidationException –

You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_resource_explorer_2/_services/async_resource_explorer2.py

async def get_index(
    self, *, config_overrides: Optional[AsyncResourceExplorer2ClientConfig] = None
) -> "capo_resource_explorer_2.types.get_index_output.GetIndexOutput":
    """<p>Retrieves details about the Amazon Web Services Resource Explorer index in the Amazon Web Services Region in which you invoked the operation.</p>

    Raises:
        capo_resource_explorer_2.errors.access_denied_exception.AccessDeniedException: <p>The credentials that you used to call this operation don't have the minimum required permissions.</p>
        capo_resource_explorer_2.errors.internal_server_exception.InternalServerException: <p>The request failed because of internal service error. Try your request again later.</p>
        capo_resource_explorer_2.errors.resource_not_found_exception.ResourceNotFoundException: <p>You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.</p>
        capo_resource_explorer_2.errors.throttling_exception.ThrottlingException: <p>The request failed because you exceeded a rate limit for this operation. For more information, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/quotas.html">Quotas for Resource Explorer</a>.</p>
        capo_resource_explorer_2.errors.validation_exception.ValidationException: <p>You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.</p>
        capo_resource_explorer_2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[None]",
    ) -> AsyncOperationResponse[
        "capo_resource_explorer_2.types.get_index_output.GetIndexOutput"
    ]:
        import capo_resource_explorer_2._operations.resource_explorer.get_index

        (
            output,
            http_response,
        ) = await capo_resource_explorer_2._operations.resource_explorer.get_index.async_get_index(
            req.options
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_resource_explorer_2.types.get_index_output.GetIndexOutput",
    ) -> dict[str, Any]:
        import capo_resource_explorer_2.types.get_index_output

        return capo_resource_explorer_2.types.get_index_output.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetIndex", redact_output=_redact_output)
    )

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

get_index async ¶

get_index `async` ¶