2024/07/22 - Redshift Serverless - 10 updated api methods
Changes Adds dualstack support for Redshift Serverless workgroup.
{'endpoint': {'vpcEndpoint': {'networkInterfaces': {'ipv6Address': 'string'}}}}
Creates an Amazon Redshift Serverless managed VPC endpoint.
See also: AWS API Documentation
Request Syntax
client.create_endpoint_access(
endpointName='string',
ownerAccount='string',
subnetIds=[
'string',
],
vpcSecurityGroupIds=[
'string',
],
workgroupName='string'
)
string
[REQUIRED]
The name of the VPC endpoint. An endpoint name must contain 1-30 characters. Valid characters are A-Z, a-z, 0-9, and hyphen(-). The first character must be a letter. The name can't contain two consecutive hyphens or end with a hyphen.
string
The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup.
list
[REQUIRED]
The unique identifers of subnets from which Amazon Redshift Serverless chooses one to deploy a VPC endpoint.
(string) --
list
The unique identifiers of the security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
(string) --
string
[REQUIRED]
The name of the workgroup to associate with the VPC endpoint.
dict
Response Syntax
{
'endpoint': {
'address': 'string',
'endpointArn': 'string',
'endpointCreateTime': datetime(2015, 1, 1),
'endpointName': 'string',
'endpointStatus': 'string',
'port': 123,
'subnetIds': [
'string',
],
'vpcEndpoint': {
'networkInterfaces': [
{
'availabilityZone': 'string',
'ipv6Address': 'string',
'networkInterfaceId': 'string',
'privateIpAddress': 'string',
'subnetId': 'string'
},
],
'vpcEndpointId': 'string',
'vpcId': 'string'
},
'vpcSecurityGroups': [
{
'status': 'string',
'vpcSecurityGroupId': 'string'
},
],
'workgroupName': 'string'
}
}
Response Structure
(dict) --
endpoint (dict) --
The created VPC endpoint.
address (string) --
The DNS address of the endpoint.
endpointArn (string) --
The Amazon Resource Name (ARN) of the VPC endpoint.
endpointCreateTime (datetime) --
The time that the endpoint was created.
endpointName (string) --
The name of the VPC endpoint.
endpointStatus (string) --
The status of the VPC endpoint.
port (integer) --
The port number on which Amazon Redshift Serverless accepts incoming connections.
subnetIds (list) --
The unique identifier of subnets where Amazon Redshift Serverless choose to deploy the VPC endpoint.
(string) --
vpcEndpoint (dict) --
The connection endpoint for connecting to Amazon Redshift Serverless.
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.
vpcSecurityGroups (list) --
The security groups associated with the endpoint.
(dict) --
Describes the members of a VPC security group.
status (string) --
The status of the VPC security group.
vpcSecurityGroupId (string) --
The unique identifier of the VPC security group.
workgroupName (string) --
The name of the workgroup associated with the endpoint.
{'ipAddressType': 'string'}
Response {'workgroup': {'endpoint': {'vpcEndpoints': {'networkInterfaces': {'ipv6Address': 'string'}}},
'ipAddressType': 'string'}}
Creates an workgroup in Amazon Redshift Serverless.
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,
publiclyAccessible=True|False,
securityGroupIds=[
'string',
],
subnetIds=[
'string',
],
tags=[
{
'key': 'string',
'value': '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.
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
[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',
'port': 123,
'publiclyAccessible': True|False,
'securityGroupIds': [
'string',
],
'status': 'CREATING'|'AVAILABLE'|'MODIFYING'|'DELETING',
'subnetIds': [
'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.
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.
workgroupVersion (string) --
The Amazon Redshift Serverless version of your workgroup. For more information about Amazon Redshift Serverless versions, see Cluster versions for Amazon Redshift.
{'endpoint': {'vpcEndpoint': {'networkInterfaces': {'ipv6Address': 'string'}}}}
Deletes an Amazon Redshift Serverless managed VPC endpoint.
See also: AWS API Documentation
Request Syntax
client.delete_endpoint_access(
endpointName='string'
)
string
[REQUIRED]
The name of the VPC endpoint to delete.
dict
Response Syntax
{
'endpoint': {
'address': 'string',
'endpointArn': 'string',
'endpointCreateTime': datetime(2015, 1, 1),
'endpointName': 'string',
'endpointStatus': 'string',
'port': 123,
'subnetIds': [
'string',
],
'vpcEndpoint': {
'networkInterfaces': [
{
'availabilityZone': 'string',
'ipv6Address': 'string',
'networkInterfaceId': 'string',
'privateIpAddress': 'string',
'subnetId': 'string'
},
],
'vpcEndpointId': 'string',
'vpcId': 'string'
},
'vpcSecurityGroups': [
{
'status': 'string',
'vpcSecurityGroupId': 'string'
},
],
'workgroupName': 'string'
}
}
Response Structure
(dict) --
endpoint (dict) --
The deleted VPC endpoint.
address (string) --
The DNS address of the endpoint.
endpointArn (string) --
The Amazon Resource Name (ARN) of the VPC endpoint.
endpointCreateTime (datetime) --
The time that the endpoint was created.
endpointName (string) --
The name of the VPC endpoint.
endpointStatus (string) --
The status of the VPC endpoint.
port (integer) --
The port number on which Amazon Redshift Serverless accepts incoming connections.
subnetIds (list) --
The unique identifier of subnets where Amazon Redshift Serverless choose to deploy the VPC endpoint.
(string) --
vpcEndpoint (dict) --
The connection endpoint for connecting to Amazon Redshift Serverless.
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.
vpcSecurityGroups (list) --
The security groups associated with the endpoint.
(dict) --
Describes the members of a VPC security group.
status (string) --
The status of the VPC security group.
vpcSecurityGroupId (string) --
The unique identifier of the VPC security group.
workgroupName (string) --
The name of the workgroup associated with the endpoint.
{'workgroup': {'endpoint': {'vpcEndpoints': {'networkInterfaces': {'ipv6Address': 'string'}}},
'ipAddressType': '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',
'port': 123,
'publiclyAccessible': True|False,
'securityGroupIds': [
'string',
],
'status': 'CREATING'|'AVAILABLE'|'MODIFYING'|'DELETING',
'subnetIds': [
'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.
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.
workgroupVersion (string) --
The Amazon Redshift Serverless version of your workgroup. For more information about Amazon Redshift Serverless versions, see Cluster versions for Amazon Redshift.
{'endpoint': {'vpcEndpoint': {'networkInterfaces': {'ipv6Address': 'string'}}}}
Returns information, such as the name, about a VPC endpoint.
See also: AWS API Documentation
Request Syntax
client.get_endpoint_access(
endpointName='string'
)
string
[REQUIRED]
The name of the VPC endpoint to return information for.
dict
Response Syntax
{
'endpoint': {
'address': 'string',
'endpointArn': 'string',
'endpointCreateTime': datetime(2015, 1, 1),
'endpointName': 'string',
'endpointStatus': 'string',
'port': 123,
'subnetIds': [
'string',
],
'vpcEndpoint': {
'networkInterfaces': [
{
'availabilityZone': 'string',
'ipv6Address': 'string',
'networkInterfaceId': 'string',
'privateIpAddress': 'string',
'subnetId': 'string'
},
],
'vpcEndpointId': 'string',
'vpcId': 'string'
},
'vpcSecurityGroups': [
{
'status': 'string',
'vpcSecurityGroupId': 'string'
},
],
'workgroupName': 'string'
}
}
Response Structure
(dict) --
endpoint (dict) --
The returned VPC endpoint.
address (string) --
The DNS address of the endpoint.
endpointArn (string) --
The Amazon Resource Name (ARN) of the VPC endpoint.
endpointCreateTime (datetime) --
The time that the endpoint was created.
endpointName (string) --
The name of the VPC endpoint.
endpointStatus (string) --
The status of the VPC endpoint.
port (integer) --
The port number on which Amazon Redshift Serverless accepts incoming connections.
subnetIds (list) --
The unique identifier of subnets where Amazon Redshift Serverless choose to deploy the VPC endpoint.
(string) --
vpcEndpoint (dict) --
The connection endpoint for connecting to Amazon Redshift Serverless.
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.
vpcSecurityGroups (list) --
The security groups associated with the endpoint.
(dict) --
Describes the members of a VPC security group.
status (string) --
The status of the VPC security group.
vpcSecurityGroupId (string) --
The unique identifier of the VPC security group.
workgroupName (string) --
The name of the workgroup associated with the endpoint.
{'workgroup': {'endpoint': {'vpcEndpoints': {'networkInterfaces': {'ipv6Address': 'string'}}},
'ipAddressType': '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',
'port': 123,
'publiclyAccessible': True|False,
'securityGroupIds': [
'string',
],
'status': 'CREATING'|'AVAILABLE'|'MODIFYING'|'DELETING',
'subnetIds': [
'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.
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.
workgroupVersion (string) --
The Amazon Redshift Serverless version of your workgroup. For more information about Amazon Redshift Serverless versions, see Cluster versions for Amazon Redshift.
{'endpoints': {'vpcEndpoint': {'networkInterfaces': {'ipv6Address': 'string'}}}}
Returns an array of EndpointAccess objects and relevant information.
See also: AWS API Documentation
Request Syntax
client.list_endpoint_access(
maxResults=123,
nextToken='string',
ownerAccount='string',
vpcId='string',
workgroupName='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 ListEndpointAccess operation returns a nextToken, you can include the returned nextToken in following ListEndpointAccess operations, which returns results in the next page.
string
The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup.
string
The unique identifier of the virtual private cloud with access to Amazon Redshift Serverless.
string
The name of the workgroup associated with the VPC endpoint to return.
dict
Response Syntax
{
'endpoints': [
{
'address': 'string',
'endpointArn': 'string',
'endpointCreateTime': datetime(2015, 1, 1),
'endpointName': 'string',
'endpointStatus': 'string',
'port': 123,
'subnetIds': [
'string',
],
'vpcEndpoint': {
'networkInterfaces': [
{
'availabilityZone': 'string',
'ipv6Address': 'string',
'networkInterfaceId': 'string',
'privateIpAddress': 'string',
'subnetId': 'string'
},
],
'vpcEndpointId': 'string',
'vpcId': 'string'
},
'vpcSecurityGroups': [
{
'status': 'string',
'vpcSecurityGroupId': 'string'
},
],
'workgroupName': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
endpoints (list) --
The returned VPC endpoints.
(dict) --
Information about an Amazon Redshift Serverless VPC endpoint.
address (string) --
The DNS address of the endpoint.
endpointArn (string) --
The Amazon Resource Name (ARN) of the VPC endpoint.
endpointCreateTime (datetime) --
The time that the endpoint was created.
endpointName (string) --
The name of the VPC endpoint.
endpointStatus (string) --
The status of the VPC endpoint.
port (integer) --
The port number on which Amazon Redshift Serverless accepts incoming connections.
subnetIds (list) --
The unique identifier of subnets where Amazon Redshift Serverless choose to deploy the VPC endpoint.
(string) --
vpcEndpoint (dict) --
The connection endpoint for connecting to Amazon Redshift Serverless.
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.
vpcSecurityGroups (list) --
The security groups associated with the endpoint.
(dict) --
Describes the members of a VPC security group.
status (string) --
The status of the VPC security group.
vpcSecurityGroupId (string) --
The unique identifier of the VPC security group.
workgroupName (string) --
The name of the workgroup associated with the endpoint.
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.
{'workgroups': {'endpoint': {'vpcEndpoints': {'networkInterfaces': {'ipv6Address': 'string'}}},
'ipAddressType': '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',
'port': 123,
'publiclyAccessible': True|False,
'securityGroupIds': [
'string',
],
'status': 'CREATING'|'AVAILABLE'|'MODIFYING'|'DELETING',
'subnetIds': [
'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.
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.
workgroupVersion (string) --
The Amazon Redshift Serverless version of your workgroup. For more information about Amazon Redshift Serverless versions, see Cluster versions for Amazon Redshift.
{'endpoint': {'vpcEndpoint': {'networkInterfaces': {'ipv6Address': 'string'}}}}
Updates an Amazon Redshift Serverless managed endpoint.
See also: AWS API Documentation
Request Syntax
client.update_endpoint_access(
endpointName='string',
vpcSecurityGroupIds=[
'string',
]
)
string
[REQUIRED]
The name of the VPC endpoint to update.
list
The list of VPC security groups associated with the endpoint after the endpoint is modified.
(string) --
dict
Response Syntax
{
'endpoint': {
'address': 'string',
'endpointArn': 'string',
'endpointCreateTime': datetime(2015, 1, 1),
'endpointName': 'string',
'endpointStatus': 'string',
'port': 123,
'subnetIds': [
'string',
],
'vpcEndpoint': {
'networkInterfaces': [
{
'availabilityZone': 'string',
'ipv6Address': 'string',
'networkInterfaceId': 'string',
'privateIpAddress': 'string',
'subnetId': 'string'
},
],
'vpcEndpointId': 'string',
'vpcId': 'string'
},
'vpcSecurityGroups': [
{
'status': 'string',
'vpcSecurityGroupId': 'string'
},
],
'workgroupName': 'string'
}
}
Response Structure
(dict) --
endpoint (dict) --
The updated VPC endpoint.
address (string) --
The DNS address of the endpoint.
endpointArn (string) --
The Amazon Resource Name (ARN) of the VPC endpoint.
endpointCreateTime (datetime) --
The time that the endpoint was created.
endpointName (string) --
The name of the VPC endpoint.
endpointStatus (string) --
The status of the VPC endpoint.
port (integer) --
The port number on which Amazon Redshift Serverless accepts incoming connections.
subnetIds (list) --
The unique identifier of subnets where Amazon Redshift Serverless choose to deploy the VPC endpoint.
(string) --
vpcEndpoint (dict) --
The connection endpoint for connecting to Amazon Redshift Serverless.
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.
vpcSecurityGroups (list) --
The security groups associated with the endpoint.
(dict) --
Describes the members of a VPC security group.
status (string) --
The status of the VPC security group.
vpcSecurityGroupId (string) --
The unique identifier of the VPC security group.
workgroupName (string) --
The name of the workgroup associated with the endpoint.
{'ipAddressType': 'string'}
Response {'workgroup': {'endpoint': {'vpcEndpoints': {'networkInterfaces': {'ipv6Address': 'string'}}},
'ipAddressType': '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.
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,
publiclyAccessible=True|False,
securityGroupIds=[
'string',
],
subnetIds=[
'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.
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
[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',
'port': 123,
'publiclyAccessible': True|False,
'securityGroupIds': [
'string',
],
'status': 'CREATING'|'AVAILABLE'|'MODIFYING'|'DELETING',
'subnetIds': [
'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.
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.
workgroupVersion (string) --
The Amazon Redshift Serverless version of your workgroup. For more information about Amazon Redshift Serverless versions, see Cluster versions for Amazon Redshift.