Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . athena ]

list-work-groups

Description

Lists available workgroups for the account.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  list-work-groups
[--next-token <value>]
[--max-results <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--next-token (string)

A token to be used by the next request if this request is truncated.

--max-results (integer)

The maximum number of workgroups to return in this request.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

WorkGroups -> (list)

The list of workgroups, including their names, descriptions, creation times, and states.

(structure)

The summary information for the workgroup, which includes its name, state, description, and the date and time it was created.

Name -> (string)

The name of the workgroup.

State -> (string)

The state of the workgroup.

Description -> (string)

The workgroup description.

CreationTime -> (timestamp)

The workgroup creation date and time.

NextToken -> (string)

A token to be used by the next request if this request is truncated.