Skip to content

list_geofence_collections

list_geofence_collections(
    *,
    config_overrides: Optional[LocationClientConfig] = None,
    max_results: Optional[int] = None,
    next_token: Optional[Token] = None,
) -> ListGeofenceCollectionsResponse

Lists geofence collections in your Amazon Web Services account.

Parameters:

  • max_results (Optional[int], default: None ) –

    An optional limit for the number of resources returned in a single call.

    Default value: 100

  • next_token (Optional[Token], default: None ) –

    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.

    Default value: null

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.

  • 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/location.py
def list_geofence_collections(
    self,
    *,
    config_overrides: Optional[LocationClientConfig] = None,
    max_results: Optional[int] = None,
    next_token: Optional["capo_location.types.token.Token"] = None,
) -> "capo_location.types.list_geofence_collections_response.ListGeofenceCollectionsResponse":
    """<p>Lists geofence collections in your Amazon Web Services account.</p>

    Args:
        max_results: <p>An optional limit for the number of resources 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>

    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_geofence_collections_request.ListGeofenceCollectionsRequest]",
    ) -> OperationResponse[
        "capo_location.types.list_geofence_collections_response.ListGeofenceCollectionsResponse"
    ]:
        import capo_location._operations.location_service.list_geofence_collections

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

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

        return (
            capo_location.types.list_geofence_collections_response.redact_sensitive(
                output
            )
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("ListGeofenceCollections", redact_output=_redact_output),
    )
    input_: capo_location.types.list_geofence_collections_request.ListGeofenceCollectionsRequest = {}
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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