Client
managedgrafana | R Documentation |
Amazon Managed Grafana¶
Description¶
Amazon Managed Grafana is a fully managed and secure data visualization service that you can use to instantly query, correlate, and visualize operational metrics, logs, and traces from multiple sources. Amazon Managed Grafana makes it easy to deploy, operate, and scale Grafana, a widely deployed data visualization tool that is popular for its extensible data support.
With Amazon Managed Grafana, you create logically isolated Grafana servers called workspaces. In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces without having to build, package, or deploy any hardware to run Grafana servers.
Usage¶
Arguments¶
config
Optional configuration of credentials, endpoint, and/or region.
credentials:
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to
true
to force the request to use path-style addressing, i.e.http://s3.amazonaws.com/BUCKET/KEY
.sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
credentials
Optional credentials shorthand for the config parameter
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
endpoint
Optional shorthand for complete URL to use for the constructed client.
region
Optional shorthand for AWS Region used in instantiating the client.
Value¶
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've
assigned to the client. The available operations are listed in the
Operations section.
Service syntax¶
svc <- managedgrafana(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations¶
- associate_license
- Assigns a Grafana Enterprise license to a workspace
- create_workspace
- Creates a workspace
- create_workspace_api_key
- Creates a Grafana API key for the workspace
- create_workspace_service_account
- Creates a service account for the workspace
- Creates a token that can be used to authenticate and authorize Grafana HTTP API operations for the given workspace service account
- delete_workspace
- Deletes an Amazon Managed Grafana workspace
- delete_workspace_api_key
- Deletes a Grafana API key for the workspace
- delete_workspace_service_account
- Deletes a workspace service account from the workspace
- Deletes a token for the workspace service account
- describe_workspace
- Displays information about one Amazon Managed Grafana workspace
- describe_workspace_authentication
- Displays information about the authentication methods used in one Amazon Managed Grafana workspace
- describe_workspace_configuration
- Gets the current configuration string for the given workspace
- disassociate_license
- Removes the Grafana Enterprise license from a workspace
- list_permissions
- Lists the users and groups who have the Grafana Admin and Editor roles in this workspace
- list_tags_for_resource
- The ListTagsForResource operation returns the tags that are associated with the Amazon Managed Service for Grafana resource specified by the resourceArn
- list_versions
- Lists available versions of Grafana
- list_workspaces
- Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace
- list_workspace_service_accounts
- Returns a list of service accounts for a workspace
- list_workspace_service_account_tokens
- Returns a list of tokens for a workspace service account
- tag_resource
- The TagResource operation associates tags with an Amazon Managed Grafana resource
- untag_resource
- The UntagResource operation removes the association of the tag with the Amazon Managed Grafana resource
- update_permissions
- Updates which users in a workspace have the Grafana Admin or Editor roles
- update_workspace
- Modifies an existing Amazon Managed Grafana workspace
- update_workspace_authentication
- Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using SAML
- update_workspace_configuration
- Updates the configuration string for the given workspace