Skip to content
AWS for Query.Farm

aws.redshift_serverless.get_workgroup

Example SQL Queries

SELECT * FROM
aws.redshift_serverless.get_workgroup
WHERE
"workgroup_name" = 'VALUE';

Description

Returns information about a specific workgroup.

Table Definition

Column NameColumn Data Type
workgroup_name Required Input Column

The name of the workgroup to return information for.

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
workgroup

The returned workgroup object.

STRUCT(
    "base_capacity" BIGINT,
    "config_parameters" STRUCT(
        "parameter_key" VARCHAR,
        "parameter_value" VARCHAR
    )[],
    "creation_date" TIMESTAMP_S,
    "cross_account_vpcs" VARCHAR[],
    "custom_domain_certificate_arn" VARCHAR,
    "custom_domain_certificate_expiry_time" TIMESTAMP_S,
    "custom_domain_name" VARCHAR,
    "endpoint" STRUCT(
        "address" VARCHAR,
        "port" BIGINT,
        "vpc_endpoints" STRUCT(
            "network_interfaces" STRUCT(
                "availability_zone" VARCHAR,
                "ipv6_address" VARCHAR,
                "network_interface_id" VARCHAR,
                "private_ip_address" VARCHAR,
                "subnet_id" VARCHAR
            )[],
            "vpc_endpoint_id" VARCHAR,
            "vpc_id" VARCHAR
        )[]
    ),
    "enhanced_vpc_routing" BOOLEAN,
    "ip_address_type" VARCHAR,
    "max_capacity" BIGINT,
    "namespace_name" VARCHAR,
    "patch_version" VARCHAR,
    "port" BIGINT,
    "publicly_accessible" BOOLEAN,
    "security_group_ids" VARCHAR[],
    "status" VARCHAR,
    "subnet_ids" VARCHAR[],
    "workgroup_arn" VARCHAR,
    "workgroup_id" VARCHAR,
    "workgroup_name" VARCHAR,
    "workgroup_version" VARCHAR
)
Show child fields
workgroup.base_capacity

The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).

workgroup.config_parameters[]
Show child fields
workgroup.config_parameters[].parameter_key

The key of the parameter. The options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging, query_group, search_path, require_ssl, use_fips_ssl, and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.

workgroup.config_parameters[].parameter_value

The value of the parameter to set.

workgroup.creation_date

The creation date of the workgroup.

workgroup.cross_account_vpcs[]
workgroup.custom_domain_certificate_arn

The custom domain name’s certificate Amazon resource name (ARN).

workgroup.custom_domain_certificate_expiry_time

The expiration time for the certificate.

workgroup.custom_domain_name

The custom domain name associated with the workgroup.

workgroup.endpoint

The endpoint that is created from the workgroup.

Show child fields
workgroup.endpoint.address

The DNS address of the VPC endpoint.

workgroup.endpoint.port

The port that Amazon Redshift Serverless listens on.

workgroup.endpoint.vpc_endpoints[]
Show child fields
workgroup.endpoint.vpc_endpoints[].network_interfaces[]
Show child fields
workgroup.endpoint.vpc_endpoints[].network_interfaces[].availability_zone

The availability Zone.

workgroup.endpoint.vpc_endpoints[].network_interfaces[].ipv6_address

The IPv6 address of the network interface within the subnet.

workgroup.endpoint.vpc_endpoints[].network_interfaces[].network_interface_id

The unique identifier of the network interface.

workgroup.endpoint.vpc_endpoints[].network_interfaces[].private_ip_address

The IPv4 address of the network interface within the subnet.

workgroup.endpoint.vpc_endpoints[].network_interfaces[].subnet_id

The unique identifier of the subnet.

workgroup.endpoint.vpc_endpoints[].vpc_endpoint_id

The connection endpoint ID for connecting to Amazon Redshift Serverless.

workgroup.endpoint.vpc_endpoints[].vpc_id

The VPC identifier that the endpoint is associated with.

workgroup.enhanced_vpc_routing

The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.

workgroup.ip_address_type

The IP address type that the workgroup supports. Possible values are ipv4 and dualstack.

workgroup.max_capacity

The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.

workgroup.namespace_name

The namespace the workgroup is associated with.

workgroup.patch_version

The patch version of your Amazon Redshift Serverless workgroup. For more information about patch versions, see Cluster versions for Amazon Redshift.

workgroup.port

The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.

workgroup.publicly_accessible

A value that specifies whether the workgroup can be accessible from a public network.

workgroup.security_group_ids[]
workgroup.status

The status of the workgroup.

workgroup.subnet_ids[]
workgroup.workgroup_arn

The Amazon Resource Name (ARN) that links to the workgroup.

workgroup.workgroup_id

The unique identifier of the workgroup.

workgroup.workgroup_name

The name of the workgroup.

workgroup.workgroup_version

The Amazon Redshift Serverless version of your workgroup. For more information about Amazon Redshift Serverless versions, seeCluster versions for Amazon Redshift.