[ aws . redshift-serverless ]

list-workgroups

Description

Returns information about a list of specified workgroups.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-workgroups is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: workgroups

Synopsis

  list-workgroups
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

nextToken -> (string)

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token.

workgroups -> (list)

The returned array of workgroups.

(structure)

The collection of computing resources from which an endpoint is created.

baseCapacity -> (integer)

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

configParameters -> (list)

An array of parameters to set for finer control over a database. The options are datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .

(structure)

An array of key-value pairs to set for advanced control over Amazon Redshift Serverless.

parameterKey -> (string)

The key of the parameter. The options are datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .

parameterValue -> (string)

The value of the parameter to set.

creationDate -> (timestamp)

The creation date of the workgroup.

endpoint -> (structure)

The endpoint that is created from the workgroup.

address -> (string)

The DNS address of the VPC endpoint.

port -> (integer)

The port that Amazon Redshift Serverless listens on.

vpcEndpoints -> (list)

An array of VpcEndpoint objects.

(structure)

The connection endpoint for connecting to Amazon Redshift Serverless through the proxy.

networkInterfaces -> (list)

One or more network interfaces of the endpoint. Also known as an interface endpoint.

(structure)

Contains information about a network interface in an Amazon Redshift Serverless managed VPC endpoint.

availabilityZone -> (string)

The availability Zone.

networkInterfaceId -> (string)

The unique identifier of the network interface.

privateIpAddress -> (string)

The IPv4 address of the network interface within the subnet.

subnetId -> (string)

The unique identifier of the subnet.

vpcEndpointId -> (string)

The connection endpoint ID for connecting to Amazon Redshift Serverless.

vpcId -> (string)

The VPC identifier that the endpoint is associated with.

enhancedVpcRouting -> (boolean)

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

namespaceName -> (string)

The namespace the workgroup is associated with.

publiclyAccessible -> (boolean)

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

securityGroupIds -> (list)

An array of security group IDs to associate with the workgroup.

(string)

status -> (string)

The status of the workgroup.

subnetIds -> (list)

An array of subnet IDs the workgroup is associated with.

(string)

workgroupArn -> (string)

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

workgroupId -> (string)

The unique identifier of the workgroup.

workgroupName -> (string)

The name of the workgroup.