@aws-sdk/client-grafana 3.379.1 → 3.382.0

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

@@ -38,10 +38,12 @@ export declare class ConflictException extends __BaseException {
     readonly name: "ConflictException";
     readonly $fault: "client";
     /**
+     * @public
      * <p>The ID of the resource that is associated with the error.</p>
      */
     resourceId: string | undefined;
     /**
+     * @public
      * <p>The type of the resource that is associated with the error.</p>
      */
     resourceType: string | undefined;
@@ -55,21 +57,25 @@ export declare class ConflictException extends __BaseException {
  */
 export interface CreateWorkspaceApiKeyRequest {
     /**
+     * @public
      * <p>Specifies the name of the key. Keynames must be unique to the workspace.</p>
      */
     keyName: string | undefined;
     /**
+     * @public
      * <p>Specifies the permission level of the key.</p>
      *          <p> Valid values: <code>VIEWER</code>|<code>EDITOR</code>|<code>ADMIN</code>
      *          </p>
      */
     keyRole: string | undefined;
     /**
+     * @public
      * <p>Specifies the time in seconds until the key expires. Keys can be valid for up to 30
      *             days.</p>
      */
     secondsToLive: number | undefined;
     /**
+     * @public
      * <p>The ID of the workspace to create an API key.</p>
      */
     workspaceId: string | undefined;
@@ -79,15 +85,18 @@ export interface CreateWorkspaceApiKeyRequest {
  */
 export interface CreateWorkspaceApiKeyResponse {
     /**
+     * @public
      * <p>The name of the key that was created.</p>
      */
     keyName: string | undefined;
     /**
+     * @public
      * <p>The key token. Use this value as a bearer token to authenticate HTTP requests to the
      *             workspace.</p>
      */
     key: string | undefined;
     /**
+     * @public
      * <p>The ID of the workspace that the key is valid for.</p>
      */
     workspaceId: string | undefined;
@@ -101,6 +110,7 @@ export declare class InternalServerException extends __BaseException {
     readonly $fault: "server";
     $retryable: {};
     /**
+     * @public
      * <p>How long to wait before you retry this operation.</p>
      */
     retryAfterSeconds?: number;
@@ -117,10 +127,12 @@ export declare class ResourceNotFoundException extends __BaseException {
     readonly name: "ResourceNotFoundException";
     readonly $fault: "client";
     /**
+     * @public
      * <p>The ID of the resource that is associated with the error.</p>
      */
     resourceId: string | undefined;
     /**
+     * @public
      * <p>The type of the resource that is associated with the error.</p>
      */
     resourceType: string | undefined;
@@ -137,18 +149,22 @@ export declare class ServiceQuotaExceededException extends __BaseException {
     readonly name: "ServiceQuotaExceededException";
     readonly $fault: "client";
     /**
+     * @public
      * <p>The ID of the resource that is associated with the error.</p>
      */
     resourceId: string | undefined;
     /**
+     * @public
      * <p>The type of the resource that is associated with the error.</p>
      */
     resourceType: string | undefined;
     /**
+     * @public
      * <p>The value of a parameter in the request caused an error.</p>
      */
     serviceCode: string | undefined;
     /**
+     * @public
      * <p>The ID of the service quota that was exceeded.</p>
      */
     quotaCode: string | undefined;
@@ -166,14 +182,17 @@ export declare class ThrottlingException extends __BaseException {
     readonly $fault: "client";
     $retryable: {};
     /**
+     * @public
      * <p>The ID of the service that is associated with the error.</p>
      */
     serviceCode?: string;
     /**
+     * @public
      * <p>The ID of the service quota that was exceeded.</p>
      */
     quotaCode?: string;
     /**
+     * @public
      * <p>The value of a parameter in the request caused an error.</p>
      */
     retryAfterSeconds?: number;
@@ -189,10 +208,12 @@ export declare class ThrottlingException extends __BaseException {
  */
 export interface ValidationExceptionField {
     /**
+     * @public
      * <p>The name of the field that caused the validation error.</p>
      */
     name: string | undefined;
     /**
+     * @public
      * <p>A message describing why this field couldn't be validated.</p>
      */
     message: string | undefined;
@@ -219,10 +240,12 @@ export declare class ValidationException extends __BaseException {
     readonly name: "ValidationException";
     readonly $fault: "client";
     /**
+     * @public
      * <p>The reason that the operation failed.</p>
      */
     reason: ValidationExceptionReason | string | undefined;
     /**
+     * @public
      * <p>A list of fields that might be associated with the error.</p>
      */
     fieldList?: ValidationExceptionField[];
@@ -236,10 +259,12 @@ export declare class ValidationException extends __BaseException {
  */
 export interface DeleteWorkspaceApiKeyRequest {
     /**
+     * @public
      * <p>The name of the API key to delete.</p>
      */
     keyName: string | undefined;
     /**
+     * @public
      * <p>The ID of the workspace to delete.</p>
      */
     workspaceId: string | undefined;
@@ -249,10 +274,12 @@ export interface DeleteWorkspaceApiKeyRequest {
  */
 export interface DeleteWorkspaceApiKeyResponse {
     /**
+     * @public
      * <p>The name of the key that was deleted.</p>
      */
     keyName: string | undefined;
     /**
+     * @public
      * <p>The ID of the workspace where the key was deleted.</p>
      */
     workspaceId: string | undefined;
@@ -264,30 +291,36 @@ export interface DeleteWorkspaceApiKeyResponse {
  */
 export interface AssertionAttributes {
     /**
+     * @public
      * <p>The name of the attribute within the SAML assertion to use as the user full "friendly"
      *             names for SAML users.</p>
      */
     name?: string;
     /**
+     * @public
      * <p>The name of the attribute within the SAML assertion to use as the login names for SAML
      *             users.</p>
      */
     login?: string;
     /**
+     * @public
      * <p>The name of the attribute within the SAML assertion to use as the email names for SAML
      *             users.</p>
      */
     email?: string;
     /**
+     * @public
      * <p>The name of the attribute within the SAML assertion to use as the user full "friendly"
      *             names for user groups.</p>
      */
     groups?: string;
     /**
+     * @public
      * <p>The name of the attribute within the SAML assertion to use as the user roles.</p>
      */
     role?: string;
     /**
+     * @public
      * <p>The name of the attribute within the SAML assertion to use as the user full "friendly"
      *             names for the users' organizations.</p>
      */
@@ -316,10 +349,12 @@ export type LicenseType = (typeof LicenseType)[keyof typeof LicenseType];
  */
 export interface AssociateLicenseRequest {
     /**
+     * @public
      * <p>The ID of the workspace to associate the license with.</p>
      */
     workspaceId: string | undefined;
     /**
+     * @public
      * <p>The type of license to associate with the workspace.</p>
      */
     licenseType: LicenseType | string | undefined;
@@ -368,11 +403,13 @@ export type SamlConfigurationStatus = (typeof SamlConfigurationStatus)[keyof typ
  */
 export interface AuthenticationSummary {
     /**
+     * @public
      * <p>Specifies whether the workspace uses SAML, IAM Identity Center, or both methods for
      *             user authentication.</p>
      */
     providers: (AuthenticationProviderTypes | string)[] | undefined;
     /**
+     * @public
      * <p>Specifies whether the workplace's user authentication method is fully
      *             configured.</p>
      */
@@ -445,6 +482,7 @@ export type DataSourceType = (typeof DataSourceType)[keyof typeof DataSourceType
  */
 export interface NetworkAccessConfiguration {
     /**
+     * @public
      * <p>An array of prefix list IDs. A prefix list is a list of CIDR ranges of IP addresses.
      *             The IP addresses specified are allowed to access your workspace. If the list is not
      *             included in the configuration (passed an empty array) then no IP addresses are
@@ -458,6 +496,7 @@ export interface NetworkAccessConfiguration {
      */
     prefixListIds: string[] | undefined;
     /**
+     * @public
      * <p>An array of Amazon VPC endpoint IDs for the workspace. You can create VPC
      *             endpoints to your Amazon Managed Grafana workspace for access from within a VPC. If a
      *                 <code>NetworkAccessConfiguration</code> is specified then only VPC endpoints
@@ -584,11 +623,13 @@ export type WorkspaceStatus = (typeof WorkspaceStatus)[keyof typeof WorkspaceSta
  */
 export interface VpcConfiguration {
     /**
+     * @public
      * <p>The list of Amazon EC2 security group IDs attached to the Amazon VPC
      *             for your Grafana workspace to connect. Duplicates not allowed.</p>
      */
     securityGroupIds: string[] | undefined;
     /**
+     * @public
      * <p>The list of Amazon EC2 subnet IDs created in the Amazon VPC for your
      *             Grafana workspace to connect. Duplicates not allowed.</p>
      */
@@ -601,6 +642,7 @@ export interface VpcConfiguration {
  */
 export interface WorkspaceDescription {
     /**
+     * @public
      * <p>Specifies whether the workspace can access Amazon Web Services resources in this
      *                 Amazon Web Services account only, or whether it can also access Amazon Web Services
      *             resources in other accounts in the same organization. If this is
@@ -609,10 +651,12 @@ export interface WorkspaceDescription {
      */
     accountAccessType?: AccountAccessType | string;
     /**
+     * @public
      * <p>The date that the workspace was created.</p>
      */
     created: Date | undefined;
     /**
+     * @public
      * <p>Specifies the Amazon Web Services data sources that have been configured to have
      *                 IAM roles and permissions created to allow Amazon Managed Grafana to read
      *             data from these sources.</p>
@@ -621,46 +665,56 @@ export interface WorkspaceDescription {
      */
     dataSources: (DataSourceType | string)[] | undefined;
     /**
+     * @public
      * <p>The user-defined description of the workspace.</p>
      */
     description?: string;
     /**
+     * @public
      * <p>The URL that users can use to access the Grafana console in the workspace.</p>
      */
     endpoint: string | undefined;
     /**
+     * @public
      * <p>The version of Grafana supported in this workspace.</p>
      */
     grafanaVersion: string | undefined;
     /**
+     * @public
      * <p>The unique ID of this workspace.</p>
      */
     id: string | undefined;
     /**
+     * @public
      * <p>The most recent date that the workspace was modified.</p>
      */
     modified: Date | undefined;
     /**
+     * @public
      * <p>The name of the workspace.</p>
      */
     name?: string;
     /**
+     * @public
      * <p>The name of the IAM role that is used to access resources through
      *                 Organizations.</p>
      */
     organizationRoleName?: string;
     /**
+     * @public
      * <p>The Amazon Web Services notification channels that Amazon Managed Grafana can automatically
      *             create IAM roles and permissions for, to allow Amazon Managed Grafana to use
      *             these channels.</p>
      */
     notificationDestinations?: (NotificationDestinationType | string)[];
     /**
+     * @public
      * <p>Specifies the organizational units that this workspace is allowed to use data sources
      *             from, if this workspace is in an account that is part of an organization.</p>
      */
     organizationalUnits?: string[];
     /**
+     * @public
      * <p>If this is <code>SERVICE_MANAGED</code>, and the workplace was created through the
      *             Amazon Managed Grafana console, then Amazon Managed Grafana automatically creates the
      *             IAM roles and provisions the permissions that the workspace needs to
@@ -681,52 +735,63 @@ export interface WorkspaceDescription {
      */
     permissionType?: PermissionType | string;
     /**
+     * @public
      * <p>The name of the CloudFormation stack set that is used to generate IAM roles to be used for this workspace.</p>
      */
     stackSetName?: string;
     /**
+     * @public
      * <p>The current status of the workspace.</p>
      */
     status: WorkspaceStatus | string | undefined;
     /**
+     * @public
      * <p>The IAM role that grants permissions to the Amazon Web Services
      *             resources that the workspace will view data from. This role must already exist.</p>
      */
     workspaceRoleArn?: string;
     /**
+     * @public
      * <p>Specifies whether this workspace has a full Grafana Enterprise license or a free trial
      *             license.</p>
      */
     licenseType?: LicenseType | string;
     /**
+     * @public
      * <p>Specifies whether this workspace has already fully used its free trial for Grafana
      *             Enterprise.</p>
      */
     freeTrialConsumed?: boolean;
     /**
+     * @public
      * <p>If this workspace has a full Grafana Enterprise license, this specifies when the
      *             license ends and will need to be renewed.</p>
      */
     licenseExpiration?: Date;
     /**
+     * @public
      * <p>If this workspace is currently in the free trial period for Grafana Enterprise, this
      *             value specifies when that free trial ends.</p>
      */
     freeTrialExpiration?: Date;
     /**
+     * @public
      * <p>A structure that describes whether the workspace uses SAML, IAM Identity Center, or
      *             both methods for user authentication.</p>
      */
     authentication: AuthenticationSummary | undefined;
     /**
+     * @public
      * <p>The list of tags associated with the workspace.</p>
      */
     tags?: Record<string, string>;
     /**
+     * @public
      * <p>The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).</p>
      */
     vpcConfiguration?: VpcConfiguration;
     /**
+     * @public
      * <p>The configuration settings for network access to your workspace.</p>
      */
     networkAccessControl?: NetworkAccessConfiguration;
@@ -736,6 +801,7 @@ export interface WorkspaceDescription {
  */
 export interface AssociateLicenseResponse {
     /**
+     * @public
      * <p>A structure containing data about the workspace.</p>
      */
     workspace: WorkspaceDescription | undefined;
@@ -745,6 +811,7 @@ export interface AssociateLicenseResponse {
  */
 export interface DescribeWorkspaceAuthenticationRequest {
     /**
+     * @public
      * <p>The ID of the workspace to return authentication information about.</p>
      */
     workspaceId: string | undefined;
@@ -755,6 +822,7 @@ export interface DescribeWorkspaceAuthenticationRequest {
  */
 export interface AwsSsoAuthentication {
     /**
+     * @public
      * <p>The ID of the IAM Identity Center-managed application that is created by Amazon Managed Grafana.</p>
      */
     ssoClientId?: string;
@@ -773,6 +841,7 @@ export type IdpMetadata = IdpMetadata.UrlMember | IdpMetadata.XmlMember | IdpMet
  */
 export declare namespace IdpMetadata {
     /**
+     * @public
      * <p>The URL of the location containing the IdP metadata.</p>
      */
     interface UrlMember {
@@ -781,6 +850,7 @@ export declare namespace IdpMetadata {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>The full IdP metadata, in XML format.</p>
      */
     interface XmlMember {
@@ -788,6 +858,9 @@ export declare namespace IdpMetadata {
         xml: string;
         $unknown?: never;
     }
+    /**
+     * @public
+     */
     interface $UnknownMember {
         url?: never;
         xml?: never;
@@ -809,11 +882,13 @@ export declare namespace IdpMetadata {
  */
 export interface RoleValues {
     /**
+     * @public
      * <p>A list of groups from the SAML assertion attribute to grant the Grafana
      *                 <code>Editor</code> role to.</p>
      */
     editor?: string[];
     /**
+     * @public
      * <p>A list of groups from the SAML assertion attribute to grant the Grafana
      *                 <code>Admin</code> role to.</p>
      */
@@ -825,27 +900,32 @@ export interface RoleValues {
  */
 export interface SamlConfiguration {
     /**
+     * @public
      * <p>A structure containing the identity provider (IdP) metadata used to integrate the
      *             identity provider with this workspace.</p>
      */
     idpMetadata: IdpMetadata | undefined;
     /**
+     * @public
      * <p>A structure that defines which attributes in the SAML assertion are to be used to
      *             define information about the users authenticated by that IdP to use the
      *             workspace.</p>
      */
     assertionAttributes?: AssertionAttributes;
     /**
+     * @public
      * <p>A structure containing arrays that map group names in the SAML assertion to the
      *             Grafana <code>Admin</code> and <code>Editor</code> roles in the workspace.</p>
      */
     roleValues?: RoleValues;
     /**
+     * @public
      * <p>Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace. If this is empty, all organizations in the assertion attribute
      *             have access.</p>
      */
     allowedOrganizations?: string[];
     /**
+     * @public
      * <p>How long a sign-on session by a SAML user is valid, before the user has to sign on
      *             again.</p>
      */
@@ -857,10 +937,12 @@ export interface SamlConfiguration {
  */
 export interface SamlAuthentication {
     /**
+     * @public
      * <p>Specifies whether the workspace's SAML configuration is complete.</p>
      */
     status: SamlConfigurationStatus | string | undefined;
     /**
+     * @public
      * <p>A structure containing details about how this workspace works with SAML. </p>
      */
     configuration?: SamlConfiguration;
@@ -872,18 +954,21 @@ export interface SamlAuthentication {
  */
 export interface AuthenticationDescription {
     /**
+     * @public
      * <p>Specifies whether this workspace uses IAM Identity Center, SAML, or both methods to
      *             authenticate users to use the Grafana console in the Amazon Managed Grafana
      *             workspace.</p>
      */
     providers: (AuthenticationProviderTypes | string)[] | undefined;
     /**
+     * @public
      * <p>A structure containing information about how this workspace works with SAML, including
      *             what attributes within the assertion are to be mapped to user information in the
      *             workspace. </p>
      */
     saml?: SamlAuthentication;
     /**
+     * @public
      * <p>A structure containing information about how this workspace works with IAM Identity Center. </p>
      */
     awsSso?: AwsSsoAuthentication;
@@ -893,6 +978,7 @@ export interface AuthenticationDescription {
  */
 export interface DescribeWorkspaceAuthenticationResponse {
     /**
+     * @public
      * <p>A structure containing information about the authentication methods used in the
      *             workspace.</p>
      */
@@ -903,10 +989,12 @@ export interface DescribeWorkspaceAuthenticationResponse {
  */
 export interface UpdateWorkspaceAuthenticationRequest {
     /**
+     * @public
      * <p>The ID of the workspace to update the authentication for.</p>
      */
     workspaceId: string | undefined;
     /**
+     * @public
      * <p>Specifies whether this workspace uses SAML 2.0, IAM Identity Center (successor to Single Sign-On), or both to
      *             authenticate users for using the Grafana console within a workspace. For more
      *             information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html">User authentication in
@@ -914,6 +1002,7 @@ export interface UpdateWorkspaceAuthenticationRequest {
      */
     authenticationProviders: (AuthenticationProviderTypes | string)[] | undefined;
     /**
+     * @public
      * <p>If the workspace uses SAML, use this structure to map SAML assertion attributes to
      *             workspace user information and define which groups in the assertion attribute are to
      *             have the <code>Admin</code> and <code>Editor</code> roles in the workspace.</p>
@@ -925,6 +1014,7 @@ export interface UpdateWorkspaceAuthenticationRequest {
  */
 export interface UpdateWorkspaceAuthenticationResponse {
     /**
+     * @public
      * <p>A structure that describes the user authentication for this workspace after the update
      *             is made.</p>
      */
@@ -935,6 +1025,7 @@ export interface UpdateWorkspaceAuthenticationResponse {
  */
 export interface DescribeWorkspaceConfigurationRequest {
     /**
+     * @public
      * <p>The ID of the workspace to get configuration information for.</p>
      */
     workspaceId: string | undefined;
@@ -944,12 +1035,14 @@ export interface DescribeWorkspaceConfigurationRequest {
  */
 export interface DescribeWorkspaceConfigurationResponse {
     /**
+     * @public
      * <p>The configuration string for the workspace that you requested. For more information
      *             about the format and configuration options available, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/AMG-configure-workspace.html">Working in your Grafana
      *                 workspace</a>.</p>
      */
     configuration: __LazyJsonString | string | undefined;
     /**
+     * @public
      * <p>The supported Grafana version for the workspace.</p>
      */
     grafanaVersion?: string;
@@ -959,16 +1052,19 @@ export interface DescribeWorkspaceConfigurationResponse {
  */
 export interface UpdateWorkspaceConfigurationRequest {
     /**
+     * @public
      * <p>The new configuration string for the workspace. For more information about the format
      *             and configuration options available, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/AMG-configure-workspace.html">Working in your Grafana
      *                 workspace</a>.</p>
      */
     configuration: __LazyJsonString | string | undefined;
     /**
+     * @public
      * <p>The ID of the workspace to update.</p>
      */
     workspaceId: string | undefined;
     /**
+     * @public
      * <p>Specifies the version of Grafana to support in the new workspace.</p>
      *          <p>Can only be used to upgrade (for example, from 8.4 to 9.4), not
      *             downgrade (for example, from 9.4 to 8.4).</p>
@@ -987,10 +1083,12 @@ export interface UpdateWorkspaceConfigurationResponse {
  */
 export interface DisassociateLicenseRequest {
     /**
+     * @public
      * <p>The ID of the workspace to remove the Grafana Enterprise license from.</p>
      */
     workspaceId: string | undefined;
     /**
+     * @public
      * <p>The type of license to remove from the workspace.</p>
      */
     licenseType: LicenseType | string | undefined;
@@ -1000,6 +1098,7 @@ export interface DisassociateLicenseRequest {
  */
 export interface DisassociateLicenseResponse {
     /**
+     * @public
      * <p>A structure containing information about the workspace.</p>
      */
     workspace: WorkspaceDescription | undefined;
@@ -1009,6 +1108,7 @@ export interface DisassociateLicenseResponse {
  */
 export interface ListTagsForResourceRequest {
     /**
+     * @public
      * <p>The ARN of the resource the list of tags are associated with.</p>
      */
     resourceArn: string | undefined;
@@ -1018,6 +1118,7 @@ export interface ListTagsForResourceRequest {
  */
 export interface ListTagsForResourceResponse {
     /**
+     * @public
      * <p>The list of tags that are associated with the resource.</p>
      */
     tags?: Record<string, string>;
@@ -1027,15 +1128,18 @@ export interface ListTagsForResourceResponse {
  */
 export interface ListVersionsRequest {
     /**
+     * @public
      * <p>The maximum number of results to include in the response.</p>
      */
     maxResults?: number;
     /**
+     * @public
      * <p>The token to use when requesting the next set of results. You receive this token from
      *             a previous <code>ListVersions</code> operation.</p>
      */
     nextToken?: string;
     /**
+     * @public
      * <p>The ID of the workspace to list the available upgrade versions. If not included,
      *             lists all versions of Grafana that are supported for
      *             <code>CreateWorkspace</code>.</p>
@@ -1047,11 +1151,13 @@ export interface ListVersionsRequest {
  */
 export interface ListVersionsResponse {
     /**
+     * @public
      * <p>The token to use in a subsequent <code>ListVersions</code> operation to return the
      *             next set of results.</p>
      */
     nextToken?: string;
     /**
+     * @public
      * <p>The Grafana versions available to create. If a workspace ID is included in the
      *             request, the Grafana versions to which this workspace can be upgraded.</p>
      */
@@ -1080,28 +1186,34 @@ export type UserType = (typeof UserType)[keyof typeof UserType];
  */
 export interface ListPermissionsRequest {
     /**
+     * @public
      * <p>The maximum number of results to include in the response.</p>
      */
     maxResults?: number;
     /**
+     * @public
      * <p>The token to use when requesting the next set of results. You received this token from
      *             a previous <code>ListPermissions</code> operation.</p>
      */
     nextToken?: string;
     /**
+     * @public
      * <p>(Optional) If you specify <code>SSO_USER</code>, then only the permissions of IAM Identity Center users are returned. If you specify <code>SSO_GROUP</code>, only the
      *             permissions of IAM Identity Center groups are returned.</p>
      */
     userType?: UserType | string;
     /**
+     * @public
      * <p>(Optional) Limits the results to only the user that matches this ID.</p>
      */
     userId?: string;
     /**
+     * @public
      * <p>(Optional) Limits the results to only the group that matches this ID.</p>
      */
     groupId?: string;
     /**
+     * @public
      * <p>The ID of the workspace to list permissions for. This parameter is required.</p>
      */
     workspaceId: string | undefined;
@@ -1134,6 +1246,7 @@ export type Role = (typeof Role)[keyof typeof Role];
  */
 export interface User {
     /**
+     * @public
      * <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>
@@ -1141,6 +1254,7 @@ export interface User {
      */
     id: string | undefined;
     /**
+     * @public
      * <p>Specifies whether this is a single user or a group.</p>
      */
     type: UserType | string | undefined;
@@ -1152,10 +1266,12 @@ export interface User {
  */
 export interface PermissionEntry {
     /**
+     * @public
      * <p>A structure with the ID of the user or group with this role.</p>
      */
     user: User | undefined;
     /**
+     * @public
      * <p>Specifies whether the user or group has the <code>Admin</code>, <code>Editor</code>,
      *             or <code>Viewer</code> role.</p>
      */
@@ -1166,11 +1282,13 @@ export interface PermissionEntry {
  */
 export interface ListPermissionsResponse {
     /**
+     * @public
      * <p>The token to use in a subsequent <code>ListPermissions</code> operation to return the
      *             next set of results.</p>
      */
     nextToken?: string;
     /**
+     * @public
      * <p>The permissions returned by the operation.</p>
      */
     permissions: PermissionEntry[] | undefined;
@@ -1199,15 +1317,18 @@ export type UpdateAction = (typeof UpdateAction)[keyof typeof UpdateAction];
  */
 export interface UpdateInstruction {
     /**
+     * @public
      * <p>Specifies whether this update is to add or revoke role permissions.</p>
      */
     action: UpdateAction | string | undefined;
     /**
+     * @public
      * <p>The role to add or revoke for the user or the group specified in
      *             <code>users</code>.</p>
      */
     role: Role | string | undefined;
     /**
+     * @public
      * <p>A structure that specifies the user or group to add or revoke the role for.</p>
      */
     users: User[] | undefined;
@@ -1217,10 +1338,12 @@ export interface UpdateInstruction {
  */
 export interface UpdatePermissionsRequest {
     /**
+     * @public
      * <p>An array of structures that contain the permission updates to make.</p>
      */
     updateInstructionBatch: UpdateInstruction[] | undefined;
     /**
+     * @public
      * <p>The ID of the workspace to update.</p>
      */
     workspaceId: string | undefined;
@@ -1232,14 +1355,17 @@ export interface UpdatePermissionsRequest {
  */
 export interface UpdateError {
     /**
+     * @public
      * <p>The error code.</p>
      */
     code: number | undefined;
     /**
+     * @public
      * <p>The message for this error.</p>
      */
     message: string | undefined;
     /**
+     * @public
      * <p>Specifies which permission update caused the error.</p>
      */
     causedBy: UpdateInstruction | undefined;
@@ -1249,6 +1375,7 @@ export interface UpdateError {
  */
 export interface UpdatePermissionsResponse {
     /**
+     * @public
      * <p>An array of structures that contain the errors from the operation, if any.</p>
      */
     errors: UpdateError[] | undefined;
@@ -1258,10 +1385,12 @@ export interface UpdatePermissionsResponse {
  */
 export interface TagResourceRequest {
     /**
+     * @public
      * <p>The ARN of the resource the tag is associated with.</p>
      */
     resourceArn: string | undefined;
     /**
+     * @public
      * <p>The list of tag keys and values to associate with the resource. You can associate tag
      *             keys only, tags (key and values) only or a combination of tag keys and tags.</p>
      */
@@ -1277,10 +1406,12 @@ export interface TagResourceResponse {
  */
 export interface UntagResourceRequest {
     /**
+     * @public
      * <p>The ARN of the resource the tag association is removed from. </p>
      */
     resourceArn: string | undefined;
     /**
+     * @public
      * <p>The key values of the tag to be removed from the resource.</p>
      */
     tagKeys: string[] | undefined;
@@ -1295,6 +1426,7 @@ export interface UntagResourceResponse {
  */
 export interface CreateWorkspaceRequest {
     /**
+     * @public
      * <p>Specifies whether the workspace can access Amazon Web Services resources in this
      *                 Amazon Web Services account only, or whether it can also access Amazon Web Services
      *             resources in other accounts in the same organization. If you specify
@@ -1303,16 +1435,19 @@ export interface CreateWorkspaceRequest {
      */
     accountAccessType: AccountAccessType | string | undefined;
     /**
+     * @public
      * <p>A unique, case-sensitive, user-provided identifier to ensure the idempotency of the
      *             request.</p>
      */
     clientToken?: string;
     /**
+     * @public
      * <p>The name of an IAM role that already exists to use with Organizations to access Amazon Web Services data sources and notification channels in other accounts
      *             in an organization.</p>
      */
     organizationRoleName?: string;
     /**
+     * @public
      * <p>When creating a workspace through the Amazon Web Services API, CLI or Amazon Web Services CloudFormation, you must manage IAM roles and provision the
      *             permissions that the workspace needs to use Amazon Web Services data sources and
      *             notification channels.</p>
@@ -1332,15 +1467,18 @@ export interface CreateWorkspaceRequest {
      */
     permissionType: PermissionType | string | undefined;
     /**
+     * @public
      * <p>The name of the CloudFormation stack set to use to generate IAM
      *             roles to be used for this workspace.</p>
      */
     stackSetName?: string;
     /**
+     * @public
      * <p>This parameter is for internal use only, and should not be used.</p>
      */
     workspaceDataSources?: (DataSourceType | string)[];
     /**
+     * @public
      * <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>
@@ -1348,10 +1486,12 @@ export interface CreateWorkspaceRequest {
      */
     workspaceDescription?: string;
     /**
+     * @public
      * <p>The name for the workspace. It does not have to be unique.</p>
      */
     workspaceName?: string;
     /**
+     * @public
      * <p>Specify the Amazon Web Services notification channels that you plan to use in this
      *             workspace. Specifying these data sources here enables Amazon Managed Grafana to create
      *                 IAM roles and permissions that allow Amazon Managed Grafana to use these
@@ -1359,17 +1499,20 @@ export interface CreateWorkspaceRequest {
      */
     workspaceNotificationDestinations?: (NotificationDestinationType | string)[];
     /**
+     * @public
      * <p>Specifies the organizational units that this workspace is allowed to use data sources
      *             from, if this workspace is in an account that is part of an organization.</p>
      */
     workspaceOrganizationalUnits?: string[];
     /**
+     * @public
      * <p>Specified the IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from, including both data
      *             sources and notification channels. You are responsible for managing the permissions
      *             for this role as new data sources or notification channels are added. </p>
      */
     workspaceRoleArn?: string;
     /**
+     * @public
      * <p>Specifies whether this workspace uses SAML 2.0, IAM Identity Center (successor to Single Sign-On), or both to
      *             authenticate users for using the Grafana console within a workspace. For more
      *             information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html">User authentication in
@@ -1377,10 +1520,12 @@ export interface CreateWorkspaceRequest {
      */
     authenticationProviders: (AuthenticationProviderTypes | string)[] | undefined;
     /**
+     * @public
      * <p>The list of tags associated with the workspace.</p>
      */
     tags?: Record<string, string>;
     /**
+     * @public
      * <p>The configuration settings for an Amazon VPC that contains data sources for
      *             your Grafana workspace to connect to.</p>
      *          <note>
@@ -1390,12 +1535,14 @@ export interface CreateWorkspaceRequest {
      */
     vpcConfiguration?: VpcConfiguration;
     /**
+     * @public
      * <p>The configuration string for the workspace that you create. For more information about
      *             the format and configuration options available, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/AMG-configure-workspace.html">Working in your Grafana
      *                 workspace</a>.</p>
      */
     configuration?: __LazyJsonString | string;
     /**
+     * @public
      * <p>Configuration for 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
@@ -1406,6 +1553,7 @@ export interface CreateWorkspaceRequest {
      */
     networkAccessControl?: NetworkAccessConfiguration;
     /**
+     * @public
      * <p>Specifies the version of Grafana to support in the new workspace.</p>
      *          <p>To get a list of supported version, use the <code>ListVersions</code>
      *             operation.</p>
@@ -1417,6 +1565,7 @@ export interface CreateWorkspaceRequest {
  */
 export interface CreateWorkspaceResponse {
     /**
+     * @public
      * <p>A structure containing data about the workspace that was created.</p>
      */
     workspace: WorkspaceDescription | undefined;
@@ -1426,6 +1575,7 @@ export interface CreateWorkspaceResponse {
  */
 export interface DeleteWorkspaceRequest {
     /**
+     * @public
      * <p>The ID of the workspace to delete.</p>
      */
     workspaceId: string | undefined;
@@ -1435,6 +1585,7 @@ export interface DeleteWorkspaceRequest {
  */
 export interface DeleteWorkspaceResponse {
     /**
+     * @public
      * <p>A structure containing information about the workspace that was deleted.</p>
      */
     workspace: WorkspaceDescription | undefined;
@@ -1444,6 +1595,7 @@ export interface DeleteWorkspaceResponse {
  */
 export interface DescribeWorkspaceRequest {
     /**
+     * @public
      * <p>The ID of the workspace to display information about.</p>
      */
     workspaceId: string | undefined;
@@ -1453,6 +1605,7 @@ export interface DescribeWorkspaceRequest {
  */
 export interface DescribeWorkspaceResponse {
     /**
+     * @public
      * <p>A structure containing information about the workspace.</p>
      */
     workspace: WorkspaceDescription | undefined;
@@ -1462,10 +1615,12 @@ export interface DescribeWorkspaceResponse {
  */
 export interface ListWorkspacesRequest {
     /**
+     * @public
      * <p>The maximum number of workspaces to include in the results.</p>
      */
     maxResults?: number;
     /**
+     * @public
      * <p>The token for the next set of workspaces to return. (You receive this token from a
      *             previous <code>ListWorkspaces</code> operation.)</p>
      */
@@ -1477,49 +1632,60 @@ export interface ListWorkspacesRequest {
  */
 export interface WorkspaceSummary {
     /**
+     * @public
      * <p>The date that the workspace was created.</p>
      */
     created: Date | undefined;
     /**
+     * @public
      * <p>The customer-entered description of the workspace.</p>
      */
     description?: string;
     /**
+     * @public
      * <p>The URL endpoint to use to access the Grafana console in the workspace.</p>
      */
     endpoint: string | undefined;
     /**
+     * @public
      * <p>The Grafana version that the workspace is running.</p>
      */
     grafanaVersion: string | undefined;
     /**
+     * @public
      * <p>The unique ID of the workspace.</p>
      */
     id: string | undefined;
     /**
+     * @public
      * <p>The most recent date that the workspace was modified.</p>
      */
     modified: Date | undefined;
     /**
+     * @public
      * <p>The name of the workspace.</p>
      */
     name?: string;
     /**
+     * @public
      * <p>The Amazon Web Services notification channels that Amazon Managed Grafana can automatically
      *             create IAM roles and permissions for, which allows Amazon Managed Grafana to
      *             use these channels.</p>
      */
     notificationDestinations?: (NotificationDestinationType | string)[];
     /**
+     * @public
      * <p>The current status of the workspace.</p>
      */
     status: WorkspaceStatus | string | undefined;
     /**
+     * @public
      * <p>A structure containing information about the authentication methods used in the
      *             workspace.</p>
      */
     authentication: AuthenticationSummary | undefined;
     /**
+     * @public
      * <p>The list of tags associated with the workspace.</p>
      */
     tags?: Record<string, string>;
@@ -1529,11 +1695,13 @@ export interface WorkspaceSummary {
  */
 export interface ListWorkspacesResponse {
     /**
+     * @public
      * <p>An array of structures that contain some information about the workspaces in the
      *             account.</p>
      */
     workspaces: WorkspaceSummary[] | undefined;
     /**
+     * @public
      * <p>The token to use when requesting the next set of workspaces.</p>
      */
     nextToken?: string;
@@ -1543,6 +1711,7 @@ export interface ListWorkspacesResponse {
  */
 export interface UpdateWorkspaceRequest {
     /**
+     * @public
      * <p>Specifies whether the workspace can access Amazon Web Services resources in this
      *                 Amazon Web Services account only, or whether it can also access Amazon Web Services
      *             resources in other accounts in the same organization. If you specify
@@ -1551,12 +1720,14 @@ export interface UpdateWorkspaceRequest {
      */
     accountAccessType?: AccountAccessType | string;
     /**
+     * @public
      * <p>The name of an IAM role that already exists to use to access resources
      *             through Organizations. This can only be used with a workspace that has the
      *             <code>permissionType</code> set to <code>CUSTOMER_MANAGED</code>.</p>
      */
     organizationRoleName?: string;
     /**
+     * @public
      * <p>Use this parameter if you want to change a workspace from <code>SERVICE_MANAGED</code>
      *             to <code>CUSTOMER_MANAGED</code>. This allows you to manage the permissions that the
      *             workspace uses to access datasources and notification channels. If the workspace is
@@ -1581,28 +1752,34 @@ export interface UpdateWorkspaceRequest {
      */
     permissionType?: PermissionType | string;
     /**
+     * @public
      * <p>The name of the CloudFormation stack set to use to generate IAM
      *             roles to be used for this workspace.</p>
      */
     stackSetName?: string;
     /**
+     * @public
      * <p>This parameter is for internal use only, and should not be used.</p>
      */
     workspaceDataSources?: (DataSourceType | string)[];
     /**
+     * @public
      * <p>A description for the workspace. This is used only to help you identify this
      *             workspace.</p>
      */
     workspaceDescription?: string;
     /**
+     * @public
      * <p>The ID of the workspace to update.</p>
      */
     workspaceId: string | undefined;
     /**
+     * @public
      * <p>A new name for the workspace to update.</p>
      */
     workspaceName?: string;
     /**
+     * @public
      * <p>Specify the Amazon Web Services notification channels that you plan to use in this
      *             workspace. Specifying these data sources here enables Amazon Managed Grafana to create
      *                 IAM roles and permissions that allow Amazon Managed Grafana to use these
@@ -1610,11 +1787,13 @@ export interface UpdateWorkspaceRequest {
      */
     workspaceNotificationDestinations?: (NotificationDestinationType | string)[];
     /**
+     * @public
      * <p>Specifies the organizational units that this workspace is allowed to use data sources
      *             from, if this workspace is in an account that is part of an organization.</p>
      */
     workspaceOrganizationalUnits?: string[];
     /**
+     * @public
      * <p>Specifies an IAM role that grants permissions to Amazon Web Services
      *             resources that the workspace accesses, such as data sources and notification channels.
      *             If this workspace has <code>permissionType</code>
@@ -1623,17 +1802,20 @@ export interface UpdateWorkspaceRequest {
      */
     workspaceRoleArn?: string;
     /**
+     * @public
      * <p>The configuration settings for an Amazon VPC that contains data sources for
      *             your Grafana workspace to connect to.</p>
      */
     vpcConfiguration?: VpcConfiguration;
     /**
+     * @public
      * <p>Whether to remove the VPC configuration from the workspace.</p>
      *          <p>Setting this to <code>true</code> and providing a <code>vpcConfiguration</code> to set
      *             will return an error.</p>
      */
     removeVpcConfiguration?: boolean;
     /**
+     * @public
      * <p>The configuration settings for 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
@@ -1644,6 +1826,7 @@ export interface UpdateWorkspaceRequest {
      */
     networkAccessControl?: NetworkAccessConfiguration;
     /**
+     * @public
      * <p>Whether to remove the network access configuration from the workspace.</p>
      *          <p>Setting this to <code>true</code> and providing a <code>networkAccessControl</code> to
      *             set will return an error.</p>
@@ -1658,6 +1841,7 @@ export interface UpdateWorkspaceRequest {
  */
 export interface UpdateWorkspaceResponse {
     /**
+     * @public
      * <p>A structure containing data about the workspace that was created.</p>
      */
     workspace: WorkspaceDescription | undefined;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-grafana",
   "description": "AWS SDK for JavaScript Grafana Client for Node.js, Browser and React Native",
-  "version": "3.379.1",
+  "version": "3.382.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.379.1",
-    "@aws-sdk/credential-provider-node": "3.379.1",
+    "@aws-sdk/client-sts": "3.382.0",
+    "@aws-sdk/credential-provider-node": "3.382.0",
     "@aws-sdk/middleware-host-header": "3.379.1",
     "@aws-sdk/middleware-logger": "3.378.0",
     "@aws-sdk/middleware-recursion-detection": "3.378.0",
     "@aws-sdk/middleware-signing": "3.379.1",
-    "@aws-sdk/middleware-user-agent": "3.379.1",
+    "@aws-sdk/middleware-user-agent": "3.382.0",
     "@aws-sdk/types": "3.378.0",
-    "@aws-sdk/util-endpoints": "3.378.0",
+    "@aws-sdk/util-endpoints": "3.382.0",
     "@aws-sdk/util-user-agent-browser": "3.378.0",
     "@aws-sdk/util-user-agent-node": "3.378.0",
     "@smithy/config-resolver": "^2.0.1",