Class: Aws::ManagedGrafana::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
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](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :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`

    • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

    • ENV, ENV, ENV, and ENV

    • ‘~/.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::InstanceProfileCredentials` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV 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:

  • :access_key_id (String)
  • :account_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.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :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.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :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.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • ‘when_supported` - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a `requestAlgorithmMember` is modeled.

    • ‘when_required` - When set, a checksum will only be calculated for request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` or where a `requestAlgorithmMember` is modeled and supplied.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • ‘when_supported` - (default) When set, checksum validation is performed on all response payloads of operations modeled with the `httpChecksum` trait where `responseAlgorithms` is modeled, except when no modeled checksum algorithms are supported.

    • ‘when_required` - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the `requestValidationModeMember` member is set to `ENABLED`.

  • :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 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.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :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.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :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.

  • :endpoint_provider (Aws::ManagedGrafana::EndpointProvider) —

    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`.

  • :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.

  • :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_open_timeout (Float) — default: 15 —

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

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :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_wire_trace (Boolean) — default: false —

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

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :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.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

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



467
468
469
 
# File 'lib/aws-sdk-managedgrafana/client.rb', line 467

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



2202
2203
2204
 
# File 'lib/aws-sdk-managedgrafana/client.rb', line 2202

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



2205
2206
2207
 
# File 'lib/aws-sdk-managedgrafana/client.rb', line 2205

def errors_module
  Errors
end

Instance Method Details

#associate_license(params = {}) ⇒ Types::AssociateLicenseResponse

Assigns a Grafana Enterprise license to a workspace. To upgrade, you must use ‘ENTERPRISE` for the `licenseType`, and pass in a valid Grafana Labs token for the `grafanaToken`. Upgrading to Grafana Enterprise incurs additional fees. For more information, see [Upgrade a workspace to Grafana Enterprise].

[1]: docs.aws.amazon.com/grafana/latest/userguide/upgrade-to-Grafana-Enterprise.html

Examples:

Request syntax with placeholder values


resp = client.associate_license({
  grafana_token: "GrafanaToken",
  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", "TWINMAKER"
resp.workspace.description #=> String
resp.workspace.endpoint #=> String
resp.workspace.free_trial_consumed #=> Boolean
resp.workspace.free_trial_expiration #=> Time
resp.workspace.grafana_token #=> String
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.network_access_control.prefix_list_ids #=> Array
resp.workspace.network_access_control.prefix_list_ids[0] #=> String
resp.workspace.network_access_control.vpce_ids #=> Array
resp.workspace.network_access_control.vpce_ids[0] #=> 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", "VERSION_UPDATING", "VERSION_UPDATE_FAILED"
resp.workspace.tags #=> Hash
resp.workspace.tags["TagKey"] #=> String
resp.workspace.vpc_configuration.security_group_ids #=> Array
resp.workspace.vpc_configuration.security_group_ids[0] #=> String
resp.workspace.vpc_configuration.subnet_ids #=> Array
resp.workspace.vpc_configuration.subnet_ids[0] #=> String
resp.workspace.workspace_role_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :grafana_token (String) —

    A token from Grafana Labs that ties your Amazon Web Services account with a Grafana Labs account. For more information, see [Link your account with Grafana Labs].

    [1]: docs.aws.amazon.com/grafana/latest/userguide/upgrade-to-Grafana-Enterprise.html#AMG-workspace-register-enterprise

  • :license_type (required, String) —

    The type of license to associate with the workspace.

    <note markdown=“1”> Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

    </note>
  • :workspace_id (required, String) —

    The ID of the workspace to associate the license with.

Returns:

See Also:



559
560
561
562
 
# File 'lib/aws-sdk-managedgrafana/client.rb', line 559

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

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

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


2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
 
# File 'lib/aws-sdk-managedgrafana/client.rb', line 2175

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::ManagedGrafana')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-managedgrafana'
  context[:gem_version] = '1.42.0'
  Seahorse::Client::Request.new(handlers, context)
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].

[1]: docs.aws.amazon.com/grafana/latest/APIReference/API_UpdateWorkspace.html

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",
  configuration: "OverridableConfigurationJson",
  grafana_version: "GrafanaVersion",
  network_access_control: {
    prefix_list_ids: ["PrefixListId"], # required
    vpce_ids: ["VpceId"], # required
  },
  organization_role_name: "OrganizationRoleName",
  permission_type: "CUSTOMER_MANAGED", # required, accepts CUSTOMER_MANAGED, SERVICE_MANAGED
  stack_set_name: "StackSetName",
  tags: {
    "TagKey" => "TagValue",
  },
  vpc_configuration: {
    security_group_ids: ["SecurityGroupId"], # required
    subnet_ids: ["SubnetId"], # required
  },
  workspace_data_sources: ["AMAZON_OPENSEARCH_SERVICE"], # accepts AMAZON_OPENSEARCH_SERVICE, CLOUDWATCH, PROMETHEUS, XRAY, TIMESTREAM, SITEWISE, ATHENA, REDSHIFT, TWINMAKER
  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", "TWINMAKER"
resp.workspace.description #=> String
resp.workspace.endpoint #=> String
resp.workspace.free_trial_consumed #=> Boolean
resp.workspace.free_trial_expiration #=> Time
resp.workspace.grafana_token #=> String
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.network_access_control.prefix_list_ids #=> Array
resp.workspace.network_access_control.prefix_list_ids[0] #=> String
resp.workspace.network_access_control.vpce_ids #=> Array
resp.workspace.network_access_control.vpce_ids[0] #=> 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", "VERSION_UPDATING", "VERSION_UPDATE_FAILED"
resp.workspace.tags #=> Hash
resp.workspace.tags["TagKey"] #=> String
resp.workspace.vpc_configuration.security_group_ids #=> Array
resp.workspace.vpc_configuration.security_group_ids[0] #=> String
resp.workspace.vpc_configuration.subnet_ids #=> Array
resp.workspace.vpc_configuration.subnet_ids[0] #=> 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, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see [User authentication in Amazon Managed Grafana].

    [1]: docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html

  • :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.**

  • :configuration (String) —

    The configuration string for the workspace that you create. For more information about the format and configuration options available, see [Working in your Grafana workspace].

    **SDK automatically handles json encoding and base64 encoding for you when the required value (Hash, Array, etc.) is provided according to the description.**

    [1]: docs.aws.amazon.com/grafana/latest/userguide/AMG-configure-workspace.html

  • :grafana_version (String) —

    Specifies the version of Grafana to support in the new workspace. If not specified, defaults to the latest version (for example, 10.4).

    To get a list of supported versions, use the ‘ListVersions` operation.

  • :network_access_control (Types::NetworkAccessConfiguration) —

    Configuration for network access to your workspace.

    When this is configured, only listed IP addresses and VPC endpoints will be able to access your workspace. Standard Grafana authentication and authorization will still be required.

    If this is not configured, or is removed, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required.

  • :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) —

    When creating a workspace through the Amazon Web Services API, CLI or Amazon Web Services CloudFormation, you must manage IAM roles and provision the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.

    You must also specify a ‘workspaceRoleArn` for a role that you will manage for the workspace to use when accessing those datasources and notification channels.

    The ability for Amazon Managed Grafana to create and update IAM roles on behalf of the user is supported only in the Amazon Managed Grafana console, where this value may be set to ‘SERVICE_MANAGED`.

    <note markdown=“1”> Use only the ‘CUSTOMER_MANAGED` permission type when creating a workspace with the API, CLI or Amazon Web Services CloudFormation.

    </note>

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

    [1]: docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html

  • :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.

  • :vpc_configuration (Types::VpcConfiguration) —

    The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.

    <note markdown=“1”> Connecting to a private VPC is not yet available in the Asia Pacific (Seoul) Region (ap-northeast-2).

    </note>
  • :workspace_data_sources (Array<String>) —

    This parameter is for internal use only, and should not be used.

  • :workspace_description (String) —

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

    Pattern: ‘^[\pL\pZ\pN\pP]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) —

    Specified the IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from, including both data sources and notification channels. You are responsible for managing the permissions for this role as new data sources or notification channels are added.

Returns:

See Also:



787
788
789
790
 
# File 'lib/aws-sdk-managedgrafana/client.rb', line 787

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

docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html][1

for available APIs and example requests.

<note markdown=“1”> In workspaces compatible with Grafana version 9 or above, use workspace service accounts instead of API keys. API keys will be removed in a future release.

</note>

[1]: docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html

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. Keynames must be unique to the workspace.

  • :key_role (required, String) —

    Specifies the permission level of the key.

    Valid values: ‘ADMIN`|`EDITOR`|`VIEWER`

  • :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 to create an API key.

