2025/02/27 - Redshift Serverless - 2 new5 updated api methods
Changes Add track support for Redshift Serverless workgroup.
List the Amazon Redshift Serverless versions.
See also: AWS API Documentation
Request Syntax
client.list_tracks(
maxResults=123,
nextToken='string'
)
integer
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
string
If your initial ListTracksRequest operation returns a nextToken, you can include the returned nextToken in following ListTracksRequest operations, which returns results in the next page.
dict
Response Syntax
{
'nextToken': 'string',
'tracks': [
{
'trackName': 'string',
'updateTargets': [
{
'trackName': 'string',
'workgroupVersion': 'string'
},
],
'workgroupVersion': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
tracks (list) --
The returned tracks.
(dict) --
Defines a track that determines which Amazon Redshift version to apply after a new version is released. If the value for ServerlessTrack is current, the workgroup is updated to the most recently certified release. If the value is trailing, the workgroup is updated to the previously certified release.
trackName (string) --
The name of the track. Valid values are current and trailing.
updateTargets (list) --
An array of UpdateTarget objects to update with the track.
(dict) --
A track that you can switch the current track to.
trackName (string) --
The name of the new track.
workgroupVersion (string) --
The workgroup version for the new track.
workgroupVersion (string) --
The workgroup version number for the workgroup release.
Get the Redshift Serverless version for a specified track.
See also: AWS API Documentation
Request Syntax
client.get_track(
trackName='string'
)
string
[REQUIRED]
The name of the track of which its version is fetched.
dict
Response Syntax
{
'track': {
'trackName': 'string',
'updateTargets': [
{
'trackName': 'string',
'workgroupVersion': 'string'
},
],
'workgroupVersion': 'string'
}
}
Response Structure
(dict) --
track (dict) --
The version of the specified track.
trackName (string) --
The name of the track. Valid values are current and trailing.
updateTargets (list) --
An array of UpdateTarget objects to update with the track.
(dict) --
A track that you can switch the current track to.
trackName (string) --
The name of the new track.
workgroupVersion (string) --
The workgroup version for the new track.
workgroupVersion (string) --
The workgroup version number for the workgroup release.
{'trackName': 'string'}
Response {'workgroup': {'pendingTrackName': 'string', 'trackName': 'string'}}
Creates an workgroup in Amazon Redshift Serverless.
VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. If a workgroup is in an account with VPC BPA turned on, the following capabilities are blocked:
Creating a public access workgroup
Modifying a private workgroup to public
Adding a subnet with VPC BPA turned on to the workgroup when the workgroup is public
For more information about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.
See also: AWS API Documentation
Request Syntax
client.create_workgroup(
baseCapacity=123,
configParameters=[
{
'parameterKey': 'string',
'parameterValue': 'string'
},
],
enhancedVpcRouting=True|False,
ipAddressType='string',
maxCapacity=123,
namespaceName='string',
port=123,
pricePerformanceTarget={
'level': 123,
'status': 'ENABLED'|'DISABLED'
},
publiclyAccessible=True|False,
securityGroupIds=[
'string',
],
subnetIds=[
'string',
],
tags=[
{
'key': 'string',
'value': 'string'
},
],
trackName='string',
workgroupName='string'
)
integer
The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
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.
boolean
The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC instead of over the internet.
string
The IP address type that the workgroup supports. Possible values are ipv4 and dualstack.
integer
The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.
string
[REQUIRED]
The name of the namespace to associate with the workgroup.
integer
The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
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.
boolean
A value that specifies whether the workgroup can be accessed from a public network.
list
An array of security group IDs to associate with the workgroup.
(string) --
list
An array of VPC subnet IDs to associate with the workgroup.
(string) --
list
A array of tag instances.
(dict) --
A map of key-value pairs.
key (string) -- [REQUIRED]
The key to use in the tag.
value (string) -- [REQUIRED]
The value of the tag.
string
An optional parameter for the name of the track for the workgroup. If you don't provide a track name, the workgroup is assigned to the current track.
string
[REQUIRED]
The name of the created workgroup.
dict
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 created 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.
{'workgroup': {'pendingTrackName': 'string', 'trackName': 'string'}}
Deletes a workgroup.
See also: AWS API Documentation
Request Syntax
client.delete_workgroup(
workgroupName='string'
)
string
[REQUIRED]
The name of the workgroup to be deleted.
dict
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.
{'workgroup': {'pendingTrackName': 'string', 'trackName': 'string'}}
Returns information about a specific workgroup.
See also: AWS API Documentation
Request Syntax
client.get_workgroup(
workgroupName='string'
)
string
[REQUIRED]
The name of the workgroup to return information for.
dict
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 returned 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.
{'workgroups': {'pendingTrackName': 'string', 'trackName': 'string'}}
Returns information about a list of specified workgroups.
See also: AWS API Documentation
Request Syntax
client.list_workgroups(
maxResults=123,
nextToken='string',
ownerAccount='string'
)
integer
An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
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.
string
The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup.
dict
Response Syntax
{
'nextToken': 'string',
'workgroups': [
{
'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) --
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_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.
{'trackName': 'string'}
Response {'workgroup': {'pendingTrackName': 'string', 'trackName': 'string'}}
Updates a workgroup with the specified configuration settings. You can't update multiple parameters in one request. For example, you can update baseCapacity or port in a single request, but you can't update both in the same request.
VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. If a workgroup is in an account with VPC BPA turned on, the following capabilities are blocked:
Creating a public access workgroup
Modifying a private workgroup to public
Adding a subnet with VPC BPA turned on to the workgroup when the workgroup is public
For more information about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.
See also: AWS API Documentation
Request Syntax
client.update_workgroup(
baseCapacity=123,
configParameters=[
{
'parameterKey': 'string',
'parameterValue': 'string'
},
],
enhancedVpcRouting=True|False,
ipAddressType='string',
maxCapacity=123,
port=123,
pricePerformanceTarget={
'level': 123,
'status': 'ENABLED'|'DISABLED'
},
publiclyAccessible=True|False,
securityGroupIds=[
'string',
],
subnetIds=[
'string',
],
trackName='string',
workgroupName='string'
)
integer
The new base data warehouse capacity in Redshift Processing Units (RPUs).
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.
boolean
The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
string
The IP address type that the workgroup supports. Possible values are ipv4 and dualstack.
integer
The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.
integer
The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
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.
boolean
A value that specifies whether the workgroup can be accessible from a public network.
list
An array of security group IDs to associate with the workgroup.
(string) --
list
An array of VPC subnet IDs to associate with the workgroup.
(string) --
string
An optional parameter for the name of the track for the workgroup. If you don't provide a track name, the workgroup is assigned to the current track.
string
[REQUIRED]
The name of the workgroup to update. You can't update the name of a workgroup once it is created.
dict
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 updated 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.