Class: Aws::ManagedGrafana::Client

Inherits:
Seahorse::Client::Base show all
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

#config, #handlers

API Operations collapse

Instance Method Summary collapse

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.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String)

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: ""

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1"

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy"

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String)

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false

    When set to true, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default

    The log formatter.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the :logger at.

  • :logger (Logger)

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default"

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_backoff (Proc)

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy"

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :use_dualstack_endpoint (Boolean)

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean)

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Float) — default: 60

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :ssl_timeout (Float) — default: nil

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String)

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String)

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



348
349
350
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb', line 348

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.

Examples:

Request syntax with placeholder values


resp = client.associate_license({
  license_type: "ENTERPRISE", # required, accepts ENTERPRISE, ENTERPRISE_FREE_TRIAL
  workspace_id: "WorkspaceId", # required
})

Response structure


resp.workspace. #=> String, one of "CURRENT_ACCOUNT", "ORGANIZATION"
resp.workspace.authentication.providers #=> Array
resp.workspace.authentication.providers[0] #=> String, one of "AWS_SSO", "SAML"
resp.workspace.authentication.saml_configuration_status #=> String, one of "CONFIGURED", "NOT_CONFIGURED"
resp.workspace.created #=> Time
resp.workspace.data_sources #=> Array
resp.workspace.data_sources[0] #=> String, one of "AMAZON_OPENSEARCH_SERVICE", "CLOUDWATCH", "PROMETHEUS", "XRAY", "TIMESTREAM", "SITEWISE", "ATHENA", "REDSHIFT"
resp.workspace.description #=> String
resp.workspace.endpoint #=> String
resp.workspace.free_trial_consumed #=> Boolean
resp.workspace.free_trial_expiration #=> Time
resp.workspace.grafana_version #=> String
resp.workspace.id #=> String
resp.workspace.license_expiration #=> Time
resp.workspace.license_type #=> String, one of "ENTERPRISE", "ENTERPRISE_FREE_TRIAL"
resp.workspace.modified #=> Time
resp.workspace.name #=> String
resp.workspace.notification_destinations #=> Array
resp.workspace.notification_destinations[0] #=> String, one of "SNS"
resp.workspace.organization_role_name #=> String
resp.workspace.organizational_units #=> Array
resp.workspace.organizational_units[0] #=> String
resp.workspace.permission_type #=> String, one of "CUSTOMER_MANAGED", "SERVICE_MANAGED"
resp.workspace.stack_set_name #=> String
resp.workspace.status #=> String, one of "ACTIVE", "CREATING", "DELETING", "FAILED", "UPDATING", "UPGRADING", "DELETION_FAILED", "CREATION_FAILED", "UPDATE_FAILED", "UPGRADE_FAILED", "LICENSE_REMOVAL_FAILED"
resp.workspace.tags #=> Hash
resp.workspace.tags["TagKey"] #=> String
resp.workspace.workspace_role_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :license_type (required, String)

    The type of license to associate with the workspace.

  • :workspace_id (required, String)

    The ID of the workspace to associate the license with.

Returns:

See Also:



414
415
416
417
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb', line 414

