/*
* 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.
*/
/*
* Do not modify this file. This file is generated from the grafana-2020-08-18.normal.json service model.
*/
using System;
using System.Threading;
using System.Threading.Tasks;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.ManagedGrafana.Model;
namespace Amazon.ManagedGrafana
{
///
/// Interface for accessing ManagedGrafana
///
/// 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.
///
///
public partial interface IAmazonManagedGrafana : IAmazonService, IDisposable
{
#if AWS_ASYNC_ENUMERABLES_API
///
/// Paginators for the service
///
IManagedGrafanaPaginatorFactory Paginators { get; }
#endif
#region AssociateLicense
///
/// 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.
///
/// Container for the necessary parameters to execute the AssociateLicense service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the AssociateLicense service method, as returned by ManagedGrafana.
///
/// You do not have sufficient permissions to perform this action.
///
///
/// Unexpected error while processing the request. Retry the request.
///
///
/// The request references a resource that does not exist.
///
///
/// The request was denied because of request throttling. Retry the request.
///
///
/// The value of a parameter in the request caused an error.
///
/// REST API Reference for AssociateLicense Operation
Task AssociateLicenseAsync(AssociateLicenseRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateWorkspace
///
/// 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.
///
///
/// Container for the necessary parameters to execute the CreateWorkspace service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateWorkspace service method, as returned by ManagedGrafana.
///
/// You do not have sufficient permissions to perform this action.
///
///
/// A resource was in an inconsistent state during an update or a deletion.
///
///
/// Unexpected error while processing the request. Retry the request.
///
///
/// The request would cause a service quota to be exceeded.
///
///
/// The request was denied because of request throttling. Retry the request.
///
///
/// The value of a parameter in the request caused an error.
///
/// REST API Reference for CreateWorkspace Operation
Task CreateWorkspaceAsync(CreateWorkspaceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateWorkspaceApiKey
///
/// Creates a Grafana API key for the workspace. This key can be used to authenticate
/// requests sent to the workspace's HTTP API. See https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html
/// for available APIs and example requests.
///
/// Container for the necessary parameters to execute the CreateWorkspaceApiKey service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateWorkspaceApiKey service method, as returned by ManagedGrafana.
///
/// You do not have sufficient permissions to perform this action.
///
///
/// A resource was in an inconsistent state during an update or a deletion.
///
///
/// Unexpected error while processing the request. Retry the request.
///
///
/// The request references a resource that does not exist.
///
///
/// The request would cause a service quota to be exceeded.
///
///
/// The request was denied because of request throttling. Retry the request.
///
///
/// The value of a parameter in the request caused an error.
///
/// REST API Reference for CreateWorkspaceApiKey Operation
Task CreateWorkspaceApiKeyAsync(CreateWorkspaceApiKeyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteWorkspace
///
/// Deletes an Amazon Managed Grafana workspace.
///
/// Container for the necessary parameters to execute the DeleteWorkspace service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteWorkspace service method, as returned by ManagedGrafana.
///
/// You do not have sufficient permissions to perform this action.
///
///
/// A resource was in an inconsistent state during an update or a deletion.
///
///
/// Unexpected error while processing the request. Retry the request.
///
///
/// The request references a resource that does not exist.
///
///
/// The request was denied because of request throttling. Retry the request.
///
///
/// The value of a parameter in the request caused an error.
///
/// REST API Reference for DeleteWorkspace Operation
Task DeleteWorkspaceAsync(DeleteWorkspaceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteWorkspaceApiKey
///
/// Deletes a Grafana API key for the workspace.
///
/// Container for the necessary parameters to execute the DeleteWorkspaceApiKey service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteWorkspaceApiKey service method, as returned by ManagedGrafana.
///
/// You do not have sufficient permissions to perform this action.
///
///
/// A resource was in an inconsistent state during an update or a deletion.
///
///
/// Unexpected error while processing the request. Retry the request.
///
///
/// The request references a resource that does not exist.
///
///
/// The request was denied because of request throttling. Retry the request.
///
///
/// The value of a parameter in the request caused an error.
///
/// REST API Reference for DeleteWorkspaceApiKey Operation
Task DeleteWorkspaceApiKeyAsync(DeleteWorkspaceApiKeyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeWorkspace
///
/// Displays information about one Amazon Managed Grafana workspace.
///
/// Container for the necessary parameters to execute the DescribeWorkspace service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeWorkspace service method, as returned by ManagedGrafana.
///
/// You do not have sufficient permissions to perform this action.
///
///
/// Unexpected error while processing the request. Retry the request.
///
///
/// The request references a resource that does not exist.
///
///
/// The request was denied because of request throttling. Retry the request.
///
///
/// The value of a parameter in the request caused an error.
///
/// REST API Reference for DescribeWorkspace Operation
Task DescribeWorkspaceAsync(DescribeWorkspaceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeWorkspaceAuthentication
///
/// Displays information about the authentication methods used in one Amazon Managed Grafana
/// workspace.
///
/// Container for the necessary parameters to execute the DescribeWorkspaceAuthentication service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeWorkspaceAuthentication service method, as returned by ManagedGrafana.
///
/// You do not have sufficient permissions to perform this action.
///
///
/// Unexpected error while processing the request. Retry the request.
///
///
/// The request references a resource that does not exist.
///
///
/// The request was denied because of request throttling. Retry the request.
///
///
/// The value of a parameter in the request caused an error.
///
/// REST API Reference for DescribeWorkspaceAuthentication Operation
Task DescribeWorkspaceAuthenticationAsync(DescribeWorkspaceAuthenticationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeWorkspaceConfiguration
///
/// Gets the current configuration string for the given workspace.
///
/// Container for the necessary parameters to execute the DescribeWorkspaceConfiguration service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeWorkspaceConfiguration service method, as returned by ManagedGrafana.
///
/// You do not have sufficient permissions to perform this action.
///
///
/// Unexpected error while processing the request. Retry the request.
///
///
/// The request references a resource that does not exist.
///
///
/// The request was denied because of request throttling. Retry the request.
///
/// REST API Reference for DescribeWorkspaceConfiguration Operation
Task DescribeWorkspaceConfigurationAsync(DescribeWorkspaceConfigurationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DisassociateLicense
///
/// Removes the Grafana Enterprise license from a workspace.
///
/// Container for the necessary parameters to execute the DisassociateLicense service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DisassociateLicense service method, as returned by ManagedGrafana.
///
/// You do not have sufficient permissions to perform this action.
///
///
/// Unexpected error while processing the request. Retry the request.
///
///
/// The request references a resource that does not exist.
///
///
/// The request was denied because of request throttling. Retry the request.
///
///
/// The value of a parameter in the request caused an error.
///
/// REST API Reference for DisassociateLicense Operation
Task DisassociateLicenseAsync(DisassociateLicenseRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListPermissions
///
/// 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.
///
/// Container for the necessary parameters to execute the ListPermissions service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListPermissions service method, as returned by ManagedGrafana.
///
/// You do not have sufficient permissions to perform this action.
///
///
/// Unexpected error while processing the request. Retry the request.
///
///
/// The request references a resource that does not exist.
///
///
/// The request was denied because of request throttling. Retry the request.
///
///
/// The value of a parameter in the request caused an error.
///
/// REST API Reference for ListPermissions Operation
Task ListPermissionsAsync(ListPermissionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListTagsForResource
///
/// The ListTagsForResource operation returns the tags that are associated
/// with the Amazon Managed Service for Grafana resource specified by the resourceArn.
/// Currently, the only resource that can be tagged is a workspace.
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListTagsForResource service method, as returned by ManagedGrafana.
///
/// You do not have sufficient permissions to perform this action.
///
///
/// Unexpected error while processing the request. Retry the request.
///
///
/// The request references a resource that does not exist.
///
///
/// The request was denied because of request throttling. Retry the request.
///
///
/// The value of a parameter in the request caused an error.
///
/// REST API Reference for ListTagsForResource Operation
Task ListTagsForResourceAsync(ListTagsForResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListVersions
///
/// Lists available versions of Grafana. These are available when calling CreateWorkspace.
/// Optionally, include a workspace to list the versions to which it can be upgraded.
///
/// Container for the necessary parameters to execute the ListVersions service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListVersions service method, as returned by ManagedGrafana.
///
/// You do not have sufficient permissions to perform this action.
///
///
/// Unexpected error while processing the request. Retry the request.
///
///
/// The request references a resource that does not exist.
///
///
/// The request was denied because of request throttling. Retry the request.
///
///
/// The value of a parameter in the request caused an error.
///
/// REST API Reference for ListVersions Operation
Task ListVersionsAsync(ListVersionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListWorkspaces
///
/// 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.
///
/// Container for the necessary parameters to execute the ListWorkspaces service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListWorkspaces service method, as returned by ManagedGrafana.
///
/// You do not have sufficient permissions to perform this action.
///
///
/// Unexpected error while processing the request. Retry the request.
///
///
/// The request was denied because of request throttling. Retry the request.
///
/// REST API Reference for ListWorkspaces Operation
Task ListWorkspacesAsync(ListWorkspacesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region TagResource
///
/// The TagResource operation associates tags with an Amazon Managed Grafana
/// resource. Currently, the only resource that can be tagged is workspaces.
///
///
///
/// If you specify a new tag key for the resource, this tag is appended to the list of
/// tags associated with the resource. If you specify a tag key that is already associated
/// with the resource, the new tag value that you specify replaces the previous value
/// for that tag.
///
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the TagResource service method, as returned by ManagedGrafana.
///
/// You do not have sufficient permissions to perform this action.
///
///
/// Unexpected error while processing the request. Retry the request.
///
///
/// The request references a resource that does not exist.
///
///
/// The request was denied because of request throttling. Retry the request.
///
///
/// The value of a parameter in the request caused an error.
///
/// REST API Reference for TagResource Operation
Task TagResourceAsync(TagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UntagResource
///
/// The UntagResource operation removes the association of the tag with the
/// Amazon Managed Grafana resource.
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UntagResource service method, as returned by ManagedGrafana.
///
/// You do not have sufficient permissions to perform this action.
///
///
/// Unexpected error while processing the request. Retry the request.
///
///
/// The request references a resource that does not exist.
///
///
/// The request was denied because of request throttling. Retry the request.
///
///
/// The value of a parameter in the request caused an error.
///
/// REST API Reference for UntagResource Operation
Task UntagResourceAsync(UntagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdatePermissions
///
/// Updates which users in a workspace have the Grafana Admin or Editor
/// roles.
///
/// Container for the necessary parameters to execute the UpdatePermissions service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdatePermissions service method, as returned by ManagedGrafana.
///
/// You do not have sufficient permissions to perform this action.
///
///
/// Unexpected error while processing the request. Retry the request.
///
///
/// The request references a resource that does not exist.
///
///
/// The request was denied because of request throttling. Retry the request.
///
///
/// The value of a parameter in the request caused an error.
///
/// REST API Reference for UpdatePermissions Operation
Task UpdatePermissionsAsync(UpdatePermissionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateWorkspace
///
/// 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
/// IAM Identity Center, use UpdateWorkspaceAuthentication.
///
///
///
/// To modify which users in the workspace have the Admin and Editor
/// Grafana roles, use UpdatePermissions.
///
///
/// Container for the necessary parameters to execute the UpdateWorkspace service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateWorkspace service method, as returned by ManagedGrafana.
///
/// You do not have sufficient permissions to perform this action.
///
///
/// A resource was in an inconsistent state during an update or a deletion.
///
///
/// Unexpected error while processing the request. Retry the request.
///
///
/// The request references a resource that does not exist.
///
///
/// The request was denied because of request throttling. Retry the request.
///
///
/// The value of a parameter in the request caused an error.
///
/// REST API Reference for UpdateWorkspace Operation
Task UpdateWorkspaceAsync(UpdateWorkspaceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateWorkspaceAuthentication
///
/// 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.
///
///
///
/// Changes to the authentication method for a workspace may take a few minutes to take
/// effect.
///
///
///
/// Container for the necessary parameters to execute the UpdateWorkspaceAuthentication service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateWorkspaceAuthentication service method, as returned by ManagedGrafana.
///
/// You do not have sufficient permissions to perform this action.
///
///
/// A resource was in an inconsistent state during an update or a deletion.
///
///
/// Unexpected error while processing the request. Retry the request.
///
///
/// The request references a resource that does not exist.
///
///
/// The request was denied because of request throttling. Retry the request.
///
///
/// The value of a parameter in the request caused an error.
///
/// REST API Reference for UpdateWorkspaceAuthentication Operation
Task UpdateWorkspaceAuthenticationAsync(UpdateWorkspaceAuthenticationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateWorkspaceConfiguration
///
/// Updates the configuration string for the given workspace
///
/// Container for the necessary parameters to execute the UpdateWorkspaceConfiguration service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateWorkspaceConfiguration service method, as returned by ManagedGrafana.
///
/// You do not have sufficient permissions to perform this action.
///
///
/// A resource was in an inconsistent state during an update or a deletion.
///
///
/// Unexpected error while processing the request. Retry the request.
///
///
/// The request references a resource that does not exist.
///
///
/// The request was denied because of request throttling. Retry the request.
///
///
/// The value of a parameter in the request caused an error.
///
/// REST API Reference for UpdateWorkspaceConfiguration Operation
Task UpdateWorkspaceConfigurationAsync(UpdateWorkspaceConfigurationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
}
}