Skip to content
AWS for Query.Farm

aws.amp.describe_workspace

Example SQL Queries

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

Description

Returns information about an existing workspace.

Table Definition

Column NameColumn Data Type
workspace_id Required Input Column

The ID of the workspace to describe.

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.

workspace

A structure that contains details about the workspace.

STRUCT(
    "alias" VARCHAR,
    "arn" VARCHAR,
    "created_at" TIMESTAMP_S,
    "kms_key_arn" VARCHAR,
    "prometheus_endpoint" VARCHAR,
    "status" STRUCT(
        "status_code" VARCHAR
    ),
    "tags" MAP(VARCHAR, VARCHAR),
    "workspace_id" VARCHAR
)
Show child fields
workspace.alias

The alias that is assigned to this workspace to help identify it. It may not be unique.

workspace.arn

The ARN of the workspace.

workspace.created_at

The date and time that the workspace was created.

workspace.kms_key_arn

(optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.

workspace.prometheus_endpoint

The Prometheus endpoint available for this workspace.

workspace.status

The current status of the workspace.

Show child fields
workspace.status.status_code

The current status of the workspace.

workspace.tags

The list of tag keys and values that are associated with the workspace.

workspace.workspace_id

The unique ID for the workspace.