Skip to content

modify_client_properties

modify_client_properties(
    resource_id: NonEmptyString,
    client_properties: ClientProperties,
    *,
    config_overrides: Optional[WorkSpacesClientConfig] = None,
) -> ModifyClientPropertiesResult

Modifies the properties of the specified Amazon WorkSpaces clients.

Parameters:

  • resource_id (NonEmptyString) –

    The resource identifiers, in the form of directory IDs.

  • client_properties (ClientProperties) –

    Information about the Amazon WorkSpaces client.

Raises:

Source code in docs_src/capo_workspaces/_services/work_spaces.py
def modify_client_properties(
    self,
    resource_id: "capo_workspaces.types.non_empty_string.NonEmptyString",
    client_properties: "capo_workspaces.types.client_properties.ClientProperties",
    *,
    config_overrides: Optional[WorkSpacesClientConfig] = None,
) -> "capo_workspaces.types.modify_client_properties_result.ModifyClientPropertiesResult":
    """<p>Modifies the properties of the specified Amazon WorkSpaces clients.</p>

    Args:
        resource_id: <p>The resource identifiers, in the form of directory IDs.</p>
        client_properties: <p>Information about the Amazon WorkSpaces client.</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.operation_not_supported_exception.OperationNotSupportedException: <p>This operation is not supported.</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.
    """

    def _handler(
        req: "OperationRequest[capo_workspaces.types.modify_client_properties_request.ModifyClientPropertiesRequest]",
    ) -> OperationResponse[
        "capo_workspaces.types.modify_client_properties_result.ModifyClientPropertiesResult"
    ]:
        import capo_workspaces._operations.workspaces_service.modify_client_properties

        output, http_response = (
            capo_workspaces._operations.workspaces_service.modify_client_properties.modify_client_properties(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ModifyClientProperties")
    )
    input_: capo_workspaces.types.modify_client_properties_request.ModifyClientPropertiesRequest = {
        "resource_id": resource_id,
        "client_properties": client_properties,
    }

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