Returns:

See Also:



848
849
850
851
 
# File 'lib/aws-sdk-managedgrafana/client.rb', line 848

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

#create_workspace_service_account(params = {}) ⇒ Types::CreateWorkspaceServiceAccountResponse

Creates a service account for the workspace. A service account can be used to call Grafana HTTP APIs, and run automated workloads. After creating the service account with the correct ‘GrafanaRole` for your use case, use `CreateWorkspaceServiceAccountToken` to create a token that can be used to authenticate and authorize Grafana HTTP API calls.

You can only create service accounts for workspaces that are compatible with Grafana version 9 and above.

<note markdown=“1”> For more information about service accounts, see [Service accounts] in the *Amazon Managed Grafana User Guide*.

For more information about the Grafana HTTP APIs, see [Using Grafana

HTTP APIs] in the *Amazon Managed Grafana User Guide*.

</note>

[1]: docs.aws.amazon.com/grafana/latest/userguide/service-accounts.html [2]: docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html

Examples:

Request syntax with placeholder values


resp = client.({
  grafana_role: "ADMIN", # required, accepts ADMIN, EDITOR, VIEWER
  name: "ServiceAccountName", # required
  workspace_id: "WorkspaceId", # required
})

Response structure


resp.grafana_role #=> String, one of "ADMIN", "EDITOR", "VIEWER"
resp.id #=> String
resp.name #=> String
resp.workspace_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :grafana_role (required, String) —

    The permission level to use for this service account.

    <note markdown=“1”> For more information about the roles and the permissions each has, see

    User roles][1

    in the *Amazon Managed Grafana User Guide*.

    </note>

    [1]: docs.aws.amazon.com/grafana/latest/userguide/Grafana-user-roles.html

  • :name (required, String) —

    A name for the service account. The name must be unique within the workspace, as it determines the ID associated with the service account.

  • :workspace_id (required, String) —

    The ID of the workspace within which to create the service account.

Returns:

See Also:



921
922
923
924
 
# File 'lib/aws-sdk-managedgrafana/client.rb', line 921

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

#create_workspace_service_account_token(params = {}) ⇒ Types::CreateWorkspaceServiceAccountTokenResponse

Creates a token that can be used to authenticate and authorize Grafana HTTP API operations for the given [workspace service account]. The service account acts as a user for the API operations, and defines the permissions that are used by the API.

When you create the service account token, you will receive a key that is used when calling Grafana APIs. Do not lose this key, as it will not be retrievable again.

If you do lose the key, you can delete the token and recreate it to

receive a new key. This will disable the initial key.

Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.

[1]: docs.aws.amazon.com/grafana/latest/userguide/service-accounts.html

Examples:

Request syntax with placeholder values


resp = client.({
  name: "ServiceAccountTokenName", # required
  seconds_to_live: 1, # required
  service_account_id: "String", # required
  workspace_id: "WorkspaceId", # required
})

Response structure


resp. #=> String
resp..id #=> String
resp..key #=> String
resp..name #=> String
resp.workspace_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    A name for the token to create.

  • :seconds_to_live (required, Integer) —

    Sets how long the token will be valid, in seconds. You can set the time up to 30 days in the future.

  • :service_account_id (required, String) —

    The ID of the service account for which to create a token.

  • :workspace_id (required, String) —

    The ID of the workspace the service account resides within.

Returns:

See Also:



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

def (params = {}, options = {})
  req = build_request(:create_workspace_service_account_token, 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", "TWINMAKER"
resp.workspace.description #=> String
resp.workspace.endpoint #=> String
resp.workspace.free_trial_consumed #=> Boolean
resp.workspace.free_trial_expiration #=> Time
resp.workspace.grafana_token #=> String
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.network_access_control.prefix_list_ids #=> Array
resp.workspace.network_access_control.prefix_list_ids[0] #=> String
resp.workspace.network_access_control.vpce_ids #=> Array
resp.workspace.network_access_control.vpce_ids[0] #=> 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", "VERSION_UPDATING", "VERSION_UPDATE_FAILED"
resp.workspace.tags #=> Hash
resp.workspace.tags["TagKey"] #=> String
resp.workspace.vpc_configuration.security_group_ids #=> Array
resp.workspace.vpc_configuration.security_group_ids[0] #=> String
resp.workspace.vpc_configuration.subnet_ids #=> Array
resp.workspace.vpc_configuration.subnet_ids[0] #=> 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:



1049
1050
1051
1052
 
# File 'lib/aws-sdk-managedgrafana/client.rb', line 1049

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

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

Deletes a Grafana API key for the workspace.

<note markdown=“1”> In workspaces compatible with Grafana version 9 or above, use workspace service accounts instead of API keys. API keys will be removed in a future release.

</note>

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:



1089
1090
1091
1092
 
# File 'lib/aws-sdk-managedgrafana/client.rb', line 1089

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

#delete_workspace_service_account(params = {}) ⇒ Types::DeleteWorkspaceServiceAccountResponse

Deletes a workspace service account from the workspace.

This will delete any tokens created for the service account, as well. If the tokens are currently in use, the will fail to authenticate / authorize after they are deleted.

Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :service_account_id (required, String) —

    The ID of the service account to delete.

  • :workspace_id (required, String) —

    The ID of the workspace where the service account resides.

Returns:

See Also:



1130
1131
1132
1133
 
# File 'lib/aws-sdk-managedgrafana/client.rb', line 1130

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

#delete_workspace_service_account_token(params = {}) ⇒ Types::DeleteWorkspaceServiceAccountTokenResponse

Deletes a token for the workspace service account.

This will disable the key associated with the token. If any automation is currently using the key, it will no longer be authenticated or authorized to perform actions with the Grafana HTTP APIs.

Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.

Examples:

Request syntax with placeholder values


resp = client.({
  service_account_id: "String", # required
  token_id: "String", # required
  workspace_id: "WorkspaceId", # required
})

Response structure


resp. #=> String
resp.token_id #=> String
resp.workspace_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :service_account_id (required, String) —

    The ID of the service account from which to delete the token.

  • :token_id (required, String) —

    The ID of the token to delete.

  • :workspace_id (required, String) —

    The ID of the workspace from which to delete the token.

Returns:

See Also:



1177
1178
1179
1180
 
# File 'lib/aws-sdk-managedgrafana/client.rb', line 1177

def (params = {}, options = {})
  req = build_request(:delete_workspace_service_account_token, 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", "TWINMAKER"
resp.workspace.description #=> String
resp.workspace.endpoint #=> String
resp.workspace.free_trial_consumed #=> Boolean
resp.workspace.free_trial_expiration #=> Time
resp.workspace.grafana_token #=> String
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.network_access_control.prefix_list_ids #=> Array
resp.workspace.network_access_control.prefix_list_ids[0] #=> String
resp.workspace.network_access_control.vpce_ids #=> Array
resp.workspace.network_access_control.vpce_ids[0] #=> 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", "VERSION_UPDATING", "VERSION_UPDATE_FAILED"
resp.workspace.tags #=> Hash
resp.workspace.tags["TagKey"] #=> String
resp.workspace.vpc_configuration.security_group_ids #=> Array
resp.workspace.vpc_configuration.security_group_ids[0] #=> String
resp.workspace.vpc_configuration.subnet_ids #=> Array
resp.workspace.vpc_configuration.subnet_ids[0] #=> 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:



1241
1242
1243
1244
 
# File 'lib/aws-sdk-managedgrafana/client.rb', line 1241

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.idp_metadata.url #=> String
resp.authentication.saml.configuration.idp_metadata.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:



1288
1289
1290
1291
 
# File 'lib/aws-sdk-managedgrafana/client.rb', line 1288

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

#describe_workspace_configuration(params = {}) ⇒ Types::DescribeWorkspaceConfigurationResponse

Gets the current configuration string for the given workspace.

Examples:

Request syntax with placeholder values


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

Response structure


resp.configuration #=> String
resp.grafana_version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace to get configuration information for.

Returns:

See Also:



1318
1319
1320
1321
 
# File 'lib/aws-sdk-managedgrafana/client.rb', line 1318

def describe_workspace_configuration(params = {}, options = {})
  req = build_request(:describe_workspace_configuration, 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", "TWINMAKER"
resp.workspace.description #=> String
resp.workspace.endpoint #=> String
resp.workspace.free_trial_consumed #=> Boolean
resp.workspace.free_trial_expiration #=> Time
resp.workspace.grafana_token #=> String
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.network_access_control.prefix_list_ids #=> Array
resp.workspace.network_access_control.prefix_list_ids[0] #=> String
resp.workspace.network_access_control.vpce_ids #=> Array
resp.workspace.network_access_control.vpce_ids[0] #=> 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", "VERSION_UPDATING", "VERSION_UPDATE_FAILED"
resp.workspace.tags #=> Hash
resp.workspace.tags["TagKey"] #=> String
resp.workspace.vpc_configuration.security_group_ids #=> Array
resp.workspace.vpc_configuration.security_group_ids[0] #=> String
resp.workspace.vpc_configuration.subnet_ids #=> Array
resp.workspace.vpc_configuration.subnet_ids[0] #=> 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:



1386
1387
1388
1389
 
# File 'lib/aws-sdk-managedgrafana/client.rb', line 1386

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 IAM Identity Center users are returned. If you specify `SSO_GROUP`, only the permissions of IAM Identity Center groups are returned.

  • :workspace_id (required, String) —

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

Returns:

See Also:



1450
1451
1452
1453
 
# File 'lib/aws-sdk-managedgrafana/client.rb', line 1450

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:



1482
1483
1484
1485
 
# File 'lib/aws-sdk-managedgrafana/client.rb', line 1482

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

Examples:

Request syntax with placeholder values


resp = client.list_versions({
  max_results: 1,
  next_token: "PaginationToken",
  workspace_id: "WorkspaceId",
})

Response structure


resp.grafana_versions #=> Array
resp.grafana_versions[0] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :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 receive this token from a previous ‘ListVersions` operation.

  • :workspace_id (String) —

    The ID of the workspace to list the available upgrade versions. If not included, lists all versions of Grafana that are supported for ‘CreateWorkspace`.

Returns:

See Also:



1528
1529
1530
1531
 
# File 'lib/aws-sdk-managedgrafana/client.rb', line 1528

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

#list_workspace_service_account_tokens(params = {}) ⇒ Types::ListWorkspaceServiceAccountTokensResponse

Returns a list of tokens for a workspace service account.

<note markdown=“1”> This does not return the key for each token. You cannot access keys after they are created. To create a new key, delete the token and recreate it.

</note>

Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.({
  max_results: 1,
  next_token: "PaginationToken",
  service_account_id: "String", # required
  workspace_id: "WorkspaceId", # required
})

Response structure


resp.next_token #=> String
resp. #=> String
resp. #=> Array
resp.[0].created_at #=> Time
resp.[0].expires_at #=> Time
resp.[0].id #=> String
resp.[0].last_used_at #=> Time
resp.[0].name #=> String
resp.workspace_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of tokens to include in the results.

  • :next_token (String) —

    The token for the next set of service accounts to return. (You receive this token from a previous ‘ListWorkspaceServiceAccountTokens` operation.)

  • :service_account_id (required, String) —

    The ID of the service account for which to return tokens.

  • :workspace_id (required, String) —

    The ID of the workspace for which to return tokens.

