All Downloads are FREE. Search and download functionalities are using the official Maven repository.

software.amazon.awssdk.services.grafana.GrafanaAsyncClient Maven / Gradle / Ivy

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
 * the License. A copy of the License is located at
 * 
 * http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
 * and limitations under the License.
 */

package software.amazon.awssdk.services.grafana;

import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.core.SdkClient;
import software.amazon.awssdk.services.grafana.model.AssociateLicenseRequest;
import software.amazon.awssdk.services.grafana.model.AssociateLicenseResponse;
import software.amazon.awssdk.services.grafana.model.CreateWorkspaceRequest;
import software.amazon.awssdk.services.grafana.model.CreateWorkspaceResponse;
import software.amazon.awssdk.services.grafana.model.DeleteWorkspaceRequest;
import software.amazon.awssdk.services.grafana.model.DeleteWorkspaceResponse;
import software.amazon.awssdk.services.grafana.model.DescribeWorkspaceAuthenticationRequest;
import software.amazon.awssdk.services.grafana.model.DescribeWorkspaceAuthenticationResponse;
import software.amazon.awssdk.services.grafana.model.DescribeWorkspaceRequest;
import software.amazon.awssdk.services.grafana.model.DescribeWorkspaceResponse;
import software.amazon.awssdk.services.grafana.model.DisassociateLicenseRequest;
import software.amazon.awssdk.services.grafana.model.DisassociateLicenseResponse;
import software.amazon.awssdk.services.grafana.model.ListPermissionsRequest;
import software.amazon.awssdk.services.grafana.model.ListPermissionsResponse;
import software.amazon.awssdk.services.grafana.model.ListWorkspacesRequest;
import software.amazon.awssdk.services.grafana.model.ListWorkspacesResponse;
import software.amazon.awssdk.services.grafana.model.UpdatePermissionsRequest;
import software.amazon.awssdk.services.grafana.model.UpdatePermissionsResponse;
import software.amazon.awssdk.services.grafana.model.UpdateWorkspaceAuthenticationRequest;
import software.amazon.awssdk.services.grafana.model.UpdateWorkspaceAuthenticationResponse;
import software.amazon.awssdk.services.grafana.model.UpdateWorkspaceRequest;
import software.amazon.awssdk.services.grafana.model.UpdateWorkspaceResponse;
import software.amazon.awssdk.services.grafana.paginators.ListPermissionsPublisher;
import software.amazon.awssdk.services.grafana.paginators.ListWorkspacesPublisher;

