RedshiftServerless / Client / delete_workgroup

delete_workgroup

RedshiftServerless.Client.delete_workgroup(**kwargs)

Deletes a workgroup.

See also: AWS API Documentation

Request Syntax

response = client.delete_workgroup(
    workgroupName='string'
)

Parameters:

workgroupName (string) –

[REQUIRED]

The name of the workgroup to be deleted.

Return type:

dict

Returns:

Response Syntax

{
    'workgroup': {
        'baseCapacity': 123,
        'configParameters': [
            {
                'parameterKey': 'string',
                'parameterValue': 'string'
            },
        ],
        'creationDate': datetime(2015, 1, 1),
        'crossAccountVpcs': [
            'string',
        ],
        'customDomainCertificateArn': 'string',
        'customDomainCertificateExpiryTime': datetime(2015, 1, 1),
        'customDomainName': 'string',
        'endpoint': {
            'address': 'string',
            'port': 123,
            'vpcEndpoints': [
                {
                    'networkInterfaces': [
                        {
                            'availabilityZone': 'string',
                            'ipv6Address': 'string',
                            'networkInterfaceId': 'string',
                            'privateIpAddress': 'string',
                            'subnetId': 'string'
                        },
                    ],
                    'vpcEndpointId': 'string',
                    'vpcId': 'string'
                },
            ]
        },
        'enhancedVpcRouting': True|False,
        'ipAddressType': 'string',
        'maxCapacity': 123,
        'namespaceName': 'string',
        'patchVersion': 'string',
        'pendingTrackName': 'string',
        'port': 123,
        'pricePerformanceTarget': {
            'level': 123,
            'status': 'ENABLED'|'DISABLED'
        },
        'publiclyAccessible': True|False,
        'securityGroupIds': [
            'string',
        ],
        'status': 'CREATING'|'AVAILABLE'|'MODIFYING'|'DELETING',
        'subnetIds': [
            'string',
        ],
        'trackName': 'string',
        'workgroupArn': 'string',
        'workgroupId': 'string',
        'workgroupName': 'string',
        'workgroupVersion': 'string'
    }
}

Response Structure

• (dict) –

  • workgroup (dict) –

    The deleted workgroup object.

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

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

        • parameterValue (string) –

          The value of the parameter to set.

    • creationDate (datetime) –

      The creation date of the workgroup.

    • crossAccountVpcs (list) –

      A list of VPCs. Each entry is the unique identifier of a virtual private cloud with access to Amazon Redshift Serverless. If all of the VPCs for the grantee are allowed, it shows an asterisk.

      • (string) –

    • customDomainCertificateArn (string) –

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

    • customDomainCertificateExpiryTime (datetime) –

      The expiration time for the certificate.

    • customDomainName (string) –

      The custom domain name associated with 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.

              • ipv6Address (string) –

                The IPv6 address of the network interface within the subnet.

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

    • ipAddressType (string) –

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

    • maxCapacity (integer) –

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

    • namespaceName (string) –

      The namespace the workgroup is associated with.

    • patchVersion (string) –

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

    • pendingTrackName (string) –

      The name for the track that you want to assign to the workgroup. When the track changes, the workgroup is switched to the latest workgroup release available for the track. At this point, the track name is applied.

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

    • pricePerformanceTarget (dict) –

      An object that represents the price performance target settings for the workgroup.

      • level (integer) –

        The target price performance level for the workgroup. Valid values include 1, 25, 50, 75, and 100. These correspond to the price performance levels LOW_COST, ECONOMICAL, BALANCED, RESOURCEFUL, and HIGH_PERFORMANCE.

      • status (string) –

        Whether the price performance target is enabled for the workgroup.

    • 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) –

    • trackName (string) –

      The name of the track for the workgroup.

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

    • workgroupVersion (string) –

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

Exceptions

• RedshiftServerless.Client.exceptions.InternalServerException

• RedshiftServerless.Client.exceptions.ResourceNotFoundException

• RedshiftServerless.Client.exceptions.ConflictException

• RedshiftServerless.Client.exceptions.ValidationException