describe_place_index `async` ¶

describe_place_index(
    index_name: ResourceName,
    *,
    config_overrides: Optional[AsyncLocationClientConfig] = None,
) -> DescribePlaceIndexResponse

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Places API V2 unless you require Grab data.

DescribePlaceIndex is part of a previous Amazon Location Service Places API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2).
The Places API version 2 has a simplified interface that can be used without creating or managing place index resources.
If you are using an Amazon Web Services SDK or the Amazon Web Services CLI, note that the Places API version 2 is found under geo-places or geo_places, not under location.
Since Grab is not yet fully supported in Places API version 2, we recommend you continue using API version 1 when using Grab.
Start your version 2 API journey with the Places V2 API Reference or the Developer Guide.

Retrieves the place index resource details.

Parameters:

index_name (ResourceName) –

The name of the place index resource.

Raises:

AccessDeniedException –

The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
InternalServerException –

The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException –

The resource that you've entered was not found in your AWS account.
ThrottlingException –

The request was denied because of request throttling.
ValidationException –

The input failed to meet the constraints specified by the AWS service.
UnknownServiceError –

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

Source code in docs_src/capo_location/_services/async_location.py

async def describe_place_index(
    self,
    index_name: "capo_location.types.resource_name.ResourceName",
    *,
    config_overrides: Optional[AsyncLocationClientConfig] = None,
) -> "capo_location.types.describe_place_index_response.DescribePlaceIndexResponse":
    """<important> <p>This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Places API V2 unless you require Grab data.</p> <ul> <li> <p> <code>DescribePlaceIndex</code> is part of a previous Amazon Location Service Places API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2).</p> </li> <li> <p>The Places API version 2 has a simplified interface that can be used without creating or managing place index resources.</p> </li> <li> <p>If you are using an Amazon Web Services SDK or the Amazon Web Services CLI, note that the Places API version 2 is found under <code>geo-places</code> or <code>geo_places</code>, not under <code>location</code>.</p> </li> <li> <p>Since Grab is not yet fully supported in Places API version 2, we recommend you continue using API version 1 when using Grab.</p> </li> <li> <p>Start your version 2 API journey with the Places V2 <a href="/location/latest/APIReference/API_Operations_Amazon_Location_Service_Places_V2.html">API Reference</a> or the <a href="/location/latest/developerguide/places.html">Developer Guide</a>.</p> </li> </ul> </important> <p>Retrieves the place index resource details.</p>

    Args:
        index_name: <p>The name of the place index resource.</p>

    Raises:
        capo_location.errors.access_denied_exception.AccessDeniedException: <p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>
        capo_location.errors.internal_server_exception.InternalServerException: <p>The request has failed to process because of an unknown server error, exception, or failure.</p>
        capo_location.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource that you've entered was not found in your AWS account.</p>
        capo_location.errors.throttling_exception.ThrottlingException: <p>The request was denied because of request throttling.</p>
        capo_location.errors.validation_exception.ValidationException: <p>The input failed to meet the constraints specified by the AWS service. </p>
        capo_location.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_location.types.describe_place_index_request.DescribePlaceIndexRequest]",
    ) -> AsyncOperationResponse[
        "capo_location.types.describe_place_index_response.DescribePlaceIndexResponse"
    ]:
        import capo_location._operations.location_service.describe_place_index

        (
            output,
            http_response,
        ) = await capo_location._operations.location_service.describe_place_index.async_describe_place_index(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_location.types.describe_place_index_response.DescribePlaceIndexResponse",
    ) -> dict[str, Any]:
        import capo_location.types.describe_place_index_response

        return capo_location.types.describe_place_index_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribePlaceIndex", redact_output=_redact_output),
    )
    input_: capo_location.types.describe_place_index_request.DescribePlaceIndexRequest = {
        "index_name": index_name
    }

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

describe_place_index async ¶

describe_place_index `async` ¶