@aws-sdk/client-grafana 3.295.0 → 3.297.0

package/dist-types/models/models_0.d.ts

@@ -1,6 +1,7 @@
 import { ExceptionOptionType as __ExceptionOptionType, LazyJsonString as __LazyJsonString } from "@aws-sdk/smithy-client";
 import { GrafanaServiceException as __BaseException } from "./GrafanaServiceException";
 /**
+ * @public
  * <p>You do not have sufficient permissions to perform this action. </p>
  */
 export declare class AccessDeniedException extends __BaseException {
@@ -11,6 +12,9 @@ export declare class AccessDeniedException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
 }
+/**
+ * @public
+ */
 export declare enum AccountAccessType {
     /**
      * Indicates that the customer is using Grafana to monitor resources in their current account.
@@ -22,6 +26,7 @@ export declare enum AccountAccessType {
     ORGANIZATION = "ORGANIZATION"
 }
 /**
+ * @public
  * <p>A resource was in an inconsistent state during an update or a deletion.</p>
  */
 export declare class ConflictException extends __BaseException {
@@ -40,6 +45,9 @@ export declare class ConflictException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface CreateWorkspaceApiKeyRequest {
     /**
      * <p>Specifies the name of the key. Keynames must be unique to the workspace.</p>
@@ -61,6 +69,9 @@ export interface CreateWorkspaceApiKeyRequest {
      */
     workspaceId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface CreateWorkspaceApiKeyResponse {
     /**
      * <p>The name of the key that was created.</p>
@@ -77,6 +88,7 @@ export interface CreateWorkspaceApiKeyResponse {
     workspaceId: string | undefined;
 }
 /**
+ * @public
  * <p>Unexpected error while processing the request. Retry the request.</p>
  */
 export declare class InternalServerException extends __BaseException {
@@ -93,6 +105,7 @@ export declare class InternalServerException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request references a resource that does not exist.</p>
  */
 export declare class ResourceNotFoundException extends __BaseException {
@@ -112,6 +125,7 @@ export declare class ResourceNotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request would cause a service quota to be exceeded.</p>
  */
 export declare class ServiceQuotaExceededException extends __BaseException {
@@ -139,6 +153,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request was denied because of request throttling. Retry the request.</p>
  */
 export declare class ThrottlingException extends __BaseException {
@@ -163,6 +178,7 @@ export declare class ThrottlingException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
 }
 /**
+ * @public
  * <p>A structure that contains information about a request parameter that caused an
  *             error.</p>
  */
@@ -176,6 +192,9 @@ export interface ValidationExceptionField {
      */
     message: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum ValidationExceptionReason {
     CANNOT_PARSE = "CANNOT_PARSE",
     FIELD_VALIDATION_FAILED = "FIELD_VALIDATION_FAILED",
@@ -183,6 +202,7 @@ export declare enum ValidationExceptionReason {
     UNKNOWN_OPERATION = "UNKNOWN_OPERATION"
 }
 /**
+ * @public
  * <p>The value of a parameter in the request caused an error.</p>
  */
 export declare class ValidationException extends __BaseException {
@@ -201,6 +221,9 @@ export declare class ValidationException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface DeleteWorkspaceApiKeyRequest {
     /**
      * <p>The name of the API key to delete.</p>
@@ -211,6 +234,9 @@ export interface DeleteWorkspaceApiKeyRequest {
      */
     workspaceId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteWorkspaceApiKeyResponse {
     /**
      * <p>The name of the key that was deleted.</p>
@@ -222,6 +248,7 @@ export interface DeleteWorkspaceApiKeyResponse {
     workspaceId: string | undefined;
 }
 /**
+ * @public
  * <p>A structure that defines which attributes in the IdP assertion are to be used to
  *             define information about the users authenticated by the IdP to use the workspace.</p>
  */
@@ -256,6 +283,9 @@ export interface AssertionAttributes {
      */
     org?: string;
 }
+/**
+ * @public
+ */
 export declare enum LicenseType {
     /**
      * Grafana Enterprise License.
@@ -266,6 +296,9 @@ export declare enum LicenseType {
      */
     ENTERPRISE_FREE_TRIAL = "ENTERPRISE_FREE_TRIAL"
 }
+/**
+ * @public
+ */
 export interface AssociateLicenseRequest {
     /**
      * <p>The ID of the workspace to associate the license with.</p>
@@ -276,6 +309,9 @@ export interface AssociateLicenseRequest {
      */
     licenseType: LicenseType | string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum AuthenticationProviderTypes {
     /**
      * Indicates that AMG workspace has AWS SSO enabled as its authentication provider.
@@ -286,6 +322,9 @@ export declare enum AuthenticationProviderTypes {
      */
     SAML = "SAML"
 }
+/**
+ * @public
+ */
 export declare enum SamlConfigurationStatus {
     /**
      * Indicates that SAML on an AMG workspace is enabled and has been configured.
@@ -297,6 +336,7 @@ export declare enum SamlConfigurationStatus {
     NOT_CONFIGURED = "NOT_CONFIGURED"
 }
 /**
+ * @public
  * <p>A structure that describes whether the workspace uses SAML, IAM Identity Center, or
  *             both methods for user authentication, and whether that authentication is fully
  *             configured.</p>
@@ -313,6 +353,9 @@ export interface AuthenticationSummary {
      */
     samlConfigurationStatus?: SamlConfigurationStatus | string;
 }
+/**
+ * @public
+ */
 export declare enum DataSourceType {
     /**
      * Amazon OpenSearch Service
@@ -352,6 +395,7 @@ export declare enum DataSourceType {
     XRAY = "XRAY"
 }
 /**
+ * @public
  * <p>The configuration settings for in-bound network access to your workspace.</p>
  *          <p>When this is configured, only listed IP addresses and VPC endpoints will be able to
  *             access your workspace. Standard Grafana authentication and authorization will still be
@@ -392,12 +436,18 @@ export interface NetworkAccessConfiguration {
      */
     vpceIds: string[] | undefined;
 }
+/**
+ * @public
+ */
 export declare enum NotificationDestinationType {
     /**
      * AWS Simple Notification Service
      */
     SNS = "SNS"
 }
+/**
+ * @public
+ */
 export declare enum PermissionType {
     /**
      * Customer Managed
@@ -408,6 +458,9 @@ export declare enum PermissionType {
      */
     SERVICE_MANAGED = "SERVICE_MANAGED"
 }
+/**
+ * @public
+ */
 export declare enum WorkspaceStatus {
     /**
      * Workspace is active.
@@ -455,6 +508,7 @@ export declare enum WorkspaceStatus {
     UPGRADING = "UPGRADING"
 }
 /**
+ * @public
  * <p>The configuration settings for an Amazon VPC that contains data sources for
  *             your Grafana workspace to connect to.</p>
  *          <note>
@@ -475,6 +529,7 @@ export interface VpcConfiguration {
     subnetIds: string[] | undefined;
 }
 /**
+ * @public
  * <p>A structure containing information about an Amazon Managed Grafana workspace in your
  *             account.</p>
  */
@@ -610,12 +665,18 @@ export interface WorkspaceDescription {
      */
     networkAccessControl?: NetworkAccessConfiguration;
 }
+/**
+ * @public
+ */
 export interface AssociateLicenseResponse {
     /**
      * <p>A structure containing data about the workspace.</p>
      */
     workspace: WorkspaceDescription | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeWorkspaceAuthenticationRequest {
     /**
      * <p>The ID of the workspace to return authentication information about.</p>
@@ -623,6 +684,7 @@ export interface DescribeWorkspaceAuthenticationRequest {
     workspaceId: string | undefined;
 }
 /**
+ * @public
  * <p>A structure containing information about how this workspace works with IAM Identity Center. </p>
  */
 export interface AwsSsoAuthentication {
@@ -632,6 +694,7 @@ export interface AwsSsoAuthentication {
     ssoClientId?: string;
 }
 /**
+ * @public
  * <p>A structure containing the identity provider (IdP) metadata used to integrate the
  *             identity provider with this workspace. You can specify the metadata either by providing
  *             a URL to its location in the <code>url</code> parameter, or by specifying the full
@@ -639,6 +702,9 @@ export interface AwsSsoAuthentication {
  *             error.</p>
  */
 export type IdpMetadata = IdpMetadata.UrlMember | IdpMetadata.XmlMember | IdpMetadata.$UnknownMember;
+/**
+ * @public
+ */
 export declare namespace IdpMetadata {
     /**
      * <p>The URL of the location containing the IdP metadata.</p>
@@ -669,6 +735,7 @@ export declare namespace IdpMetadata {
     const visit: <T>(value: IdpMetadata, visitor: Visitor<T>) => T;
 }
 /**
+ * @public
  * <p>This structure defines which groups defined in the SAML assertion attribute are to be
  *             mapped to the Grafana <code>Admin</code> and <code>Editor</code> roles in the workspace.
  *             SAML authenticated users not part of <code>Admin</code> or <code>Editor</code> role
@@ -687,6 +754,7 @@ export interface RoleValues {
     admin?: string[];
 }
 /**
+ * @public
  * <p>A structure containing information about how this workspace works with SAML. </p>
  */
 export interface SamlConfiguration {
@@ -718,6 +786,7 @@ export interface SamlConfiguration {
     loginValidityDuration?: number;
 }
 /**
+ * @public
  * <p>A structure containing information about how this workspace works with SAML. </p>
  */
 export interface SamlAuthentication {
@@ -731,6 +800,7 @@ export interface SamlAuthentication {
     configuration?: SamlConfiguration;
 }
 /**
+ * @public
  * <p>A structure containing information about the user authentication methods used by the
  *             workspace.</p>
  */
@@ -752,6 +822,9 @@ export interface AuthenticationDescription {
      */
     awsSso?: AwsSsoAuthentication;
 }
+/**
+ * @public
+ */
 export interface DescribeWorkspaceAuthenticationResponse {
     /**
      * <p>A structure containing information about the authentication methods used in the
@@ -759,6 +832,9 @@ export interface DescribeWorkspaceAuthenticationResponse {
      */
     authentication: AuthenticationDescription | undefined;
 }
+/**
+ * @public
+ */
 export interface UpdateWorkspaceAuthenticationRequest {
     /**
      * <p>The ID of the workspace to update the authentication for.</p>
@@ -778,6 +854,9 @@ export interface UpdateWorkspaceAuthenticationRequest {
      */
     samlConfiguration?: SamlConfiguration;
 }
+/**
+ * @public
+ */
 export interface UpdateWorkspaceAuthenticationResponse {
     /**
      * <p>A structure that describes the user authentication for this workspace after the update
@@ -785,12 +864,18 @@ export interface UpdateWorkspaceAuthenticationResponse {
      */
     authentication: AuthenticationDescription | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeWorkspaceConfigurationRequest {
     /**
      * <p>The ID of the workspace to get configuration information for.</p>
      */
     workspaceId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeWorkspaceConfigurationResponse {
     /**
      * <p>The configuration string for the workspace that you requested. For more information
@@ -799,6 +884,9 @@ export interface DescribeWorkspaceConfigurationResponse {
      */
     configuration: __LazyJsonString | string | undefined;
 }
+/**
+ * @public
+ */
 export interface UpdateWorkspaceConfigurationRequest {
     /**
      * <p>The new configuration string for the workspace. For more information about the format
@@ -811,8 +899,14 @@ export interface UpdateWorkspaceConfigurationRequest {
      */
     workspaceId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface UpdateWorkspaceConfigurationResponse {
 }
+/**
+ * @public
+ */
 export interface DisassociateLicenseRequest {
     /**
      * <p>The ID of the workspace to remove the Grafana Enterprise license from.</p>
@@ -823,24 +917,36 @@ export interface DisassociateLicenseRequest {
      */
     licenseType: LicenseType | string | undefined;
 }
+/**
+ * @public
+ */
 export interface DisassociateLicenseResponse {
     /**
      * <p>A structure containing information about the workspace.</p>
      */
     workspace: WorkspaceDescription | undefined;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceRequest {
     /**
      * <p>The ARN of the resource the list of tags are associated with.</p>
      */
     resourceArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceResponse {
     /**
      * <p>The list of tags that are associated with the resource.</p>
      */
     tags?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export declare enum UserType {
     /**
      * SSO group.
@@ -851,6 +957,9 @@ export declare enum UserType {
      */
     SSO_USER = "SSO_USER"
 }
+/**
+ * @public
+ */
 export interface ListPermissionsRequest {
     /**
      * <p>The maximum number of results to include in the response.</p>
@@ -879,6 +988,9 @@ export interface ListPermissionsRequest {
      */
     workspaceId: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum Role {
     /**
      * Role Admin.
@@ -894,13 +1006,14 @@ export declare enum Role {
     VIEWER = "VIEWER"
 }
 /**
+ * @public
  * <p>A structure that specifies one user or group in the workspace.</p>
  */
 export interface User {
     /**
      * <p>The ID of the user or group.</p>
      *          <p>Pattern:
-     *                 <code>^([0-9a-fA-F]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$</code>
+     *                 <code>^([0-9a-fA-F]\{10\}-|)[A-Fa-f0-9]\{8\}-[A-Fa-f0-9]\{4\}-[A-Fa-f0-9]\{4\}-[A-Fa-f0-9]\{4\}-[A-Fa-f0-9]\{12\}$</code>
      *          </p>
      */
     id: string | undefined;
@@ -910,6 +1023,7 @@ export interface User {
     type: UserType | string | undefined;
 }
 /**
+ * @public
  * <p>A structure containing the identity of one user or group and the <code>Admin</code>,
  *                 <code>Editor</code>, or <code>Viewer</code> role that they have.</p>
  */
@@ -924,6 +1038,9 @@ export interface PermissionEntry {
      */
     role: Role | string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListPermissionsResponse {
     /**
      * <p>The token to use in a subsequent <code>ListPermissions</code> operation to return the
@@ -935,6 +1052,9 @@ export interface ListPermissionsResponse {
      */
     permissions: PermissionEntry[] | undefined;
 }
+/**
+ * @public
+ */
 export declare enum UpdateAction {
     /**
      * Add permissions.
@@ -946,6 +1066,7 @@ export declare enum UpdateAction {
     REVOKE = "REVOKE"
 }
 /**
+ * @public
  * <p>Contains the instructions for one Grafana role permission update in a <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdatePermissions.html">UpdatePermissions</a> operation.</p>
  */
 export interface UpdateInstruction {
@@ -963,6 +1084,9 @@ export interface UpdateInstruction {
      */
     users: User[] | undefined;
 }
+/**
+ * @public
+ */
 export interface UpdatePermissionsRequest {
     /**
      * <p>An array of structures that contain the permission updates to make.</p>
@@ -974,6 +1098,7 @@ export interface UpdatePermissionsRequest {
     workspaceId: string | undefined;
 }
 /**
+ * @public
  * <p>A structure containing information about one error encountered while performing an
  *                 <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdatePermissions.html">UpdatePermissions</a> operation.</p>
  */
@@ -991,12 +1116,18 @@ export interface UpdateError {
      */
     causedBy: UpdateInstruction | undefined;
 }
+/**
+ * @public
+ */
 export interface UpdatePermissionsResponse {
     /**
      * <p>An array of structures that contain the errors from the operation, if any.</p>
      */
     errors: UpdateError[] | undefined;
 }
+/**
+ * @public
+ */
 export interface TagResourceRequest {
     /**
      * <p>The ARN of the resource the tag is associated with.</p>
@@ -1008,8 +1139,14 @@ export interface TagResourceRequest {
      */
     tags: Record<string, string> | undefined;
 }
+/**
+ * @public
+ */
 export interface TagResourceResponse {
 }
+/**
+ * @public
+ */
 export interface UntagResourceRequest {
     /**
      * <p>The ARN of the resource the tag association is removed from. </p>
@@ -1020,8 +1157,14 @@ export interface UntagResourceRequest {
      */
     tagKeys: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface UntagResourceResponse {
 }
+/**
+ * @public
+ */
 export interface CreateWorkspaceRequest {
     /**
      * <p>Specifies whether the workspace can access Amazon Web Services resources in this
@@ -1072,7 +1215,7 @@ export interface CreateWorkspaceRequest {
     /**
      * <p>A description for the workspace. This is used only to help you identify this
      *             workspace.</p>
-     *          <p>Pattern: <code>^[\\p{L}\\p{Z}\\p{N}\\p{P}]{0,2048}$</code>
+     *          <p>Pattern: <code>^[\\p\{L\}\\p\{Z\}\\p\{N\}\\p\{P\}]\{0,2048\}$</code>
      *          </p>
      */
     workspaceDescription?: string;
@@ -1131,36 +1274,54 @@ export interface CreateWorkspaceRequest {
      */
     networkAccessControl?: NetworkAccessConfiguration;
 }
+/**
+ * @public
+ */
 export interface CreateWorkspaceResponse {
     /**
      * <p>A structure containing data about the workspace that was created.</p>
      */
     workspace: WorkspaceDescription | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteWorkspaceRequest {
     /**
      * <p>The ID of the workspace to delete.</p>
      */
     workspaceId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteWorkspaceResponse {
     /**
      * <p>A structure containing information about the workspace that was deleted.</p>
      */
     workspace: WorkspaceDescription | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeWorkspaceRequest {
     /**
      * <p>The ID of the workspace to display information about.</p>
      */
     workspaceId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeWorkspaceResponse {
     /**
      * <p>A structure containing information about the workspace.</p>
      */
     workspace: WorkspaceDescription | undefined;
 }
+/**
+ * @public
+ */
 export interface ListWorkspacesRequest {
     /**
      * <p>The maximum number of workspaces to include in the results.</p>
@@ -1173,6 +1334,7 @@ export interface ListWorkspacesRequest {
     nextToken?: string;
 }
 /**
+ * @public
  * <p>A structure that contains some information about one workspace in the account.</p>
  */
 export interface WorkspaceSummary {
@@ -1224,6 +1386,9 @@ export interface WorkspaceSummary {
      */
     tags?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface ListWorkspacesResponse {
     /**
      * <p>An array of structures that contain some information about the workspaces in the
@@ -1235,6 +1400,9 @@ export interface ListWorkspacesResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface UpdateWorkspaceRequest {
     /**
      * <p>Specifies whether the workspace can access Amazon Web Services resources in this
@@ -1347,6 +1515,9 @@ export interface UpdateWorkspaceRequest {
      */
     removeNetworkAccessConfiguration?: boolean;
 }
+/**
+ * @public
+ */
 export interface UpdateWorkspaceResponse {
     /**
      * <p>A structure containing data about the workspace that was created.</p>

package/dist-types/pagination/Interfaces.d.ts

@@ -1,5 +1,8 @@
 import { PaginationConfiguration } from "@aws-sdk/types";
 import { GrafanaClient } from "../GrafanaClient";
+/**
+ * @public
+ */
 export interface GrafanaPaginationConfiguration extends PaginationConfiguration {
     client: GrafanaClient;
 }

package/dist-types/pagination/ListPermissionsPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListPermissionsCommandInput, ListPermissionsCommandOutput } from "../commands/ListPermissionsCommand";
 import { GrafanaPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListPermissions(config: GrafanaPaginationConfiguration, input: ListPermissionsCommandInput, ...additionalArguments: any): Paginator<ListPermissionsCommandOutput>;

package/dist-types/pagination/ListWorkspacesPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListWorkspacesCommandInput, ListWorkspacesCommandOutput } from "../commands/ListWorkspacesCommand";
 import { GrafanaPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListWorkspaces(config: GrafanaPaginationConfiguration, input: ListWorkspacesCommandInput, ...additionalArguments: any): Paginator<ListWorkspacesCommandOutput>;