aws-sdk-managedgrafana 1.8.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-managedgrafana/client.rb +183 -35
- data/lib/aws-sdk-managedgrafana/client_api.rb +61 -0
- data/lib/aws-sdk-managedgrafana/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-managedgrafana/endpoint_provider.rb +111 -0
- data/lib/aws-sdk-managedgrafana/endpoints.rb +267 -0
- data/lib/aws-sdk-managedgrafana/plugins/endpoints.rb +104 -0
- data/lib/aws-sdk-managedgrafana/types.rb +193 -41
- data/lib/aws-sdk-managedgrafana.rb +5 -1
- metadata +8 -4
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,16 @@
|
|
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
|
+
|
9
|
+
1.9.0 (2022-10-25)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
4
14
|
1.8.0 (2022-05-13)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.10.0
|
@@ -30,7 +30,7 @@ require 'aws-sdk-core/plugins/http_checksum.rb'
|
|
30
30
|
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
31
31
|
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
32
32
|
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
33
|
-
require 'aws-sdk-core/plugins/
|
33
|
+
require 'aws-sdk-core/plugins/sign.rb'
|
34
34
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
35
35
|
|
36
36
|
Aws::Plugins::GlobalConfiguration.add_identifier(:managedgrafana)
|
@@ -79,8 +79,9 @@ module Aws::ManagedGrafana
|
|
79
79
|
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
80
80
|
add_plugin(Aws::Plugins::DefaultsMode)
|
81
81
|
add_plugin(Aws::Plugins::RecursionDetection)
|
82
|
-
add_plugin(Aws::Plugins::
|
82
|
+
add_plugin(Aws::Plugins::Sign)
|
83
83
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
84
|
+
add_plugin(Aws::ManagedGrafana::Plugins::Endpoints)
|
84
85
|
|
85
86
|
# @overload initialize(options)
|
86
87
|
# @param [Hash] options
|
@@ -287,6 +288,19 @@ module Aws::ManagedGrafana
|
|
287
288
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
288
289
|
# requests are made, and retries are disabled.
|
289
290
|
#
|
291
|
+
# @option options [Aws::TokenProvider] :token_provider
|
292
|
+
# A Bearer Token Provider. This can be an instance of any one of the
|
293
|
+
# following classes:
|
294
|
+
#
|
295
|
+
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
296
|
+
# tokens.
|
297
|
+
#
|
298
|
+
# * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
|
299
|
+
# access token generated from `aws login`.
|
300
|
+
#
|
301
|
+
# When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
|
302
|
+
# will be used to search for tokens configured for your profile in shared configuration files.
|
303
|
+
#
|
290
304
|
# @option options [Boolean] :use_dualstack_endpoint
|
291
305
|
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
292
306
|
# will be used if available.
|
@@ -300,6 +314,9 @@ module Aws::ManagedGrafana
|
|
300
314
|
# When `true`, request parameters are validated before
|
301
315
|
# sending the request.
|
302
316
|
#
|
317
|
+
# @option options [Aws::ManagedGrafana::EndpointProvider] :endpoint_provider
|
318
|
+
# The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::ManagedGrafana::EndpointParameters`
|
319
|
+
#
|
303
320
|
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
304
321
|
# requests through. Formatted like 'http://proxy.com:123'.
|
305
322
|
#
|
@@ -384,7 +401,7 @@ module Aws::ManagedGrafana
|
|
384
401
|
# resp.workspace.authentication.saml_configuration_status #=> String, one of "CONFIGURED", "NOT_CONFIGURED"
|
385
402
|
# resp.workspace.created #=> Time
|
386
403
|
# resp.workspace.data_sources #=> Array
|
387
|
-
# 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"
|
388
405
|
# resp.workspace.description #=> String
|
389
406
|
# resp.workspace.endpoint #=> String
|
390
407
|
# resp.workspace.free_trial_consumed #=> Boolean
|
@@ -405,6 +422,10 @@ module Aws::ManagedGrafana
|
|
405
422
|
# resp.workspace.status #=> String, one of "ACTIVE", "CREATING", "DELETING", "FAILED", "UPDATING", "UPGRADING", "DELETION_FAILED", "CREATION_FAILED", "UPDATE_FAILED", "UPGRADE_FAILED", "LICENSE_REMOVAL_FAILED"
|
406
423
|
# resp.workspace.tags #=> Hash
|
407
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
|
408
429
|
# resp.workspace.workspace_role_arn #=> String
|
409
430
|
#
|
410
431
|
# @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/AssociateLicense AWS API Documentation
|
@@ -437,10 +458,10 @@ module Aws::ManagedGrafana
|
|
437
458
|
# `workspaceOrganizationalUnits` parameter.
|
438
459
|
#
|
439
460
|
# @option params [required, Array<String>] :authentication_providers
|
440
|
-
# Specifies whether this workspace uses SAML 2.0,
|
441
|
-
# Single Sign
|
442
|
-
# console within a workspace. For more information, see
|
443
|
-
# 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].
|
444
465
|
#
|
445
466
|
#
|
446
467
|
#
|
@@ -453,6 +474,19 @@ module Aws::ManagedGrafana
|
|
453
474
|
# **A suitable default value is auto-generated.** You should normally
|
454
475
|
# not need to pass this option.**
|
455
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
|
+
#
|
456
490
|
# @option params [String] :organization_role_name
|
457
491
|
# The name of an IAM role that already exists to use with Organizations
|
458
492
|
# to access Amazon Web Services data sources and notification channels
|
@@ -462,8 +496,12 @@ module Aws::ManagedGrafana
|
|
462
496
|
# If you specify `SERVICE_MANAGED` on AWS Grafana console, Amazon
|
463
497
|
# Managed Grafana automatically creates the IAM roles and provisions the
|
464
498
|
# permissions that the workspace needs to use Amazon Web Services data
|
465
|
-
# sources and notification channels. In CLI mode, the permissionType
|
466
|
-
# `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.
|
467
505
|
#
|
468
506
|
# If you specify `CUSTOMER_MANAGED`, you will manage those roles and
|
469
507
|
# permissions yourself. If you are creating this workspace in a member
|
@@ -487,6 +525,10 @@ module Aws::ManagedGrafana
|
|
487
525
|
# @option params [Hash<String,String>] :tags
|
488
526
|
# The list of tags associated with the workspace.
|
489
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
|
+
#
|
490
532
|
# @option params [Array<String>] :workspace_data_sources
|
491
533
|
# Specify the Amazon Web Services data sources that you want to be
|
492
534
|
# queried in this workspace. Specifying these data sources here enables
|
@@ -534,13 +576,18 @@ module Aws::ManagedGrafana
|
|
534
576
|
# account_access_type: "CURRENT_ACCOUNT", # required, accepts CURRENT_ACCOUNT, ORGANIZATION
|
535
577
|
# authentication_providers: ["AWS_SSO"], # required, accepts AWS_SSO, SAML
|
536
578
|
# client_token: "ClientToken",
|
579
|
+
# configuration: "OverridableConfigurationJson",
|
537
580
|
# organization_role_name: "OrganizationRoleName",
|
538
581
|
# permission_type: "CUSTOMER_MANAGED", # required, accepts CUSTOMER_MANAGED, SERVICE_MANAGED
|
539
582
|
# stack_set_name: "StackSetName",
|
540
583
|
# tags: {
|
541
584
|
# "TagKey" => "TagValue",
|
542
585
|
# },
|
543
|
-
#
|
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
|
544
591
|
# workspace_description: "Description",
|
545
592
|
# workspace_name: "WorkspaceName",
|
546
593
|
# workspace_notification_destinations: ["SNS"], # accepts SNS
|
@@ -556,7 +603,7 @@ module Aws::ManagedGrafana
|
|
556
603
|
# resp.workspace.authentication.saml_configuration_status #=> String, one of "CONFIGURED", "NOT_CONFIGURED"
|
557
604
|
# resp.workspace.created #=> Time
|
558
605
|
# resp.workspace.data_sources #=> Array
|
559
|
-
# 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"
|
560
607
|
# resp.workspace.description #=> String
|
561
608
|
# resp.workspace.endpoint #=> String
|
562
609
|
# resp.workspace.free_trial_consumed #=> Boolean
|
@@ -577,6 +624,10 @@ module Aws::ManagedGrafana
|
|
577
624
|
# resp.workspace.status #=> String, one of "ACTIVE", "CREATING", "DELETING", "FAILED", "UPDATING", "UPGRADING", "DELETION_FAILED", "CREATION_FAILED", "UPDATE_FAILED", "UPGRADE_FAILED", "LICENSE_REMOVAL_FAILED"
|
578
625
|
# resp.workspace.tags #=> Hash
|
579
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
|
580
631
|
# resp.workspace.workspace_role_arn #=> String
|
581
632
|
#
|
582
633
|
# @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/CreateWorkspace AWS API Documentation
|
@@ -588,27 +639,30 @@ module Aws::ManagedGrafana
|
|
588
639
|
req.send_request(options)
|
589
640
|
end
|
590
641
|
|
591
|
-
# Creates
|
592
|
-
# authenticate requests sent to the workspace's HTTP API. See
|
593
|
-
# https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html]
|
594
|
-
# 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]
|
595
645
|
# for available APIs and example requests.
|
596
646
|
#
|
647
|
+
#
|
648
|
+
#
|
649
|
+
# [1]: https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html
|
650
|
+
#
|
597
651
|
# @option params [required, String] :key_name
|
598
|
-
# Specifies the name of the key
|
599
|
-
#
|
652
|
+
# Specifies the name of the key. Keynames must be unique to the
|
653
|
+
# workspace.
|
600
654
|
#
|
601
655
|
# @option params [required, String] :key_role
|
602
656
|
# Specifies the permission level of the key.
|
603
657
|
#
|
604
|
-
# Valid
|
658
|
+
# Valid values: `VIEWER`\|`EDITOR`\|`ADMIN`
|
605
659
|
#
|
606
660
|
# @option params [required, Integer] :seconds_to_live
|
607
661
|
# Specifies the time in seconds until the key expires. Keys can be valid
|
608
662
|
# for up to 30 days.
|
609
663
|
#
|
610
664
|
# @option params [required, String] :workspace_id
|
611
|
-
# The ID of the workspace
|
665
|
+
# The ID of the workspace to create an API key.
|
612
666
|
#
|
613
667
|
# @return [Types::CreateWorkspaceApiKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
614
668
|
#
|
@@ -663,7 +717,7 @@ module Aws::ManagedGrafana
|
|
663
717
|
# resp.workspace.authentication.saml_configuration_status #=> String, one of "CONFIGURED", "NOT_CONFIGURED"
|
664
718
|
# resp.workspace.created #=> Time
|
665
719
|
# resp.workspace.data_sources #=> Array
|
666
|
-
# 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"
|
667
721
|
# resp.workspace.description #=> String
|
668
722
|
# resp.workspace.endpoint #=> String
|
669
723
|
# resp.workspace.free_trial_consumed #=> Boolean
|
@@ -684,6 +738,10 @@ module Aws::ManagedGrafana
|
|
684
738
|
# resp.workspace.status #=> String, one of "ACTIVE", "CREATING", "DELETING", "FAILED", "UPDATING", "UPGRADING", "DELETION_FAILED", "CREATION_FAILED", "UPDATE_FAILED", "UPGRADE_FAILED", "LICENSE_REMOVAL_FAILED"
|
685
739
|
# resp.workspace.tags #=> Hash
|
686
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
|
687
745
|
# resp.workspace.workspace_role_arn #=> String
|
688
746
|
#
|
689
747
|
# @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/DeleteWorkspace AWS API Documentation
|
@@ -695,7 +753,7 @@ module Aws::ManagedGrafana
|
|
695
753
|
req.send_request(options)
|
696
754
|
end
|
697
755
|
|
698
|
-
# Deletes
|
756
|
+
# Deletes a Grafana API key for the workspace.
|
699
757
|
#
|
700
758
|
# @option params [required, String] :key_name
|
701
759
|
# The name of the API key to delete.
|
@@ -752,7 +810,7 @@ module Aws::ManagedGrafana
|
|
752
810
|
# resp.workspace.authentication.saml_configuration_status #=> String, one of "CONFIGURED", "NOT_CONFIGURED"
|
753
811
|
# resp.workspace.created #=> Time
|
754
812
|
# resp.workspace.data_sources #=> Array
|
755
|
-
# 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"
|
756
814
|
# resp.workspace.description #=> String
|
757
815
|
# resp.workspace.endpoint #=> String
|
758
816
|
# resp.workspace.free_trial_consumed #=> Boolean
|
@@ -773,6 +831,10 @@ module Aws::ManagedGrafana
|
|
773
831
|
# resp.workspace.status #=> String, one of "ACTIVE", "CREATING", "DELETING", "FAILED", "UPDATING", "UPGRADING", "DELETION_FAILED", "CREATION_FAILED", "UPDATE_FAILED", "UPGRADE_FAILED", "LICENSE_REMOVAL_FAILED"
|
774
832
|
# resp.workspace.tags #=> Hash
|
775
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
|
776
838
|
# resp.workspace.workspace_role_arn #=> String
|
777
839
|
#
|
778
840
|
# @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/DescribeWorkspace AWS API Documentation
|
@@ -831,6 +893,34 @@ module Aws::ManagedGrafana
|
|
831
893
|
req.send_request(options)
|
832
894
|
end
|
833
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
|
+
|
834
924
|
# Removes the Grafana Enterprise license from a workspace.
|
835
925
|
#
|
836
926
|
# @option params [required, String] :license_type
|
@@ -858,7 +948,7 @@ module Aws::ManagedGrafana
|
|
858
948
|
# resp.workspace.authentication.saml_configuration_status #=> String, one of "CONFIGURED", "NOT_CONFIGURED"
|
859
949
|
# resp.workspace.created #=> Time
|
860
950
|
# resp.workspace.data_sources #=> Array
|
861
|
-
# 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"
|
862
952
|
# resp.workspace.description #=> String
|
863
953
|
# resp.workspace.endpoint #=> String
|
864
954
|
# resp.workspace.free_trial_consumed #=> Boolean
|
@@ -879,6 +969,10 @@ module Aws::ManagedGrafana
|
|
879
969
|
# resp.workspace.status #=> String, one of "ACTIVE", "CREATING", "DELETING", "FAILED", "UPDATING", "UPGRADING", "DELETION_FAILED", "CREATION_FAILED", "UPDATE_FAILED", "UPGRADE_FAILED", "LICENSE_REMOVAL_FAILED"
|
880
970
|
# resp.workspace.tags #=> Hash
|
881
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
|
882
976
|
# resp.workspace.workspace_role_arn #=> String
|
883
977
|
#
|
884
978
|
# @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/DisassociateLicense AWS API Documentation
|
@@ -911,10 +1005,9 @@ module Aws::ManagedGrafana
|
|
911
1005
|
# (Optional) Limits the results to only the user that matches this ID.
|
912
1006
|
#
|
913
1007
|
# @option params [String] :user_type
|
914
|
-
# (Optional) If you specify `SSO_USER`, then only the permissions of
|
915
|
-
#
|
916
|
-
#
|
917
|
-
# 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.
|
918
1011
|
#
|
919
1012
|
# @option params [required, String] :workspace_id
|
920
1013
|
# The ID of the workspace to list permissions for. This parameter is
|
@@ -1165,7 +1258,7 @@ module Aws::ManagedGrafana
|
|
1165
1258
|
# those parameters are not changed.
|
1166
1259
|
#
|
1167
1260
|
# To modify the user authentication methods that the workspace uses,
|
1168
|
-
# such as SAML or
|
1261
|
+
# such as SAML or IAM Identity Center, use
|
1169
1262
|
# [UpdateWorkspaceAuthentication][1].
|
1170
1263
|
#
|
1171
1264
|
# To modify which users in the workspace have the `Admin` and `Editor`
|
@@ -1209,10 +1302,20 @@ module Aws::ManagedGrafana
|
|
1209
1302
|
#
|
1210
1303
|
# [1]: https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html
|
1211
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
|
+
#
|
1212
1311
|
# @option params [String] :stack_set_name
|
1213
1312
|
# The name of the CloudFormation stack set to use to generate IAM roles
|
1214
1313
|
# to be used for this workspace.
|
1215
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
|
+
#
|
1216
1319
|
# @option params [Array<String>] :workspace_data_sources
|
1217
1320
|
# Specify the Amazon Web Services data sources that you want to be
|
1218
1321
|
# queried in this workspace. Specifying these data sources here enables
|
@@ -1263,8 +1366,13 @@ module Aws::ManagedGrafana
|
|
1263
1366
|
# account_access_type: "CURRENT_ACCOUNT", # accepts CURRENT_ACCOUNT, ORGANIZATION
|
1264
1367
|
# organization_role_name: "OrganizationRoleName",
|
1265
1368
|
# permission_type: "CUSTOMER_MANAGED", # accepts CUSTOMER_MANAGED, SERVICE_MANAGED
|
1369
|
+
# remove_vpc_configuration: false,
|
1266
1370
|
# stack_set_name: "StackSetName",
|
1267
|
-
#
|
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
|
1268
1376
|
# workspace_description: "Description",
|
1269
1377
|
# workspace_id: "WorkspaceId", # required
|
1270
1378
|
# workspace_name: "WorkspaceName",
|
@@ -1281,7 +1389,7 @@ module Aws::ManagedGrafana
|
|
1281
1389
|
# resp.workspace.authentication.saml_configuration_status #=> String, one of "CONFIGURED", "NOT_CONFIGURED"
|
1282
1390
|
# resp.workspace.created #=> Time
|
1283
1391
|
# resp.workspace.data_sources #=> Array
|
1284
|
-
# 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"
|
1285
1393
|
# resp.workspace.description #=> String
|
1286
1394
|
# resp.workspace.endpoint #=> String
|
1287
1395
|
# resp.workspace.free_trial_consumed #=> Boolean
|
@@ -1302,6 +1410,10 @@ module Aws::ManagedGrafana
|
|
1302
1410
|
# resp.workspace.status #=> String, one of "ACTIVE", "CREATING", "DELETING", "FAILED", "UPDATING", "UPGRADING", "DELETION_FAILED", "CREATION_FAILED", "UPDATE_FAILED", "UPGRADE_FAILED", "LICENSE_REMOVAL_FAILED"
|
1303
1411
|
# resp.workspace.tags #=> Hash
|
1304
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
|
1305
1417
|
# resp.workspace.workspace_role_arn #=> String
|
1306
1418
|
#
|
1307
1419
|
# @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/UpdateWorkspace AWS API Documentation
|
@@ -1320,10 +1432,10 @@ module Aws::ManagedGrafana
|
|
1320
1432
|
# roles in the workspace.
|
1321
1433
|
#
|
1322
1434
|
# @option params [required, Array<String>] :authentication_providers
|
1323
|
-
# Specifies whether this workspace uses SAML 2.0,
|
1324
|
-
# Single Sign
|
1325
|
-
# console within a workspace. For more information, see
|
1326
|
-
# 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].
|
1327
1439
|
#
|
1328
1440
|
#
|
1329
1441
|
#
|
@@ -1400,6 +1512,42 @@ module Aws::ManagedGrafana
|
|
1400
1512
|
req.send_request(options)
|
1401
1513
|
end
|
1402
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
|
+
|
1403
1551
|
# @!endgroup
|
1404
1552
|
|
1405
1553
|
# @param params ({})
|
@@ -1413,7 +1561,7 @@ module Aws::ManagedGrafana
|
|
1413
1561
|
params: params,
|
1414
1562
|
config: config)
|
1415
1563
|
context[:gem_name] = 'aws-sdk-managedgrafana'
|
1416
|
-
context[:gem_version] = '1.
|
1564
|
+
context[:gem_version] = '1.10.0'
|
1417
1565
|
Seahorse::Client::Request.new(handlers, context)
|
1418
1566
|
end
|
1419
1567
|
|