/**
 * Service client for accessing Amazon Managed Grafana asynchronously. This can be created using the static
 * {@link #builder()} method.
 *
 * 

* Amazon Managed Grafana is a fully managed and secure data visualization service that you can use to instantly query, * correlate, and visualize operational metrics, logs, and traces from multiple sources. Amazon Managed Grafana makes it * easy to deploy, operate, and scale Grafana, a widely deployed data visualization tool that is popular for its * extensible data support. *

*

* With Amazon Managed Grafana, you create logically isolated Grafana servers called workspaces. In a workspace, * you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces without having to * build, package, or deploy any hardware to run Grafana servers. *

*/ @Generated("software.amazon.awssdk:codegen") @SdkPublicApi @ThreadSafe public interface GrafanaAsyncClient extends SdkClient { String SERVICE_NAME = "grafana"; /** * Value for looking up the service's metadata from the * {@link software.amazon.awssdk.regions.ServiceMetadataProvider}. */ String SERVICE_METADATA_ID = "grafana"; /** * Create a {@link GrafanaAsyncClient} with the region loaded from the * {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the * {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}. */ static GrafanaAsyncClient create() { return builder().build(); } /** * Create a builder that can be used to configure and create a {@link GrafanaAsyncClient}. */ static GrafanaAsyncClientBuilder builder() { return new DefaultGrafanaAsyncClientBuilder(); } /** *

* Assigns a Grafana Enterprise license to a workspace. Upgrading to Grafana Enterprise incurs additional fees. For * more information, see Upgrade a * workspace to Grafana Enterprise. *

* * @param associateLicenseRequest * @return A Java Future containing the result of the AssociateLicense operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following * exceptions. *
    *
  • ResourceNotFoundException The request references a resource that does not exist.
  • *
  • ThrottlingException The request was denied because of request throttling. Retry the request.
  • *
  • ValidationException The value of a parameter in the request caused an error.
  • *
  • AccessDeniedException You do not have sufficient permissions to perform this action.
  • *
  • InternalServerException Unexpected error while processing the request. Retry the request.
  • *
  • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). * Can be used for catch all scenarios.
  • *
  • SdkClientException If any client side error occurs such as an IO related failure, failure to get * credentials, etc.
  • *
  • GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an * instance of this type.
  • *
* @sample GrafanaAsyncClient.AssociateLicense * @see AWS API * Documentation */ default CompletableFuture associateLicense(AssociateLicenseRequest associateLicenseRequest) { throw new UnsupportedOperationException(); } /** *

* Assigns a Grafana Enterprise license to a workspace. Upgrading to Grafana Enterprise incurs additional fees. For * more information, see Upgrade a * workspace to Grafana Enterprise. *

*
*

* This is a convenience which creates an instance of the {@link AssociateLicenseRequest.Builder} avoiding the need * to create one manually via {@link AssociateLicenseRequest#builder()} *

* * @param associateLicenseRequest * A {@link Consumer} that will call methods on {@link AssociateLicenseRequest.Builder} to create a request. * @return A Java Future containing the result of the AssociateLicense operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following * exceptions. *
    *
  • ResourceNotFoundException The request references a resource that does not exist.
  • *
  • ThrottlingException The request was denied because of request throttling. Retry the request.
  • *
  • ValidationException The value of a parameter in the request caused an error.
  • *
  • AccessDeniedException You do not have sufficient permissions to perform this action.
  • *
  • InternalServerException Unexpected error while processing the request. Retry the request.
  • *
  • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). * Can be used for catch all scenarios.
  • *
  • SdkClientException If any client side error occurs such as an IO related failure, failure to get * credentials, etc.
  • *
  • GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an * instance of this type.
  • *
* @sample GrafanaAsyncClient.AssociateLicense * @see AWS API * Documentation */ default CompletableFuture associateLicense( Consumer associateLicenseRequest) { return associateLicense(AssociateLicenseRequest.builder().applyMutation(associateLicenseRequest).build()); } /** *

* Creates a workspace. In a workspace, you can create Grafana dashboards and visualizations to analyze your * metrics, logs, and traces. You don't have to build, package, or deploy any hardware to run the Grafana server. *

*

* Don't use CreateWorkspace to modify an existing workspace. Instead, use UpdateWorkspace. *

* * @param createWorkspaceRequest * @return A Java Future containing the result of the CreateWorkspace operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following * exceptions. *
    *
  • ThrottlingException The request was denied because of request throttling. Retry the request.
  • *
  • ConflictException A resource was in an inconsistent state during an update or a deletion.
  • *
  • ValidationException The value of a parameter in the request caused an error.
  • *
  • AccessDeniedException You do not have sufficient permissions to perform this action.
  • *
  • InternalServerException Unexpected error while processing the request. Retry the request.
  • *
  • ServiceQuotaExceededException The request would cause a service quota to be exceeded.
  • *
  • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). * Can be used for catch all scenarios.
  • *
  • SdkClientException If any client side error occurs such as an IO related failure, failure to get * credentials, etc.
  • *
  • GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an * instance of this type.
  • *
* @sample GrafanaAsyncClient.CreateWorkspace * @see AWS API * Documentation */ default CompletableFuture createWorkspace(CreateWorkspaceRequest createWorkspaceRequest) { throw new UnsupportedOperationException(); } /** *

* Creates a workspace. In a workspace, you can create Grafana dashboards and visualizations to analyze your * metrics, logs, and traces. You don't have to build, package, or deploy any hardware to run the Grafana server. *

*

* Don't use CreateWorkspace to modify an existing workspace. Instead, use UpdateWorkspace. *

*
*

* This is a convenience which creates an instance of the {@link CreateWorkspaceRequest.Builder} avoiding the need * to create one manually via {@link CreateWorkspaceRequest#builder()} *

* * @param createWorkspaceRequest * A {@link Consumer} that will call methods on {@link CreateWorkspaceRequest.Builder} to create a request. * @return A Java Future containing the result of the CreateWorkspace operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following * exceptions. *
    *
  • ThrottlingException The request was denied because of request throttling. Retry the request.
  • *
  • ConflictException A resource was in an inconsistent state during an update or a deletion.
  • *
  • ValidationException The value of a parameter in the request caused an error.
  • *
  • AccessDeniedException You do not have sufficient permissions to perform this action.
  • *
  • InternalServerException Unexpected error while processing the request. Retry the request.
  • *
  • ServiceQuotaExceededException The request would cause a service quota to be exceeded.
  • *
  • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). * Can be used for catch all scenarios.
  • *
  • SdkClientException If any client side error occurs such as an IO related failure, failure to get * credentials, etc.
  • *
  • GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an * instance of this type.
  • *
* @sample GrafanaAsyncClient.CreateWorkspace * @see AWS API * Documentation */ default CompletableFuture createWorkspace( Consumer createWorkspaceRequest) { return createWorkspace(CreateWorkspaceRequest.builder().applyMutation(createWorkspaceRequest).build()); } /** *

* Deletes an Amazon Managed Grafana workspace. *

* * @param deleteWorkspaceRequest * @return A Java Future containing the result of the DeleteWorkspace operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following * exceptions. *
    *
  • ResourceNotFoundException The request references a resource that does not exist.
  • *
  • ThrottlingException The request was denied because of request throttling. Retry the request.
  • *
  • ConflictException A resource was in an inconsistent state during an update or a deletion.
  • *
  • ValidationException The value of a parameter in the request caused an error.
  • *
  • AccessDeniedException You do not have sufficient permissions to perform this action.
  • *
  • InternalServerException Unexpected error while processing the request. Retry the request.
  • *
  • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). * Can be used for catch all scenarios.
  • *
  • SdkClientException If any client side error occurs such as an IO related failure, failure to get * credentials, etc.
  • *
  • GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an * instance of this type.
  • *
* @sample GrafanaAsyncClient.DeleteWorkspace * @see AWS API * Documentation */ default CompletableFuture deleteWorkspace(DeleteWorkspaceRequest deleteWorkspaceRequest) { throw new UnsupportedOperationException(); } /** *

* Deletes an Amazon Managed Grafana workspace. *

*
*

* This is a convenience which creates an instance of the {@link DeleteWorkspaceRequest.Builder} avoiding the need * to create one manually via {@link DeleteWorkspaceRequest#builder()} *

* * @param deleteWorkspaceRequest * A {@link Consumer} that will call methods on {@link DeleteWorkspaceRequest.Builder} to create a request. * @return A Java Future containing the result of the DeleteWorkspace operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following * exceptions. *
    *
  • ResourceNotFoundException The request references a resource that does not exist.
  • *
  • ThrottlingException The request was denied because of request throttling. Retry the request.
  • *
  • ConflictException A resource was in an inconsistent state during an update or a deletion.
  • *
  • ValidationException The value of a parameter in the request caused an error.
  • *
  • AccessDeniedException You do not have sufficient permissions to perform this action.
  • *
  • InternalServerException Unexpected error while processing the request. Retry the request.
  • *
  • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). * Can be used for catch all scenarios.
  • *
  • SdkClientException If any client side error occurs such as an IO related failure, failure to get * credentials, etc.
  • *
  • GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an * instance of this type.
  • *
* @sample GrafanaAsyncClient.DeleteWorkspace * @see AWS API * Documentation */ default CompletableFuture deleteWorkspace( Consumer deleteWorkspaceRequest) { return deleteWorkspace(DeleteWorkspaceRequest.builder().applyMutation(deleteWorkspaceRequest).build()); } /** *

* Displays information about one Amazon Managed Grafana workspace. *

* * @param describeWorkspaceRequest * @return A Java Future containing the result of the DescribeWorkspace operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following * exceptions. *
    *
  • ResourceNotFoundException The request references a resource that does not exist.
  • *
  • ThrottlingException The request was denied because of request throttling. Retry the request.
  • *
  • ValidationException The value of a parameter in the request caused an error.
  • *
  • AccessDeniedException You do not have sufficient permissions to perform this action.
  • *
  • InternalServerException Unexpected error while processing the request. Retry the request.
  • *
  • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). * Can be used for catch all scenarios.
  • *
  • SdkClientException If any client side error occurs such as an IO related failure, failure to get * credentials, etc.
  • *
  • GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an * instance of this type.
  • *
* @sample GrafanaAsyncClient.DescribeWorkspace * @see AWS API * Documentation */ default CompletableFuture describeWorkspace(DescribeWorkspaceRequest describeWorkspaceRequest) { throw new UnsupportedOperationException(); } /** *

* Displays information about one Amazon Managed Grafana workspace. *

*
*

* This is a convenience which creates an instance of the {@link DescribeWorkspaceRequest.Builder} avoiding the need * to create one manually via {@link DescribeWorkspaceRequest#builder()} *

* * @param describeWorkspaceRequest * A {@link Consumer} that will call methods on {@link DescribeWorkspaceRequest.Builder} to create a request. * @return A Java Future containing the result of the DescribeWorkspace operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following * exceptions. *
    *
  • ResourceNotFoundException The request references a resource that does not exist.
  • *
  • ThrottlingException The request was denied because of request throttling. Retry the request.
  • *
  • ValidationException The value of a parameter in the request caused an error.
  • *
  • AccessDeniedException You do not have sufficient permissions to perform this action.
  • *
  • InternalServerException Unexpected error while processing the request. Retry the request.
  • *
  • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). * Can be used for catch all scenarios.
  • *
  • SdkClientException If any client side error occurs such as an IO related failure, failure to get * credentials, etc.
  • *
  • GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an * instance of this type.
  • *
* @sample GrafanaAsyncClient.DescribeWorkspace * @see AWS API * Documentation */ default CompletableFuture describeWorkspace( Consumer describeWorkspaceRequest) { return describeWorkspace(DescribeWorkspaceRequest.builder().applyMutation(describeWorkspaceRequest).build()); } /** *

* Displays information about the authentication methods used in one Amazon Managed Grafana workspace. *

* * @param describeWorkspaceAuthenticationRequest * @return A Java Future containing the result of the DescribeWorkspaceAuthentication operation returned by the * service.
* The CompletableFuture returned by this method can be completed exceptionally with the following * exceptions. *
    *
  • ResourceNotFoundException The request references a resource that does not exist.
  • *
  • ThrottlingException The request was denied because of request throttling. Retry the request.
  • *
  • ValidationException The value of a parameter in the request caused an error.
  • *
  • AccessDeniedException You do not have sufficient permissions to perform this action.
  • *
  • InternalServerException Unexpected error while processing the request. Retry the request.
  • *
  • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). * Can be used for catch all scenarios.
  • *
  • SdkClientException If any client side error occurs such as an IO related failure, failure to get * credentials, etc.
  • *
  • GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an * instance of this type.
  • *
* @sample GrafanaAsyncClient.DescribeWorkspaceAuthentication * @see AWS API Documentation */ default CompletableFuture describeWorkspaceAuthentication( DescribeWorkspaceAuthenticationRequest describeWorkspaceAuthenticationRequest) { throw new UnsupportedOperationException(); } /** *

* Displays information about the authentication methods used in one Amazon Managed Grafana workspace. *

*
*

* This is a convenience which creates an instance of the {@link DescribeWorkspaceAuthenticationRequest.Builder} * avoiding the need to create one manually via {@link DescribeWorkspaceAuthenticationRequest#builder()} *

* * @param describeWorkspaceAuthenticationRequest * A {@link Consumer} that will call methods on {@link DescribeWorkspaceAuthenticationRequest.Builder} to * create a request. * @return A Java Future containing the result of the DescribeWorkspaceAuthentication operation returned by the * service.
* The CompletableFuture returned by this method can be completed exceptionally with the following * exceptions. *
    *
  • ResourceNotFoundException The request references a resource that does not exist.
  • *
  • ThrottlingException The request was denied because of request throttling. Retry the request.
  • *
  • ValidationException The value of a parameter in the request caused an error.
  • *
  • AccessDeniedException You do not have sufficient permissions to perform this action.
  • *
  • InternalServerException Unexpected error while processing the request. Retry the request.
  • *
  • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). * Can be used for catch all scenarios.
  • *
  • SdkClientException If any client side error occurs such as an IO related failure, failure to get * credentials, etc.
  • *
  • GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an * instance of this type.
  • *
* @sample GrafanaAsyncClient.DescribeWorkspaceAuthentication * @see AWS API Documentation */ default CompletableFuture describeWorkspaceAuthentication( Consumer describeWorkspaceAuthenticationRequest) { return describeWorkspaceAuthentication(DescribeWorkspaceAuthenticationRequest.builder() .applyMutation(describeWorkspaceAuthenticationRequest).build()); } /** *

* Removes the Grafana Enterprise license from a workspace. *

* * @param disassociateLicenseRequest * @return A Java Future containing the result of the DisassociateLicense operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following * exceptions. *
    *
  • ResourceNotFoundException The request references a resource that does not exist.
  • *
  • ThrottlingException The request was denied because of request throttling. Retry the request.
  • *
  • ValidationException The value of a parameter in the request caused an error.
  • *
  • AccessDeniedException You do not have sufficient permissions to perform this action.
  • *
  • InternalServerException Unexpected error while processing the request. Retry the request.
  • *
  • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). * Can be used for catch all scenarios.
  • *
  • SdkClientException If any client side error occurs such as an IO related failure, failure to get * credentials, etc.
  • *
  • GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an * instance of this type.
  • *
* @sample GrafanaAsyncClient.DisassociateLicense * @see AWS * API Documentation */ default CompletableFuture disassociateLicense( DisassociateLicenseRequest disassociateLicenseRequest) { throw new UnsupportedOperationException(); } /** *

* Removes the Grafana Enterprise license from a workspace. *

*
*

* This is a convenience which creates an instance of the {@link DisassociateLicenseRequest.Builder} avoiding the * need to create one manually via {@link DisassociateLicenseRequest#builder()} *

* * @param disassociateLicenseRequest * A {@link Consumer} that will call methods on {@link DisassociateLicenseRequest.Builder} to create a * request. * @return A Java Future containing the result of the DisassociateLicense operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following * exceptions. *
    *
  • ResourceNotFoundException The request references a resource that does not exist.
  • *
  • ThrottlingException The request was denied because of request throttling. Retry the request.
  • *
  • ValidationException The value of a parameter in the request caused an error.
  • *
  • AccessDeniedException You do not have sufficient permissions to perform this action.
  • *
  • InternalServerException Unexpected error while processing the request. Retry the request.
  • *
  • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). * Can be used for catch all scenarios.
  • *
  • SdkClientException If any client side error occurs such as an IO related failure, failure to get * credentials, etc.
  • *
  • GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an * instance of this type.
  • *
* @sample GrafanaAsyncClient.DisassociateLicense * @see AWS * API Documentation */ default CompletableFuture disassociateLicense( Consumer disassociateLicenseRequest) { return disassociateLicense(DisassociateLicenseRequest.builder().applyMutation(disassociateLicenseRequest).build()); } /** *

* Lists the users and groups who have the Grafana Admin and Editor roles in this * workspace. If you use this operation without specifying userId or groupId, the * operation returns the roles of all users and groups. If you specify a userId or a * groupId, only the roles for that user or group are returned. If you do this, you can specify only * one userId or one groupId. *

* * @param listPermissionsRequest * @return A Java Future containing the result of the ListPermissions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following * exceptions. *
    *
  • ResourceNotFoundException The request references a resource that does not exist.
  • *
  • ThrottlingException The request was denied because of request throttling. Retry the request.
  • *
  • ValidationException The value of a parameter in the request caused an error.
  • *
  • AccessDeniedException You do not have sufficient permissions to perform this action.
  • *
  • InternalServerException Unexpected error while processing the request. Retry the request.
  • *
  • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). * Can be used for catch all scenarios.
  • *
  • SdkClientException If any client side error occurs such as an IO related failure, failure to get * credentials, etc.
  • *
  • GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an * instance of this type.
  • *
* @sample GrafanaAsyncClient.ListPermissions * @see AWS API * Documentation */ default CompletableFuture listPermissions(ListPermissionsRequest listPermissionsRequest) { throw new UnsupportedOperationException(); } /** *

* Lists the users and groups who have the Grafana Admin and Editor roles in this * workspace. If you use this operation without specifying userId or groupId, the * operation returns the roles of all users and groups. If you specify a userId or a * groupId, only the roles for that user or group are returned. If you do this, you can specify only * one userId or one groupId. *

*
*

* This is a convenience which creates an instance of the {@link ListPermissionsRequest.Builder} avoiding the need * to create one manually via {@link ListPermissionsRequest#builder()} *

* * @param listPermissionsRequest * A {@link Consumer} that will call methods on {@link ListPermissionsRequest.Builder} to create a request. * @return A Java Future containing the result of the ListPermissions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following * exceptions. *
    *
  • ResourceNotFoundException The request references a resource that does not exist.
  • *
  • ThrottlingException The request was denied because of request throttling. Retry the request.
  • *
  • ValidationException The value of a parameter in the request caused an error.
  • *
  • AccessDeniedException You do not have sufficient permissions to perform this action.
  • *
  • InternalServerException Unexpected error while processing the request. Retry the request.
  • *
  • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). * Can be used for catch all scenarios.
  • *
  • SdkClientException If any client side error occurs such as an IO related failure, failure to get * credentials, etc.
  • *
  • GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an * instance of this type.
  • *
* @sample GrafanaAsyncClient.ListPermissions * @see AWS API * Documentation */ default CompletableFuture listPermissions( Consumer listPermissionsRequest) { return listPermissions(ListPermissionsRequest.builder().applyMutation(listPermissionsRequest).build()); } /** *

* Lists the users and groups who have the Grafana Admin and Editor roles in this * workspace. If you use this operation without specifying userId or groupId, the * operation returns the roles of all users and groups. If you specify a userId or a * groupId, only the roles for that user or group are returned. If you do this, you can specify only * one userId or one groupId. *

*
*

* This is a variant of * {@link #listPermissions(software.amazon.awssdk.services.grafana.model.ListPermissionsRequest)} operation. The * return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will * internally handle making service calls for you. *

*

* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet * and so there is no guarantee that the request is valid. If there are errors in your request, you will see the * failures only after you start streaming the data. The subscribe method should be called as a request to start * streaming data. For more info, see * {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe * method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the * starting request. *

* *

* The following are few ways to use the response class: *

* 1) Using the subscribe helper method * *
     * {@code
     * software.amazon.awssdk.services.grafana.paginators.ListPermissionsPublisher publisher = client.listPermissionsPaginator(request);
     * CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
     * future.get();
     * }
     * 
* * 2) Using a custom subscriber * *
     * {@code
     * software.amazon.awssdk.services.grafana.paginators.ListPermissionsPublisher publisher = client.listPermissionsPaginator(request);
     * publisher.subscribe(new Subscriber() {
     * 
     * public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
     * 
     * 
     * public void onNext(software.amazon.awssdk.services.grafana.model.ListPermissionsResponse response) { //... };
     * });}
     * 
* * As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2. *

* Please notice that the configuration of maxResults won't limit the number of results you get with the * paginator. It only limits the number of results in each page. *

*

* Note: If you prefer to have control on service calls, use the * {@link #listPermissions(software.amazon.awssdk.services.grafana.model.ListPermissionsRequest)} operation. *

* * @param listPermissionsRequest * @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following * exceptions. *
    *
  • ResourceNotFoundException The request references a resource that does not exist.
  • *
  • ThrottlingException The request was denied because of request throttling. Retry the request.
  • *
  • ValidationException The value of a parameter in the request caused an error.
  • *
  • AccessDeniedException You do not have sufficient permissions to perform this action.
  • *
  • InternalServerException Unexpected error while processing the request. Retry the request.
  • *
  • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). * Can be used for catch all scenarios.
  • *
  • SdkClientException If any client side error occurs such as an IO related failure, failure to get * credentials, etc.
  • *
  • GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an * instance of this type.
  • *
* @sample GrafanaAsyncClient.ListPermissions * @see AWS API * Documentation */ default ListPermissionsPublisher listPermissionsPaginator(ListPermissionsRequest listPermissionsRequest) { throw new UnsupportedOperationException(); } /** *

* Lists the users and groups who have the Grafana Admin and Editor roles in this * workspace. If you use this operation without specifying userId or groupId, the * operation returns the roles of all users and groups. If you specify a userId or a * groupId, only the roles for that user or group are returned. If you do this, you can specify only * one userId or one groupId. *

*
*

* This is a variant of * {@link #listPermissions(software.amazon.awssdk.services.grafana.model.ListPermissionsRequest)} operation. The * return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will * internally handle making service calls for you. *

*

* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet * and so there is no guarantee that the request is valid. If there are errors in your request, you will see the * failures only after you start streaming the data. The subscribe method should be called as a request to start * streaming data. For more info, see * {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe * method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the * starting request. *

* *

* The following are few ways to use the response class: *

* 1) Using the subscribe helper method * *
     * {@code
     * software.amazon.awssdk.services.grafana.paginators.ListPermissionsPublisher publisher = client.listPermissionsPaginator(request);
     * CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
     * future.get();
     * }
     * 
* * 2) Using a custom subscriber * *
     * {@code
     * software.amazon.awssdk.services.grafana.paginators.ListPermissionsPublisher publisher = client.listPermissionsPaginator(request);
     * publisher.subscribe(new Subscriber() {
     * 
     * public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
     * 
     * 
     * public void onNext(software.amazon.awssdk.services.grafana.model.ListPermissionsResponse response) { //... };
     * });}
     * 
* * As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2. *

* Please notice that the configuration of maxResults won't limit the number of results you get with the * paginator. It only limits the number of results in each page. *

*

* Note: If you prefer to have control on service calls, use the * {@link #listPermissions(software.amazon.awssdk.services.grafana.model.ListPermissionsRequest)} operation. *

*

* This is a convenience which creates an instance of the {@link ListPermissionsRequest.Builder} avoiding the need * to create one manually via {@link ListPermissionsRequest#builder()} *

* * @param listPermissionsRequest * A {@link Consumer} that will call methods on {@link ListPermissionsRequest.Builder} to create a request. * @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following * exceptions. *
    *
  • ResourceNotFoundException The request references a resource that does not exist.
  • *
  • ThrottlingException The request was denied because of request throttling. Retry the request.
  • *
  • ValidationException The value of a parameter in the request caused an error.
  • *
  • AccessDeniedException You do not have sufficient permissions to perform this action.
  • *
  • InternalServerException Unexpected error while processing the request. Retry the request.
  • *
  • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). * Can be used for catch all scenarios.
  • *
  • SdkClientException If any client side error occurs such as an IO related failure, failure to get * credentials, etc.
  • *
  • GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an * instance of this type.
  • *
* @sample GrafanaAsyncClient.ListPermissions * @see AWS API * Documentation */ default ListPermissionsPublisher listPermissionsPaginator(Consumer listPermissionsRequest) { return listPermissionsPaginator(ListPermissionsRequest.builder().applyMutation(listPermissionsRequest).build()); } /** *

* Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace. * For more complete information about one workspace, use DescribeWorkspace. *

* * @param listWorkspacesRequest * @return A Java Future containing the result of the ListWorkspaces operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following * exceptions. *
    *
  • ThrottlingException The request was denied because of request throttling. Retry the request.
  • *
  • AccessDeniedException You do not have sufficient permissions to perform this action.
  • *
  • InternalServerException Unexpected error while processing the request. Retry the request.
  • *
  • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). * Can be used for catch all scenarios.
  • *
  • SdkClientException If any client side error occurs such as an IO related failure, failure to get * credentials, etc.
  • *
  • GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an * instance of this type.
  • *
* @sample GrafanaAsyncClient.ListWorkspaces * @see AWS API * Documentation */ default CompletableFuture listWorkspaces(ListWorkspacesRequest listWorkspacesRequest) { throw new UnsupportedOperationException(); } /** *

* Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace. * For more complete information about one workspace, use DescribeWorkspace. *

*
*

* This is a convenience which creates an instance of the {@link ListWorkspacesRequest.Builder} avoiding the need to * create one manually via {@link ListWorkspacesRequest#builder()} *

* * @param listWorkspacesRequest * A {@link Consumer} that will call methods on {@link ListWorkspacesRequest.Builder} to create a request. * @return A Java Future containing the result of the ListWorkspaces operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following * exceptions. *
    *
  • ThrottlingException The request was denied because of request throttling. Retry the request.
  • *
  • AccessDeniedException You do not have sufficient permissions to perform this action.
  • *
  • InternalServerException Unexpected error while processing the request. Retry the request.
  • *
  • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). * Can be used for catch all scenarios.
  • *
  • SdkClientException If any client side error occurs such as an IO related failure, failure to get * credentials, etc.
  • *
  • GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an * instance of this type.
  • *
* @sample GrafanaAsyncClient.ListWorkspaces * @see AWS API * Documentation */ default CompletableFuture listWorkspaces(Consumer listWorkspacesRequest) { return listWorkspaces(ListWorkspacesRequest.builder().applyMutation(listWorkspacesRequest).build()); } /** *

* Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace. * For more complete information about one workspace, use DescribeWorkspace. *

*
*

* This is a variant of {@link #listWorkspaces(software.amazon.awssdk.services.grafana.model.ListWorkspacesRequest)} * operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. * SDK will internally handle making service calls for you. *

*

* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet * and so there is no guarantee that the request is valid. If there are errors in your request, you will see the * failures only after you start streaming the data. The subscribe method should be called as a request to start * streaming data. For more info, see * {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe * method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the * starting request. *

* *

* The following are few ways to use the response class: *

* 1) Using the subscribe helper method * *
     * {@code
     * software.amazon.awssdk.services.grafana.paginators.ListWorkspacesPublisher publisher = client.listWorkspacesPaginator(request);
     * CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
     * future.get();
     * }
     * 
* * 2) Using a custom subscriber * *
     * {@code
     * software.amazon.awssdk.services.grafana.paginators.ListWorkspacesPublisher publisher = client.listWorkspacesPaginator(request);
     * publisher.subscribe(new Subscriber() {
     * 
     * public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
     * 
     * 
     * public void onNext(software.amazon.awssdk.services.grafana.model.ListWorkspacesResponse response) { //... };
     * });}
     * 
* * As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2. *

* Please notice that the configuration of maxResults won't limit the number of results you get with the * paginator. It only limits the number of results in each page. *

*

* Note: If you prefer to have control on service calls, use the * {@link #listWorkspaces(software.amazon.awssdk.services.grafana.model.ListWorkspacesRequest)} operation. *

* * @param listWorkspacesRequest * @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following * exceptions. *
    *
  • ThrottlingException The request was denied because of request throttling. Retry the request.
  • *
  • AccessDeniedException You do not have sufficient permissions to perform this action.
  • *
  • InternalServerException Unexpected error while processing the request. Retry the request.
  • *
  • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). * Can be used for catch all scenarios.
  • *
  • SdkClientException If any client side error occurs such as an IO related failure, failure to get * credentials, etc.
  • *
  • GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an * instance of this type.
  • *
* @sample GrafanaAsyncClient.ListWorkspaces * @see AWS API * Documentation */ default ListWorkspacesPublisher listWorkspacesPaginator(ListWorkspacesRequest listWorkspacesRequest) { throw new UnsupportedOperationException(); } /** *

* Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace. * For more complete information about one workspace, use DescribeWorkspace. *

*
*

* This is a variant of {@link #listWorkspaces(software.amazon.awssdk.services.grafana.model.ListWorkspacesRequest)} * operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. * SDK will internally handle making service calls for you. *

*

* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet * and so there is no guarantee that the request is valid. If there are errors in your request, you will see the * failures only after you start streaming the data. The subscribe method should be called as a request to start * streaming data. For more info, see * {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe * method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the * starting request. *

* *

* The following are few ways to use the response class: *

* 1) Using the subscribe helper method * *
     * {@code
     * software.amazon.awssdk.services.grafana.paginators.ListWorkspacesPublisher publisher = client.listWorkspacesPaginator(request);
     * CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
     * future.get();
     * }
     * 
* * 2) Using a custom subscriber * *
     * {@code
     * software.amazon.awssdk.services.grafana.paginators.ListWorkspacesPublisher publisher = client.listWorkspacesPaginator(request);
     * publisher.subscribe(new Subscriber() {
     * 
     * public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
     * 
     * 
     * public void onNext(software.amazon.awssdk.services.grafana.model.ListWorkspacesResponse response) { //... };
     * });}
     * 
* * As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2. *

* Please notice that the configuration of maxResults won't limit the number of results you get with the * paginator. It only limits the number of results in each page. *

*

* Note: If you prefer to have control on service calls, use the * {@link #listWorkspaces(software.amazon.awssdk.services.grafana.model.ListWorkspacesRequest)} operation. *

*

* This is a convenience which creates an instance of the {@link ListWorkspacesRequest.Builder} avoiding the need to * create one manually via {@link ListWorkspacesRequest#builder()} *

* * @param listWorkspacesRequest * A {@link Consumer} that will call methods on {@link ListWorkspacesRequest.Builder} to create a request. * @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following * exceptions. *
    *
  • ThrottlingException The request was denied because of request throttling. Retry the request.
  • *
  • AccessDeniedException You do not have sufficient permissions to perform this action.
  • *
  • InternalServerException Unexpected error while processing the request. Retry the request.
  • *
  • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). * Can be used for catch all scenarios.
  • *
  • SdkClientException If any client side error occurs such as an IO related failure, failure to get * credentials, etc.
  • *
  • GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an * instance of this type.
  • *
* @sample GrafanaAsyncClient.ListWorkspaces * @see AWS API * Documentation */ default ListWorkspacesPublisher listWorkspacesPaginator(Consumer listWorkspacesRequest) { return listWorkspacesPaginator(ListWorkspacesRequest.builder().applyMutation(listWorkspacesRequest).build()); } /** *

* Updates which users in a workspace have the Grafana Admin or Editor roles. *

* * @param updatePermissionsRequest * @return A Java Future containing the result of the UpdatePermissions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following * exceptions. *
    *
  • ResourceNotFoundException The request references a resource that does not exist.
  • *
  • ThrottlingException The request was denied because of request throttling. Retry the request.
  • *
  • ValidationException The value of a parameter in the request caused an error.
  • *
  • AccessDeniedException You do not have sufficient permissions to perform this action.
  • *
  • InternalServerException Unexpected error while processing the request. Retry the request.
  • *
  • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). * Can be used for catch all scenarios.
  • *
  • SdkClientException If any client side error occurs such as an IO related failure, failure to get * credentials, etc.
  • *
  • GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an * instance of this type.
  • *
* @sample GrafanaAsyncClient.UpdatePermissions * @see AWS API * Documentation */ default CompletableFuture updatePermissions(UpdatePermissionsRequest updatePermissionsRequest) { throw new UnsupportedOperationException(); } /** *

* Updates which users in a workspace have the Grafana Admin or Editor roles. *

*
*

* This is a convenience which creates an instance of the {@link UpdatePermissionsRequest.Builder} avoiding the need * to create one manually via {@link UpdatePermissionsRequest#builder()} *

* * @param updatePermissionsRequest * A {@link Consumer} that will call methods on {@link UpdatePermissionsRequest.Builder} to create a request. * @return A Java Future containing the result of the UpdatePermissions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following * exceptions. *
    *
  • ResourceNotFoundException The request references a resource that does not exist.
  • *
  • ThrottlingException The request was denied because of request throttling. Retry the request.
  • *
  • ValidationException The value of a parameter in the request caused an error.
  • *
  • AccessDeniedException You do not have sufficient permissions to perform this action.
  • *
  • InternalServerException Unexpected error while processing the request. Retry the request.
  • *
  • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). * Can be used for catch all scenarios.
  • *
  • SdkClientException If any client side error occurs such as an IO related failure, failure to get * credentials, etc.
  • *
  • GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an * instance of this type.
  • *
* @sample GrafanaAsyncClient.UpdatePermissions * @see AWS API * Documentation */ default CompletableFuture updatePermissions( Consumer updatePermissionsRequest) { return updatePermissions(UpdatePermissionsRequest.builder().applyMutation(updatePermissionsRequest).build()); } /** *

* Modifies an existing Amazon Managed Grafana workspace. If you use this operation and omit any optional * parameters, the existing values of those parameters are not changed. *

*

* To modify the user authentication methods that the workspace uses, such as SAML or Amazon Web Services SSO, use * * UpdateWorkspaceAuthentication. *

*

* To modify which users in the workspace have the Admin and Editor Grafana roles, use UpdatePermissions. *

* * @param updateWorkspaceRequest * @return A Java Future containing the result of the UpdateWorkspace operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following * exceptions. *
    *
  • ResourceNotFoundException The request references a resource that does not exist.
  • *
  • ThrottlingException The request was denied because of request throttling. Retry the request.
  • *
  • ConflictException A resource was in an inconsistent state during an update or a deletion.
  • *
  • ValidationException The value of a parameter in the request caused an error.
  • *
  • AccessDeniedException You do not have sufficient permissions to perform this action.
  • *
  • InternalServerException Unexpected error while processing the request. Retry the request.
  • *
  • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). * Can be used for catch all scenarios.
  • *
  • SdkClientException If any client side error occurs such as an IO related failure, failure to get * credentials, etc.
  • *
  • GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an * instance of this type.
  • *
* @sample GrafanaAsyncClient.UpdateWorkspace * @see AWS API * Documentation */ default CompletableFuture updateWorkspace(UpdateWorkspaceRequest updateWorkspaceRequest) { throw new UnsupportedOperationException(); } /** *

* Modifies an existing Amazon Managed Grafana workspace. If you use this operation and omit any optional * parameters, the existing values of those parameters are not changed. *

*

* To modify the user authentication methods that the workspace uses, such as SAML or Amazon Web Services SSO, use * * UpdateWorkspaceAuthentication. *

*

* To modify which users in the workspace have the Admin and Editor Grafana roles, use UpdatePermissions. *

*
*

* This is a convenience which creates an instance of the {@link UpdateWorkspaceRequest.Builder} avoiding the need * to create one manually via {@link UpdateWorkspaceRequest#builder()} *

* * @param updateWorkspaceRequest * A {@link Consumer} that will call methods on {@link UpdateWorkspaceRequest.Builder} to create a request. * @return A Java Future containing the result of the UpdateWorkspace operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following * exceptions. *
    *
  • ResourceNotFoundException The request references a resource that does not exist.
  • *
  • ThrottlingException The request was denied because of request throttling. Retry the request.
  • *
  • ConflictException A resource was in an inconsistent state during an update or a deletion.
  • *
  • ValidationException The value of a parameter in the request caused an error.
  • *
  • AccessDeniedException You do not have sufficient permissions to perform this action.
  • *
  • InternalServerException Unexpected error while processing the request. Retry the request.
  • *
  • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). * Can be used for catch all scenarios.
  • *
  • SdkClientException If any client side error occurs such as an IO related failure, failure to get * credentials, etc.
  • *
  • GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an * instance of this type.
  • *
* @sample GrafanaAsyncClient.UpdateWorkspace * @see AWS API * Documentation */ default CompletableFuture updateWorkspace( Consumer updateWorkspaceRequest) { return updateWorkspace(UpdateWorkspaceRequest.builder().applyMutation(updateWorkspaceRequest).build()); } /** *

* Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using * SAML. You can also map SAML assertion attributes to workspace user information and define which groups in the * assertion attribute are to have the Admin and Editor roles in the workspace. *

* * @param updateWorkspaceAuthenticationRequest * @return A Java Future containing the result of the UpdateWorkspaceAuthentication operation returned by the * service.
* The CompletableFuture returned by this method can be completed exceptionally with the following * exceptions. *
    *
  • ResourceNotFoundException The request references a resource that does not exist.
  • *
  • ThrottlingException The request was denied because of request throttling. Retry the request.
  • *
  • ConflictException A resource was in an inconsistent state during an update or a deletion.
  • *
  • ValidationException The value of a parameter in the request caused an error.
  • *
  • AccessDeniedException You do not have sufficient permissions to perform this action.
  • *
  • InternalServerException Unexpected error while processing the request. Retry the request.
  • *
  • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). * Can be used for catch all scenarios.
  • *
  • SdkClientException If any client side error occurs such as an IO related failure, failure to get * credentials, etc.
  • *
  • GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an * instance of this type.
  • *
* @sample GrafanaAsyncClient.UpdateWorkspaceAuthentication * @see AWS API Documentation */ default CompletableFuture updateWorkspaceAuthentication( UpdateWorkspaceAuthenticationRequest updateWorkspaceAuthenticationRequest) { throw new UnsupportedOperationException(); } /** *

* Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using * SAML. You can also map SAML assertion attributes to workspace user information and define which groups in the * assertion attribute are to have the Admin and Editor roles in the workspace. *

*
*

* This is a convenience which creates an instance of the {@link UpdateWorkspaceAuthenticationRequest.Builder} * avoiding the need to create one manually via {@link UpdateWorkspaceAuthenticationRequest#builder()} *

* * @param updateWorkspaceAuthenticationRequest * A {@link Consumer} that will call methods on {@link UpdateWorkspaceAuthenticationRequest.Builder} to * create a request. * @return A Java Future containing the result of the UpdateWorkspaceAuthentication operation returned by the * service.
* The CompletableFuture returned by this method can be completed exceptionally with the following * exceptions. *
    *
  • ResourceNotFoundException The request references a resource that does not exist.
  • *
  • ThrottlingException The request was denied because of request throttling. Retry the request.
  • *
  • ConflictException A resource was in an inconsistent state during an update or a deletion.
  • *
  • ValidationException The value of a parameter in the request caused an error.
  • *
  • AccessDeniedException You do not have sufficient permissions to perform this action.
  • *
  • InternalServerException Unexpected error while processing the request. Retry the request.
  • *
  • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). * Can be used for catch all scenarios.
  • *
  • SdkClientException If any client side error occurs such as an IO related failure, failure to get * credentials, etc.
  • *
  • GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an * instance of this type.
  • *
* @sample GrafanaAsyncClient.UpdateWorkspaceAuthentication * @see AWS API Documentation */ default CompletableFuture updateWorkspaceAuthentication( Consumer updateWorkspaceAuthenticationRequest) { return updateWorkspaceAuthentication(UpdateWorkspaceAuthenticationRequest.builder() .applyMutation(updateWorkspaceAuthenticationRequest).build()); } }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy