list_devices ¶

def list_devices(
    self,
    *,
    config_overrides: Optional[PanoramaClientConfig] = None,
    next_token: Optional["capo_panorama.types.next_token.NextToken"] = None,
    max_results: Optional["capo_panorama.types.max_size25.MaxSize25"] = None,
    sort_by: Optional[
        "capo_panorama.types.list_devices_sort_by.ListDevicesSortBy"
    ] = None,
    sort_order: Optional["capo_panorama.types.sort_order.SortOrder"] = None,
    name_filter: Optional["capo_panorama.types.name_filter.NameFilter"] = None,
    device_aggregated_status_filter: Optional[
        "capo_panorama.types.device_aggregated_status.DeviceAggregatedStatus"
    ] = None,
) -> "capo_panorama.types.list_devices_response.ListDevicesResponse":
    """<p>Returns a list of devices.</p>

    Args:
        next_token: <p>Specify the pagination token from a previous request to retrieve the next page of results.</p>
        max_results: <p>The maximum number of devices to return in one page of results.</p>
        sort_by: <p>The target column to be sorted on. Default column sort is CREATED_TIME.</p>
        sort_order: <p>The sorting order for the returned list. SortOrder is DESCENDING by default based on CREATED_TIME. Otherwise, SortOrder is ASCENDING.</p>
        name_filter: <p>Filter based on device's name. Prefixes supported.</p>
        device_aggregated_status_filter: <p>Filter based on a device's status.</p>

    Raises:
        capo_panorama.errors.access_denied_exception.AccessDeniedException: <p>The requestor does not have permission to access the target action or resource.</p>
        capo_panorama.errors.conflict_exception.ConflictException: <p>The target resource is in use.</p>
        capo_panorama.errors.internal_server_exception.InternalServerException: <p>An internal error occurred.</p>
        capo_panorama.errors.validation_exception.ValidationException: <p>The request contains an invalid parameter value.</p>
        capo_panorama.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_panorama.types.list_devices_request.ListDevicesRequest]",
    ) -> OperationResponse[
        "capo_panorama.types.list_devices_response.ListDevicesResponse"
    ]:
        import capo_panorama._operations.omni_cloud_service_lambda.list_devices

        output, http_response = (
            capo_panorama._operations.omni_cloud_service_lambda.list_devices.list_devices(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListDevices")
    )
    input_: capo_panorama.types.list_devices_request.ListDevicesRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if sort_by is not None:
        input_["sort_by"] = sort_by
    if sort_order is not None:
        input_["sort_order"] = sort_order
    if name_filter is not None:
        input_["name_filter"] = name_filter
    if device_aggregated_status_filter is not None:
        input_["device_aggregated_status_filter"] = device_aggregated_status_filter

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