list_device_positions ¶

def list_device_positions(
    self,
    tracker_name: "capo_location.types.resource_name.ResourceName",
    *,
    config_overrides: Optional[LocationClientConfig] = None,
    max_results: Optional[int] = None,
    next_token: Optional["capo_location.types.token.Token"] = None,
    filter_geometry: Optional[
        "capo_location.types.tracking_filter_geometry.TrackingFilterGeometry"
    ] = None,
) -> (
    "capo_location.types.list_device_positions_response.ListDevicePositionsResponse"
):
    """<p>A batch request to retrieve all device positions.</p>

    Args:
        tracker_name: <p>The tracker resource containing the requested devices.</p>
        max_results: <p>An optional limit for the number of entries returned in a single call.</p> <p>Default value: <code>100</code> </p>
        next_token: <p>The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.</p> <p>Default value: <code>null</code> </p>
        filter_geometry: <p>The geometry used to filter device positions.</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.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.
    """

    def _handler(
        req: "OperationRequest[capo_location.types.list_device_positions_request.ListDevicePositionsRequest]",
    ) -> OperationResponse[
        "capo_location.types.list_device_positions_response.ListDevicePositionsResponse"
    ]:
        import capo_location._operations.location_service.list_device_positions

        output, http_response = (
            capo_location._operations.location_service.list_device_positions.list_device_positions(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_location.types.list_device_positions_request.ListDevicePositionsRequest",
    ) -> dict[str, Any]:
        import capo_location.types.list_device_positions_request

        return capo_location.types.list_device_positions_request.redact_sensitive(
            input_
        )

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

        return capo_location.types.list_device_positions_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "ListDevicePositions",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_location.types.list_device_positions_request.ListDevicePositionsRequest = {
        "tracker_name": tracker_name
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if filter_geometry is not None:
        input_["filter_geometry"] = filter_geometry

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output