@aws-sdk/client-grafana 3.216.0 → 3.217.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. package/dist-cjs/Grafana.js +30 -0
  2. package/dist-cjs/commands/DescribeWorkspaceConfigurationCommand.js +46 -0
  3. package/dist-cjs/commands/UpdateWorkspaceConfigurationCommand.js +46 -0
  4. package/dist-cjs/commands/index.js +2 -0
  5. package/dist-cjs/models/models_0.js +23 -2
  6. package/dist-cjs/protocols/Aws_restJson1.js +192 -1
  7. package/dist-es/Grafana.js +30 -0
  8. package/dist-es/commands/DescribeWorkspaceConfigurationCommand.js +42 -0
  9. package/dist-es/commands/UpdateWorkspaceConfigurationCommand.js +42 -0
  10. package/dist-es/commands/index.js +2 -0
  11. package/dist-es/models/models_0.js +17 -1
  12. package/dist-es/protocols/Aws_restJson1.js +188 -1
  13. package/dist-types/Grafana.d.ts +47 -33
  14. package/dist-types/GrafanaClient.d.ts +4 -2
  15. package/dist-types/commands/AssociateLicenseCommand.d.ts +2 -2
  16. package/dist-types/commands/CreateWorkspaceApiKeyCommand.d.ts +4 -4
  17. package/dist-types/commands/CreateWorkspaceCommand.d.ts +4 -4
  18. package/dist-types/commands/DeleteWorkspaceApiKeyCommand.d.ts +1 -1
  19. package/dist-types/commands/DescribeWorkspaceConfigurationCommand.d.ts +37 -0
  20. package/dist-types/commands/ListPermissionsCommand.d.ts +6 -6
  21. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -2
  22. package/dist-types/commands/ListWorkspacesCommand.d.ts +1 -1
  23. package/dist-types/commands/TagResourceCommand.d.ts +4 -4
  24. package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
  25. package/dist-types/commands/UpdateWorkspaceAuthenticationCommand.d.ts +3 -3
  26. package/dist-types/commands/UpdateWorkspaceCommand.d.ts +5 -5
  27. package/dist-types/commands/UpdateWorkspaceConfigurationCommand.d.ts +37 -0
  28. package/dist-types/commands/index.d.ts +2 -0
  29. package/dist-types/models/models_0.d.ts +227 -127
  30. package/dist-types/protocols/Aws_restJson1.d.ts +6 -0
  31. package/dist-types/ts3.4/Grafana.d.ts +34 -0
  32. package/dist-types/ts3.4/GrafanaClient.d.ts +14 -2
  33. package/dist-types/ts3.4/commands/DescribeWorkspaceConfigurationCommand.d.ts +41 -0
  34. package/dist-types/ts3.4/commands/UpdateWorkspaceConfigurationCommand.d.ts +41 -0
  35. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  36. package/dist-types/ts3.4/models/models_0.d.ts +40 -1
  37. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -0
  38. package/package.json +1 -1
@@ -1,4 +1,4 @@
1
- import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
1
+ import { ExceptionOptionType as __ExceptionOptionType, LazyJsonString as __LazyJsonString } from "@aws-sdk/smithy-client";
2
2
  import { GrafanaServiceException as __BaseException } from "./GrafanaServiceException";
3
3
  /**
4
4
  * <p>You do not have sufficient permissions to perform this action. </p>
@@ -42,21 +42,21 @@ export declare class ConflictException extends __BaseException {
42
42
  }
43
43
  export interface CreateWorkspaceApiKeyRequest {
44
44
  /**
45
- * <p>Specifies the name of the key to create. Key names must be unique to the workspace.</p>
45
+ * <p>Specifies the name of the key. Keynames must be unique to the workspace.</p>
46
46
  */
47
47
  keyName: string | undefined;
48
48
  /**
49
49
  * <p>Specifies the permission level of the key.</p>
50
- * <p>Valid Values: <code>VIEWER</code> | <code>EDITOR</code> | <code>ADMIN</code>
50
+ * <p> Valid values: <code>VIEWER</code>|<code>EDITOR</code>|<code>ADMIN</code>
51
51
  * </p>
52
52
  */
53
53
  keyRole: string | undefined;
54
54
  /**
55
- * <p>Specifies the time in seconds until the key expires. Keys can be valid for up to 30 days.</p>
55
+ * <p>Specifies the time in seconds until the key expires. Keys can be valid for up to 30 days.</p>
56
56
  */
57
57
  secondsToLive: number | undefined;
58
58
  /**
59
- * <p>The ID of the workspace in which to create an API key.</p>
59
+ * <p>The ID of the workspace to create an API key.</p>
60
60
  */
61
61
  workspaceId: string | undefined;
62
62
  }