Returns:

See Also:



1592
1593
1594
1595
 
# File 'lib/aws-sdk-managedgrafana/client.rb', line 1592

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

#list_workspace_service_accounts(params = {}) ⇒ Types::ListWorkspaceServiceAccountsResponse

Returns a list of service accounts for a workspace.

Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.

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_workspace_service_accounts({
  max_results: 1,
  next_token: "PaginationToken",
  workspace_id: "WorkspaceId", # required
})

Response structure


resp.next_token #=> String
resp.service_accounts #=> Array
resp.service_accounts[0].grafana_role #=> String, one of "ADMIN", "EDITOR", "VIEWER"
resp.service_accounts[0].id #=> String
resp.service_accounts[0].is_disabled #=> String
resp.service_accounts[0].name #=> String
resp.workspace_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of service accounts to include in the results.

  • :next_token (String) —

    The token for the next set of service accounts to return. (You receive this token from a previous ‘ListWorkspaceServiceAccounts` operation.)

  • :workspace_id (required, String) —

    The workspace for which to list service accounts.

Returns:

See Also:



1642
1643
1644
1645
 
# File 'lib/aws-sdk-managedgrafana/client.rb', line 1642

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

[1]: docs.aws.amazon.com/AAMG/latest/APIReference/API_DescribeWorkspace.html

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_token #=> String
resp.workspaces[0].grafana_version #=> String
resp.workspaces[0].id #=> String
resp.workspaces[0].license_type #=> String, one of "ENTERPRISE", "ENTERPRISE_FREE_TRIAL"
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", "VERSION_UPDATING", "VERSION_UPDATE_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:



1702
1703
1704
1705
 
# File 'lib/aws-sdk-managedgrafana/client.rb', line 1702

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:



1739
1740
1741
1742
 
# File 'lib/aws-sdk-managedgrafana/client.rb', line 1739

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:



1766
1767
1768
1769
 
# File 'lib/aws-sdk-managedgrafana/client.rb', line 1766

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:



1817
1818
1819
1820
 
# File 'lib/aws-sdk-managedgrafana/client.rb', line 1817

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 IAM Identity Center, use [UpdateWorkspaceAuthentication].

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

[1]: docs.aws.amazon.com/grafana/latest/APIReference/API_UpdateWorkspaceAuthentication.html [2]: docs.aws.amazon.com/grafana/latest/APIReference/API_UpdatePermissions.html

Examples:

Request syntax with placeholder values


resp = client.update_workspace({
  account_access_type: "CURRENT_ACCOUNT", # accepts CURRENT_ACCOUNT, ORGANIZATION
  network_access_control: {
    prefix_list_ids: ["PrefixListId"], # required
    vpce_ids: ["VpceId"], # required
  },
  organization_role_name: "OrganizationRoleName",
  permission_type: "CUSTOMER_MANAGED", # accepts CUSTOMER_MANAGED, SERVICE_MANAGED
  remove_network_access_configuration: false,
  remove_vpc_configuration: false,
  stack_set_name: "StackSetName",
  vpc_configuration: {
    security_group_ids: ["SecurityGroupId"], # required
    subnet_ids: ["SubnetId"], # required
  },
  workspace_data_sources: ["AMAZON_OPENSEARCH_SERVICE"], # accepts AMAZON_OPENSEARCH_SERVICE, CLOUDWATCH, PROMETHEUS, XRAY, TIMESTREAM, SITEWISE, ATHENA, REDSHIFT, TWINMAKER
  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", "TWINMAKER"
resp.workspace.description #=> String
resp.workspace.endpoint #=> String
resp.workspace.free_trial_consumed #=> Boolean
resp.workspace.free_trial_expiration #=> Time
resp.workspace.grafana_token #=> String
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.network_access_control.prefix_list_ids #=> Array
resp.workspace.network_access_control.prefix_list_ids[0] #=> String
resp.workspace.network_access_control.vpce_ids #=> Array
resp.workspace.network_access_control.vpce_ids[0] #=> 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", "VERSION_UPDATING", "VERSION_UPDATE_FAILED"
resp.workspace.tags #=> Hash
resp.workspace.tags["TagKey"] #=> String
resp.workspace.vpc_configuration.security_group_ids #=> Array
resp.workspace.vpc_configuration.security_group_ids[0] #=> String
resp.workspace.vpc_configuration.subnet_ids #=> Array
resp.workspace.vpc_configuration.subnet_ids[0] #=> 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.

  • :network_access_control (Types::NetworkAccessConfiguration) —

    The configuration settings for network access to your workspace.

    When this is configured, only listed IP addresses and VPC endpoints will be able to access your workspace. Standard Grafana authentication and authorization will still be required.

    If this is not configured, or is removed, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required.

  • :organization_role_name (String) —

    The name of an IAM role that already exists to use to access resources through Organizations. This can only be used with a workspace that has the ‘permissionType` set to `CUSTOMER_MANAGED`.

  • :permission_type (String) —

    Use this parameter if you want to change a workspace from ‘SERVICE_MANAGED` to `CUSTOMER_MANAGED`. This allows you to manage the permissions that the workspace uses to access datasources and notification channels. If the workspace is in a member Amazon Web Services 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`.

    If you specify this as ‘CUSTOMER_MANAGED`, you must also specify a `workspaceRoleArn` that the workspace will use for accessing Amazon Web Services resources.

    For more information on the role and permissions needed, see [Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels]

    <note markdown=“1”> Do not use this to convert a ‘CUSTOMER_MANAGED` workspace to `SERVICE_MANAGED`. Do not include this parameter if you want to leave the workspace as `SERVICE_MANAGED`.

    You can convert a `CUSTOMER_MANAGED` workspace to `SERVICE_MANAGED`

    using the Amazon Managed Grafana console. For more information, see [Managing permissions for data sources and notification channels].

    </note>

    [1]: docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html [2]: docs.aws.amazon.com/grafana/latest/userguide/AMG-datasource-and-notification.html

  • :remove_network_access_configuration (Boolean) —

    Whether to remove the network access configuration from the workspace.

    Setting this to ‘true` and providing a `networkAccessControl` to set will return an error.

    If you remove this configuration by setting this to ‘true`, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required.

  • :remove_vpc_configuration (Boolean) —

    Whether to remove the VPC configuration from the workspace.

    Setting this to ‘true` and providing a `vpcConfiguration` to set will return an error.

  • :stack_set_name (String) —

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

  • :vpc_configuration (Types::VpcConfiguration) —

    The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.

  • :workspace_data_sources (Array<String>) —

    This parameter is for internal use only, and should not be used.

  • :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) —

    Specifies an IAM role that grants permissions to Amazon Web Services resources that the workspace accesses, such as data sources and notification channels. If this workspace has ‘permissionType` `CUSTOMER_MANAGED`, then this role is required.

Returns:

See Also:



2023
2024
2025
2026
 
# File 'lib/aws-sdk-managedgrafana/client.rb', line 2023

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.

<note markdown=“1”> Changes to the authentication method for a workspace may take a few minutes to take effect.

</note>

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.idp_metadata.url #=> String
resp.authentication.saml.configuration.idp_metadata.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, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see [User authentication in Amazon Managed Grafana].

    [1]: docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html

  • :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:



2115
2116
2117
2118
 
# File 'lib/aws-sdk-managedgrafana/client.rb', line 2115

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

#update_workspace_configuration(params = {}) ⇒ Struct

Updates the configuration string for the given workspace

Examples:

Request syntax with placeholder values


resp = client.update_workspace_configuration({
  configuration: "OverridableConfigurationJson", # required
  grafana_version: "GrafanaVersion",
  workspace_id: "WorkspaceId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :configuration (required, String) —

    The new configuration string for the workspace. For more information about the format and configuration options available, see [Working in your Grafana workspace].

    **SDK automatically handles json encoding and base64 encoding for you when the required value (Hash, Array, etc.) is provided according to the description.**

    [1]: docs.aws.amazon.com/grafana/latest/userguide/AMG-configure-workspace.html

  • :grafana_version (String) —

    Specifies the version of Grafana to support in the workspace. If not specified, keeps the current version of the workspace.

    Can only be used to upgrade (for example, from 8.4 to 9.4), not downgrade (for example, from 9.4 to 8.4).

    To know what versions are available to upgrade to for a specific workspace, see the [ListVersions] operation.

    [1]: docs.aws.amazon.com/grafana/latest/APIReference/API_ListVersions.html

  • :workspace_id (required, String) —

    The ID of the workspace to update.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2166
2167
2168
2169
 
# File 'lib/aws-sdk-managedgrafana/client.rb', line 2166

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

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


2195
2196
2197
 
# File 'lib/aws-sdk-managedgrafana/client.rb', line 2195

def waiter_names
  []
end