def associate_license(params = {}, options = {})
  req = build_request(:associate_license, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.create_workspace({
  account_access_type: "CURRENT_ACCOUNT", # required, accepts CURRENT_ACCOUNT, ORGANIZATION
  authentication_providers: ["AWS_SSO"], # required, accepts AWS_SSO, SAML
  client_token: "ClientToken",
  organization_role_name: "OrganizationRoleName",
  permission_type: "CUSTOMER_MANAGED", # required, accepts CUSTOMER_MANAGED, SERVICE_MANAGED
  stack_set_name: "StackSetName",
  tags: {
    "TagKey" => "TagValue",
  },
  workspace_data_sources: ["AMAZON_OPENSEARCH_SERVICE"], # accepts AMAZON_OPENSEARCH_SERVICE, CLOUDWATCH, PROMETHEUS, XRAY, TIMESTREAM, SITEWISE, ATHENA, REDSHIFT
  workspace_description: "Description",
  workspace_name: "WorkspaceName",
  workspace_notification_destinations: ["SNS"], # accepts SNS
  workspace_organizational_units: ["OrganizationalUnit"],
  workspace_role_arn: "IamRoleArn",
})

Response structure


resp.workspace. #=> String, one of "CURRENT_ACCOUNT", "ORGANIZATION"
resp.workspace.authentication.providers #=> Array
resp.workspace.authentication.providers[0] #=> String, one of "AWS_SSO", "SAML"
resp.workspace.authentication.saml_configuration_status #=> String, one of "CONFIGURED", "NOT_CONFIGURED"
resp.workspace.created #=> Time
resp.workspace.data_sources #=> Array
resp.workspace.data_sources[0] #=> String, one of "AMAZON_OPENSEARCH_SERVICE", "CLOUDWATCH", "PROMETHEUS", "XRAY", "TIMESTREAM", "SITEWISE", "ATHENA", "REDSHIFT"
resp.workspace.description #=> String
resp.workspace.endpoint #=> String
resp.workspace.free_trial_consumed #=> Boolean
resp.workspace.free_trial_expiration #=> Time
resp.workspace.grafana_version #=> String
resp.workspace.id #=> String
resp.workspace.license_expiration #=> Time
resp.workspace.license_type #=> String, one of "ENTERPRISE", "ENTERPRISE_FREE_TRIAL"
resp.workspace.modified #=> Time
resp.workspace.name #=> String
resp.workspace.notification_destinations #=> Array
resp.workspace.notification_destinations[0] #=> String, one of "SNS"
resp.workspace.organization_role_name #=> String
resp.workspace.organizational_units #=> Array
resp.workspace.organizational_units[0] #=> String
resp.workspace.permission_type #=> String, one of "CUSTOMER_MANAGED", "SERVICE_MANAGED"
resp.workspace.stack_set_name #=> String
resp.workspace.status #=> String, one of "ACTIVE", "CREATING", "DELETING", "FAILED", "UPDATING", "UPGRADING", "DELETION_FAILED", "CREATION_FAILED", "UPDATE_FAILED", "UPGRADE_FAILED", "LICENSE_REMOVAL_FAILED"
resp.workspace.tags #=> Hash
resp.workspace.tags["TagKey"] #=> String
resp.workspace.workspace_role_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :account_access_type (required, String)

    Specifies whether the workspace can access Amazon Web Services resources in this Amazon Web Services account only, or whether it can also access Amazon Web Services resources in other accounts in the same organization. If you specify ORGANIZATION, you must specify which organizational units the workspace can access in the workspaceOrganizationalUnits parameter.

  • :authentication_providers (required, Array<String>)

    Specifies whether this workspace uses SAML 2.0, Amazon Web Services Single Sign On, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.

  • :client_token (String)

    A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :organization_role_name (String)

    The name of an IAM role that already exists to use with Organizations to access Amazon Web Services data sources and notification channels in other accounts in an organization.

  • :permission_type (required, String)

    If you specify SERVICE_MANAGED on AWS Grafana console, Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels. In CLI mode, the permissionType SERVICE_MANAGED will not create the IAM role for you.

    If you specify CUSTOMER_MANAGED, you will manage those roles and permissions yourself. If you are creating this workspace in a member account of an organization that is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, you must choose CUSTOMER_MANAGED.

    For more information, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels.

  • :stack_set_name (String)

    The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.

  • :tags (Hash<String,String>)

    The list of tags associated with the workspace.

  • :workspace_data_sources (Array<String>)

    Specify the Amazon Web Services data sources that you want to be queried in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to read data from these sources. You must still add them as data sources in the Grafana console in the workspace.

    If you don't specify a data source here, you can still add it as a data source in the workspace console later. However, you will then have to manually configure permissions for it.

  • :workspace_description (String)

    A description for the workspace. This is used only to help you identify this workspace.

    Pattern: ^[\\p\{L\}\\p\{Z\}\\p\{N\}\\p\{P\}]\{0,2048\}$

  • :workspace_name (String)

    The name for the workspace. It does not have to be unique.

  • :workspace_notification_destinations (Array<String>)

    Specify the Amazon Web Services notification channels that you plan to use in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to use these channels.

  • :workspace_organizational_units (Array<String>)

    Specifies the organizational units that this workspace is allowed to use data sources from, if this workspace is in an account that is part of an organization.

  • :workspace_role_arn (String)

    The workspace needs an IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from. If you already have a role that you want to use, specify it here. The permission type should be set to CUSTOMER_MANAGED.

Returns:

See Also:



586
587
588
589
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb', line 586

def create_workspace(params = {}, options = {})
  req = build_request(:create_workspace, params)
  req.send_request(options)
end

#create_workspace_api_key(params = {}) ⇒ Types::CreateWorkspaceApiKeyResponse

Creates an 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.

Examples:

Request syntax with placeholder values


resp = client.create_workspace_api_key({
  key_name: "ApiKeyName", # required
  key_role: "String", # required
  seconds_to_live: 1, # required
  workspace_id: "WorkspaceId", # required
})

Response structure


resp.key #=> String
resp.key_name #=> String
resp.workspace_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :key_name (required, String)

    Specifies the name of the key to create. Key names must be unique to the workspace.

  • :key_role (required, String)

    Specifies the permission level of the key.

    Valid Values: VIEWER | EDITOR | ADMIN

  • :seconds_to_live (required, Integer)

    Specifies the time in seconds until the key expires. Keys can be valid for up to 30 days.

  • :workspace_id (required, String)

    The ID of the workspace in which to create an API key.

Returns:

See Also:



638
639
640
641
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb', line 638

def create_workspace_api_key(params = {}, options = {})
  req = build_request(:create_workspace_api_key, params)
  req.send_request(options)
end

#delete_workspace(params = {}) ⇒ Types::DeleteWorkspaceResponse

Deletes an Amazon Managed Grafana workspace.

Examples:

Request syntax with placeholder values


resp = client.delete_workspace({
  workspace_id: "WorkspaceId", # required
})

Response structure


resp.workspace. #=> String, one of "CURRENT_ACCOUNT", "ORGANIZATION"
resp.workspace.authentication.providers #=> Array
resp.workspace.authentication.providers[0] #=> String, one of "AWS_SSO", "SAML"
resp.workspace.authentication.saml_configuration_status #=> String, one of "CONFIGURED", "NOT_CONFIGURED"
resp.workspace.created #=> Time
resp.workspace.data_sources #=> Array
resp.workspace.data_sources[0] #=> String, one of "AMAZON_OPENSEARCH_SERVICE", "CLOUDWATCH", "PROMETHEUS", "XRAY", "TIMESTREAM", "SITEWISE", "ATHENA", "REDSHIFT"
resp.workspace.description #=> String
resp.workspace.endpoint #=> String
resp.workspace.free_trial_consumed #=> Boolean
resp.workspace.free_trial_expiration #=> Time
resp.workspace.grafana_version #=> String
resp.workspace.id #=> String
resp.workspace.license_expiration #=> Time
resp.workspace.license_type #=> String, one of "ENTERPRISE", "ENTERPRISE_FREE_TRIAL"
resp.workspace.modified #=> Time
resp.workspace.name #=> String
resp.workspace.notification_destinations #=> Array
resp.workspace.notification_destinations[0] #=> String, one of "SNS"
resp.workspace.organization_role_name #=> String
resp.workspace.organizational_units #=> Array
resp.workspace.organizational_units[0] #=> String
resp.workspace.permission_type #=> String, one of "CUSTOMER_MANAGED", "SERVICE_MANAGED"
resp.workspace.stack_set_name #=> String
resp.workspace.status #=> String, one of "ACTIVE", "CREATING", "DELETING", "FAILED", "UPDATING", "UPGRADING", "DELETION_FAILED", "CREATION_FAILED", "UPDATE_FAILED", "UPGRADE_FAILED", "LICENSE_REMOVAL_FAILED"
resp.workspace.tags #=> Hash
resp.workspace.tags["TagKey"] #=> String
resp.workspace.workspace_role_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :workspace_id (required, String)

    The ID of the workspace to delete.

Returns:

See Also:



693
694
695
696
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb', line 693

def delete_workspace(params = {}, options = {})
  req = build_request(:delete_workspace, params)
  req.send_request(options)
end

#delete_workspace_api_key(params = {}) ⇒ Types::DeleteWorkspaceApiKeyResponse

Deletes an API key for a workspace.

Examples:

Request syntax with placeholder values


resp = client.delete_workspace_api_key({
  key_name: "ApiKeyName", # required
  workspace_id: "WorkspaceId", # required
})

Response structure


resp.key_name #=> String
resp.workspace_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :key_name (required, String)

    The name of the API key to delete.

  • :workspace_id (required, String)

    The ID of the workspace to delete.

Returns:

See Also:



727
728
729
730
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb', line 727

def delete_workspace_api_key(params = {}, options = {})
  req = build_request(:delete_workspace_api_key, params)
  req.send_request(options)
end

#describe_workspace(params = {}) ⇒ Types::DescribeWorkspaceResponse

Displays information about one Amazon Managed Grafana workspace.

Examples:

Request syntax with placeholder values


resp = client.describe_workspace({
  workspace_id: "WorkspaceId", # required
})

Response structure


resp.workspace. #=> String, one of "CURRENT_ACCOUNT", "ORGANIZATION"
resp.workspace.authentication.providers #=> Array
resp.workspace.authentication.providers[0] #=> String, one of "AWS_SSO", "SAML"
resp.workspace.authentication.saml_configuration_status #=> String, one of "CONFIGURED", "NOT_CONFIGURED"
resp.workspace.created #=> Time
resp.workspace.data_sources #=> Array
resp.workspace.data_sources[0] #=> String, one of "AMAZON_OPENSEARCH_SERVICE", "CLOUDWATCH", "PROMETHEUS", "XRAY", "TIMESTREAM", "SITEWISE", "ATHENA", "REDSHIFT"
resp.workspace.description #=> String
resp.workspace.endpoint #=> String
resp.workspace.free_trial_consumed #=> Boolean
resp.workspace.free_trial_expiration #=> Time
resp.workspace.grafana_version #=> String
resp.workspace.id #=> String
resp.workspace.license_expiration #=> Time
resp.workspace.license_type #=> String, one of "ENTERPRISE", "ENTERPRISE_FREE_TRIAL"
resp.workspace.modified #=> Time
resp.workspace.name #=> String
resp.workspace.notification_destinations #=> Array
resp.workspace.notification_destinations[0] #=> String, one of "SNS"
resp.workspace.organization_role_name #=> String
resp.workspace.organizational_units #=> Array
resp.workspace.organizational_units[0] #=> String
resp.workspace.permission_type #=> String, one of "CUSTOMER_MANAGED", "SERVICE_MANAGED"
resp.workspace.stack_set_name #=> String
resp.workspace.status #=> String, one of "ACTIVE", "CREATING", "DELETING", "FAILED", "UPDATING", "UPGRADING", "DELETION_FAILED", "CREATION_FAILED", "UPDATE_FAILED", "UPGRADE_FAILED", "LICENSE_REMOVAL_FAILED"
resp.workspace.tags #=> Hash
resp.workspace.tags["TagKey"] #=> String
resp.workspace.workspace_role_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :workspace_id (required, String)

    The ID of the workspace to display information about.

Returns:

See Also:



782
783
784
785
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb', line 782

def describe_workspace(params = {}, options = {})
  req = build_request(:describe_workspace, params)
  req.send_request(options)
end

#describe_workspace_authentication(params = {}) ⇒ Types::DescribeWorkspaceAuthenticationResponse

Displays information about the authentication methods used in one Amazon Managed Grafana workspace.

Examples:

Request syntax with placeholder values


resp = client.describe_workspace_authentication({
  workspace_id: "WorkspaceId", # required
})

Response structure


resp.authentication.aws_sso.sso_client_id #=> String
resp.authentication.providers #=> Array
resp.authentication.providers[0] #=> String, one of "AWS_SSO", "SAML"
resp.authentication.saml.configuration.allowed_organizations #=> Array
resp.authentication.saml.configuration.allowed_organizations[0] #=> String
resp.authentication.saml.configuration.assertion_attributes.email #=> String
resp.authentication.saml.configuration.assertion_attributes.groups #=> String
resp.authentication.saml.configuration.assertion_attributes. #=> String
resp.authentication.saml.configuration.assertion_attributes.name #=> String
resp.authentication.saml.configuration.assertion_attributes.org #=> String
resp.authentication.saml.configuration.assertion_attributes.role #=> String
resp.authentication.saml.configuration..url #=> String
resp.authentication.saml.configuration..xml #=> String
resp.authentication.saml.configuration. #=> Integer
resp.authentication.saml.configuration.role_values.admin #=> Array
resp.authentication.saml.configuration.role_values.admin[0] #=> String
resp.authentication.saml.configuration.role_values.editor #=> Array
resp.authentication.saml.configuration.role_values.editor[0] #=> String
resp.authentication.saml.status #=> String, one of "CONFIGURED", "NOT_CONFIGURED"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :workspace_id (required, String)

    The ID of the workspace to return authentication information about.

Returns:

See Also:



829
830
831
832
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb', line 829

def describe_workspace_authentication(params = {}, options = {})
  req = build_request(:describe_workspace_authentication, params)
  req.send_request(options)
end

#disassociate_license(params = {}) ⇒ Types::DisassociateLicenseResponse

Removes the Grafana Enterprise license from a workspace.

Examples:

Request syntax with placeholder values


resp = client.disassociate_license({
  license_type: "ENTERPRISE", # required, accepts ENTERPRISE, ENTERPRISE_FREE_TRIAL
  workspace_id: "WorkspaceId", # required
})

Response structure


resp.workspace. #=> String, one of "CURRENT_ACCOUNT", "ORGANIZATION"
resp.workspace.authentication.providers #=> Array
resp.workspace.authentication.providers[0] #=> String, one of "AWS_SSO", "SAML"
resp.workspace.authentication.saml_configuration_status #=> String, one of "CONFIGURED", "NOT_CONFIGURED"
resp.workspace.created #=> Time
resp.workspace.data_sources #=> Array
resp.workspace.data_sources[0] #=> String, one of "AMAZON_OPENSEARCH_SERVICE", "CLOUDWATCH", "PROMETHEUS", "XRAY", "TIMESTREAM", "SITEWISE", "ATHENA", "REDSHIFT"
resp.workspace.description #=> String
resp.workspace.endpoint #=> String
resp.workspace.free_trial_consumed #=> Boolean
resp.workspace.free_trial_expiration #=> Time
resp.workspace.grafana_version #=> String
resp.workspace.id #=> String
resp.workspace.license_expiration #=> Time
resp.workspace.license_type #=> String, one of "ENTERPRISE", "ENTERPRISE_FREE_TRIAL"
resp.workspace.modified #=> Time
resp.workspace.name #=> String
resp.workspace.notification_destinations #=> Array
resp.workspace.notification_destinations[0] #=> String, one of "SNS"
resp.workspace.organization_role_name #=> String
resp.workspace.organizational_units #=> Array
resp.workspace.organizational_units[0] #=> String
resp.workspace.permission_type #=> String, one of "CUSTOMER_MANAGED", "SERVICE_MANAGED"
resp.workspace.stack_set_name #=> String
resp.workspace.status #=> String, one of "ACTIVE", "CREATING", "DELETING", "FAILED", "UPDATING", "UPGRADING", "DELETION_FAILED", "CREATION_FAILED", "UPDATE_FAILED", "UPGRADE_FAILED", "LICENSE_REMOVAL_FAILED"
resp.workspace.tags #=> Hash
resp.workspace.tags["TagKey"] #=> String
resp.workspace.workspace_role_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :license_type (required, String)

    The type of license to remove from the workspace.

  • :workspace_id (required, String)

    The ID of the workspace to remove the Grafana Enterprise license from.

Returns:

See Also:



888
889
890
891
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb', line 888

def disassociate_license(params = {}, options = {})
  req = build_request(:disassociate_license, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_permissions({
  group_id: "SsoId",
  max_results: 1,
  next_token: "PaginationToken",
  user_id: "SsoId",
  user_type: "SSO_USER", # accepts SSO_USER, SSO_GROUP
  workspace_id: "WorkspaceId", # required
})

Response structure


resp.next_token #=> String
resp.permissions #=> Array
resp.permissions[0].role #=> String, one of "ADMIN", "EDITOR", "VIEWER"
resp.permissions[0].user.id #=> String
resp.permissions[0].user.type #=> String, one of "SSO_USER", "SSO_GROUP"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :group_id (String) — default: Optional

    Limits the results to only the group that matches this ID.

  • :max_results (Integer)

    The maximum number of results to include in the response.

  • :next_token (String)

    The token to use when requesting the next set of results. You received this token from a previous ListPermissions operation.

  • :user_id (String) — default: Optional

    Limits the results to only the user that matches this ID.

  • :user_type (String) — default: Optional

    If you specify SSO_USER, then only the permissions of Amazon Web Services SSO users are returned. If you specify SSO_GROUP, only the permissions of Amazon Web Services SSO groups are returned.

  • :workspace_id (required, String)

    The ID of the workspace to list permissions for. This parameter is required.

Returns:

See Also:



953
954
955
956
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb', line 953

def list_permissions(params = {}, options = {})
  req = build_request(:list_permissions, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "String", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The ARN of the resource the list of tags are associated with.

Returns:

See Also:



985
986
987
988
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb', line 985

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_workspaces({
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.next_token #=> String
resp.workspaces #=> Array
resp.workspaces[0].authentication.providers #=> Array
resp.workspaces[0].authentication.providers[0] #=> String, one of "AWS_SSO", "SAML"
resp.workspaces[0].authentication.saml_configuration_status #=> String, one of "CONFIGURED", "NOT_CONFIGURED"
resp.workspaces[0].created #=> Time
resp.workspaces[0].description #=> String
resp.workspaces[0].endpoint #=> String
resp.workspaces[0].grafana_version #=> String
resp.workspaces[0].id #=> String
resp.workspaces[0].modified #=> Time
resp.workspaces[0].name #=> String
resp.workspaces[0].notification_destinations #=> Array
resp.workspaces[0].notification_destinations[0] #=> String, one of "SNS"
resp.workspaces[0].status #=> String, one of "ACTIVE", "CREATING", "DELETING", "FAILED", "UPDATING", "UPGRADING", "DELETION_FAILED", "CREATION_FAILED", "UPDATE_FAILED", "UPGRADE_FAILED", "LICENSE_REMOVAL_FAILED"
resp.workspaces[0].tags #=> Hash
resp.workspaces[0].tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :max_results (Integer)

    The maximum number of workspaces to include in the results.

  • :next_token (String)

    The token for the next set of workspaces to return. (You receive this token from a previous ListWorkspaces operation.)

Returns:

See Also:



1043
1044
1045
1046
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb', line 1043

def list_workspaces(params = {}, options = {})
  req = build_request(:list_workspaces, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "String", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The ARN of the resource the tag is associated with.

  • :tags (required, Hash<String,String>)

    The list of tag keys and values to associate with the resource. You can associate tag keys only, tags (key and values) only or a combination of tag keys and tags.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1080
1081
1082
1083
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb', line 1080

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

The UntagResource operation removes the association of the tag with the Amazon Managed Grafana resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "String", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The ARN of the resource the tag association is removed from.

  • :tag_keys (required, Array<String>)

    The key values of the tag to be removed from the resource.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1107
1108
1109
1110
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb', line 1107

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_permissions(params = {}) ⇒ Types::UpdatePermissionsResponse

Updates which users in a workspace have the Grafana Admin or Editor roles.

Examples:

Request syntax with placeholder values


resp = client.update_permissions({
  update_instruction_batch: [ # required
    {
      action: "ADD", # required, accepts ADD, REVOKE
      role: "ADMIN", # required, accepts ADMIN, EDITOR, VIEWER
      users: [ # required
        {
          id: "SsoId", # required
          type: "SSO_USER", # required, accepts SSO_USER, SSO_GROUP
        },
      ],
    },
  ],
  workspace_id: "WorkspaceId", # required
})

Response structure


resp.errors #=> Array
resp.errors[0].caused_by.action #=> String, one of "ADD", "REVOKE"
resp.errors[0].caused_by.role #=> String, one of "ADMIN", "EDITOR", "VIEWER"
resp.errors[0].caused_by.users #=> Array
resp.errors[0].caused_by.users[0].id #=> String
resp.errors[0].caused_by.users[0].type #=> String, one of "SSO_USER", "SSO_GROUP"
resp.errors[0].code #=> Integer
resp.errors[0].message #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :update_instruction_batch (required, Array<Types::UpdateInstruction>)

    An array of structures that contain the permission updates to make.

  • :workspace_id (required, String)

    The ID of the workspace to update.

Returns:

See Also:



1158
1159
1160
1161
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb', line 1158

def update_permissions(params = {}, options = {})
  req = build_request(:update_permissions, params)
  req.send_request(options)
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 Amazon Web Services SSO, use UpdateWorkspaceAuthentication.

To modify which users in the workspace have the Admin and Editor Grafana roles, use UpdatePermissions.

Examples:

Request syntax with placeholder values


resp = client.update_workspace({
  account_access_type: "CURRENT_ACCOUNT", # accepts CURRENT_ACCOUNT, ORGANIZATION
  organization_role_name: "OrganizationRoleName",
  permission_type: "CUSTOMER_MANAGED", # accepts CUSTOMER_MANAGED, SERVICE_MANAGED
  stack_set_name: "StackSetName",
  workspace_data_sources: ["AMAZON_OPENSEARCH_SERVICE"], # accepts AMAZON_OPENSEARCH_SERVICE, CLOUDWATCH, PROMETHEUS, XRAY, TIMESTREAM, SITEWISE, ATHENA, REDSHIFT
  workspace_description: "Description",
  workspace_id: "WorkspaceId", # required
  workspace_name: "WorkspaceName",
  workspace_notification_destinations: ["SNS"], # accepts SNS
  workspace_organizational_units: ["OrganizationalUnit"],
  workspace_role_arn: "IamRoleArn",
})

Response structure


resp.workspace. #=> String, one of "CURRENT_ACCOUNT", "ORGANIZATION"
resp.workspace.authentication.providers #=> Array
resp.workspace.authentication.providers[0] #=> String, one of "AWS_SSO", "SAML"
resp.workspace.authentication.saml_configuration_status #=> String, one of "CONFIGURED", "NOT_CONFIGURED"
resp.workspace.created #=> Time
resp.workspace.data_sources #=> Array
resp.workspace.data_sources[0] #=> String, one of "AMAZON_OPENSEARCH_SERVICE", "CLOUDWATCH", "PROMETHEUS", "XRAY", "TIMESTREAM", "SITEWISE", "ATHENA", "REDSHIFT"
resp.workspace.description #=> String
resp.workspace.endpoint #=> String
resp.workspace.free_trial_consumed #=> Boolean
resp.workspace.free_trial_expiration #=> Time
resp.workspace.grafana_version #=> String
resp.workspace.id #=> String
resp.workspace.license_expiration #=> Time
resp.workspace.license_type #=> String, one of "ENTERPRISE", "ENTERPRISE_FREE_TRIAL"
resp.workspace.modified #=> Time
resp.workspace.name #=> String
resp.workspace.notification_destinations #=> Array
resp.workspace.notification_destinations[0] #=> String, one of "SNS"
resp.workspace.organization_role_name #=> String
resp.workspace.organizational_units #=> Array
resp.workspace.organizational_units[0] #=> String
resp.workspace.permission_type #=> String, one of "CUSTOMER_MANAGED", "SERVICE_MANAGED"
resp.workspace.stack_set_name #=> String
resp.workspace.status #=> String, one of "ACTIVE", "CREATING", "DELETING", "FAILED", "UPDATING", "UPGRADING", "DELETION_FAILED", "CREATION_FAILED", "UPDATE_FAILED", "UPGRADE_FAILED", "LICENSE_REMOVAL_FAILED"
resp.workspace.tags #=> Hash
resp.workspace.tags["TagKey"] #=> String
resp.workspace.workspace_role_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :account_access_type (String)

    Specifies whether the workspace can access Amazon Web Services resources in this Amazon Web Services account only, or whether it can also access Amazon Web Services resources in other accounts in the same organization. If you specify ORGANIZATION, you must specify which organizational units the workspace can access in the workspaceOrganizationalUnits parameter.

  • :organization_role_name (String)

    The name of an IAM role that already exists to use to access resources through Organizations.

  • :permission_type (String)

    If you specify Service Managed, Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.

    If you specify CUSTOMER_MANAGED, you will manage those roles and permissions yourself. If you are creating this workspace in a member account of an organization and that account is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, you must choose CUSTOMER_MANAGED.

    For more information, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels

  • :stack_set_name (String)

    The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.

  • :workspace_data_sources (Array<String>)

    Specify the Amazon Web Services data sources that you want to be queried in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to read data from these sources. You must still add them as data sources in the Grafana console in the workspace.

    If you don't specify a data source here, you can still add it as a data source later in the workspace console. However, you will then have to manually configure permissions for it.

  • :workspace_description (String)

    A description for the workspace. This is used only to help you identify this workspace.

  • :workspace_id (required, String)

    The ID of the workspace to update.

  • :workspace_name (String)

    A new name for the workspace to update.

  • :workspace_notification_destinations (Array<String>)

    Specify the Amazon Web Services notification channels that you plan to use in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to use these channels.

  • :workspace_organizational_units (Array<String>)

    Specifies the organizational units that this workspace is allowed to use data sources from, if this workspace is in an account that is part of an organization.

  • :workspace_role_arn (String)

    The workspace needs an IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from. If you already have a role that you want to use, specify it here. If you omit this field and you specify some Amazon Web Services resources in workspaceDataSources or workspaceNotificationDestinations, a new IAM role with the necessary permissions is automatically created.

Returns:

See Also:



1311
1312
1313
1314
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb', line 1311

def update_workspace(params = {}, options = {})
  req = build_request(:update_workspace, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.update_workspace_authentication({
  authentication_providers: ["AWS_SSO"], # required, accepts AWS_SSO, SAML
  saml_configuration: {
    allowed_organizations: ["AllowedOrganization"],
    assertion_attributes: {
      email: "AssertionAttribute",
      groups: "AssertionAttribute",
      login: "AssertionAttribute",
      name: "AssertionAttribute",
      org: "AssertionAttribute",
      role: "AssertionAttribute",
    },
    idp_metadata: { # required
      url: "IdpMetadataUrl",
      xml: "String",
    },
    login_validity_duration: 1,
    role_values: {
      admin: ["RoleValue"],
      editor: ["RoleValue"],
    },
  },
  workspace_id: "WorkspaceId", # required
})

Response structure


resp.authentication.aws_sso.sso_client_id #=> String
resp.authentication.providers #=> Array
resp.authentication.providers[0] #=> String, one of "AWS_SSO", "SAML"
resp.authentication.saml.configuration.allowed_organizations #=> Array
resp.authentication.saml.configuration.allowed_organizations[0] #=> String
resp.authentication.saml.configuration.assertion_attributes.email #=> String
resp.authentication.saml.configuration.assertion_attributes.groups #=> String
resp.authentication.saml.configuration.assertion_attributes. #=> String
resp.authentication.saml.configuration.assertion_attributes.name #=> String
resp.authentication.saml.configuration.assertion_attributes.org #=> String
resp.authentication.saml.configuration.assertion_attributes.role #=> String
resp.authentication.saml.configuration..url #=> String
resp.authentication.saml.configuration..xml #=> String
resp.authentication.saml.configuration. #=> Integer
resp.authentication.saml.configuration.role_values.admin #=> Array
resp.authentication.saml.configuration.role_values.admin[0] #=> String
resp.authentication.saml.configuration.role_values.editor #=> Array
resp.authentication.saml.configuration.role_values.editor[0] #=> String
resp.authentication.saml.status #=> String, one of "CONFIGURED", "NOT_CONFIGURED"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :authentication_providers (required, Array<String>)

    Specifies whether this workspace uses SAML 2.0, Amazon Web Services Single Sign On, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.

  • :saml_configuration (Types::SamlConfiguration)

    If the workspace uses SAML, use this structure to 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.

  • :workspace_id (required, String)

    The ID of the workspace to update the authentication for.

Returns:

See Also:



1398
1399
1400
1401
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/client.rb', line 1398

def update_workspace_authentication(params = {}, options = {})
  req = build_request(:update_workspace_authentication, params)
  req.send_request(options)
end