Skip to content

describe_client_properties async

describe_client_properties(
    resource_ids: ResourceIdList,
    *,
    config_overrides: Optional[AsyncWorkSpacesClientConfig] = None,
) -> DescribeClientPropertiesResult

Retrieves a list that describes one or more specified Amazon WorkSpaces clients.

Parameters:

  • resource_ids (ResourceIdList) –

    The resource identifier, in the form of directory IDs.

Raises:

Source code in docs_src/capo_workspaces/_services/async_work_spaces.py
async def describe_client_properties(
    self,
    resource_ids: "capo_workspaces.types.resource_id_list.ResourceIdList",
    *,
    config_overrides: Optional[AsyncWorkSpacesClientConfig] = None,
) -> "capo_workspaces.types.describe_client_properties_result.DescribeClientPropertiesResult":
    """<p>Retrieves a list that describes one or more specified Amazon WorkSpaces clients.</p>

    Args:
        resource_ids: <p>The resource identifier, in the form of directory IDs.</p>

    Raises:
        capo_workspaces.errors.access_denied_exception.AccessDeniedException: <p>The user is not authorized to access a resource.</p>
        capo_workspaces.errors.invalid_parameter_values_exception.InvalidParameterValuesException: <p>One or more parameter values are not valid.</p>
        capo_workspaces.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource could not be found.</p>
        capo_workspaces.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_workspaces.types.describe_client_properties_request.DescribeClientPropertiesRequest]",
    ) -> AsyncOperationResponse[
        "capo_workspaces.types.describe_client_properties_result.DescribeClientPropertiesResult"
    ]:
        import capo_workspaces._operations.workspaces_service.describe_client_properties

        (
            output,
            http_response,
        ) = await capo_workspaces._operations.workspaces_service.describe_client_properties.async_describe_client_properties(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeClientProperties")
    )
    input_: capo_workspaces.types.describe_client_properties_request.DescribeClientPropertiesRequest = {
        "resource_ids": resource_ids
    }

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