aws-sdk-managedgrafana 1.9.0 → 1.10.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-managedgrafana/client.rb +164 -33
- data/lib/aws-sdk-managedgrafana/client_api.rb +61 -0
- data/lib/aws-sdk-managedgrafana/endpoints.rb +28 -0
- data/lib/aws-sdk-managedgrafana/plugins/endpoints.rb +4 -0
- data/lib/aws-sdk-managedgrafana/types.rb +193 -41
- data/lib/aws-sdk-managedgrafana.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 98a3805f6f6c020f69a8681129b0ff5ebce892f8a0b4d2536cfa7abeca8f4cc5
|
|
4
|
+
data.tar.gz: 6c5f9dda87b536a675bf8e25613e79ca974371cdc30eb911eb58898624a6ffa4
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c878b1d4197f1c82ba977f416ba7891e6877f5bc9c92630b78f8e7cda676b1e4dfbec83adf97a252c83b3aeec715d392be3162b0e946724bb7c3b03b2a756232
|
|
7
|
+
data.tar.gz: 6c33ed2eb57ea1317c67c769e28c4a5d919a2cfbd564bd8f1813bf1d5edc80c65266bdd8497c707bef5b64c735b2604b745402955081fcab4bfd81991c3e28f0
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.10.0 (2022-11-23)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - This release includes support for configuring a Grafana workspace to connect to a datasource within a VPC as well as new APIs for configuring Grafana settings.
|
|
8
|
+
|
|
4
9
|
1.9.0 (2022-10-25)
|
|
5
10
|
------------------
|
|
6
11
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.10.0
|
|
@@ -401,7 +401,7 @@ module Aws::ManagedGrafana
|
|
|
401
401
|
# resp.workspace.authentication.saml_configuration_status #=> String, one of "CONFIGURED", "NOT_CONFIGURED"
|
|
402
402
|
# resp.workspace.created #=> Time
|
|
403
403
|
# resp.workspace.data_sources #=> Array
|
|
404
|
-
# resp.workspace.data_sources[0] #=> String, one of "AMAZON_OPENSEARCH_SERVICE", "CLOUDWATCH", "PROMETHEUS", "XRAY", "TIMESTREAM", "SITEWISE", "ATHENA", "REDSHIFT"
|
|
404
|
+
# resp.workspace.data_sources[0] #=> String, one of "AMAZON_OPENSEARCH_SERVICE", "CLOUDWATCH", "PROMETHEUS", "XRAY", "TIMESTREAM", "SITEWISE", "ATHENA", "REDSHIFT", "TWINMAKER"
|
|
405
405
|
# resp.workspace.description #=> String
|
|
406
406
|
# resp.workspace.endpoint #=> String
|
|
407
407
|
# resp.workspace.free_trial_consumed #=> Boolean
|
|
@@ -422,6 +422,10 @@ module Aws::ManagedGrafana
|
|
|
422
422
|
# resp.workspace.status #=> String, one of "ACTIVE", "CREATING", "DELETING", "FAILED", "UPDATING", "UPGRADING", "DELETION_FAILED", "CREATION_FAILED", "UPDATE_FAILED", "UPGRADE_FAILED", "LICENSE_REMOVAL_FAILED"
|
|
423
423
|
# resp.workspace.tags #=> Hash
|
|
424
424
|
# resp.workspace.tags["TagKey"] #=> String
|
|
425
|
+
# resp.workspace.vpc_configuration.security_group_ids #=> Array
|
|
426
|
+
# resp.workspace.vpc_configuration.security_group_ids[0] #=> String
|
|
427
|
+
# resp.workspace.vpc_configuration.subnet_ids #=> Array
|
|
428
|
+
# resp.workspace.vpc_configuration.subnet_ids[0] #=> String
|
|
425
429
|
# resp.workspace.workspace_role_arn #=> String
|
|
426
430
|
#
|
|
427
431
|
# @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/AssociateLicense AWS API Documentation
|
|
@@ -454,10 +458,10 @@ module Aws::ManagedGrafana
|
|
|
454
458
|
# `workspaceOrganizationalUnits` parameter.
|
|
455
459
|
#
|
|
456
460
|
# @option params [required, Array<String>] :authentication_providers
|
|
457
|
-
# Specifies whether this workspace uses SAML 2.0,
|
|
458
|
-
# Single Sign
|
|
459
|
-
# console within a workspace. For more information, see
|
|
460
|
-
# authentication in Amazon Managed Grafana][1].
|
|
461
|
+
# Specifies whether this workspace uses SAML 2.0, IAM Identity Center
|
|
462
|
+
# (successor to Single Sign-On), or both to authenticate users for using
|
|
463
|
+
# the Grafana console within a workspace. For more information, see
|
|
464
|
+
# [User authentication in Amazon Managed Grafana][1].
|
|
461
465
|
#
|
|
462
466
|
#
|
|
463
467
|
#
|
|
@@ -470,6 +474,19 @@ module Aws::ManagedGrafana
|
|
|
470
474
|
# **A suitable default value is auto-generated.** You should normally
|
|
471
475
|
# not need to pass this option.**
|
|
472
476
|
#
|
|
477
|
+
# @option params [String] :configuration
|
|
478
|
+
# The configuration string for the workspace that you create. For more
|
|
479
|
+
# information about the format and configuration options available, see
|
|
480
|
+
# [Working in your Grafana workspace][1].
|
|
481
|
+
#
|
|
482
|
+
# **SDK automatically handles json encoding and base64 encoding for you
|
|
483
|
+
# when the required value (Hash, Array, etc.) is provided according to
|
|
484
|
+
# the description.**
|
|
485
|
+
#
|
|
486
|
+
#
|
|
487
|
+
#
|
|
488
|
+
# [1]: https://docs.aws.amazon.com/grafana/latest/userguide/AMG-configure-workspace.html
|
|
489
|
+
#
|
|
473
490
|
# @option params [String] :organization_role_name
|
|
474
491
|
# The name of an IAM role that already exists to use with Organizations
|
|
475
492
|
# to access Amazon Web Services data sources and notification channels
|
|
@@ -479,8 +496,12 @@ module Aws::ManagedGrafana
|
|
|
479
496
|
# If you specify `SERVICE_MANAGED` on AWS Grafana console, Amazon
|
|
480
497
|
# Managed Grafana automatically creates the IAM roles and provisions the
|
|
481
498
|
# permissions that the workspace needs to use Amazon Web Services data
|
|
482
|
-
# sources and notification channels. In CLI mode, the permissionType
|
|
483
|
-
# `SERVICE_MANAGED` will not create the IAM role for you.
|
|
499
|
+
# sources and notification channels. In the CLI mode, the permissionType
|
|
500
|
+
# `SERVICE_MANAGED` will not create the IAM role for you. The ability
|
|
501
|
+
# for the Amazon Managed Grafana to create the IAM role on behalf of the
|
|
502
|
+
# user is supported only in the Amazon Managed Grafana AWS console. Use
|
|
503
|
+
# only the `CUSTOMER_MANAGED` permission type when creating a workspace
|
|
504
|
+
# in the CLI.
|
|
484
505
|
#
|
|
485
506
|
# If you specify `CUSTOMER_MANAGED`, you will manage those roles and
|
|
486
507
|
# permissions yourself. If you are creating this workspace in a member
|
|
@@ -504,6 +525,10 @@ module Aws::ManagedGrafana
|
|
|
504
525
|
# @option params [Hash<String,String>] :tags
|
|
505
526
|
# The list of tags associated with the workspace.
|
|
506
527
|
#
|
|
528
|
+
# @option params [Types::VpcConfiguration] :vpc_configuration
|
|
529
|
+
# The configuration settings for an Amazon VPC that contains data
|
|
530
|
+
# sources for your Grafana workspace to connect to.
|
|
531
|
+
#
|
|
507
532
|
# @option params [Array<String>] :workspace_data_sources
|
|
508
533
|
# Specify the Amazon Web Services data sources that you want to be
|
|
509
534
|
# queried in this workspace. Specifying these data sources here enables
|
|
@@ -551,13 +576,18 @@ module Aws::ManagedGrafana
|
|
|
551
576
|
# account_access_type: "CURRENT_ACCOUNT", # required, accepts CURRENT_ACCOUNT, ORGANIZATION
|
|
552
577
|
# authentication_providers: ["AWS_SSO"], # required, accepts AWS_SSO, SAML
|
|
553
578
|
# client_token: "ClientToken",
|
|
579
|
+
# configuration: "OverridableConfigurationJson",
|
|
554
580
|
# organization_role_name: "OrganizationRoleName",
|
|
555
581
|
# permission_type: "CUSTOMER_MANAGED", # required, accepts CUSTOMER_MANAGED, SERVICE_MANAGED
|
|
556
582
|
# stack_set_name: "StackSetName",
|
|
557
583
|
# tags: {
|
|
558
584
|
# "TagKey" => "TagValue",
|
|
559
585
|
# },
|
|
560
|
-
#
|
|
586
|
+
# vpc_configuration: {
|
|
587
|
+
# security_group_ids: ["SecurityGroupId"], # required
|
|
588
|
+
# subnet_ids: ["SubnetId"], # required
|
|
589
|
+
# },
|
|
590
|
+
# workspace_data_sources: ["AMAZON_OPENSEARCH_SERVICE"], # accepts AMAZON_OPENSEARCH_SERVICE, CLOUDWATCH, PROMETHEUS, XRAY, TIMESTREAM, SITEWISE, ATHENA, REDSHIFT, TWINMAKER
|
|
561
591
|
# workspace_description: "Description",
|
|
562
592
|
# workspace_name: "WorkspaceName",
|
|
563
593
|
# workspace_notification_destinations: ["SNS"], # accepts SNS
|
|
@@ -573,7 +603,7 @@ module Aws::ManagedGrafana
|
|
|
573
603
|
# resp.workspace.authentication.saml_configuration_status #=> String, one of "CONFIGURED", "NOT_CONFIGURED"
|
|
574
604
|
# resp.workspace.created #=> Time
|
|
575
605
|
# resp.workspace.data_sources #=> Array
|
|
576
|
-
# resp.workspace.data_sources[0] #=> String, one of "AMAZON_OPENSEARCH_SERVICE", "CLOUDWATCH", "PROMETHEUS", "XRAY", "TIMESTREAM", "SITEWISE", "ATHENA", "REDSHIFT"
|
|
606
|
+
# resp.workspace.data_sources[0] #=> String, one of "AMAZON_OPENSEARCH_SERVICE", "CLOUDWATCH", "PROMETHEUS", "XRAY", "TIMESTREAM", "SITEWISE", "ATHENA", "REDSHIFT", "TWINMAKER"
|
|
577
607
|
# resp.workspace.description #=> String
|
|
578
608
|
# resp.workspace.endpoint #=> String
|
|
579
609
|
# resp.workspace.free_trial_consumed #=> Boolean
|
|
@@ -594,6 +624,10 @@ module Aws::ManagedGrafana
|
|
|
594
624
|
# resp.workspace.status #=> String, one of "ACTIVE", "CREATING", "DELETING", "FAILED", "UPDATING", "UPGRADING", "DELETION_FAILED", "CREATION_FAILED", "UPDATE_FAILED", "UPGRADE_FAILED", "LICENSE_REMOVAL_FAILED"
|
|
595
625
|
# resp.workspace.tags #=> Hash
|
|
596
626
|
# resp.workspace.tags["TagKey"] #=> String
|
|
627
|
+
# resp.workspace.vpc_configuration.security_group_ids #=> Array
|
|
628
|
+
# resp.workspace.vpc_configuration.security_group_ids[0] #=> String
|
|
629
|
+
# resp.workspace.vpc_configuration.subnet_ids #=> Array
|
|
630
|
+
# resp.workspace.vpc_configuration.subnet_ids[0] #=> String
|
|
597
631
|
# resp.workspace.workspace_role_arn #=> String
|
|
598
632
|
#
|
|
599
633
|
# @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/CreateWorkspace AWS API Documentation
|
|
@@ -605,27 +639,30 @@ module Aws::ManagedGrafana
|
|
|
605
639
|
req.send_request(options)
|
|
606
640
|
end
|
|
607
641
|
|
|
608
|
-
# Creates
|
|
609
|
-
# authenticate requests sent to the workspace's HTTP API. See
|
|
610
|
-
# https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html]
|
|
611
|
-
# https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html)
|
|
642
|
+
# Creates a Grafana API key for the workspace. This key can be used to
|
|
643
|
+
# authenticate requests sent to the workspace's HTTP API. See
|
|
644
|
+
# [https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html][1]
|
|
612
645
|
# for available APIs and example requests.
|
|
613
646
|
#
|
|
647
|
+
#
|
|
648
|
+
#
|
|
649
|
+
# [1]: https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html
|
|
650
|
+
#
|
|
614
651
|
# @option params [required, String] :key_name
|
|
615
|
-
# Specifies the name of the key
|
|
616
|
-
#
|
|
652
|
+
# Specifies the name of the key. Keynames must be unique to the
|
|
653
|
+
# workspace.
|
|
617
654
|
#
|
|
618
655
|
# @option params [required, String] :key_role
|
|
619
656
|
# Specifies the permission level of the key.
|
|
620
657
|
#
|
|
621
|
-
# Valid
|
|
658
|
+
# Valid values: `VIEWER`\|`EDITOR`\|`ADMIN`
|
|
622
659
|
#
|
|
623
660
|
# @option params [required, Integer] :seconds_to_live
|
|
624
661
|
# Specifies the time in seconds until the key expires. Keys can be valid
|
|
625
662
|
# for up to 30 days.
|
|
626
663
|
#
|
|
627
664
|
# @option params [required, String] :workspace_id
|
|
628
|
-
# The ID of the workspace
|
|
665
|
+
# The ID of the workspace to create an API key.
|
|
629
666
|
#
|
|
630
667
|
# @return [Types::CreateWorkspaceApiKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
631
668
|
#
|
|
@@ -680,7 +717,7 @@ module Aws::ManagedGrafana
|
|
|
680
717
|
# resp.workspace.authentication.saml_configuration_status #=> String, one of "CONFIGURED", "NOT_CONFIGURED"
|
|
681
718
|
# resp.workspace.created #=> Time
|
|
682
719
|
# resp.workspace.data_sources #=> Array
|
|
683
|
-
# resp.workspace.data_sources[0] #=> String, one of "AMAZON_OPENSEARCH_SERVICE", "CLOUDWATCH", "PROMETHEUS", "XRAY", "TIMESTREAM", "SITEWISE", "ATHENA", "REDSHIFT"
|
|
720
|
+
# resp.workspace.data_sources[0] #=> String, one of "AMAZON_OPENSEARCH_SERVICE", "CLOUDWATCH", "PROMETHEUS", "XRAY", "TIMESTREAM", "SITEWISE", "ATHENA", "REDSHIFT", "TWINMAKER"
|
|
684
721
|
# resp.workspace.description #=> String
|
|
685
722
|
# resp.workspace.endpoint #=> String
|
|
686
723
|
# resp.workspace.free_trial_consumed #=> Boolean
|
|
@@ -701,6 +738,10 @@ module Aws::ManagedGrafana
|
|
|
701
738
|
# resp.workspace.status #=> String, one of "ACTIVE", "CREATING", "DELETING", "FAILED", "UPDATING", "UPGRADING", "DELETION_FAILED", "CREATION_FAILED", "UPDATE_FAILED", "UPGRADE_FAILED", "LICENSE_REMOVAL_FAILED"
|
|
702
739
|
# resp.workspace.tags #=> Hash
|
|
703
740
|
# resp.workspace.tags["TagKey"] #=> String
|
|
741
|
+
# resp.workspace.vpc_configuration.security_group_ids #=> Array
|
|
742
|
+
# resp.workspace.vpc_configuration.security_group_ids[0] #=> String
|
|
743
|
+
# resp.workspace.vpc_configuration.subnet_ids #=> Array
|
|
744
|
+
# resp.workspace.vpc_configuration.subnet_ids[0] #=> String
|
|
704
745
|
# resp.workspace.workspace_role_arn #=> String
|
|
705
746
|
#
|
|
706
747
|
# @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/DeleteWorkspace AWS API Documentation
|
|
@@ -712,7 +753,7 @@ module Aws::ManagedGrafana
|
|
|
712
753
|
req.send_request(options)
|
|
713
754
|
end
|
|
714
755
|
|
|
715
|
-
# Deletes
|
|
756
|
+
# Deletes a Grafana API key for the workspace.
|
|
716
757
|
#
|
|
717
758
|
# @option params [required, String] :key_name
|
|
718
759
|
# The name of the API key to delete.
|
|
@@ -769,7 +810,7 @@ module Aws::ManagedGrafana
|
|
|
769
810
|
# resp.workspace.authentication.saml_configuration_status #=> String, one of "CONFIGURED", "NOT_CONFIGURED"
|
|
770
811
|
# resp.workspace.created #=> Time
|
|
771
812
|
# resp.workspace.data_sources #=> Array
|
|
772
|
-
# resp.workspace.data_sources[0] #=> String, one of "AMAZON_OPENSEARCH_SERVICE", "CLOUDWATCH", "PROMETHEUS", "XRAY", "TIMESTREAM", "SITEWISE", "ATHENA", "REDSHIFT"
|
|
813
|
+
# resp.workspace.data_sources[0] #=> String, one of "AMAZON_OPENSEARCH_SERVICE", "CLOUDWATCH", "PROMETHEUS", "XRAY", "TIMESTREAM", "SITEWISE", "ATHENA", "REDSHIFT", "TWINMAKER"
|
|
773
814
|
# resp.workspace.description #=> String
|
|
774
815
|
# resp.workspace.endpoint #=> String
|
|
775
816
|
# resp.workspace.free_trial_consumed #=> Boolean
|
|
@@ -790,6 +831,10 @@ module Aws::ManagedGrafana
|
|
|
790
831
|
# resp.workspace.status #=> String, one of "ACTIVE", "CREATING", "DELETING", "FAILED", "UPDATING", "UPGRADING", "DELETION_FAILED", "CREATION_FAILED", "UPDATE_FAILED", "UPGRADE_FAILED", "LICENSE_REMOVAL_FAILED"
|
|
791
832
|
# resp.workspace.tags #=> Hash
|
|
792
833
|
# resp.workspace.tags["TagKey"] #=> String
|
|
834
|
+
# resp.workspace.vpc_configuration.security_group_ids #=> Array
|
|
835
|
+
# resp.workspace.vpc_configuration.security_group_ids[0] #=> String
|
|
836
|
+
# resp.workspace.vpc_configuration.subnet_ids #=> Array
|
|
837
|
+
# resp.workspace.vpc_configuration.subnet_ids[0] #=> String
|
|
793
838
|
# resp.workspace.workspace_role_arn #=> String
|
|
794
839
|
#
|
|
795
840
|
# @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/DescribeWorkspace AWS API Documentation
|
|
@@ -848,6 +893,34 @@ module Aws::ManagedGrafana
|
|
|
848
893
|
req.send_request(options)
|
|
849
894
|
end
|
|
850
895
|
|
|
896
|
+
# Gets the current configuration string for the given workspace.
|
|
897
|
+
#
|
|
898
|
+
# @option params [required, String] :workspace_id
|
|
899
|
+
# The ID of the workspace to get configuration information for.
|
|
900
|
+
#
|
|
901
|
+
# @return [Types::DescribeWorkspaceConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
902
|
+
#
|
|
903
|
+
# * {Types::DescribeWorkspaceConfigurationResponse#configuration #configuration} => String
|
|
904
|
+
#
|
|
905
|
+
# @example Request syntax with placeholder values
|
|
906
|
+
#
|
|
907
|
+
# resp = client.describe_workspace_configuration({
|
|
908
|
+
# workspace_id: "WorkspaceId", # required
|
|
909
|
+
# })
|
|
910
|
+
#
|
|
911
|
+
# @example Response structure
|
|
912
|
+
#
|
|
913
|
+
# resp.configuration #=> String
|
|
914
|
+
#
|
|
915
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/DescribeWorkspaceConfiguration AWS API Documentation
|
|
916
|
+
#
|
|
917
|
+
# @overload describe_workspace_configuration(params = {})
|
|
918
|
+
# @param [Hash] params ({})
|
|
919
|
+
def describe_workspace_configuration(params = {}, options = {})
|
|
920
|
+
req = build_request(:describe_workspace_configuration, params)
|
|
921
|
+
req.send_request(options)
|
|
922
|
+
end
|
|
923
|
+
|
|
851
924
|
# Removes the Grafana Enterprise license from a workspace.
|
|
852
925
|
#
|
|
853
926
|
# @option params [required, String] :license_type
|
|
@@ -875,7 +948,7 @@ module Aws::ManagedGrafana
|
|
|
875
948
|
# resp.workspace.authentication.saml_configuration_status #=> String, one of "CONFIGURED", "NOT_CONFIGURED"
|
|
876
949
|
# resp.workspace.created #=> Time
|
|
877
950
|
# resp.workspace.data_sources #=> Array
|
|
878
|
-
# resp.workspace.data_sources[0] #=> String, one of "AMAZON_OPENSEARCH_SERVICE", "CLOUDWATCH", "PROMETHEUS", "XRAY", "TIMESTREAM", "SITEWISE", "ATHENA", "REDSHIFT"
|
|
951
|
+
# resp.workspace.data_sources[0] #=> String, one of "AMAZON_OPENSEARCH_SERVICE", "CLOUDWATCH", "PROMETHEUS", "XRAY", "TIMESTREAM", "SITEWISE", "ATHENA", "REDSHIFT", "TWINMAKER"
|
|
879
952
|
# resp.workspace.description #=> String
|
|
880
953
|
# resp.workspace.endpoint #=> String
|
|
881
954
|
# resp.workspace.free_trial_consumed #=> Boolean
|
|
@@ -896,6 +969,10 @@ module Aws::ManagedGrafana
|
|
|
896
969
|
# resp.workspace.status #=> String, one of "ACTIVE", "CREATING", "DELETING", "FAILED", "UPDATING", "UPGRADING", "DELETION_FAILED", "CREATION_FAILED", "UPDATE_FAILED", "UPGRADE_FAILED", "LICENSE_REMOVAL_FAILED"
|
|
897
970
|
# resp.workspace.tags #=> Hash
|
|
898
971
|
# resp.workspace.tags["TagKey"] #=> String
|
|
972
|
+
# resp.workspace.vpc_configuration.security_group_ids #=> Array
|
|
973
|
+
# resp.workspace.vpc_configuration.security_group_ids[0] #=> String
|
|
974
|
+
# resp.workspace.vpc_configuration.subnet_ids #=> Array
|
|
975
|
+
# resp.workspace.vpc_configuration.subnet_ids[0] #=> String
|
|
899
976
|
# resp.workspace.workspace_role_arn #=> String
|
|
900
977
|
#
|
|
901
978
|
# @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/DisassociateLicense AWS API Documentation
|
|
@@ -928,10 +1005,9 @@ module Aws::ManagedGrafana
|
|
|
928
1005
|
# (Optional) Limits the results to only the user that matches this ID.
|
|
929
1006
|
#
|
|
930
1007
|
# @option params [String] :user_type
|
|
931
|
-
# (Optional) If you specify `SSO_USER`, then only the permissions of
|
|
932
|
-
#
|
|
933
|
-
#
|
|
934
|
-
# are returned.
|
|
1008
|
+
# (Optional) If you specify `SSO_USER`, then only the permissions of IAM
|
|
1009
|
+
# Identity Center users are returned. If you specify `SSO_GROUP`, only
|
|
1010
|
+
# the permissions of IAM Identity Center groups are returned.
|
|
935
1011
|
#
|
|
936
1012
|
# @option params [required, String] :workspace_id
|
|
937
1013
|
# The ID of the workspace to list permissions for. This parameter is
|
|
@@ -1182,7 +1258,7 @@ module Aws::ManagedGrafana
|
|
|
1182
1258
|
# those parameters are not changed.
|
|
1183
1259
|
#
|
|
1184
1260
|
# To modify the user authentication methods that the workspace uses,
|
|
1185
|
-
# such as SAML or
|
|
1261
|
+
# such as SAML or IAM Identity Center, use
|
|
1186
1262
|
# [UpdateWorkspaceAuthentication][1].
|
|
1187
1263
|
#
|
|
1188
1264
|
# To modify which users in the workspace have the `Admin` and `Editor`
|
|
@@ -1226,10 +1302,20 @@ module Aws::ManagedGrafana
|
|
|
1226
1302
|
#
|
|
1227
1303
|
# [1]: https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html
|
|
1228
1304
|
#
|
|
1305
|
+
# @option params [Boolean] :remove_vpc_configuration
|
|
1306
|
+
# Whether to remove the VPC configuration from the workspace.
|
|
1307
|
+
#
|
|
1308
|
+
# Setting this to `true` and providing a `vpcConfiguration` to set will
|
|
1309
|
+
# return an error.
|
|
1310
|
+
#
|
|
1229
1311
|
# @option params [String] :stack_set_name
|
|
1230
1312
|
# The name of the CloudFormation stack set to use to generate IAM roles
|
|
1231
1313
|
# to be used for this workspace.
|
|
1232
1314
|
#
|
|
1315
|
+
# @option params [Types::VpcConfiguration] :vpc_configuration
|
|
1316
|
+
# The configuration settings for an Amazon VPC that contains data
|
|
1317
|
+
# sources for your Grafana workspace to connect to.
|
|
1318
|
+
#
|
|
1233
1319
|
# @option params [Array<String>] :workspace_data_sources
|
|
1234
1320
|
# Specify the Amazon Web Services data sources that you want to be
|
|
1235
1321
|
# queried in this workspace. Specifying these data sources here enables
|
|
@@ -1280,8 +1366,13 @@ module Aws::ManagedGrafana
|
|
|
1280
1366
|
# account_access_type: "CURRENT_ACCOUNT", # accepts CURRENT_ACCOUNT, ORGANIZATION
|
|
1281
1367
|
# organization_role_name: "OrganizationRoleName",
|
|
1282
1368
|
# permission_type: "CUSTOMER_MANAGED", # accepts CUSTOMER_MANAGED, SERVICE_MANAGED
|
|
1369
|
+
# remove_vpc_configuration: false,
|
|
1283
1370
|
# stack_set_name: "StackSetName",
|
|
1284
|
-
#
|
|
1371
|
+
# vpc_configuration: {
|
|
1372
|
+
# security_group_ids: ["SecurityGroupId"], # required
|
|
1373
|
+
# subnet_ids: ["SubnetId"], # required
|
|
1374
|
+
# },
|
|
1375
|
+
# workspace_data_sources: ["AMAZON_OPENSEARCH_SERVICE"], # accepts AMAZON_OPENSEARCH_SERVICE, CLOUDWATCH, PROMETHEUS, XRAY, TIMESTREAM, SITEWISE, ATHENA, REDSHIFT, TWINMAKER
|
|
1285
1376
|
# workspace_description: "Description",
|
|
1286
1377
|
# workspace_id: "WorkspaceId", # required
|
|
1287
1378
|
# workspace_name: "WorkspaceName",
|
|
@@ -1298,7 +1389,7 @@ module Aws::ManagedGrafana
|
|
|
1298
1389
|
# resp.workspace.authentication.saml_configuration_status #=> String, one of "CONFIGURED", "NOT_CONFIGURED"
|
|
1299
1390
|
# resp.workspace.created #=> Time
|
|
1300
1391
|
# resp.workspace.data_sources #=> Array
|
|
1301
|
-
# resp.workspace.data_sources[0] #=> String, one of "AMAZON_OPENSEARCH_SERVICE", "CLOUDWATCH", "PROMETHEUS", "XRAY", "TIMESTREAM", "SITEWISE", "ATHENA", "REDSHIFT"
|
|
1392
|
+
# resp.workspace.data_sources[0] #=> String, one of "AMAZON_OPENSEARCH_SERVICE", "CLOUDWATCH", "PROMETHEUS", "XRAY", "TIMESTREAM", "SITEWISE", "ATHENA", "REDSHIFT", "TWINMAKER"
|
|
1302
1393
|
# resp.workspace.description #=> String
|
|
1303
1394
|
# resp.workspace.endpoint #=> String
|
|
1304
1395
|
# resp.workspace.free_trial_consumed #=> Boolean
|
|
@@ -1319,6 +1410,10 @@ module Aws::ManagedGrafana
|
|
|
1319
1410
|
# resp.workspace.status #=> String, one of "ACTIVE", "CREATING", "DELETING", "FAILED", "UPDATING", "UPGRADING", "DELETION_FAILED", "CREATION_FAILED", "UPDATE_FAILED", "UPGRADE_FAILED", "LICENSE_REMOVAL_FAILED"
|
|
1320
1411
|
# resp.workspace.tags #=> Hash
|
|
1321
1412
|
# resp.workspace.tags["TagKey"] #=> String
|
|
1413
|
+
# resp.workspace.vpc_configuration.security_group_ids #=> Array
|
|
1414
|
+
# resp.workspace.vpc_configuration.security_group_ids[0] #=> String
|
|
1415
|
+
# resp.workspace.vpc_configuration.subnet_ids #=> Array
|
|
1416
|
+
# resp.workspace.vpc_configuration.subnet_ids[0] #=> String
|
|
1322
1417
|
# resp.workspace.workspace_role_arn #=> String
|
|
1323
1418
|
#
|
|
1324
1419
|
# @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/UpdateWorkspace AWS API Documentation
|
|
@@ -1337,10 +1432,10 @@ module Aws::ManagedGrafana
|
|
|
1337
1432
|
# roles in the workspace.
|
|
1338
1433
|
#
|
|
1339
1434
|
# @option params [required, Array<String>] :authentication_providers
|
|
1340
|
-
# Specifies whether this workspace uses SAML 2.0,
|
|
1341
|
-
# Single Sign
|
|
1342
|
-
# console within a workspace. For more information, see
|
|
1343
|
-
# authentication in Amazon Managed Grafana][1].
|
|
1435
|
+
# Specifies whether this workspace uses SAML 2.0, IAM Identity Center
|
|
1436
|
+
# (successor to Single Sign-On), or both to authenticate users for using
|
|
1437
|
+
# the Grafana console within a workspace. For more information, see
|
|
1438
|
+
# [User authentication in Amazon Managed Grafana][1].
|
|
1344
1439
|
#
|
|
1345
1440
|
#
|
|
1346
1441
|
#
|
|
@@ -1417,6 +1512,42 @@ module Aws::ManagedGrafana
|
|
|
1417
1512
|
req.send_request(options)
|
|
1418
1513
|
end
|
|
1419
1514
|
|
|
1515
|
+
# Updates the configuration string for the given workspace
|
|
1516
|
+
#
|
|
1517
|
+
# @option params [required, String] :configuration
|
|
1518
|
+
# The new configuration string for the workspace. For more information
|
|
1519
|
+
# about the format and configuration options available, see [Working in
|
|
1520
|
+
# your Grafana workspace][1].
|
|
1521
|
+
#
|
|
1522
|
+
# **SDK automatically handles json encoding and base64 encoding for you
|
|
1523
|
+
# when the required value (Hash, Array, etc.) is provided according to
|
|
1524
|
+
# the description.**
|
|
1525
|
+
#
|
|
1526
|
+
#
|
|
1527
|
+
#
|
|
1528
|
+
# [1]: https://docs.aws.amazon.com/grafana/latest/userguide/AMG-configure-workspace.html
|
|
1529
|
+
#
|
|
1530
|
+
# @option params [required, String] :workspace_id
|
|
1531
|
+
# The ID of the workspace to update.
|
|
1532
|
+
#
|
|
1533
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1534
|
+
#
|
|
1535
|
+
# @example Request syntax with placeholder values
|
|
1536
|
+
#
|
|
1537
|
+
# resp = client.update_workspace_configuration({
|
|
1538
|
+
# configuration: "OverridableConfigurationJson", # required
|
|
1539
|
+
# workspace_id: "WorkspaceId", # required
|
|
1540
|
+
# })
|
|
1541
|
+
#
|
|
1542
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/UpdateWorkspaceConfiguration AWS API Documentation
|
|
1543
|
+
#
|
|
1544
|
+
# @overload update_workspace_configuration(params = {})
|
|
1545
|
+
# @param [Hash] params ({})
|
|
1546
|
+
def update_workspace_configuration(params = {}, options = {})
|
|
1547
|
+
req = build_request(:update_workspace_configuration, params)
|
|
1548
|
+
req.send_request(options)
|
|
1549
|
+
end
|
|
1550
|
+
|
|
1420
1551
|
# @!endgroup
|
|
1421
1552
|
|
|
1422
1553
|
# @param params ({})
|
|
@@ -1430,7 +1561,7 @@ module Aws::ManagedGrafana
|
|
|
1430
1561
|
params: params,
|
|
1431
1562
|
config: config)
|
|
1432
1563
|
context[:gem_name] = 'aws-sdk-managedgrafana'
|
|
1433
|
-
context[:gem_version] = '1.
|
|
1564
|
+
context[:gem_version] = '1.10.0'
|
|
1434
1565
|
Seahorse::Client::Request.new(handlers, context)
|
|
1435
1566
|
end
|
|
1436
1567
|
|
|
@@ -44,6 +44,8 @@ module Aws::ManagedGrafana
|
|
|
44
44
|
DeleteWorkspaceResponse = Shapes::StructureShape.new(name: 'DeleteWorkspaceResponse')
|
|
45
45
|
DescribeWorkspaceAuthenticationRequest = Shapes::StructureShape.new(name: 'DescribeWorkspaceAuthenticationRequest')
|
|
46
46
|
DescribeWorkspaceAuthenticationResponse = Shapes::StructureShape.new(name: 'DescribeWorkspaceAuthenticationResponse')
|
|
47
|
+
DescribeWorkspaceConfigurationRequest = Shapes::StructureShape.new(name: 'DescribeWorkspaceConfigurationRequest')
|
|
48
|
+
DescribeWorkspaceConfigurationResponse = Shapes::StructureShape.new(name: 'DescribeWorkspaceConfigurationResponse')
|
|
47
49
|
DescribeWorkspaceRequest = Shapes::StructureShape.new(name: 'DescribeWorkspaceRequest')
|
|
48
50
|
DescribeWorkspaceResponse = Shapes::StructureShape.new(name: 'DescribeWorkspaceResponse')
|
|
49
51
|
Description = Shapes::StringShape.new(name: 'Description')
|
|
@@ -71,6 +73,7 @@ module Aws::ManagedGrafana
|
|
|
71
73
|
OrganizationRoleName = Shapes::StringShape.new(name: 'OrganizationRoleName')
|
|
72
74
|
OrganizationalUnit = Shapes::StringShape.new(name: 'OrganizationalUnit')
|
|
73
75
|
OrganizationalUnitList = Shapes::ListShape.new(name: 'OrganizationalUnitList')
|
|
76
|
+
OverridableConfigurationJson = Shapes::StringShape.new(name: 'OverridableConfigurationJson')
|
|
74
77
|
PaginationToken = Shapes::StringShape.new(name: 'PaginationToken')
|
|
75
78
|
PermissionEntry = Shapes::StructureShape.new(name: 'PermissionEntry')
|
|
76
79
|
PermissionEntryList = Shapes::ListShape.new(name: 'PermissionEntryList')
|
|
@@ -84,10 +87,14 @@ module Aws::ManagedGrafana
|
|
|
84
87
|
SamlAuthentication = Shapes::StructureShape.new(name: 'SamlAuthentication')
|
|
85
88
|
SamlConfiguration = Shapes::StructureShape.new(name: 'SamlConfiguration')
|
|
86
89
|
SamlConfigurationStatus = Shapes::StringShape.new(name: 'SamlConfigurationStatus')
|
|
90
|
+
SecurityGroupId = Shapes::StringShape.new(name: 'SecurityGroupId')
|
|
91
|
+
SecurityGroupIds = Shapes::ListShape.new(name: 'SecurityGroupIds')
|
|
87
92
|
ServiceQuotaExceededException = Shapes::StructureShape.new(name: 'ServiceQuotaExceededException')
|
|
88
93
|
SsoId = Shapes::StringShape.new(name: 'SsoId')
|
|
89
94
|
StackSetName = Shapes::StringShape.new(name: 'StackSetName')
|
|
90
95
|
String = Shapes::StringShape.new(name: 'String')
|
|
96
|
+
SubnetId = Shapes::StringShape.new(name: 'SubnetId')
|
|
97
|
+
SubnetIds = Shapes::ListShape.new(name: 'SubnetIds')
|
|
91
98
|
TagKey = Shapes::StringShape.new(name: 'TagKey')
|
|
92
99
|
TagKeys = Shapes::ListShape.new(name: 'TagKeys')
|
|
93
100
|
TagMap = Shapes::MapShape.new(name: 'TagMap')
|
|
@@ -108,6 +115,8 @@ module Aws::ManagedGrafana
|
|
|
108
115
|
UpdatePermissionsResponse = Shapes::StructureShape.new(name: 'UpdatePermissionsResponse')
|
|
109
116
|
UpdateWorkspaceAuthenticationRequest = Shapes::StructureShape.new(name: 'UpdateWorkspaceAuthenticationRequest')
|
|
110
117
|
UpdateWorkspaceAuthenticationResponse = Shapes::StructureShape.new(name: 'UpdateWorkspaceAuthenticationResponse')
|
|
118
|
+
UpdateWorkspaceConfigurationRequest = Shapes::StructureShape.new(name: 'UpdateWorkspaceConfigurationRequest')
|
|
119
|
+
UpdateWorkspaceConfigurationResponse = Shapes::StructureShape.new(name: 'UpdateWorkspaceConfigurationResponse')
|
|
111
120
|
UpdateWorkspaceRequest = Shapes::StructureShape.new(name: 'UpdateWorkspaceRequest')
|
|
112
121
|
UpdateWorkspaceResponse = Shapes::StructureShape.new(name: 'UpdateWorkspaceResponse')
|
|
113
122
|
User = Shapes::StructureShape.new(name: 'User')
|
|
@@ -117,6 +126,7 @@ module Aws::ManagedGrafana
|
|
|
117
126
|
ValidationExceptionField = Shapes::StructureShape.new(name: 'ValidationExceptionField')
|
|
118
127
|
ValidationExceptionFieldList = Shapes::ListShape.new(name: 'ValidationExceptionFieldList')
|
|
119
128
|
ValidationExceptionReason = Shapes::StringShape.new(name: 'ValidationExceptionReason')
|
|
129
|
+
VpcConfiguration = Shapes::StructureShape.new(name: 'VpcConfiguration')
|
|
120
130
|
WorkspaceDescription = Shapes::StructureShape.new(name: 'WorkspaceDescription')
|
|
121
131
|
WorkspaceId = Shapes::StringShape.new(name: 'WorkspaceId')
|
|
122
132
|
WorkspaceList = Shapes::ListShape.new(name: 'WorkspaceList')
|
|
@@ -177,10 +187,12 @@ module Aws::ManagedGrafana
|
|
|
177
187
|
CreateWorkspaceRequest.add_member(:account_access_type, Shapes::ShapeRef.new(shape: AccountAccessType, required: true, location_name: "accountAccessType"))
|
|
178
188
|
CreateWorkspaceRequest.add_member(:authentication_providers, Shapes::ShapeRef.new(shape: AuthenticationProviders, required: true, location_name: "authenticationProviders"))
|
|
179
189
|
CreateWorkspaceRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true}))
|
|
190
|
+
CreateWorkspaceRequest.add_member(:configuration, Shapes::ShapeRef.new(shape: OverridableConfigurationJson, location_name: "configuration", metadata: {"jsonvalue"=>true}))
|
|
180
191
|
CreateWorkspaceRequest.add_member(:organization_role_name, Shapes::ShapeRef.new(shape: OrganizationRoleName, location_name: "organizationRoleName"))
|
|
181
192
|
CreateWorkspaceRequest.add_member(:permission_type, Shapes::ShapeRef.new(shape: PermissionType, required: true, location_name: "permissionType"))
|
|
182
193
|
CreateWorkspaceRequest.add_member(:stack_set_name, Shapes::ShapeRef.new(shape: StackSetName, location_name: "stackSetName"))
|
|
183
194
|
CreateWorkspaceRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "tags"))
|
|
195
|
+
CreateWorkspaceRequest.add_member(:vpc_configuration, Shapes::ShapeRef.new(shape: VpcConfiguration, location_name: "vpcConfiguration"))
|
|
184
196
|
CreateWorkspaceRequest.add_member(:workspace_data_sources, Shapes::ShapeRef.new(shape: DataSourceTypesList, location_name: "workspaceDataSources"))
|
|
185
197
|
CreateWorkspaceRequest.add_member(:workspace_description, Shapes::ShapeRef.new(shape: Description, location_name: "workspaceDescription"))
|
|
186
198
|
CreateWorkspaceRequest.add_member(:workspace_name, Shapes::ShapeRef.new(shape: WorkspaceName, location_name: "workspaceName"))
|
|
@@ -214,6 +226,12 @@ module Aws::ManagedGrafana
|
|
|
214
226
|
DescribeWorkspaceAuthenticationResponse.add_member(:authentication, Shapes::ShapeRef.new(shape: AuthenticationDescription, required: true, location_name: "authentication"))
|
|
215
227
|
DescribeWorkspaceAuthenticationResponse.struct_class = Types::DescribeWorkspaceAuthenticationResponse
|
|
216
228
|
|
|
229
|
+
DescribeWorkspaceConfigurationRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location: "uri", location_name: "workspaceId"))
|
|
230
|
+
DescribeWorkspaceConfigurationRequest.struct_class = Types::DescribeWorkspaceConfigurationRequest
|
|
231
|
+
|
|
232
|
+
DescribeWorkspaceConfigurationResponse.add_member(:configuration, Shapes::ShapeRef.new(shape: OverridableConfigurationJson, required: true, location_name: "configuration", metadata: {"jsonvalue"=>true}))
|
|
233
|
+
DescribeWorkspaceConfigurationResponse.struct_class = Types::DescribeWorkspaceConfigurationResponse
|
|
234
|
+
|
|
217
235
|
DescribeWorkspaceRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location: "uri", location_name: "workspaceId"))
|
|
218
236
|
DescribeWorkspaceRequest.struct_class = Types::DescribeWorkspaceRequest
|
|
219
237
|
|
|
@@ -297,6 +315,8 @@ module Aws::ManagedGrafana
|
|
|
297
315
|
SamlConfiguration.add_member(:role_values, Shapes::ShapeRef.new(shape: RoleValues, location_name: "roleValues"))
|
|
298
316
|
SamlConfiguration.struct_class = Types::SamlConfiguration
|
|
299
317
|
|
|
318
|
+
SecurityGroupIds.member = Shapes::ShapeRef.new(shape: SecurityGroupId)
|
|
319
|
+
|
|
300
320
|
ServiceQuotaExceededException.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "message"))
|
|
301
321
|
ServiceQuotaExceededException.add_member(:quota_code, Shapes::ShapeRef.new(shape: String, required: true, location_name: "quotaCode"))
|
|
302
322
|
ServiceQuotaExceededException.add_member(:resource_id, Shapes::ShapeRef.new(shape: String, required: true, location_name: "resourceId"))
|
|
@@ -304,6 +324,8 @@ module Aws::ManagedGrafana
|
|
|
304
324
|
ServiceQuotaExceededException.add_member(:service_code, Shapes::ShapeRef.new(shape: String, required: true, location_name: "serviceCode"))
|
|
305
325
|
ServiceQuotaExceededException.struct_class = Types::ServiceQuotaExceededException
|
|
306
326
|
|
|
327
|
+
SubnetIds.member = Shapes::ShapeRef.new(shape: SubnetId)
|
|
328
|
+
|
|
307
329
|
TagKeys.member = Shapes::ShapeRef.new(shape: TagKey)
|
|
308
330
|
|
|
309
331
|
TagMap.key = Shapes::ShapeRef.new(shape: TagKey)
|
|
@@ -356,10 +378,18 @@ module Aws::ManagedGrafana
|
|
|
356
378
|
UpdateWorkspaceAuthenticationResponse.add_member(:authentication, Shapes::ShapeRef.new(shape: AuthenticationDescription, required: true, location_name: "authentication"))
|
|
357
379
|
UpdateWorkspaceAuthenticationResponse.struct_class = Types::UpdateWorkspaceAuthenticationResponse
|
|
358
380
|
|
|
381
|
+
UpdateWorkspaceConfigurationRequest.add_member(:configuration, Shapes::ShapeRef.new(shape: OverridableConfigurationJson, required: true, location_name: "configuration", metadata: {"jsonvalue"=>true}))
|
|
382
|
+
UpdateWorkspaceConfigurationRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location: "uri", location_name: "workspaceId"))
|
|
383
|
+
UpdateWorkspaceConfigurationRequest.struct_class = Types::UpdateWorkspaceConfigurationRequest
|
|
384
|
+
|
|
385
|
+
UpdateWorkspaceConfigurationResponse.struct_class = Types::UpdateWorkspaceConfigurationResponse
|
|
386
|
+
|
|
359
387
|
UpdateWorkspaceRequest.add_member(:account_access_type, Shapes::ShapeRef.new(shape: AccountAccessType, location_name: "accountAccessType"))
|
|
360
388
|
UpdateWorkspaceRequest.add_member(:organization_role_name, Shapes::ShapeRef.new(shape: OrganizationRoleName, location_name: "organizationRoleName"))
|
|
361
389
|
UpdateWorkspaceRequest.add_member(:permission_type, Shapes::ShapeRef.new(shape: PermissionType, location_name: "permissionType"))
|
|
390
|
+
UpdateWorkspaceRequest.add_member(:remove_vpc_configuration, Shapes::ShapeRef.new(shape: Boolean, location_name: "removeVpcConfiguration"))
|
|
362
391
|
UpdateWorkspaceRequest.add_member(:stack_set_name, Shapes::ShapeRef.new(shape: StackSetName, location_name: "stackSetName"))
|
|
392
|
+
UpdateWorkspaceRequest.add_member(:vpc_configuration, Shapes::ShapeRef.new(shape: VpcConfiguration, location_name: "vpcConfiguration"))
|
|
363
393
|
UpdateWorkspaceRequest.add_member(:workspace_data_sources, Shapes::ShapeRef.new(shape: DataSourceTypesList, location_name: "workspaceDataSources"))
|
|
364
394
|
UpdateWorkspaceRequest.add_member(:workspace_description, Shapes::ShapeRef.new(shape: Description, location_name: "workspaceDescription"))
|
|
365
395
|
UpdateWorkspaceRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location: "uri", location_name: "workspaceId"))
|
|
@@ -389,6 +419,10 @@ module Aws::ManagedGrafana
|
|
|
389
419
|
|
|
390
420
|
ValidationExceptionFieldList.member = Shapes::ShapeRef.new(shape: ValidationExceptionField)
|
|
391
421
|
|
|
422
|
+
VpcConfiguration.add_member(:security_group_ids, Shapes::ShapeRef.new(shape: SecurityGroupIds, required: true, location_name: "securityGroupIds"))
|
|
423
|
+
VpcConfiguration.add_member(:subnet_ids, Shapes::ShapeRef.new(shape: SubnetIds, required: true, location_name: "subnetIds"))
|
|
424
|
+
VpcConfiguration.struct_class = Types::VpcConfiguration
|
|
425
|
+
|
|
392
426
|
WorkspaceDescription.add_member(:account_access_type, Shapes::ShapeRef.new(shape: AccountAccessType, location_name: "accountAccessType"))
|
|
393
427
|
WorkspaceDescription.add_member(:authentication, Shapes::ShapeRef.new(shape: AuthenticationSummary, required: true, location_name: "authentication"))
|
|
394
428
|
WorkspaceDescription.add_member(:created, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "created"))
|
|
@@ -410,6 +444,7 @@ module Aws::ManagedGrafana
|
|
|
410
444
|
WorkspaceDescription.add_member(:stack_set_name, Shapes::ShapeRef.new(shape: StackSetName, location_name: "stackSetName"))
|
|
411
445
|
WorkspaceDescription.add_member(:status, Shapes::ShapeRef.new(shape: WorkspaceStatus, required: true, location_name: "status"))
|
|
412
446
|
WorkspaceDescription.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "tags"))
|
|
447
|
+
WorkspaceDescription.add_member(:vpc_configuration, Shapes::ShapeRef.new(shape: VpcConfiguration, location_name: "vpcConfiguration"))
|
|
413
448
|
WorkspaceDescription.add_member(:workspace_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "workspaceRoleArn"))
|
|
414
449
|
WorkspaceDescription.struct_class = Types::WorkspaceDescription
|
|
415
450
|
|
|
@@ -542,6 +577,18 @@ module Aws::ManagedGrafana
|
|
|
542
577
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
|
543
578
|
end)
|
|
544
579
|
|
|
580
|
+
api.add_operation(:describe_workspace_configuration, Seahorse::Model::Operation.new.tap do |o|
|
|
581
|
+
o.name = "DescribeWorkspaceConfiguration"
|
|
582
|
+
o.http_method = "GET"
|
|
583
|
+
o.http_request_uri = "/workspaces/{workspaceId}/configuration"
|
|
584
|
+
o.input = Shapes::ShapeRef.new(shape: DescribeWorkspaceConfigurationRequest)
|
|
585
|
+
o.output = Shapes::ShapeRef.new(shape: DescribeWorkspaceConfigurationResponse)
|
|
586
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
|
587
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
|
588
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
|
589
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
|
590
|
+
end)
|
|
591
|
+
|
|
545
592
|
api.add_operation(:disassociate_license, Seahorse::Model::Operation.new.tap do |o|
|
|
546
593
|
o.name = "DisassociateLicense"
|
|
547
594
|
o.http_method = "DELETE"
|
|
@@ -670,6 +717,20 @@ module Aws::ManagedGrafana
|
|
|
670
717
|
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
|
671
718
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
|
672
719
|
end)
|
|
720
|
+
|
|
721
|
+
api.add_operation(:update_workspace_configuration, Seahorse::Model::Operation.new.tap do |o|
|
|
722
|
+
o.name = "UpdateWorkspaceConfiguration"
|
|
723
|
+
o.http_method = "PUT"
|
|
724
|
+
o.http_request_uri = "/workspaces/{workspaceId}/configuration"
|
|
725
|
+
o.input = Shapes::ShapeRef.new(shape: UpdateWorkspaceConfigurationRequest)
|
|
726
|
+
o.output = Shapes::ShapeRef.new(shape: UpdateWorkspaceConfigurationResponse)
|
|
727
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
|
728
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
|
729
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
|
730
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
|
731
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
|
732
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
|
733
|
+
end)
|
|
673
734
|
end
|
|
674
735
|
|
|
675
736
|
end
|
|
@@ -109,6 +109,20 @@ module Aws::ManagedGrafana
|
|
|
109
109
|
end
|
|
110
110
|
end
|
|
111
111
|
|
|
112
|
+
class DescribeWorkspaceConfiguration
|
|
113
|
+
def self.build(context)
|
|
114
|
+
unless context.config.regional_endpoint
|
|
115
|
+
endpoint = context.config.endpoint.to_s
|
|
116
|
+
end
|
|
117
|
+
Aws::ManagedGrafana::EndpointParameters.new(
|
|
118
|
+
region: context.config.region,
|
|
119
|
+
use_dual_stack: context.config.use_dualstack_endpoint,
|
|
120
|
+
use_fips: context.config.use_fips_endpoint,
|
|
121
|
+
endpoint: endpoint,
|
|
122
|
+
)
|
|
123
|
+
end
|
|
124
|
+
end
|
|
125
|
+
|
|
112
126
|
class DisassociateLicense
|
|
113
127
|
def self.build(context)
|
|
114
128
|
unless context.config.regional_endpoint
|
|
@@ -235,5 +249,19 @@ module Aws::ManagedGrafana
|
|
|
235
249
|
end
|
|
236
250
|
end
|
|
237
251
|
|
|
252
|
+
class UpdateWorkspaceConfiguration
|
|
253
|
+
def self.build(context)
|
|
254
|
+
unless context.config.regional_endpoint
|
|
255
|
+
endpoint = context.config.endpoint.to_s
|
|
256
|
+
end
|
|
257
|
+
Aws::ManagedGrafana::EndpointParameters.new(
|
|
258
|
+
region: context.config.region,
|
|
259
|
+
use_dual_stack: context.config.use_dualstack_endpoint,
|
|
260
|
+
use_fips: context.config.use_fips_endpoint,
|
|
261
|
+
endpoint: endpoint,
|
|
262
|
+
)
|
|
263
|
+
end
|
|
264
|
+
end
|
|
265
|
+
|
|
238
266
|
end
|
|
239
267
|
end
|
|
@@ -70,6 +70,8 @@ module Aws::ManagedGrafana
|
|
|
70
70
|
Aws::ManagedGrafana::Endpoints::DescribeWorkspace.build(context)
|
|
71
71
|
when :describe_workspace_authentication
|
|
72
72
|
Aws::ManagedGrafana::Endpoints::DescribeWorkspaceAuthentication.build(context)
|
|
73
|
+
when :describe_workspace_configuration
|
|
74
|
+
Aws::ManagedGrafana::Endpoints::DescribeWorkspaceConfiguration.build(context)
|
|
73
75
|
when :disassociate_license
|
|
74
76
|
Aws::ManagedGrafana::Endpoints::DisassociateLicense.build(context)
|
|
75
77
|
when :list_permissions
|
|
@@ -88,6 +90,8 @@ module Aws::ManagedGrafana
|
|
|
88
90
|
Aws::ManagedGrafana::Endpoints::UpdateWorkspace.build(context)
|
|
89
91
|
when :update_workspace_authentication
|
|
90
92
|
Aws::ManagedGrafana::Endpoints::UpdateWorkspaceAuthentication.build(context)
|
|
93
|
+
when :update_workspace_configuration
|
|
94
|
+
Aws::ManagedGrafana::Endpoints::UpdateWorkspaceConfiguration.build(context)
|
|
91
95
|
end
|
|
92
96
|
end
|
|
93
97
|
end
|
|
@@ -124,13 +124,13 @@ module Aws::ManagedGrafana
|
|
|
124
124
|
#
|
|
125
125
|
# @!attribute [rw] aws_sso
|
|
126
126
|
# A structure containing information about how this workspace works
|
|
127
|
-
# with
|
|
127
|
+
# with IAM Identity Center.
|
|
128
128
|
# @return [Types::AwsSsoAuthentication]
|
|
129
129
|
#
|
|
130
130
|
# @!attribute [rw] providers
|
|
131
|
-
# Specifies whether this workspace uses
|
|
132
|
-
#
|
|
133
|
-
#
|
|
131
|
+
# Specifies whether this workspace uses IAM Identity Center, SAML, or
|
|
132
|
+
# both methods to authenticate users to use the Grafana console in the
|
|
133
|
+
# Amazon Managed Grafana workspace.
|
|
134
134
|
# @return [Array<String>]
|
|
135
135
|
#
|
|
136
136
|
# @!attribute [rw] saml
|
|
@@ -149,13 +149,13 @@ module Aws::ManagedGrafana
|
|
|
149
149
|
include Aws::Structure
|
|
150
150
|
end
|
|
151
151
|
|
|
152
|
-
# A structure that describes whether the workspace uses SAML,
|
|
153
|
-
#
|
|
152
|
+
# A structure that describes whether the workspace uses SAML, IAM
|
|
153
|
+
# Identity Center, or both methods for user authentication, and whether
|
|
154
154
|
# that authentication is fully configured.
|
|
155
155
|
#
|
|
156
156
|
# @!attribute [rw] providers
|
|
157
|
-
# Specifies whether the workspace uses SAML,
|
|
158
|
-
#
|
|
157
|
+
# Specifies whether the workspace uses SAML, IAM Identity Center, or
|
|
158
|
+
# both methods for user authentication.
|
|
159
159
|
# @return [Array<String>]
|
|
160
160
|
#
|
|
161
161
|
# @!attribute [rw] saml_configuration_status
|
|
@@ -173,10 +173,10 @@ module Aws::ManagedGrafana
|
|
|
173
173
|
end
|
|
174
174
|
|
|
175
175
|
# A structure containing information about how this workspace works with
|
|
176
|
-
#
|
|
176
|
+
# IAM Identity Center.
|
|
177
177
|
#
|
|
178
178
|
# @!attribute [rw] sso_client_id
|
|
179
|
-
# The ID of the
|
|
179
|
+
# The ID of the IAM Identity Center-managed application that is
|
|
180
180
|
# created by Amazon Managed Grafana.
|
|
181
181
|
# @return [String]
|
|
182
182
|
#
|
|
@@ -224,14 +224,14 @@ module Aws::ManagedGrafana
|
|
|
224
224
|
# }
|
|
225
225
|
#
|
|
226
226
|
# @!attribute [rw] key_name
|
|
227
|
-
# Specifies the name of the key
|
|
228
|
-
#
|
|
227
|
+
# Specifies the name of the key. Keynames must be unique to the
|
|
228
|
+
# workspace.
|
|
229
229
|
# @return [String]
|
|
230
230
|
#
|
|
231
231
|
# @!attribute [rw] key_role
|
|
232
232
|
# Specifies the permission level of the key.
|
|
233
233
|
#
|
|
234
|
-
# Valid
|
|
234
|
+
# Valid values: `VIEWER`\|`EDITOR`\|`ADMIN`
|
|
235
235
|
# @return [String]
|
|
236
236
|
#
|
|
237
237
|
# @!attribute [rw] seconds_to_live
|
|
@@ -240,7 +240,7 @@ module Aws::ManagedGrafana
|
|
|
240
240
|
# @return [Integer]
|
|
241
241
|
#
|
|
242
242
|
# @!attribute [rw] workspace_id
|
|
243
|
-
# The ID of the workspace
|
|
243
|
+
# The ID of the workspace to create an API key.
|
|
244
244
|
# @return [String]
|
|
245
245
|
#
|
|
246
246
|
# @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/CreateWorkspaceApiKeyRequest AWS API Documentation
|
|
@@ -255,8 +255,8 @@ module Aws::ManagedGrafana
|
|
|
255
255
|
end
|
|
256
256
|
|
|
257
257
|
# @!attribute [rw] key
|
|
258
|
-
# The key token
|
|
259
|
-
#
|
|
258
|
+
# The key token. Use this value as a bearer token to authenticate HTTP
|
|
259
|
+
# requests to the workspace.
|
|
260
260
|
# @return [String]
|
|
261
261
|
#
|
|
262
262
|
# @!attribute [rw] key_name
|
|
@@ -284,13 +284,18 @@ module Aws::ManagedGrafana
|
|
|
284
284
|
# account_access_type: "CURRENT_ACCOUNT", # required, accepts CURRENT_ACCOUNT, ORGANIZATION
|
|
285
285
|
# authentication_providers: ["AWS_SSO"], # required, accepts AWS_SSO, SAML
|
|
286
286
|
# client_token: "ClientToken",
|
|
287
|
+
# configuration: "OverridableConfigurationJson",
|
|
287
288
|
# organization_role_name: "OrganizationRoleName",
|
|
288
289
|
# permission_type: "CUSTOMER_MANAGED", # required, accepts CUSTOMER_MANAGED, SERVICE_MANAGED
|
|
289
290
|
# stack_set_name: "StackSetName",
|
|
290
291
|
# tags: {
|
|
291
292
|
# "TagKey" => "TagValue",
|
|
292
293
|
# },
|
|
293
|
-
#
|
|
294
|
+
# vpc_configuration: {
|
|
295
|
+
# security_group_ids: ["SecurityGroupId"], # required
|
|
296
|
+
# subnet_ids: ["SubnetId"], # required
|
|
297
|
+
# },
|
|
298
|
+
# workspace_data_sources: ["AMAZON_OPENSEARCH_SERVICE"], # accepts AMAZON_OPENSEARCH_SERVICE, CLOUDWATCH, PROMETHEUS, XRAY, TIMESTREAM, SITEWISE, ATHENA, REDSHIFT, TWINMAKER
|
|
294
299
|
# workspace_description: "Description",
|
|
295
300
|
# workspace_name: "WorkspaceName",
|
|
296
301
|
# workspace_notification_destinations: ["SNS"], # accepts SNS
|
|
@@ -308,10 +313,10 @@ module Aws::ManagedGrafana
|
|
|
308
313
|
# @return [String]
|
|
309
314
|
#
|
|
310
315
|
# @!attribute [rw] authentication_providers
|
|
311
|
-
# Specifies whether this workspace uses SAML 2.0,
|
|
312
|
-
# Single Sign
|
|
313
|
-
# console within a workspace. For more information,
|
|
314
|
-
# authentication in Amazon Managed Grafana][1].
|
|
316
|
+
# Specifies whether this workspace uses SAML 2.0, IAM Identity Center
|
|
317
|
+
# (successor to Single Sign-On), or both to authenticate users for
|
|
318
|
+
# using the Grafana console within a workspace. For more information,
|
|
319
|
+
# see [User authentication in Amazon Managed Grafana][1].
|
|
315
320
|
#
|
|
316
321
|
#
|
|
317
322
|
#
|
|
@@ -326,6 +331,16 @@ module Aws::ManagedGrafana
|
|
|
326
331
|
# not need to pass this option.
|
|
327
332
|
# @return [String]
|
|
328
333
|
#
|
|
334
|
+
# @!attribute [rw] configuration
|
|
335
|
+
# The configuration string for the workspace that you create. For more
|
|
336
|
+
# information about the format and configuration options available,
|
|
337
|
+
# see [Working in your Grafana workspace][1].
|
|
338
|
+
#
|
|
339
|
+
#
|
|
340
|
+
#
|
|
341
|
+
# [1]: https://docs.aws.amazon.com/grafana/latest/userguide/AMG-configure-workspace.html
|
|
342
|
+
# @return [String]
|
|
343
|
+
#
|
|
329
344
|
# @!attribute [rw] organization_role_name
|
|
330
345
|
# The name of an IAM role that already exists to use with
|
|
331
346
|
# Organizations to access Amazon Web Services data sources and
|
|
@@ -336,9 +351,12 @@ module Aws::ManagedGrafana
|
|
|
336
351
|
# If you specify `SERVICE_MANAGED` on AWS Grafana console, Amazon
|
|
337
352
|
# Managed Grafana automatically creates the IAM roles and provisions
|
|
338
353
|
# the permissions that the workspace needs to use Amazon Web Services
|
|
339
|
-
# data sources and notification channels. In CLI mode, the
|
|
354
|
+
# data sources and notification channels. In the CLI mode, the
|
|
340
355
|
# permissionType `SERVICE_MANAGED` will not create the IAM role for
|
|
341
|
-
# you.
|
|
356
|
+
# you. The ability for the Amazon Managed Grafana to create the IAM
|
|
357
|
+
# role on behalf of the user is supported only in the Amazon Managed
|
|
358
|
+
# Grafana AWS console. Use only the `CUSTOMER_MANAGED` permission type
|
|
359
|
+
# when creating a workspace in the CLI.
|
|
342
360
|
#
|
|
343
361
|
# If you specify `CUSTOMER_MANAGED`, you will manage those roles and
|
|
344
362
|
# permissions yourself. If you are creating this workspace in a member
|
|
@@ -365,6 +383,11 @@ module Aws::ManagedGrafana
|
|
|
365
383
|
# The list of tags associated with the workspace.
|
|
366
384
|
# @return [Hash<String,String>]
|
|
367
385
|
#
|
|
386
|
+
# @!attribute [rw] vpc_configuration
|
|
387
|
+
# The configuration settings for an Amazon VPC that contains data
|
|
388
|
+
# sources for your Grafana workspace to connect to.
|
|
389
|
+
# @return [Types::VpcConfiguration]
|
|
390
|
+
#
|
|
368
391
|
# @!attribute [rw] workspace_data_sources
|
|
369
392
|
# Specify the Amazon Web Services data sources that you want to be
|
|
370
393
|
# queried in this workspace. Specifying these data sources here
|
|
@@ -415,10 +438,12 @@ module Aws::ManagedGrafana
|
|
|
415
438
|
:account_access_type,
|
|
416
439
|
:authentication_providers,
|
|
417
440
|
:client_token,
|
|
441
|
+
:configuration,
|
|
418
442
|
:organization_role_name,
|
|
419
443
|
:permission_type,
|
|
420
444
|
:stack_set_name,
|
|
421
445
|
:tags,
|
|
446
|
+
:vpc_configuration,
|
|
422
447
|
:workspace_data_sources,
|
|
423
448
|
:workspace_description,
|
|
424
449
|
:workspace_name,
|
|
@@ -467,7 +492,7 @@ module Aws::ManagedGrafana
|
|
|
467
492
|
end
|
|
468
493
|
|
|
469
494
|
# @!attribute [rw] key_name
|
|
470
|
-
# The name of the
|
|
495
|
+
# The name of the key that was deleted.
|
|
471
496
|
# @return [String]
|
|
472
497
|
#
|
|
473
498
|
# @!attribute [rw] workspace_id
|
|
@@ -547,6 +572,43 @@ module Aws::ManagedGrafana
|
|
|
547
572
|
include Aws::Structure
|
|
548
573
|
end
|
|
549
574
|
|
|
575
|
+
# @note When making an API call, you may pass DescribeWorkspaceConfigurationRequest
|
|
576
|
+
# data as a hash:
|
|
577
|
+
#
|
|
578
|
+
# {
|
|
579
|
+
# workspace_id: "WorkspaceId", # required
|
|
580
|
+
# }
|
|
581
|
+
#
|
|
582
|
+
# @!attribute [rw] workspace_id
|
|
583
|
+
# The ID of the workspace to get configuration information for.
|
|
584
|
+
# @return [String]
|
|
585
|
+
#
|
|
586
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/DescribeWorkspaceConfigurationRequest AWS API Documentation
|
|
587
|
+
#
|
|
588
|
+
class DescribeWorkspaceConfigurationRequest < Struct.new(
|
|
589
|
+
:workspace_id)
|
|
590
|
+
SENSITIVE = []
|
|
591
|
+
include Aws::Structure
|
|
592
|
+
end
|
|
593
|
+
|
|
594
|
+
# @!attribute [rw] configuration
|
|
595
|
+
# The configuration string for the workspace that you requested. For
|
|
596
|
+
# more information about the format and configuration options
|
|
597
|
+
# available, see [Working in your Grafana workspace][1].
|
|
598
|
+
#
|
|
599
|
+
#
|
|
600
|
+
#
|
|
601
|
+
# [1]: https://docs.aws.amazon.com/grafana/latest/userguide/AMG-configure-workspace.html
|
|
602
|
+
# @return [String]
|
|
603
|
+
#
|
|
604
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/DescribeWorkspaceConfigurationResponse AWS API Documentation
|
|
605
|
+
#
|
|
606
|
+
class DescribeWorkspaceConfigurationResponse < Struct.new(
|
|
607
|
+
:configuration)
|
|
608
|
+
SENSITIVE = []
|
|
609
|
+
include Aws::Structure
|
|
610
|
+
end
|
|
611
|
+
|
|
550
612
|
# @note When making an API call, you may pass DescribeWorkspaceRequest
|
|
551
613
|
# data as a hash:
|
|
552
614
|
#
|
|
@@ -620,18 +682,18 @@ module Aws::ManagedGrafana
|
|
|
620
682
|
# integrate the identity provider with this workspace. You can specify
|
|
621
683
|
# the metadata either by providing a URL to its location in the `url`
|
|
622
684
|
# parameter, or by specifying the full metadata in XML format in the
|
|
623
|
-
# `xml` parameter.
|
|
685
|
+
# `xml` parameter. Specifying both will cause an error.
|
|
624
686
|
#
|
|
625
687
|
# @note IdpMetadata is a union - when making an API calls you must set exactly one of the members.
|
|
626
688
|
#
|
|
627
689
|
# @note IdpMetadata is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of IdpMetadata corresponding to the set member.
|
|
628
690
|
#
|
|
629
691
|
# @!attribute [rw] url
|
|
630
|
-
# The URL of the location containing the metadata.
|
|
692
|
+
# The URL of the location containing the IdP metadata.
|
|
631
693
|
# @return [String]
|
|
632
694
|
#
|
|
633
695
|
# @!attribute [rw] xml
|
|
634
|
-
# The
|
|
696
|
+
# The full IdP metadata, in XML format.
|
|
635
697
|
# @return [String]
|
|
636
698
|
#
|
|
637
699
|
# @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/IdpMetadata AWS API Documentation
|
|
@@ -700,9 +762,8 @@ module Aws::ManagedGrafana
|
|
|
700
762
|
#
|
|
701
763
|
# @!attribute [rw] user_type
|
|
702
764
|
# (Optional) If you specify `SSO_USER`, then only the permissions of
|
|
703
|
-
#
|
|
704
|
-
#
|
|
705
|
-
# are returned.
|
|
765
|
+
# IAM Identity Center users are returned. If you specify `SSO_GROUP`,
|
|
766
|
+
# only the permissions of IAM Identity Center groups are returned.
|
|
706
767
|
# @return [String]
|
|
707
768
|
#
|
|
708
769
|
# @!attribute [rw] workspace_id
|
|
@@ -817,11 +878,11 @@ module Aws::ManagedGrafana
|
|
|
817
878
|
end
|
|
818
879
|
|
|
819
880
|
# A structure containing the identity of one user or group and the
|
|
820
|
-
# `Admin` or `
|
|
881
|
+
# `Admin`, `Editor`, or `Viewer` role that they have.
|
|
821
882
|
#
|
|
822
883
|
# @!attribute [rw] role
|
|
823
|
-
# Specifies whether the user or group has the `Admin` or
|
|
824
|
-
# role.
|
|
884
|
+
# Specifies whether the user or group has the `Admin`, `Editor`, or
|
|
885
|
+
# `Viewer` role.
|
|
825
886
|
# @return [String]
|
|
826
887
|
#
|
|
827
888
|
# @!attribute [rw] user
|
|
@@ -863,7 +924,8 @@ module Aws::ManagedGrafana
|
|
|
863
924
|
|
|
864
925
|
# This structure defines which groups defined in the SAML assertion
|
|
865
926
|
# attribute are to be mapped to the Grafana `Admin` and `Editor` roles
|
|
866
|
-
# in the workspace.
|
|
927
|
+
# in the workspace. SAML authenticated users not part of `Admin` or
|
|
928
|
+
# `Editor` role groups have `Viewer` permission over the workspace.
|
|
867
929
|
#
|
|
868
930
|
# @note When making an API call, you may pass RoleValues
|
|
869
931
|
# data as a hash:
|
|
@@ -1258,10 +1320,10 @@ module Aws::ManagedGrafana
|
|
|
1258
1320
|
# }
|
|
1259
1321
|
#
|
|
1260
1322
|
# @!attribute [rw] authentication_providers
|
|
1261
|
-
# Specifies whether this workspace uses SAML 2.0,
|
|
1262
|
-
# Single Sign
|
|
1263
|
-
# console within a workspace. For more information,
|
|
1264
|
-
# authentication in Amazon Managed Grafana][1].
|
|
1323
|
+
# Specifies whether this workspace uses SAML 2.0, IAM Identity Center
|
|
1324
|
+
# (successor to Single Sign-On), or both to authenticate users for
|
|
1325
|
+
# using the Grafana console within a workspace. For more information,
|
|
1326
|
+
# see [User authentication in Amazon Managed Grafana][1].
|
|
1265
1327
|
#
|
|
1266
1328
|
#
|
|
1267
1329
|
#
|
|
@@ -1302,6 +1364,41 @@ module Aws::ManagedGrafana
|
|
|
1302
1364
|
include Aws::Structure
|
|
1303
1365
|
end
|
|
1304
1366
|
|
|
1367
|
+
# @note When making an API call, you may pass UpdateWorkspaceConfigurationRequest
|
|
1368
|
+
# data as a hash:
|
|
1369
|
+
#
|
|
1370
|
+
# {
|
|
1371
|
+
# configuration: "OverridableConfigurationJson", # required
|
|
1372
|
+
# workspace_id: "WorkspaceId", # required
|
|
1373
|
+
# }
|
|
1374
|
+
#
|
|
1375
|
+
# @!attribute [rw] configuration
|
|
1376
|
+
# The new configuration string for the workspace. For more information
|
|
1377
|
+
# about the format and configuration options available, see [Working
|
|
1378
|
+
# in your Grafana workspace][1].
|
|
1379
|
+
#
|
|
1380
|
+
#
|
|
1381
|
+
#
|
|
1382
|
+
# [1]: https://docs.aws.amazon.com/grafana/latest/userguide/AMG-configure-workspace.html
|
|
1383
|
+
# @return [String]
|
|
1384
|
+
#
|
|
1385
|
+
# @!attribute [rw] workspace_id
|
|
1386
|
+
# The ID of the workspace to update.
|
|
1387
|
+
# @return [String]
|
|
1388
|
+
#
|
|
1389
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/UpdateWorkspaceConfigurationRequest AWS API Documentation
|
|
1390
|
+
#
|
|
1391
|
+
class UpdateWorkspaceConfigurationRequest < Struct.new(
|
|
1392
|
+
:configuration,
|
|
1393
|
+
:workspace_id)
|
|
1394
|
+
SENSITIVE = []
|
|
1395
|
+
include Aws::Structure
|
|
1396
|
+
end
|
|
1397
|
+
|
|
1398
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/UpdateWorkspaceConfigurationResponse AWS API Documentation
|
|
1399
|
+
#
|
|
1400
|
+
class UpdateWorkspaceConfigurationResponse < Aws::EmptyStructure; end
|
|
1401
|
+
|
|
1305
1402
|
# @note When making an API call, you may pass UpdateWorkspaceRequest
|
|
1306
1403
|
# data as a hash:
|
|
1307
1404
|
#
|
|
@@ -1309,8 +1406,13 @@ module Aws::ManagedGrafana
|
|
|
1309
1406
|
# account_access_type: "CURRENT_ACCOUNT", # accepts CURRENT_ACCOUNT, ORGANIZATION
|
|
1310
1407
|
# organization_role_name: "OrganizationRoleName",
|
|
1311
1408
|
# permission_type: "CUSTOMER_MANAGED", # accepts CUSTOMER_MANAGED, SERVICE_MANAGED
|
|
1409
|
+
# remove_vpc_configuration: false,
|
|
1312
1410
|
# stack_set_name: "StackSetName",
|
|
1313
|
-
#
|
|
1411
|
+
# vpc_configuration: {
|
|
1412
|
+
# security_group_ids: ["SecurityGroupId"], # required
|
|
1413
|
+
# subnet_ids: ["SubnetId"], # required
|
|
1414
|
+
# },
|
|
1415
|
+
# workspace_data_sources: ["AMAZON_OPENSEARCH_SERVICE"], # accepts AMAZON_OPENSEARCH_SERVICE, CLOUDWATCH, PROMETHEUS, XRAY, TIMESTREAM, SITEWISE, ATHENA, REDSHIFT, TWINMAKER
|
|
1314
1416
|
# workspace_description: "Description",
|
|
1315
1417
|
# workspace_id: "WorkspaceId", # required
|
|
1316
1418
|
# workspace_name: "WorkspaceName",
|
|
@@ -1355,11 +1457,23 @@ module Aws::ManagedGrafana
|
|
|
1355
1457
|
# [1]: https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html
|
|
1356
1458
|
# @return [String]
|
|
1357
1459
|
#
|
|
1460
|
+
# @!attribute [rw] remove_vpc_configuration
|
|
1461
|
+
# Whether to remove the VPC configuration from the workspace.
|
|
1462
|
+
#
|
|
1463
|
+
# Setting this to `true` and providing a `vpcConfiguration` to set
|
|
1464
|
+
# will return an error.
|
|
1465
|
+
# @return [Boolean]
|
|
1466
|
+
#
|
|
1358
1467
|
# @!attribute [rw] stack_set_name
|
|
1359
1468
|
# The name of the CloudFormation stack set to use to generate IAM
|
|
1360
1469
|
# roles to be used for this workspace.
|
|
1361
1470
|
# @return [String]
|
|
1362
1471
|
#
|
|
1472
|
+
# @!attribute [rw] vpc_configuration
|
|
1473
|
+
# The configuration settings for an Amazon VPC that contains data
|
|
1474
|
+
# sources for your Grafana workspace to connect to.
|
|
1475
|
+
# @return [Types::VpcConfiguration]
|
|
1476
|
+
#
|
|
1363
1477
|
# @!attribute [rw] workspace_data_sources
|
|
1364
1478
|
# Specify the Amazon Web Services data sources that you want to be
|
|
1365
1479
|
# queried in this workspace. Specifying these data sources here
|
|
@@ -1415,7 +1529,9 @@ module Aws::ManagedGrafana
|
|
|
1415
1529
|
:account_access_type,
|
|
1416
1530
|
:organization_role_name,
|
|
1417
1531
|
:permission_type,
|
|
1532
|
+
:remove_vpc_configuration,
|
|
1418
1533
|
:stack_set_name,
|
|
1534
|
+
:vpc_configuration,
|
|
1419
1535
|
:workspace_data_sources,
|
|
1420
1536
|
:workspace_description,
|
|
1421
1537
|
:workspace_id,
|
|
@@ -1513,6 +1629,36 @@ module Aws::ManagedGrafana
|
|
|
1513
1629
|
include Aws::Structure
|
|
1514
1630
|
end
|
|
1515
1631
|
|
|
1632
|
+
# The configuration settings for an Amazon VPC that contains data
|
|
1633
|
+
# sources for your Grafana workspace to connect to.
|
|
1634
|
+
#
|
|
1635
|
+
# @note When making an API call, you may pass VpcConfiguration
|
|
1636
|
+
# data as a hash:
|
|
1637
|
+
#
|
|
1638
|
+
# {
|
|
1639
|
+
# security_group_ids: ["SecurityGroupId"], # required
|
|
1640
|
+
# subnet_ids: ["SubnetId"], # required
|
|
1641
|
+
# }
|
|
1642
|
+
#
|
|
1643
|
+
# @!attribute [rw] security_group_ids
|
|
1644
|
+
# The list of Amazon EC2 security group IDs attached to the Amazon VPC
|
|
1645
|
+
# for your Grafana workspace to connect.
|
|
1646
|
+
# @return [Array<String>]
|
|
1647
|
+
#
|
|
1648
|
+
# @!attribute [rw] subnet_ids
|
|
1649
|
+
# The list of Amazon EC2 subnet IDs created in the Amazon VPC for your
|
|
1650
|
+
# Grafana workspace to connect.
|
|
1651
|
+
# @return [Array<String>]
|
|
1652
|
+
#
|
|
1653
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/VpcConfiguration AWS API Documentation
|
|
1654
|
+
#
|
|
1655
|
+
class VpcConfiguration < Struct.new(
|
|
1656
|
+
:security_group_ids,
|
|
1657
|
+
:subnet_ids)
|
|
1658
|
+
SENSITIVE = []
|
|
1659
|
+
include Aws::Structure
|
|
1660
|
+
end
|
|
1661
|
+
|
|
1516
1662
|
# A structure containing information about an Amazon Managed Grafana
|
|
1517
1663
|
# workspace in your account.
|
|
1518
1664
|
#
|
|
@@ -1526,8 +1672,8 @@ module Aws::ManagedGrafana
|
|
|
1526
1672
|
# @return [String]
|
|
1527
1673
|
#
|
|
1528
1674
|
# @!attribute [rw] authentication
|
|
1529
|
-
# A structure that describes whether the workspace uses SAML,
|
|
1530
|
-
#
|
|
1675
|
+
# A structure that describes whether the workspace uses SAML, IAM
|
|
1676
|
+
# Identity Center, or both methods for user authentication.
|
|
1531
1677
|
# @return [Types::AuthenticationSummary]
|
|
1532
1678
|
#
|
|
1533
1679
|
# @!attribute [rw] created
|
|
@@ -1637,6 +1783,11 @@ module Aws::ManagedGrafana
|
|
|
1637
1783
|
# The list of tags associated with the workspace.
|
|
1638
1784
|
# @return [Hash<String,String>]
|
|
1639
1785
|
#
|
|
1786
|
+
# @!attribute [rw] vpc_configuration
|
|
1787
|
+
# The configuration for connecting to data sources in a private VPC
|
|
1788
|
+
# (Amazon Virtual Private Cloud).
|
|
1789
|
+
# @return [Types::VpcConfiguration]
|
|
1790
|
+
#
|
|
1640
1791
|
# @!attribute [rw] workspace_role_arn
|
|
1641
1792
|
# The IAM role that grants permissions to the Amazon Web Services
|
|
1642
1793
|
# resources that the workspace will view data from. This role must
|
|
@@ -1667,6 +1818,7 @@ module Aws::ManagedGrafana
|
|
|
1667
1818
|
:stack_set_name,
|
|
1668
1819
|
:status,
|
|
1669
1820
|
:tags,
|
|
1821
|
+
:vpc_configuration,
|
|
1670
1822
|
:workspace_role_arn)
|
|
1671
1823
|
SENSITIVE = [:description, :name, :organization_role_name, :organizational_units, :workspace_role_arn]
|
|
1672
1824
|
include Aws::Structure
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: aws-sdk-managedgrafana
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.
|
|
4
|
+
version: 1.10.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Amazon Web Services
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2022-
|
|
11
|
+
date: 2022-11-23 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: aws-sdk-core
|