Skip to content

aws.grafana.describe_workspace

Example SQL Queries

SELECT * FROM
aws.grafana.describe_workspace
WHERE
"workspace_id" = 'VALUE';

Description

Displays information about one Amazon Managed Grafana workspace.

Table Definition

Column NameColumn Data Type
workspace_id Required Input Column

The ID of the workspace to display information about.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
workspace

A structure containing information about the workspace.

STRUCT(
"account_access_type" VARCHAR,
"authentication" STRUCT(
"providers" VARCHAR[],
"saml_configuration_status" VARCHAR
),
"created" TIMESTAMP_S,
"data_sources" VARCHAR[],
"description" VARCHAR,
"endpoint" VARCHAR,
"free_trial_consumed" BOOLEAN,
"free_trial_expiration" TIMESTAMP_S,
"grafana_token" VARCHAR,
"grafana_version" VARCHAR,
"id" VARCHAR,
"license_expiration" TIMESTAMP_S,
"license_type" VARCHAR,
"modified" TIMESTAMP_S,
"name" VARCHAR,
"network_access_control" STRUCT(
"prefix_list_ids" VARCHAR[],
"vpce_ids" VARCHAR[]
),
"notification_destinations" VARCHAR[],
"organization_role_name" VARCHAR,
"organizational_units" VARCHAR[],
"permission_type" VARCHAR,
"stack_set_name" VARCHAR,
"status" VARCHAR,
"tags" MAP(VARCHAR, VARCHAR),
"vpc_configuration" STRUCT(
"security_group_ids" VARCHAR[],
"subnet_ids" VARCHAR[]
),
"workspace_role_arn" VARCHAR
)
Show child fields
workspace.account_access_type

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 this is ORGANIZATION, the workspaceOrganizationalUnits parameter specifies which organizational units the workspace can access.

workspace.authentication

A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.

Show child fields
workspace.authentication.providers[]
workspace.authentication.saml_configuration_status

Specifies whether the workplace's user authentication method is fully configured.

workspace.created

The date that the workspace was created.

workspace.data_sources[]
workspace.description

The user-defined description of the workspace.

workspace.endpoint

The URL that users can use to access the Grafana console in the workspace.

workspace.free_trial_consumed

Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.

Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

workspace.free_trial_expiration

If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.

Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

workspace.grafana_token

The token that ties this workspace to a Grafana Labs account. For more information, see Link your account with Grafana Labs.

workspace.grafana_version

The version of Grafana supported in this workspace.

workspace.id

The unique ID of this workspace.

workspace.license_expiration

If this workspace has a full Grafana Enterprise license purchased through Amazon Web Services Marketplace, this specifies when the license ends and will need to be renewed. Purchasing the Enterprise plugins option through Amazon Managed Grafana does not have an expiration. It is valid until the license is removed.

workspace.license_type

Specifies whether this workspace has a full Grafana Enterprise license.

Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

workspace.modified

The most recent date that the workspace was modified.

workspace.name

The name of the workspace.

workspace.network_access_control

The configuration settings for network access to your workspace.

Show child fields
workspace.network_access_control.prefix_list_ids[]
workspace.network_access_control.vpce_ids[]
workspace.notification_destinations[]
workspace.organization_role_name

The name of the IAM role that is used to access resources through Organizations.

workspace.organizational_units[]
workspace.permission_type

If this is SERVICE_MANAGED, and the workplace was created through the Amazon Managed Grafana console, then 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 this is CUSTOMER_MANAGED, you must manage those roles and permissions yourself.

If you are working with a 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, this parameter must be set to CUSTOMER_MANAGED.

For more information about converting between customer and service managed, see Managing permissions for data sources and notification channels. For more information about the roles and permissions that must be managed for customer managed workspaces, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels

workspace.stack_set_name

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

workspace.status

The current status of the workspace.

workspace.tags

The list of tags associated with the workspace.

workspace.vpc_configuration

The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).

Show child fields
workspace.vpc_configuration.security_group_ids[]
workspace.vpc_configuration.subnet_ids[]
workspace.workspace_role_arn

The IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from. This role must already exist.