@@ -66,8 +66,8 @@ export interface CreateWorkspaceApiKeyResponse {
66
66
  */
67
67
  keyName: string | undefined;
68
68
  /**
69
- * <p>The key token that was created. Use this value as a bearer token to
70
- * authenticate HTTP requests to the workspace.</p>
69
+ * <p>The key token. Use this value as a bearer token to
70
+ * authenticate HTTP requests to the workspace.</p>
71
71
  */
72
72
  key: string | undefined;
73
73
  /**
@@ -211,7 +211,7 @@ export interface DeleteWorkspaceApiKeyRequest {
211
211
  }
212
212
  export interface DeleteWorkspaceApiKeyResponse {
213
213
  /**
214
- * <p>The name of the API key that was deleted.</p>
214
+ * <p>The name of the key that was deleted.</p>
215
215
  */
216
216
  keyName: string | undefined;
217
217
  /**
@@ -290,13 +290,14 @@ export declare enum SamlConfigurationStatus {
290
290
  NOT_CONFIGURED = "NOT_CONFIGURED"
291
291
  }
292
292
  /**
293
- * <p>A structure that describes whether the workspace uses SAML, Amazon Web Services SSO, or both methods
294
- * for user authentication, and whether that authentication is fully configured.</p>
293
+ * <p>A structure that describes whether the workspace uses SAML, IAM Identity Center, or
294
+ * both methods for user authentication, and whether that authentication is fully
295
+ * configured.</p>
295
296
  */
296
297
  export interface AuthenticationSummary {
297
298
  /**
298
- * <p>Specifies whether the workspace uses SAML, Amazon Web Services SSO, or both methods for user
299
- * authentication.</p>
299
+ * <p>Specifies whether the workspace uses SAML, IAM Identity Center, or both methods for user
300
+ * authentication.</p>
300
301
  */
301
302
  providers: (AuthenticationProviderTypes | string)[] | undefined;
302
303
  /**
@@ -333,6 +334,10 @@ export declare enum DataSourceType {
333
334
  * Timestream
334
335
  */
335
336
  TIMESTREAM = "TIMESTREAM",
337
+ /**
338
+ * IoT TwinMaker
339
+ */
340
+ TWINMAKER = "TWINMAKER",
336
341
  /**
337
342
  * X-Ray
338
343
  */
@@ -400,15 +405,31 @@ export declare enum WorkspaceStatus {
400
405
  */
401
406
  UPGRADING = "UPGRADING"
402
407
  }
408
+ /**
409
+ * <p>The configuration settings for an Amazon VPC that contains data sources
410
+ * for your Grafana workspace to connect to.</p>
411
+ */
412
+ export interface VpcConfiguration {
413
+ /**
414
+ * <p>The list of Amazon EC2 security group IDs attached to the Amazon VPC
415
+ * for your Grafana workspace to connect.</p>
416
+ */
417
+ securityGroupIds: string[] | undefined;
418
+ /**
419
+ * <p>The list of Amazon EC2 subnet IDs created in the Amazon VPC for
420
+ * your Grafana workspace to connect.</p>
421
+ */
422
+ subnetIds: string[] | undefined;
423
+ }
403
424
  /**
404
425
  * <p>A structure containing information about an Amazon Managed Grafana workspace in your account.</p>
405
426
  */
406
427
  export interface WorkspaceDescription {
407
428
  /**
408
429
  * <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
409
- * other accounts in the same organization. If this is <code>ORGANIZATION</code>, the
430
+ * other accounts in the same organization. If this is <code>ORGANIZATION</code>, the
410
431
  * <code>workspaceOrganizationalUnits</code> parameter specifies which organizational units
411
- * the workspace can access.</p>
432
+ * the workspace can access.</p>
412
433
  */
413
434
  accountAccessType?: AccountAccessType | string;
414
435
  /**
@@ -417,8 +438,8 @@ export interface WorkspaceDescription {
417
438
  created: Date | undefined;
418
439
  /**
419
440
  * <p>Specifies the Amazon Web Services data sources that have been configured to have IAM
420
- * roles and permissions created to allow
421
- * Amazon Managed Grafana to read data from these sources.</p>
441
+ * roles and permissions created to allow
442
+ * Amazon Managed Grafana to read data from these sources.</p>
422
443
  */
423
444
  dataSources: (DataSourceType | string)[] | undefined;
424
445
  /**
@@ -451,31 +472,31 @@ export interface WorkspaceDescription {
451
472
  organizationRoleName?: string;
452
473
  /**
453
474
  * <p>The Amazon Web Services notification channels that Amazon Managed Grafana can automatically create IAM
454
- * roles and permissions for, to allow
455
- * Amazon Managed Grafana to use these channels.</p>
475
+ * roles and permissions for, to allow
476
+ * Amazon Managed Grafana to use these channels.</p>
456
477
  */
457
478
  notificationDestinations?: (NotificationDestinationType | string)[];
458
479
  /**
459
480
  * <p>Specifies the organizational units that this workspace is allowed to use data sources
460
- * from, if this workspace is in an account that is part of an organization.</p>
481
+ * from, if this workspace is in an account that is part of an organization.</p>
461
482
  */
462
483
  organizationalUnits?: string[];
463
484
  /**
464
485
  * <p>If this is <code>Service Managed</code>, Amazon Managed Grafana automatically creates the IAM roles
465
- * and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.</p>
466
- * <p>If this is <code>CUSTOMER_MANAGED</code>, you manage those roles and permissions
467
- * yourself. If you are creating this workspace in a member account of an organization and that account is not a
468
- * delegated administrator account, and
469
- * you want the workspace to access data sources in other Amazon Web Services accounts in the
470
- * organization, you must choose <code>CUSTOMER_MANAGED</code>.</p>
471
- * <p>For more information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html">Amazon Managed Grafana permissions and policies for
472
- * Amazon Web Services data sources and notification channels</a>
486
+ * and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.</p>
487
+ * <p>If this is <code>CUSTOMER_MANAGED</code>, you manage those roles and permissions
488
+ * yourself. If you are creating this workspace in a member account of an organization and that account is not a
489
+ * delegated administrator account, and
490
+ * you want the workspace to access data sources in other Amazon Web Services accounts in the
491
+ * organization, you must choose <code>CUSTOMER_MANAGED</code>.</p>
492
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html">Amazon Managed Grafana permissions and policies for
493
+ * Amazon Web Services data sources and notification channels</a>
473
494
  * </p>
474
495
  */
475
496
  permissionType?: PermissionType | string;
476
497
  /**
477
498
  * <p>The name of the CloudFormation stack set that is used to generate IAM roles
478
- * to be used for this workspace.</p>
499
+ * to be used for this workspace.</p>
479
500
  */
480
501
  stackSetName?: string;
481
502
  /**
@@ -484,7 +505,7 @@ export interface WorkspaceDescription {
484
505
  status: WorkspaceStatus | string | undefined;
485
506
  /**
486
507
  * <p>The IAM role that grants permissions to the Amazon Web Services resources that the
487
- * workspace will view data from. This role must already exist.</p>
508
+ * workspace will view data from. This role must already exist.</p>
488
509
  */
489
510
  workspaceRoleArn?: string;
490
511
  /**
@@ -497,23 +518,28 @@ export interface WorkspaceDescription {
497
518
  freeTrialConsumed?: boolean;
498
519
  /**
499
520
  * <p>If this workspace has a full Grafana Enterprise license, this specifies when the license ends and
500
- * will need to be renewed.</p>
521
+ * will need to be renewed.</p>
501
522
  */
502
523
  licenseExpiration?: Date;
503
524
  /**
504
525
  * <p>If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies
505
- * when that free trial ends.</p>
526
+ * when that free trial ends.</p>
506
527
  */
507
528
  freeTrialExpiration?: Date;
508
529
  /**
509
- * <p>A structure that describes whether the workspace uses SAML, Amazon Web Services SSO, or both methods
510
- * for user authentication.</p>
530
+ * <p>A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods
531
+ * for user authentication.</p>
511
532
  */
512
533
  authentication: AuthenticationSummary | undefined;
513
534
  /**
514
535
  * <p>The list of tags associated with the workspace.</p>
515
536
  */
516
537
  tags?: Record<string, string>;
538
+ /**
539
+ * <p>The configuration for connecting to data sources in a private VPC
540
+ * (Amazon Virtual Private Cloud).</p>
541
+ */
542
+ vpcConfiguration?: VpcConfiguration;
517
543
  }
518
544
  export interface AssociateLicenseResponse {
519
545
  /**
@@ -529,24 +555,24 @@ export interface DescribeWorkspaceAuthenticationRequest {
529
555
  }
530
556
  /**
531
557
  * <p>A structure containing information about how this workspace works with
532
- * Amazon Web Services SSO. </p>
558
+ * IAM Identity Center. </p>
533
559
  */
534
560
  export interface AwsSsoAuthentication {
535
561
  /**
536
- * <p>The ID of the Amazon Web Services SSO-managed application that is created by Amazon Managed Grafana.</p>
562
+ * <p>The ID of the IAM Identity Center-managed application that is created by Amazon Managed Grafana.</p>
537
563
  */
538
564
  ssoClientId?: string;
539
565
  }
540
566
  /**
541
567
  * <p>A structure containing the identity provider (IdP) metadata used to integrate the
542
- * identity provider with this workspace. You can specify the metadata either by providing a
543
- * URL to its location in the <code>url</code> parameter, or by specifying the full metadata
544
- * in XML format in the <code>xml</code> parameter.</p>
568
+ * identity provider with this workspace. You can specify the metadata either by providing a
569
+ * URL to its location in the <code>url</code> parameter, or by specifying the full metadata
570
+ * in XML format in the <code>xml</code> parameter. Specifying both will cause an error.</p>
545
571
  */
546
572
  export declare type IdpMetadata = IdpMetadata.UrlMember | IdpMetadata.XmlMember | IdpMetadata.$UnknownMember;
547
573
  export declare namespace IdpMetadata {
548
574
  /**
549
- * <p>The URL of the location containing the metadata.</p>
575
+ * <p>The URL of the location containing the IdP metadata.</p>
550
576
  */
551
577
  interface UrlMember {
552
578
  url: string;
@@ -554,7 +580,7 @@ export declare namespace IdpMetadata {
554
580
  $unknown?: never;
555
581
  }
556
582
  /**
557
- * <p>The actual full metadata file, in XML format.</p>
583
+ * <p>The full IdP metadata, in XML format.</p>
558
584
  */
559
585
  interface XmlMember {
560
586
  url?: never;
@@ -574,8 +600,11 @@ export declare namespace IdpMetadata {
574
600
  const visit: <T>(value: IdpMetadata, visitor: Visitor<T>) => T;
575
601
  }
576
602
  /**
577
- * <p>This structure defines which groups defined in the SAML assertion attribute are to be mapped
578
- * to the Grafana <code>Admin</code> and <code>Editor</code> roles in the workspace.</p>
603
+ * <p>This structure defines which groups defined in the SAML assertion attribute are to
604
+ * be mapped to the Grafana <code>Admin</code> and <code>Editor</code> roles in the
605
+ * workspace. SAML authenticated users not part of <code>Admin</code> or
606
+ * <code>Editor</code> role groups have <code>Viewer</code> permission over the
607
+ * workspace.</p>
579
608
  */
580
609
  export interface RoleValues {
581
610
  /**
@@ -591,32 +620,32 @@ export interface RoleValues {
591
620
  }
592
621
  /**
593
622
  * <p>A structure containing information about how this workspace works with
594
- * SAML. </p>
623
+ * SAML. </p>
595
624
  */
596
625
  export interface SamlConfiguration {
597
626
  /**
598
627
  * <p>A structure containing the identity provider (IdP) metadata used to integrate the
599
- * identity provider with this workspace.</p>
628
+ * identity provider with this workspace.</p>
600
629
  */
601
630
  idpMetadata: IdpMetadata | undefined;
602
631
  /**
603
632
  * <p>A structure that defines which attributes in the SAML assertion are to be used to define information about
604
- * the users authenticated by that IdP to use the workspace.</p>
633
+ * the users authenticated by that IdP to use the workspace.</p>
605
634
  */
606
635
  assertionAttributes?: AssertionAttributes;
607
636
  /**
608
637
  * <p>A structure containing arrays that map group names in the SAML assertion to the
609
- * Grafana <code>Admin</code> and <code>Editor</code> roles in the workspace.</p>
638
+ * Grafana <code>Admin</code> and <code>Editor</code> roles in the workspace.</p>
610
639
  */
611
640
  roleValues?: RoleValues;
612
641
  /**
613
642
  * <p>Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace.
614
- * If this is empty, all organizations in the assertion attribute have access.</p>
643
+ * If this is empty, all organizations in the assertion attribute have access.</p>
615
644
  */
616
645
  allowedOrganizations?: string[];
617
646
  /**
618
647
  * <p>How long a sign-on session by a SAML user is valid, before the user has to sign on
619
- * again.</p>
648
+ * again.</p>
620
649
  */
621
650
  loginValidityDuration?: number;
622
651
  }
@@ -636,29 +665,32 @@ export interface SamlAuthentication {
636
665
  configuration?: SamlConfiguration;
637
666
  }
638
667
  /**
639
- * <p>A structure containing information about the user authentication methods used by the workspace.</p>
668
+ * <p>A structure containing information about the user authentication methods used by
669
+ * the workspace.</p>
640
670
  */
641
671
  export interface AuthenticationDescription {
642
672
  /**
643
- * <p>Specifies whether this workspace uses Amazon Web Services SSO, SAML, or both methods to authenticate
644
- * users to use the Grafana console in the Amazon Managed Grafana workspace.</p>
673
+ * <p>Specifies whether this workspace uses IAM Identity Center, SAML, or both methods
674
+ * to authenticate users to use the Grafana console in the Amazon Managed Grafana
675
+ * workspace.</p>
645
676
  */
646
677
  providers: (AuthenticationProviderTypes | string)[] | undefined;
647
678
  /**
648
679
  * <p>A structure containing information about how this workspace works with
649
- * SAML, including what attributes within the assertion are to be mapped to user information in the workspace. </p>
680
+ * SAML, including what attributes within the assertion are to be mapped to
681
+ * user information in the workspace. </p>
650
682
  */
651
683
  saml?: SamlAuthentication;
652
684
  /**
653
685
  * <p>A structure containing information about how this workspace works with
654
- * Amazon Web Services SSO. </p>
686
+ * IAM Identity Center. </p>
655
687
  */
656
688
  awsSso?: AwsSsoAuthentication;
657
689
  }
658
690
  export interface DescribeWorkspaceAuthenticationResponse {
659
691
  /**
660
692
  * <p>A structure containing information about the authentication methods used in
661
- * the workspace.</p>
693
+ * the workspace.</p>
662
694
  */
663
695
  authentication: AuthenticationDescription | undefined;
664
696
  }
@@ -668,17 +700,17 @@ export interface UpdateWorkspaceAuthenticationRequest {
668
700
  */
669
701
  workspaceId: string | undefined;
670
702
  /**
671
- * <p>Specifies whether this workspace uses SAML 2.0, Amazon Web Services Single Sign On, or both to authenticate
672
- * users for using the Grafana console within a workspace. For more information,
673
- * see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html">User authentication in
674
- * Amazon Managed Grafana</a>.</p>
703
+ * <p>Specifies whether this workspace uses SAML 2.0, IAM Identity Center (successor to Single Sign-On), or both to authenticate
704
+ * users for using the Grafana console within a workspace. For more information,
705
+ * see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html">User authentication in
706
+ * Amazon Managed Grafana</a>.</p>
675
707
  */
676
708
  authenticationProviders: (AuthenticationProviderTypes | string)[] | undefined;
677
709
  /**
678
710
  * <p>If the workspace uses SAML, use this structure to
679
- * map SAML assertion attributes to workspace user information and
680
- * define which groups in the assertion attribute are to have the <code>Admin</code> and <code>Editor</code> roles
681
- * in the workspace.</p>
711
+ * map SAML assertion attributes to workspace user information and
712
+ * define which groups in the assertion attribute are to have the <code>Admin</code> and <code>Editor</code> roles
713
+ * in the workspace.</p>
682
714
  */
683
715
  samlConfiguration?: SamlConfiguration;
684
716
  }
@@ -688,6 +720,32 @@ export interface UpdateWorkspaceAuthenticationResponse {
688
720
  */
689
721
  authentication: AuthenticationDescription | undefined;
690
722
  }
723
+ export interface DescribeWorkspaceConfigurationRequest {
724
+ /**
725
+ * <p>The ID of the workspace to get configuration information for.</p>
726
+ */
727
+ workspaceId: string | undefined;
728
+ }
729
+ export interface DescribeWorkspaceConfigurationResponse {
730
+ /**
731
+ * <p>The configuration string for the workspace that you requested. For more information
732
+ * 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>
733
+ */
734
+ configuration: __LazyJsonString | string | undefined;
735
+ }
736
+ export interface UpdateWorkspaceConfigurationRequest {
737
+ /**
738
+ * <p>The new configuration string for the workspace. For more information
739
+ * 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>
740
+ */
741
+ configuration: __LazyJsonString | string | undefined;
742
+ /**
743
+ * <p>The ID of the workspace to update.</p>
744
+ */
745
+ workspaceId: string | undefined;
746
+ }
747
+ export interface UpdateWorkspaceConfigurationResponse {
748
+ }
691
749
  export interface DisassociateLicenseRequest {
692
750
  /**
693
751
  * <p>The ID of the workspace to remove the Grafana Enterprise license from.</p>
@@ -733,12 +791,12 @@ export interface ListPermissionsRequest {
733
791
  maxResults?: number;
734
792
  /**
735
793
  * <p>The token to use when requesting the next set of results. You received this token from a previous
736
- * <code>ListPermissions</code> operation.</p>
794
+ * <code>ListPermissions</code> operation.</p>
737
795
  */
738
796
  nextToken?: string;
739
797
  /**
740
- * <p>(Optional) If you specify <code>SSO_USER</code>, then only the permissions of Amazon Web Services SSO users
741
- * are returned. If you specify <code>SSO_GROUP</code>, only the permissions of Amazon Web Services SSO groups
798
+ * <p>(Optional) If you specify <code>SSO_USER</code>, then only the permissions of IAM Identity Center users
799
+ * are returned. If you specify <code>SSO_GROUP</code>, only the permissions of IAM Identity Center groups
742
800
  * are returned.</p>
743
801
  */
744
802
  userType?: UserType | string;
@@ -775,7 +833,7 @@ export declare enum Role {
775
833
  export interface User {
776
834
  /**
777
835
  * <p>The ID of the user or group.</p>
778
- * <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>
836
+ * <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>
779
837
  * </p>
780
838
  */
781
839
  id: string | undefined;
@@ -785,8 +843,8 @@ export interface User {
785
843
  type: UserType | string | undefined;
786
844
  }
787
845
  /**
788
- * <p>A structure containing the identity of one user or group and the <code>Admin</code>
789
- * or <code>Editor</code> role that they have.</p>
846
+ * <p>A structure containing the identity of one user or group and the <code>Admin</code>,
847
+ * <code>Editor</code>, or <code>Viewer</code> role that they have.</p>
790
848
  */
791
849
  export interface PermissionEntry {
792
850
  /**
@@ -794,15 +852,15 @@ export interface PermissionEntry {
794
852
  */
795
853
  user: User | undefined;
796
854
  /**
797
- * <p>Specifies whether the user or group has the <code>Admin</code>
798
- * or <code>Editor</code> role.</p>
855
+ * <p>Specifies whether the user or group has the <code>Admin</code>,
856
+ * <code>Editor</code>, or <code>Viewer</code> role.</p>
799
857
  */
800
858
  role: Role | string | undefined;
801
859
  }
802
860
  export interface ListPermissionsResponse {
803
861
  /**
804
862
  * <p>The token to use in a subsequent <code>ListPermissions</code> operation to return
805
- * the next set of results.</p>
863
+ * the next set of results.</p>
806
864
  */
807
865
  nextToken?: string;
808
866
  /**
@@ -822,7 +880,7 @@ export declare enum UpdateAction {
822
880
  }
823
881
  /**
824
882
  * <p>Contains the instructions for one Grafana role permission update in a
825
- * <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdatePermissions.html">UpdatePermissions</a> operation.</p>
883
+ * <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdatePermissions.html">UpdatePermissions</a> operation.</p>
826
884
  */
827
885
  export interface UpdateInstruction {
828
886
  /**
@@ -879,7 +937,7 @@ export interface TagResourceRequest {
879
937
  resourceArn: string | undefined;
880
938
  /**
881
939
  * <p>The list of tag keys and values to associate with the resource. You can associate tag keys only, tags (key and values) only
882
- * or a combination of tag keys and tags.</p>
940
+ * or a combination of tag keys and tags.</p>
883
941
  */
884
942
  tags: Record<string, string> | undefined;
885
943
  }
@@ -900,8 +958,8 @@ export interface UntagResourceResponse {
900
958
  export interface CreateWorkspaceRequest {
901
959
  /**
902
960
  * <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
903
- * other accounts in the same organization. If you specify <code>ORGANIZATION</code>, you must
904
- * specify which organizational units the workspace can access in the
961
+ * other accounts in the same organization. If you specify <code>ORGANIZATION</code>, you must
962
+ * specify which organizational units the workspace can access in the
905
963
  * <code>workspaceOrganizationalUnits</code> parameter.</p>
906
964
  */
907
965
  accountAccessType: AccountAccessType | string | undefined;
@@ -911,40 +969,41 @@ export interface CreateWorkspaceRequest {
911
969
  clientToken?: string;
912
970
  /**
913
971
  * <p>The name of an IAM role that already exists to use with Organizations to access Amazon Web Services
914
- * data sources and notification channels in other accounts in an organization.</p>
972
+ * data sources and notification channels in other accounts in an organization.</p>
915
973
  */
916
974
  organizationRoleName?: string;
917
975
  /**
918
976
  * <p>If you specify <code>SERVICE_MANAGED</code> on AWS Grafana console, Amazon Managed Grafana automatically creates
919
- * the IAM roles and provisions the permissions that the workspace needs to use
920
- * Amazon Web Services data sources and notification channels. In CLI mode, the permissionType <code>SERVICE_MANAGED</code> will not create the IAM role
921
- * for you.</p>
922
- * <p>If you specify <code>CUSTOMER_MANAGED</code>, you will manage those roles and
923
- * permissions yourself. If you are creating this workspace in a member account of an
924
- * organization that is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services
925
- * accounts in the organization, you must choose <code>CUSTOMER_MANAGED</code>.</p>
926
- * <p>For more information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html">Amazon Managed Grafana permissions and policies for
927
- * Amazon Web Services data sources and notification channels</a>.</p>
977
+ * the IAM roles and provisions the permissions that the workspace needs to use
978
+ * Amazon Web Services data sources and notification channels. In the CLI mode, the permissionType <code>SERVICE_MANAGED</code> will not create the IAM role
979
+ * for you. The ability for the Amazon Managed Grafana to create the IAM role on behalf of the user is supported only in the
980
+ * Amazon Managed Grafana AWS console. Use only the <code>CUSTOMER_MANAGED</code> permission type when creating a workspace in the CLI. </p>
981
+ * <p>If you specify <code>CUSTOMER_MANAGED</code>, you will manage those roles and
982
+ * permissions yourself. If you are creating this workspace in a member account of an
983
+ * organization that is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services
984
+ * accounts in the organization, you must choose <code>CUSTOMER_MANAGED</code>.</p>
985
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html">Amazon Managed Grafana permissions and policies for
986
+ * Amazon Web Services data sources and notification channels</a>.</p>
928
987
  */
929
988
  permissionType: PermissionType | string | undefined;
930
989
  /**
931
990
  * <p>The name of the CloudFormation stack set to use to generate IAM roles
932
- * to be used for this workspace.</p>
991
+ * to be used for this workspace.</p>
933
992
  */
934
993
  stackSetName?: string;
935
994
  /**
936
995
  * <p>Specify the Amazon Web Services data sources that you want to be queried in this
937
- * workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to read data from these
938
- * sources. You must still add them as data sources in the Grafana console in the
939
- * workspace.</p>
940
- * <p>If you don't specify a data source here, you can still add it as a data source in the
941
- * workspace console later. However, you will then have to manually configure permissions for
942
- * it.</p>
996
+ * workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to read data from these
997
+ * sources. You must still add them as data sources in the Grafana console in the
998
+ * workspace.</p>
999
+ * <p>If you don't specify a data source here, you can still add it as a data source in the
1000
+ * workspace console later. However, you will then have to manually configure permissions for
1001
+ * it.</p>
943
1002
  */
944
1003
  workspaceDataSources?: (DataSourceType | string)[];
945
1004
  /**
946
1005
  * <p>A description for the workspace. This is used only to help you identify this workspace.</p>
947
- * <p>Pattern: <code>^[\\p{L}\\p{Z}\\p{N}\\p{P}]{0,2048}$</code>
1006
+ * <p>Pattern: <code>^[\\p{L}\\p{Z}\\p{N}\\p{P}]{0,2048}$</code>
948
1007
  * </p>
949
1008
  */
950
1009
  workspaceDescription?: string;
@@ -954,31 +1013,41 @@ export interface CreateWorkspaceRequest {
954
1013
  workspaceName?: string;
955
1014
  /**
956
1015
  * <p>Specify the Amazon Web Services notification channels that you plan to use in this workspace. Specifying these
957
- * data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow
958
- * Amazon Managed Grafana to use these channels.</p>
1016
+ * data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow
1017
+ * Amazon Managed Grafana to use these channels.</p>
959
1018
  */
960
1019
  workspaceNotificationDestinations?: (NotificationDestinationType | string)[];
961
1020
  /**
962
1021
  * <p>Specifies the organizational units that this workspace is allowed to use data sources
963
- * from, if this workspace is in an account that is part of an organization.</p>
1022
+ * from, if this workspace is in an account that is part of an organization.</p>
964
1023
  */
965
1024
  workspaceOrganizationalUnits?: string[];
966
1025
  /**
967
1026
  * <p>The workspace needs an IAM role that grants permissions to the Amazon Web Services resources that the
968
- * workspace will view data from. If you already have a role that you want to use, specify it here. The permission type should be set to <code>CUSTOMER_MANAGED</code>.</p>
1027
+ * workspace will view data from. If you already have a role that you want to use, specify it here. The permission type should be set to <code>CUSTOMER_MANAGED</code>.</p>
969
1028
  */
970
1029
  workspaceRoleArn?: string;
971
1030
  /**
972
- * <p>Specifies whether this workspace uses SAML 2.0, Amazon Web Services Single Sign On, or both to authenticate
973
- * users for using the Grafana console within a workspace. For more information,
974
- * see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html">User authentication in
975
- * Amazon Managed Grafana</a>.</p>
1031
+ * <p>Specifies whether this workspace uses SAML 2.0, IAM Identity Center (successor to Single Sign-On), or both to authenticate
1032
+ * users for using the Grafana console within a workspace. For more information,
1033
+ * see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html">User authentication in
1034
+ * Amazon Managed Grafana</a>.</p>
976
1035
  */
977
1036
  authenticationProviders: (AuthenticationProviderTypes | string)[] | undefined;
978
1037
  /**
979
1038
  * <p>The list of tags associated with the workspace.</p>
980
1039
  */
981
1040
  tags?: Record<string, string>;
1041
+ /**
1042
+ * <p>The configuration settings for an Amazon VPC that contains data sources
1043
+ * for your Grafana workspace to connect to.</p>
1044
+ */
1045
+ vpcConfiguration?: VpcConfiguration;
1046
+ /**
1047
+ * <p>The configuration string for the workspace that you create. For more information
1048
+ * 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>
1049
+ */
1050
+ configuration?: __LazyJsonString | string;
982
1051
  }
983
1052
  export interface CreateWorkspaceResponse {
984
1053
  /**
@@ -1017,7 +1086,7 @@ export interface ListWorkspacesRequest {
1017
1086
  maxResults?: number;
1018
1087
  /**
1019
1088
  * <p>The token for the next set of workspaces to return. (You receive this token from a
1020
- * previous <code>ListWorkspaces</code> operation.)</p>
1089
+ * previous <code>ListWorkspaces</code> operation.)</p>
1021
1090
  */
1022
1091
  nextToken?: string;
1023
1092
  }
@@ -1055,8 +1124,8 @@ export interface WorkspaceSummary {
1055
1124
  name?: string;
1056
1125
  /**
1057
1126
  * <p>The Amazon Web Services notification channels that Amazon Managed Grafana can automatically
1058
- * create IAM roles and permissions for, which allows Amazon Managed Grafana to use
1059
- * these channels.</p>
1127
+ * create IAM roles and permissions for, which allows Amazon Managed Grafana to use
1128
+ * these channels.</p>
1060
1129
  */
1061
1130
  notificationDestinations?: (NotificationDestinationType | string)[];
1062
1131
  /**
@@ -1065,7 +1134,7 @@ export interface WorkspaceSummary {
1065
1134
  status: WorkspaceStatus | string | undefined;
1066
1135
  /**
1067
1136
  * <p>A structure containing information about the authentication methods used in
1068
- * the workspace.</p>
1137
+ * the workspace.</p>
1069
1138
  */
1070
1139
  authentication: AuthenticationSummary | undefined;
1071
1140
  /**
@@ -1086,8 +1155,8 @@ export interface ListWorkspacesResponse {
1086
1155
  export interface UpdateWorkspaceRequest {
1087
1156
  /**
1088
1157
  * <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
1089
- * other accounts in the same organization. If you specify <code>ORGANIZATION</code>, you must
1090
- * specify which organizational units the workspace can access in the
1158
+ * other accounts in the same organization. If you specify <code>ORGANIZATION</code>, you must
1159
+ * specify which organizational units the workspace can access in the
1091
1160
  * <code>workspaceOrganizationalUnits</code> parameter.</p>
1092
1161
  */
1093
1162
  accountAccessType?: AccountAccessType | string;
@@ -1097,30 +1166,30 @@ export interface UpdateWorkspaceRequest {
1097
1166
  organizationRoleName?: string;
1098
1167
  /**
1099
1168
  * <p>If you specify <code>Service Managed</code>, Amazon Managed Grafana automatically creates
1100
- * the IAM roles and provisions the permissions that the workspace needs to use
1169
+ * the IAM roles and provisions the permissions that the workspace needs to use
1101
1170
  * Amazon Web Services data sources and notification channels.</p>
1102
- * <p>If you specify <code>CUSTOMER_MANAGED</code>, you will manage those roles and
1103
- * permissions yourself. If you are creating this workspace in a member account of an
1104
- * organization and that account is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services
1105
- * accounts in the organization, you must choose <code>CUSTOMER_MANAGED</code>.</p>
1106
- * <p>For more information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html">Amazon Managed Grafana permissions and policies for
1107
- * Amazon Web Services data sources and notification channels</a>
1171
+ * <p>If you specify <code>CUSTOMER_MANAGED</code>, you will manage those roles and
1172
+ * permissions yourself. If you are creating this workspace in a member account of an
1173
+ * organization and that account is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services
1174
+ * accounts in the organization, you must choose <code>CUSTOMER_MANAGED</code>.</p>
1175
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html">Amazon Managed Grafana permissions and policies for
1176
+ * Amazon Web Services data sources and notification channels</a>
1108
1177
  * </p>
1109
1178
  */
1110
1179
  permissionType?: PermissionType | string;
1111
1180
  /**
1112
1181
  * <p>The name of the CloudFormation stack set to use to generate IAM roles
1113
- * to be used for this workspace.</p>
1182
+ * to be used for this workspace.</p>
1114
1183
  */
1115
1184
  stackSetName?: string;
1116
1185
  /**
1117
1186
  * <p>Specify the Amazon Web Services data sources that you want to be queried in this
1118
- * workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to read data from these
1119
- * sources. You must still add them as data sources in the Grafana console in the
1120
- * workspace.</p>
1121
- * <p>If you don't specify a data source here, you can still add it as a data source later in
1122
- * the workspace console. However, you will then have to manually configure permissions for
1123
- * it.</p>
1187
+ * workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to read data from these
1188
+ * sources. You must still add them as data sources in the Grafana console in the
1189
+ * workspace.</p>
1190
+ * <p>If you don't specify a data source here, you can still add it as a data source later in
1191
+ * the workspace console. However, you will then have to manually configure permissions for
1192
+ * it.</p>
1124
1193
  */
1125
1194
  workspaceDataSources?: (DataSourceType | string)[];
1126
1195
  /**
@@ -1137,23 +1206,34 @@ export interface UpdateWorkspaceRequest {
1137
1206
  workspaceName?: string;
1138
1207
  /**
1139
1208
  * <p>Specify the Amazon Web Services notification channels that you plan to use in this workspace. Specifying these
1140
- * data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow
1141
- * Amazon Managed Grafana to use these channels.</p>
1209
+ * data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow
1210
+ * Amazon Managed Grafana to use these channels.</p>
1142
1211
  */
1143
1212
  workspaceNotificationDestinations?: (NotificationDestinationType | string)[];
1144
1213
  /**
1145
1214
  * <p>Specifies the organizational units that this workspace is allowed to use data sources
1146
- * from, if this workspace is in an account that is part of an organization.</p>
1215
+ * from, if this workspace is in an account that is part of an organization.</p>
1147
1216
  */
1148
1217
  workspaceOrganizationalUnits?: string[];
1149
1218
  /**
1150
1219
  * <p>The workspace needs an IAM role that grants permissions to the Amazon Web Services resources that the
1151
- * workspace will view data from. If you already have a role that you want to use, specify it here. If you omit
1152
- * this field and you specify some Amazon Web Services resources in <code>workspaceDataSources</code> or
1153
- * <code>workspaceNotificationDestinations</code>, a new IAM role with the necessary permissions is
1154
- * automatically created.</p>
1220
+ * workspace will view data from. If you already have a role that you want to use, specify it here. If you omit
1221
+ * this field and you specify some Amazon Web Services resources in <code>workspaceDataSources</code> or
1222
+ * <code>workspaceNotificationDestinations</code>, a new IAM role with the necessary permissions is
1223
+ * automatically created.</p>
1155
1224
  */
1156
1225
  workspaceRoleArn?: string;
1226
+ /**
1227
+ * <p>The configuration settings for an Amazon VPC that contains data sources
1228
+ * for your Grafana workspace to connect to.</p>
1229
+ */
1230
+ vpcConfiguration?: VpcConfiguration;
1231
+ /**
1232
+ * <p>Whether to remove the VPC configuration from the workspace.</p>
1233
+ * <p>Setting this to <code>true</code> and providing a <code>vpcConfiguration</code> to set
1234
+ * will return an error.</p>
1235
+ */
1236
+ removeVpcConfiguration?: boolean;
1157
1237
  }
1158
1238
  export interface UpdateWorkspaceResponse {
1159
1239
  /**
@@ -1193,6 +1273,10 @@ export declare const AssociateLicenseRequestFilterSensitiveLog: (obj: AssociateL
1193
1273
  * @internal
1194
1274
  */
1195
1275
  export declare const AuthenticationSummaryFilterSensitiveLog: (obj: AuthenticationSummary) => any;
1276
+ /**
1277
+ * @internal
1278
+ */
1279
+ export declare const VpcConfigurationFilterSensitiveLog: (obj: VpcConfiguration) => any;
1196
1280
  /**
1197
1281
  * @internal
1198
1282
  */
@@ -1241,6 +1325,22 @@ export declare const UpdateWorkspaceAuthenticationRequestFilterSensitiveLog: (ob
1241
1325
  * @internal
1242
1326
  */
1243
1327
  export declare const UpdateWorkspaceAuthenticationResponseFilterSensitiveLog: (obj: UpdateWorkspaceAuthenticationResponse) => any;
1328
+ /**
1329
+ * @internal
1330
+ */
1331
+ export declare const DescribeWorkspaceConfigurationRequestFilterSensitiveLog: (obj: DescribeWorkspaceConfigurationRequest) => any;
1332
+ /**
1333
+ * @internal
1334
+ */
1335
+ export declare const DescribeWorkspaceConfigurationResponseFilterSensitiveLog: (obj: DescribeWorkspaceConfigurationResponse) => any;
1336
+ /**
1337
+ * @internal
1338
+ */
1339
+ export declare const UpdateWorkspaceConfigurationRequestFilterSensitiveLog: (obj: UpdateWorkspaceConfigurationRequest) => any;
1340
+ /**
1341
+ * @internal
1342
+ */
1343
+ export declare const UpdateWorkspaceConfigurationResponseFilterSensitiveLog: (obj: UpdateWorkspaceConfigurationResponse) => any;
1244
1344
  /**
1245
1345
  * @internal
1246
1346
  */