Returns a list of thin client devices.
Parameters:
-
next_token
(Optional[PaginationToken], default:
None
)
–
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
-
max_results
(Optional[MaxResults], default:
None
)
–
The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
Raises:
Source code in docs_src/capo_workspaces_thin_client/_services/work_spaces_thin_client.py
| def list_devices(
self,
*,
config_overrides: Optional[WorkSpacesThinClientClientConfig] = None,
next_token: Optional[
"capo_workspaces_thin_client.types.pagination_token.PaginationToken"
] = None,
max_results: Optional[
"capo_workspaces_thin_client.types.max_results.MaxResults"
] = None,
) -> "capo_workspaces_thin_client.types.list_devices_response.ListDevicesResponse":
"""<p>Returns a list of thin client devices.</p>
Args:
next_token: <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken error</i>.</p>
max_results: <p>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results.</p> <p>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</p>
Raises:
capo_workspaces_thin_client.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
capo_workspaces_thin_client.errors.internal_server_exception.InternalServerException: <p>The server encountered an internal error and is unable to complete the request.</p>
capo_workspaces_thin_client.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
capo_workspaces_thin_client.errors.validation_exception.ValidationException: <p>The input fails to satisfy the specified constraints.</p>
capo_workspaces_thin_client.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_workspaces_thin_client.types.list_devices_request.ListDevicesRequest]",
) -> OperationResponse[
"capo_workspaces_thin_client.types.list_devices_response.ListDevicesResponse"
]:
import capo_workspaces_thin_client._operations.thin_client.list_devices
output, http_response = (
capo_workspaces_thin_client._operations.thin_client.list_devices.list_devices(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
def _redact_output(
output: "capo_workspaces_thin_client.types.list_devices_response.ListDevicesResponse",
) -> dict[str, Any]:
import capo_workspaces_thin_client.types.list_devices_response
return capo_workspaces_thin_client.types.list_devices_response.redact_sensitive(
output
)
interceptors_, options_ = self.operation_options(
config_overrides,
OperationLogging("ListDevices", redact_output=_redact_output),
)
input_: capo_workspaces_thin_client.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
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|