list_workgroups

list_workgroups(**kwargs)

Returns information about a list of specified workgroups.

See also: AWS API Documentation

Request Syntax

response = client.list_workgroups(
    maxResults=123,
    nextToken='string'
)

Parameters

• maxResults (integer) -- An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
• nextToken (string) -- If your initial ListWorkgroups operation returns a nextToken , you can include the returned nextToken in following ListNamespaces operations, which returns results in the next page.

Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'workgroups': [
        {
            'baseCapacity': 123,
            'configParameters': [
                {
                    'parameterKey': 'string',
                    'parameterValue': 'string'
                },
            ],
            'creationDate': datetime(2015, 1, 1),
            'endpoint': {
                'address': 'string',
                'port': 123,
                'vpcEndpoints': [
                    {
                        'networkInterfaces': [
                            {
                                'availabilityZone': 'string',
                                'networkInterfaceId': 'string',
                                'privateIpAddress': 'string',
                                'subnetId': 'string'
                            },
                        ],
                        'vpcEndpointId': 'string',
                        'vpcId': 'string'
                    },
                ]
            },
            'enhancedVpcRouting': True|False,
            'namespaceName': 'string',
            'port': 123,
            'publiclyAccessible': True|False,
            'securityGroupIds': [
                'string',
            ],
            'status': 'CREATING'|'AVAILABLE'|'MODIFYING'|'DELETING',
            'subnetIds': [
                'string',
            ],
            'workgroupArn': 'string',
            'workgroupId': 'string',
            'workgroupName': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • 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.

    • (dict) --

      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 advanced control over a database. The options are auto_mv , datestyle , enable_case_sensitivity_identifier , enable_user_activity_logging , query_group , , search_path , 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.

        • (dict) --

          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 auto_mv , datestyle , enable_case_sensitivity_identifier , enable_user_activity_logging , query_group , search_path , 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.

          • parameterValue (string) --

            The value of the parameter to set.

      • creationDate (datetime) --

        The creation date of the workgroup.

      • endpoint (dict) --

        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.

          • (dict) --

            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.

              • (dict) --

                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.

      • port (integer) --

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

      • 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.

Exceptions

• RedshiftServerless.Client.exceptions.InternalServerException
• RedshiftServerless.Client.exceptions.ValidationException