get_geofence `async` ¶

get_geofence(
    collection_name: ResourceName,
    geofence_id: Id,
    *,
    config_overrides: Optional[AsyncLocationClientConfig] = None,
) -> GetGeofenceResponse

Retrieves the geofence details from a geofence collection.

The returned geometry will always match the geometry format used when the geofence was created.

Parameters:

collection_name (ResourceName) –

The geofence collection storing the target geofence.
geofence_id (Id) –

The geofence you're retrieving details for.

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 get_geofence(
    self,
    collection_name: "capo_location.types.resource_name.ResourceName",
    geofence_id: "capo_location.types.id.Id",
    *,
    config_overrides: Optional[AsyncLocationClientConfig] = None,
) -> "capo_location.types.get_geofence_response.GetGeofenceResponse":
    """<p>Retrieves the geofence details from a geofence collection.</p> <note> <p>The returned geometry will always match the geometry format used when the geofence was created.</p> </note>

    Args:
        collection_name: <p>The geofence collection storing the target geofence.</p>
        geofence_id: <p>The geofence you're retrieving details for.</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.get_geofence_request.GetGeofenceRequest]",
    ) -> AsyncOperationResponse[
        "capo_location.types.get_geofence_response.GetGeofenceResponse"
    ]:
        import capo_location._operations.location_service.get_geofence

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

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

        return capo_location.types.get_geofence_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetGeofence", redact_output=_redact_output),
    )
    input_: capo_location.types.get_geofence_request.GetGeofenceRequest = {
        "collection_name": collection_name,
        "geofence_id": geofence_id,
    }

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

get_geofence async ¶

get_geofence `async` ¶