Class: Aws::ManagedGrafana::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ManagedGrafana::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb
Overview
An API client for ManagedGrafana. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::ManagedGrafana::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#associate_license(params = {}) ⇒ Types::AssociateLicenseResponse
Assigns a Grafana Enterprise license to a workspace.
-
#create_workspace(params = {}) ⇒ Types::CreateWorkspaceResponse
Creates a workspace.
-
#create_workspace_api_key(params = {}) ⇒ Types::CreateWorkspaceApiKeyResponse
Creates a Grafana API key for the workspace.
-
#delete_workspace(params = {}) ⇒ Types::DeleteWorkspaceResponse
Deletes an Amazon Managed Grafana workspace.
-
#delete_workspace_api_key(params = {}) ⇒ Types::DeleteWorkspaceApiKeyResponse
Deletes a Grafana API key for the workspace.
-
#describe_workspace(params = {}) ⇒ Types::DescribeWorkspaceResponse
Displays information about one Amazon Managed Grafana workspace.
-
#describe_workspace_authentication(params = {}) ⇒ Types::DescribeWorkspaceAuthenticationResponse
Displays information about the authentication methods used in one Amazon Managed Grafana workspace.
-
#describe_workspace_configuration(params = {}) ⇒ Types::DescribeWorkspaceConfigurationResponse
Gets the current configuration string for the given workspace.
-
#disassociate_license(params = {}) ⇒ Types::DisassociateLicenseResponse
Removes the Grafana Enterprise license from a workspace.
-
#list_permissions(params = {}) ⇒ Types::ListPermissionsResponse
Lists the users and groups who have the Grafana
Admin
andEditor
roles in this workspace. -
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
The
ListTagsForResource
operation returns the tags that are associated with the Amazon Managed Service for Grafana resource specified by theresourceArn
. -
#list_versions(params = {}) ⇒ Types::ListVersionsResponse
Lists available versions of Grafana.
-
#list_workspaces(params = {}) ⇒ Types::ListWorkspacesResponse
Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace.
-
#tag_resource(params = {}) ⇒ Struct
The
TagResource
operation associates tags with an Amazon Managed Grafana resource. -
#untag_resource(params = {}) ⇒ Struct
The
UntagResource
operation removes the association of the tag with the Amazon Managed Grafana resource. -
#update_permissions(params = {}) ⇒ Types::UpdatePermissionsResponse
Updates which users in a workspace have the Grafana
Admin
orEditor
roles. -
#update_workspace(params = {}) ⇒ Types::UpdateWorkspaceResponse
Modifies an existing Amazon Managed Grafana workspace.
-
#update_workspace_authentication(params = {}) ⇒ Types::UpdateWorkspaceAuthenticationResponse
Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using SAML.
-
#update_workspace_configuration(params = {}) ⇒ Struct
Updates the configuration string for the given workspace.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
385 386 387 |
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb', line 385 def initialize(*args) super end |
Instance Method Details
#associate_license(params = {}) ⇒ Types::AssociateLicenseResponse
Assigns a Grafana Enterprise license to a workspace. Upgrading to Grafana Enterprise incurs additional fees. For more information, see Upgrade a workspace to Grafana Enterprise.
475 476 477 478 |
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb', line 475 def associate_license(params = {}, = {}) req = build_request(:associate_license, params) req.send_request() end |
#create_workspace(params = {}) ⇒ Types::CreateWorkspaceResponse
Creates a workspace. In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces. You don't have to build, package, or deploy any hardware to run the Grafana server.
Don't use CreateWorkspace
to modify an existing workspace. Instead,
use UpdateWorkspace.
703 704 705 706 |
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb', line 703 def create_workspace(params = {}, = {}) req = build_request(:create_workspace, params) req.send_request() end |
#create_workspace_api_key(params = {}) ⇒ Types::CreateWorkspaceApiKeyResponse
Creates a Grafana API key for the workspace. This key can be used to authenticate requests sent to the workspace's HTTP API. See https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html for available APIs and example requests.
758 759 760 761 |
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb', line 758 def create_workspace_api_key(params = {}, = {}) req = build_request(:create_workspace_api_key, params) req.send_request() end |
#delete_workspace(params = {}) ⇒ Types::DeleteWorkspaceResponse
Deletes an Amazon Managed Grafana workspace.
822 823 824 825 |
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb', line 822 def delete_workspace(params = {}, = {}) req = build_request(:delete_workspace, params) req.send_request() end |
#delete_workspace_api_key(params = {}) ⇒ Types::DeleteWorkspaceApiKeyResponse
Deletes a Grafana API key for the workspace.
856 857 858 859 |
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb', line 856 def delete_workspace_api_key(params = {}, = {}) req = build_request(:delete_workspace_api_key, params) req.send_request() end |
#describe_workspace(params = {}) ⇒ Types::DescribeWorkspaceResponse
Displays information about one Amazon Managed Grafana workspace.
920 921 922 923 |
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb', line 920 def describe_workspace(params = {}, = {}) req = build_request(:describe_workspace, params) req.send_request() end |
#describe_workspace_authentication(params = {}) ⇒ Types::DescribeWorkspaceAuthenticationResponse
Displays information about the authentication methods used in one Amazon Managed Grafana workspace.
967 968 969 970 |
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb', line 967 def describe_workspace_authentication(params = {}, = {}) req = build_request(:describe_workspace_authentication, params) req.send_request() end |
#describe_workspace_configuration(params = {}) ⇒ Types::DescribeWorkspaceConfigurationResponse
Gets the current configuration string for the given workspace.
997 998 999 1000 |
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb', line 997 def describe_workspace_configuration(params = {}, = {}) req = build_request(:describe_workspace_configuration, params) req.send_request() end |
#disassociate_license(params = {}) ⇒ Types::DisassociateLicenseResponse
Removes the Grafana Enterprise license from a workspace.
1065 1066 1067 1068 |
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb', line 1065 def disassociate_license(params = {}, = {}) req = build_request(:disassociate_license, params) req.send_request() end |
#list_permissions(params = {}) ⇒ Types::ListPermissionsResponse
Lists the users and groups who have the Grafana Admin
and Editor
roles in this workspace. If you use this operation without specifying
userId
or groupId
, the operation returns the roles of all users
and groups. If you specify a userId
or a groupId
, only the roles
for that user or group are returned. If you do this, you can specify
only one userId
or one groupId
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1129 1130 1131 1132 |
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb', line 1129 def (params = {}, = {}) req = build_request(:list_permissions, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
The ListTagsForResource
operation returns the tags that are
associated with the Amazon Managed Service for Grafana resource
specified by the resourceArn
. Currently, the only resource that can
be tagged is a workspace.
1161 1162 1163 1164 |
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb', line 1161 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_versions(params = {}) ⇒ Types::ListVersionsResponse
Lists available versions of Grafana. These are available when calling
CreateWorkspace
. Optionally, include a workspace to list the
versions to which it can be upgraded.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1207 1208 1209 1210 |
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb', line 1207 def list_versions(params = {}, = {}) req = build_request(:list_versions, params) req.send_request() end |
#list_workspaces(params = {}) ⇒ Types::ListWorkspacesResponse
Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace. For more complete information about one workspace, use DescribeWorkspace.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1267 1268 1269 1270 |
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb', line 1267 def list_workspaces(params = {}, = {}) req = build_request(:list_workspaces, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
The TagResource
operation associates tags with an Amazon Managed
Grafana resource. Currently, the only resource that can be tagged is
workspaces.
If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
1304 1305 1306 1307 |
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb', line 1304 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
The UntagResource
operation removes the association of the tag with
the Amazon Managed Grafana resource.
1331 1332 1333 1334 |
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb', line 1331 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_permissions(params = {}) ⇒ Types::UpdatePermissionsResponse
Updates which users in a workspace have the Grafana Admin
or
Editor
roles.
1382 1383 1384 1385 |
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb', line 1382 def (params = {}, = {}) req = build_request(:update_permissions, params) req.send_request() end |
#update_workspace(params = {}) ⇒ Types::UpdateWorkspaceResponse
Modifies an existing Amazon Managed Grafana workspace. If you use this operation and omit any optional parameters, the existing values of those parameters are not changed.
To modify the user authentication methods that the workspace uses, such as SAML or IAM Identity Center, use UpdateWorkspaceAuthentication.
To modify which users in the workspace have the Admin
and Editor
Grafana roles, use UpdatePermissions.
1588 1589 1590 1591 |
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb', line 1588 def update_workspace(params = {}, = {}) req = build_request(:update_workspace, params) req.send_request() end |
#update_workspace_authentication(params = {}) ⇒ Types::UpdateWorkspaceAuthenticationResponse
Use this operation to define the identity provider (IdP) that this
workspace authenticates users from, using SAML. You can also map SAML
assertion attributes to workspace user information and define which
groups in the assertion attribute are to have the Admin
and Editor
roles in the workspace.
1680 1681 1682 1683 |
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb', line 1680 def update_workspace_authentication(params = {}, = {}) req = build_request(:update_workspace_authentication, params) req.send_request() end |
#update_workspace_configuration(params = {}) ⇒ Struct
Updates the configuration string for the given workspace
1731 1732 1733 1734 |
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb', line 1731 def update_workspace_configuration(params = {}, = {}) req = build_request(:update_workspace_configuration, params) req.send_request() end |