Skip to content

get_user_settings

get_user_settings(
    user_settings_arn: ARN,
    *,
    config_overrides: Optional[WorkSpacesWebClientConfig] = None,
) -> GetUserSettingsResponse

Gets user settings.

Parameters:

  • user_settings_arn (ARN) –

    The ARN of the user settings.

Raises:

Source code in docs_src/capo_workspaces_web/_services/work_spaces_web.py
def get_user_settings(
    self,
    user_settings_arn: "capo_workspaces_web.types.arn.ARN",
    *,
    config_overrides: Optional[WorkSpacesWebClientConfig] = None,
) -> "capo_workspaces_web.types.get_user_settings_response.GetUserSettingsResponse":
    """<p>Gets user settings.</p>

    Args:
        user_settings_arn: <p>The ARN of the user settings.</p>

    Raises:
        capo_workspaces_web.errors.access_denied_exception.AccessDeniedException: <p>Access is denied.</p>
        capo_workspaces_web.errors.internal_server_exception.InternalServerException: <p>There is an internal server error.</p>
        capo_workspaces_web.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource cannot be found.</p>
        capo_workspaces_web.errors.throttling_exception.ThrottlingException: <p>There is a throttling error.</p>
        capo_workspaces_web.errors.validation_exception.ValidationException: <p>There is a validation error.</p>
        capo_workspaces_web.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_workspaces_web.types.get_user_settings_request.GetUserSettingsRequest]",
    ) -> OperationResponse[
        "capo_workspaces_web.types.get_user_settings_response.GetUserSettingsResponse"
    ]:
        import capo_workspaces_web._operations.aws_ermine_control_plane_service.get_user_settings

        output, http_response = (
            capo_workspaces_web._operations.aws_ermine_control_plane_service.get_user_settings.get_user_settings(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_workspaces_web.types.get_user_settings_response.GetUserSettingsResponse",
    ) -> dict[str, Any]:
        import capo_workspaces_web.types.get_user_settings_response

        return (
            capo_workspaces_web.types.get_user_settings_response.redact_sensitive(
                output
            )
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetUserSettings", redact_output=_redact_output),
    )
    input_: capo_workspaces_web.types.get_user_settings_request.GetUserSettingsRequest = {
        "user_settings_arn": user_settings_arn
    }

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