2022/12/02 - Redshift Serverless - 3 new 9 updated api methods
Changes Add Table Level Restore operations for Amazon Redshift Serverless. Add multi-port support for Amazon Redshift Serverless endpoints. Add Tagging support to Snapshots and Recovery Points in Amazon Redshift Serverless.
Restores a table from a snapshot to your Amazon Redshift Serverless instance.
See also: AWS API Documentation
Request Syntax
client.restore_table_from_snapshot(
activateCaseSensitiveIdentifier=True|False,
namespaceName='string',
newTableName='string',
snapshotName='string',
sourceDatabaseName='string',
sourceSchemaName='string',
sourceTableName='string',
targetDatabaseName='string',
targetSchemaName='string',
workgroupName='string'
)
boolean
Indicates whether name identifiers for database, schema, and table are case sensitive. If true, the names are case sensitive. If false, the names are not case sensitive. The default is false.
string
[REQUIRED]
The namespace of the snapshot to restore from.
string
[REQUIRED]
The name of the table to create from the restore operation.
string
[REQUIRED]
The name of the snapshot to restore the table from.
string
[REQUIRED]
The name of the source database that contains the table being restored.
string
The name of the source schema that contains the table being restored.
string
[REQUIRED]
The name of the source table being restored.
string
The name of the database to restore the table to.
string
The name of the schema to restore the table to.
string
[REQUIRED]
The workgroup to restore the table to.
dict
Response Syntax
{
'tableRestoreStatus': {
'message': 'string',
'namespaceName': 'string',
'newTableName': 'string',
'progressInMegaBytes': 123,
'requestTime': datetime(2015, 1, 1),
'snapshotName': 'string',
'sourceDatabaseName': 'string',
'sourceSchemaName': 'string',
'sourceTableName': 'string',
'status': 'string',
'tableRestoreRequestId': 'string',
'targetDatabaseName': 'string',
'targetSchemaName': 'string',
'totalDataInMegaBytes': 123,
'workgroupName': 'string'
}
}
Response Structure
(dict) --
tableRestoreStatus (dict) --
The TableRestoreStatus object that contains the status of the restore operation.
message (string) --
A description of the status of the table restore request. Status values include SUCCEEDED , FAILED , CANCELED , PENDING , IN_PROGRESS .
namespaceName (string) --
The namespace of the table being restored from.
newTableName (string) --
The name of the table to create from the restore operation.
progressInMegaBytes (integer) --
The amount of data restored to the new table so far, in megabytes (MB).
requestTime (datetime) --
The time that the table restore request was made, in Universal Coordinated Time (UTC).
snapshotName (string) --
The name of the snapshot being restored from.
sourceDatabaseName (string) --
The name of the source database being restored from.
sourceSchemaName (string) --
The name of the source schema being restored from.
sourceTableName (string) --
The name of the source table being restored from.
status (string) --
A value that describes the current state of the table restore request. Possible values include SUCCEEDED , FAILED , CANCELED , PENDING , IN_PROGRESS .
tableRestoreRequestId (string) --
The ID of the RestoreTableFromSnapshot request.
targetDatabaseName (string) --
The name of the database to restore to.
targetSchemaName (string) --
The name of the schema to restore to.
totalDataInMegaBytes (integer) --
The total amount of data to restore to the new table, in megabytes (MB).
workgroupName (string) --
The name of the workgroup being restored from.
Returns information about an array of TableRestoreStatus objects.
See also: AWS API Documentation
Request Syntax
client.list_table_restore_status(
maxResults=123,
namespaceName='string',
nextToken='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
The namespace from which to list all of the statuses of RestoreTableFromSnapshot operations .
string
If your initial ListTableRestoreStatus operation returns a nextToken, you can include the returned nextToken in following ListTableRestoreStatus operations. This will return results on the next page.
string
The workgroup from which to list all of the statuses of RestoreTableFromSnapshot operations.
dict
Response Syntax
{
'nextToken': 'string',
'tableRestoreStatuses': [
{
'message': 'string',
'namespaceName': 'string',
'newTableName': 'string',
'progressInMegaBytes': 123,
'requestTime': datetime(2015, 1, 1),
'snapshotName': 'string',
'sourceDatabaseName': 'string',
'sourceSchemaName': 'string',
'sourceTableName': 'string',
'status': 'string',
'tableRestoreRequestId': 'string',
'targetDatabaseName': 'string',
'targetSchemaName': 'string',
'totalDataInMegaBytes': 123,
'workgroupName': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
If your initial ListTableRestoreStatus operation returns a nextToken , you can include the returned nextToken in following ListTableRestoreStatus operations. This will returns results on the next page.
tableRestoreStatuses (list) --
The array of returned TableRestoreStatus objects.
(dict) --
Contains information about a table restore request.
message (string) --
A description of the status of the table restore request. Status values include SUCCEEDED , FAILED , CANCELED , PENDING , IN_PROGRESS .
namespaceName (string) --
The namespace of the table being restored from.
newTableName (string) --
The name of the table to create from the restore operation.
progressInMegaBytes (integer) --
The amount of data restored to the new table so far, in megabytes (MB).
requestTime (datetime) --
The time that the table restore request was made, in Universal Coordinated Time (UTC).
snapshotName (string) --
The name of the snapshot being restored from.
sourceDatabaseName (string) --
The name of the source database being restored from.
sourceSchemaName (string) --
The name of the source schema being restored from.
sourceTableName (string) --
The name of the source table being restored from.
status (string) --
A value that describes the current state of the table restore request. Possible values include SUCCEEDED , FAILED , CANCELED , PENDING , IN_PROGRESS .
tableRestoreRequestId (string) --
The ID of the RestoreTableFromSnapshot request.
targetDatabaseName (string) --
The name of the database to restore to.
targetSchemaName (string) --
The name of the schema to restore to.
totalDataInMegaBytes (integer) --
The total amount of data to restore to the new table, in megabytes (MB).
workgroupName (string) --
The name of the workgroup being restored from.
Returns information about a TableRestoreStatus object.
See also: AWS API Documentation
Request Syntax
client.get_table_restore_status(
tableRestoreRequestId='string'
)
string
[REQUIRED]
The ID of the RestoreTableFromSnapshot request to return status for.
dict
Response Syntax
{
'tableRestoreStatus': {
'message': 'string',
'namespaceName': 'string',
'newTableName': 'string',
'progressInMegaBytes': 123,
'requestTime': datetime(2015, 1, 1),
'snapshotName': 'string',
'sourceDatabaseName': 'string',
'sourceSchemaName': 'string',
'sourceTableName': 'string',
'status': 'string',
'tableRestoreRequestId': 'string',
'targetDatabaseName': 'string',
'targetSchemaName': 'string',
'totalDataInMegaBytes': 123,
'workgroupName': 'string'
}
}
Response Structure
(dict) --
tableRestoreStatus (dict) --
The returned TableRestoreStatus object that contains information about the status of your RestoreTableFromSnapshot request.
message (string) --
A description of the status of the table restore request. Status values include SUCCEEDED , FAILED , CANCELED , PENDING , IN_PROGRESS .
namespaceName (string) --
The namespace of the table being restored from.
newTableName (string) --
The name of the table to create from the restore operation.
progressInMegaBytes (integer) --
The amount of data restored to the new table so far, in megabytes (MB).
requestTime (datetime) --
The time that the table restore request was made, in Universal Coordinated Time (UTC).
snapshotName (string) --
The name of the snapshot being restored from.
sourceDatabaseName (string) --
The name of the source database being restored from.
sourceSchemaName (string) --
The name of the source schema being restored from.
sourceTableName (string) --
The name of the source table being restored from.
status (string) --
A value that describes the current state of the table restore request. Possible values include SUCCEEDED , FAILED , CANCELED , PENDING , IN_PROGRESS .
tableRestoreRequestId (string) --
The ID of the RestoreTableFromSnapshot request.
targetDatabaseName (string) --
The name of the database to restore to.
targetSchemaName (string) --
The name of the schema to restore to.
totalDataInMegaBytes (integer) --
The total amount of data to restore to the new table, in megabytes (MB).
workgroupName (string) --
The name of the workgroup being restored from.
{'tags': [{'key': 'string', 'value': 'string'}]}
Converts a recovery point to a snapshot. For more information about recovery points and snapshots, see Working with snapshots and recovery points.
See also: AWS API Documentation
Request Syntax
client.convert_recovery_point_to_snapshot(
recoveryPointId='string',
retentionPeriod=123,
snapshotName='string',
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
string
[REQUIRED]
The unique identifier of the recovery point.
integer
How long to retain the snapshot.
string
[REQUIRED]
The name of the snapshot.
list
An array of Tag objects to associate with the created snapshot.
(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.
dict
Response Syntax
{
'snapshot': {
'accountsWithProvisionedRestoreAccess': [
'string',
],
'accountsWithRestoreAccess': [
'string',
],
'actualIncrementalBackupSizeInMegaBytes': 123.0,
'adminUsername': 'string',
'backupProgressInMegaBytes': 123.0,
'currentBackupRateInMegaBytesPerSecond': 123.0,
'elapsedTimeInSeconds': 123,
'estimatedSecondsToCompletion': 123,
'kmsKeyId': 'string',
'namespaceArn': 'string',
'namespaceName': 'string',
'ownerAccount': 'string',
'snapshotArn': 'string',
'snapshotCreateTime': datetime(2015, 1, 1),
'snapshotName': 'string',
'snapshotRemainingDays': 123,
'snapshotRetentionPeriod': 123,
'snapshotRetentionStartTime': datetime(2015, 1, 1),
'status': 'AVAILABLE'|'CREATING'|'DELETED'|'CANCELLED'|'FAILED'|'COPYING',
'totalBackupSizeInMegaBytes': 123.0
}
}
Response Structure
(dict) --
snapshot (dict) --
The snapshot converted from the recovery point.
accountsWithProvisionedRestoreAccess (list) --
All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.
(string) --
accountsWithRestoreAccess (list) --
All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.
(string) --
actualIncrementalBackupSizeInMegaBytes (float) --
The size of the incremental backup in megabytes.
adminUsername (string) --
The username of the database within a snapshot.
backupProgressInMegaBytes (float) --
The size in megabytes of the data that has been backed up to a snapshot.
currentBackupRateInMegaBytesPerSecond (float) --
The rate at which data is backed up into a snapshot in megabytes per second.
elapsedTimeInSeconds (integer) --
The amount of time it took to back up data into a snapshot.
estimatedSecondsToCompletion (integer) --
The estimated amount of seconds until the snapshot completes backup.
kmsKeyId (string) --
The unique identifier of the KMS key used to encrypt the snapshot.
namespaceArn (string) --
The Amazon Resource Name (ARN) of the namespace the snapshot was created from.
namespaceName (string) --
The name of the namepsace.
ownerAccount (string) --
The owner Amazon Web Services; account of the snapshot.
snapshotArn (string) --
The Amazon Resource Name (ARN) of the snapshot.
snapshotCreateTime (datetime) --
The timestamp of when the snapshot was created.
snapshotName (string) --
The name of the snapshot.
snapshotRemainingDays (integer) --
The amount of days until the snapshot is deleted.
snapshotRetentionPeriod (integer) --
The period of time, in days, of how long the snapshot is retained.
snapshotRetentionStartTime (datetime) --
The timestamp of when data within the snapshot started getting retained.
status (string) --
The status of the snapshot.
totalBackupSizeInMegaBytes (float) --
The total size, in megabytes, of how big the snapshot is.
{'tags': [{'key': 'string', 'value': 'string'}]}
Creates a snapshot of all databases in a namespace. For more information about snapshots, see Working with snapshots and recovery points.
See also: AWS API Documentation
Request Syntax
client.create_snapshot(
namespaceName='string',
retentionPeriod=123,
snapshotName='string',
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
string
[REQUIRED]
The namespace to create a snapshot for.
integer
How long to retain the created snapshot.
string
[REQUIRED]
The name of the snapshot.
list
An array of Tag objects to associate with the snapshot.
(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.
dict
Response Syntax
{
'snapshot': {
'accountsWithProvisionedRestoreAccess': [
'string',
],
'accountsWithRestoreAccess': [
'string',
],
'actualIncrementalBackupSizeInMegaBytes': 123.0,
'adminUsername': 'string',
'backupProgressInMegaBytes': 123.0,
'currentBackupRateInMegaBytesPerSecond': 123.0,
'elapsedTimeInSeconds': 123,
'estimatedSecondsToCompletion': 123,
'kmsKeyId': 'string',
'namespaceArn': 'string',
'namespaceName': 'string',
'ownerAccount': 'string',
'snapshotArn': 'string',
'snapshotCreateTime': datetime(2015, 1, 1),
'snapshotName': 'string',
'snapshotRemainingDays': 123,
'snapshotRetentionPeriod': 123,
'snapshotRetentionStartTime': datetime(2015, 1, 1),
'status': 'AVAILABLE'|'CREATING'|'DELETED'|'CANCELLED'|'FAILED'|'COPYING',
'totalBackupSizeInMegaBytes': 123.0
}
}
Response Structure
(dict) --
snapshot (dict) --
The created snapshot object.
accountsWithProvisionedRestoreAccess (list) --
All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.
(string) --
accountsWithRestoreAccess (list) --
All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.
(string) --
actualIncrementalBackupSizeInMegaBytes (float) --
The size of the incremental backup in megabytes.
adminUsername (string) --
The username of the database within a snapshot.
backupProgressInMegaBytes (float) --
The size in megabytes of the data that has been backed up to a snapshot.
currentBackupRateInMegaBytesPerSecond (float) --
The rate at which data is backed up into a snapshot in megabytes per second.
elapsedTimeInSeconds (integer) --
The amount of time it took to back up data into a snapshot.
estimatedSecondsToCompletion (integer) --
The estimated amount of seconds until the snapshot completes backup.
kmsKeyId (string) --
The unique identifier of the KMS key used to encrypt the snapshot.
namespaceArn (string) --
The Amazon Resource Name (ARN) of the namespace the snapshot was created from.
namespaceName (string) --
The name of the namepsace.
ownerAccount (string) --
The owner Amazon Web Services; account of the snapshot.
snapshotArn (string) --
The Amazon Resource Name (ARN) of the snapshot.
snapshotCreateTime (datetime) --
The timestamp of when the snapshot was created.
snapshotName (string) --
The name of the snapshot.
snapshotRemainingDays (integer) --
The amount of days until the snapshot is deleted.
snapshotRetentionPeriod (integer) --
The period of time, in days, of how long the snapshot is retained.
snapshotRetentionStartTime (datetime) --
The timestamp of when data within the snapshot started getting retained.
status (string) --
The status of the snapshot.
totalBackupSizeInMegaBytes (float) --
The total size, in megabytes, of how big the snapshot is.
{'port': 'integer'}
Response {'workgroup': {'port': 'integer'}}
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,
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 more control over a serverless database. The options are datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .
(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 datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .
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
[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),
'endpoint': {
'address': 'string',
'port': 123,
'vpcEndpoints': [
{
'networkInterfaces': [
{
'availabilityZone': 'string',
'networkInterfaceId': 'string',
'privateIpAddress': 'string',
'subnetId': 'string'
},
],
'vpcEndpointId': 'string',
'vpcId': 'string'
},
]
},
'enhancedVpcRouting': True|False,
'namespaceName': 'string',
'port': 123,
'publiclyAccessible': True|False,
'securityGroupIds': [
'string',
],
'status': 'CREATING'|'AVAILABLE'|'MODIFYING'|'DELETING',
'subnetIds': [
'string',
],
'workgroupArn': 'string',
'workgroupId': 'string',
'workgroupName': 'string'
}
}
Response Structure
(dict) --
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 finer control over a database. The options are datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .
(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 datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .
parameterValue (string) --
The value of the parameter to set.
creationDate (datetime) --
The creation date of the workgroup.
endpoint (dict) --
The endpoint that is created from the workgroup.
address (string) --
The DNS address of the VPC endpoint.
port (integer) --
The port that Amazon Redshift Serverless listens on.
vpcEndpoints (list) --
An array of VpcEndpoint objects.
(dict) --
The connection endpoint for connecting to Amazon Redshift Serverless through the proxy.
networkInterfaces (list) --
One or more network interfaces of the endpoint. Also known as an interface endpoint.
(dict) --
Contains information about a network interface in an Amazon Redshift Serverless managed VPC endpoint.
availabilityZone (string) --
The availability Zone.
networkInterfaceId (string) --
The unique identifier of the network interface.
privateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
subnetId (string) --
The unique identifier of the subnet.
vpcEndpointId (string) --
The connection endpoint ID for connecting to Amazon Redshift Serverless.
vpcId (string) --
The VPC identifier that the endpoint is associated with.
enhancedVpcRouting (boolean) --
The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
namespaceName (string) --
The namespace the workgroup is associated with.
port (integer) --
The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
publiclyAccessible (boolean) --
A value that specifies whether the workgroup can be accessible from a public network
securityGroupIds (list) --
An array of security group IDs to associate with the workgroup.
(string) --
status (string) --
The status of the workgroup.
subnetIds (list) --
An array of subnet IDs the workgroup is associated with.
(string) --
workgroupArn (string) --
The Amazon Resource Name (ARN) that links to the workgroup.
workgroupId (string) --
The unique identifier of the workgroup.
workgroupName (string) --
The name of the workgroup.
{'workgroup': {'port': 'integer'}}
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),
'endpoint': {
'address': 'string',
'port': 123,
'vpcEndpoints': [
{
'networkInterfaces': [
{
'availabilityZone': 'string',
'networkInterfaceId': 'string',
'privateIpAddress': 'string',
'subnetId': 'string'
},
],
'vpcEndpointId': 'string',
'vpcId': 'string'
},
]
},
'enhancedVpcRouting': True|False,
'namespaceName': 'string',
'port': 123,
'publiclyAccessible': True|False,
'securityGroupIds': [
'string',
],
'status': 'CREATING'|'AVAILABLE'|'MODIFYING'|'DELETING',
'subnetIds': [
'string',
],
'workgroupArn': 'string',
'workgroupId': 'string',
'workgroupName': 'string'
}
}
Response Structure
(dict) --
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 finer control over a database. The options are datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .
(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 datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .
parameterValue (string) --
The value of the parameter to set.
creationDate (datetime) --
The creation date of the workgroup.
endpoint (dict) --
The endpoint that is created from the workgroup.
address (string) --
The DNS address of the VPC endpoint.
port (integer) --
The port that Amazon Redshift Serverless listens on.
vpcEndpoints (list) --
An array of VpcEndpoint objects.
(dict) --
The connection endpoint for connecting to Amazon Redshift Serverless through the proxy.
networkInterfaces (list) --
One or more network interfaces of the endpoint. Also known as an interface endpoint.
(dict) --
Contains information about a network interface in an Amazon Redshift Serverless managed VPC endpoint.
availabilityZone (string) --
The availability Zone.
networkInterfaceId (string) --
The unique identifier of the network interface.
privateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
subnetId (string) --
The unique identifier of the subnet.
vpcEndpointId (string) --
The connection endpoint ID for connecting to Amazon Redshift Serverless.
vpcId (string) --
The VPC identifier that the endpoint is associated with.
enhancedVpcRouting (boolean) --
The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
namespaceName (string) --
The namespace the workgroup is associated with.
port (integer) --
The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
publiclyAccessible (boolean) --
A value that specifies whether the workgroup can be accessible from a public network
securityGroupIds (list) --
An array of security group IDs to associate with the workgroup.
(string) --
status (string) --
The status of the workgroup.
subnetIds (list) --
An array of subnet IDs the workgroup is associated with.
(string) --
workgroupArn (string) --
The Amazon Resource Name (ARN) that links to the workgroup.
workgroupId (string) --
The unique identifier of the workgroup.
workgroupName (string) --
The name of the workgroup.
{'recoveryPoint': {'namespaceArn': 'string'}}
Returns information about a recovery point.
See also: AWS API Documentation
Request Syntax
client.get_recovery_point(
recoveryPointId='string'
)
string
[REQUIRED]
The unique identifier of the recovery point to return information for.
dict
Response Syntax
{
'recoveryPoint': {
'namespaceArn': 'string',
'namespaceName': 'string',
'recoveryPointCreateTime': datetime(2015, 1, 1),
'recoveryPointId': 'string',
'totalSizeInMegaBytes': 123.0,
'workgroupName': 'string'
}
}
Response Structure
(dict) --
recoveryPoint (dict) --
The returned recovery point object.
namespaceArn (string) --
The Amazon Resource Name (ARN) of the namespace the recovery point is associated with.
namespaceName (string) --
The name of the namespace the recovery point is associated with.
recoveryPointCreateTime (datetime) --
The time the recovery point is created.
recoveryPointId (string) --
The unique identifier of the recovery point.
totalSizeInMegaBytes (float) --
The total size of the data in the recovery point in megabytes.
workgroupName (string) --
The name of the workgroup the recovery point is associated with.
{'workgroup': {'port': 'integer'}}
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),
'endpoint': {
'address': 'string',
'port': 123,
'vpcEndpoints': [
{
'networkInterfaces': [
{
'availabilityZone': 'string',
'networkInterfaceId': 'string',
'privateIpAddress': 'string',
'subnetId': 'string'
},
],
'vpcEndpointId': 'string',
'vpcId': 'string'
},
]
},
'enhancedVpcRouting': True|False,
'namespaceName': 'string',
'port': 123,
'publiclyAccessible': True|False,
'securityGroupIds': [
'string',
],
'status': 'CREATING'|'AVAILABLE'|'MODIFYING'|'DELETING',
'subnetIds': [
'string',
],
'workgroupArn': 'string',
'workgroupId': 'string',
'workgroupName': 'string'
}
}
Response Structure
(dict) --
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 finer control over a database. The options are datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .
(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 datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .
parameterValue (string) --
The value of the parameter to set.
creationDate (datetime) --
The creation date of the workgroup.
endpoint (dict) --
The endpoint that is created from the workgroup.
address (string) --
The DNS address of the VPC endpoint.
port (integer) --
The port that Amazon Redshift Serverless listens on.
vpcEndpoints (list) --
An array of VpcEndpoint objects.
(dict) --
The connection endpoint for connecting to Amazon Redshift Serverless through the proxy.
networkInterfaces (list) --
One or more network interfaces of the endpoint. Also known as an interface endpoint.
(dict) --
Contains information about a network interface in an Amazon Redshift Serverless managed VPC endpoint.
availabilityZone (string) --
The availability Zone.
networkInterfaceId (string) --
The unique identifier of the network interface.
privateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
subnetId (string) --
The unique identifier of the subnet.
vpcEndpointId (string) --
The connection endpoint ID for connecting to Amazon Redshift Serverless.
vpcId (string) --
The VPC identifier that the endpoint is associated with.
enhancedVpcRouting (boolean) --
The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
namespaceName (string) --
The namespace the workgroup is associated with.
port (integer) --
The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
publiclyAccessible (boolean) --
A value that specifies whether the workgroup can be accessible from a public network
securityGroupIds (list) --
An array of security group IDs to associate with the workgroup.
(string) --
status (string) --
The status of the workgroup.
subnetIds (list) --
An array of subnet IDs the workgroup is associated with.
(string) --
workgroupArn (string) --
The Amazon Resource Name (ARN) that links to the workgroup.
workgroupId (string) --
The unique identifier of the workgroup.
workgroupName (string) --
The name of the workgroup.
{'namespaceArn': 'string'}
Response {'recoveryPoints': {'namespaceArn': 'string'}}
Returns an array of recovery points.
See also: AWS API Documentation
Request Syntax
client.list_recovery_points(
endTime=datetime(2015, 1, 1),
maxResults=123,
namespaceArn='string',
namespaceName='string',
nextToken='string',
startTime=datetime(2015, 1, 1)
)
datetime
The time when creation of the recovery point finished.
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
The Amazon Resource Name (ARN) of the namespace from which to list recovery points.
string
The name of the namespace to list recovery points for.
string
If your initial ListRecoveryPoints operation returns a nextToken , you can include the returned nextToken in following ListRecoveryPoints operations, which returns results in the next page.
datetime
The time when the recovery point's creation was initiated.
dict
Response Syntax
{
'nextToken': 'string',
'recoveryPoints': [
{
'namespaceArn': 'string',
'namespaceName': 'string',
'recoveryPointCreateTime': datetime(2015, 1, 1),
'recoveryPointId': 'string',
'totalSizeInMegaBytes': 123.0,
'workgroupName': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
recoveryPoints (list) --
The returned recovery point objects.
(dict) --
The automatically created recovery point of a namespace. Recovery points are created every 30 minutes and kept for 24 hours.
namespaceArn (string) --
The Amazon Resource Name (ARN) of the namespace the recovery point is associated with.
namespaceName (string) --
The name of the namespace the recovery point is associated with.
recoveryPointCreateTime (datetime) --
The time the recovery point is created.
recoveryPointId (string) --
The unique identifier of the recovery point.
totalSizeInMegaBytes (float) --
The total size of the data in the recovery point in megabytes.
workgroupName (string) --
The name of the workgroup the recovery point is associated with.
{'workgroups': {'port': 'integer'}}
Returns information about a list of specified workgroups.
See also: AWS API Documentation
Request Syntax
client.list_workgroups(
maxResults=123,
nextToken='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.
dict
Response Syntax
{
'nextToken': 'string',
'workgroups': [
{
'baseCapacity': 123,
'configParameters': [
{
'parameterKey': 'string',
'parameterValue': 'string'
},
],
'creationDate': datetime(2015, 1, 1),
'endpoint': {
'address': 'string',
'port': 123,
'vpcEndpoints': [
{
'networkInterfaces': [
{
'availabilityZone': 'string',
'networkInterfaceId': 'string',
'privateIpAddress': 'string',
'subnetId': 'string'
},
],
'vpcEndpointId': 'string',
'vpcId': 'string'
},
]
},
'enhancedVpcRouting': True|False,
'namespaceName': 'string',
'port': 123,
'publiclyAccessible': True|False,
'securityGroupIds': [
'string',
],
'status': 'CREATING'|'AVAILABLE'|'MODIFYING'|'DELETING',
'subnetIds': [
'string',
],
'workgroupArn': 'string',
'workgroupId': 'string',
'workgroupName': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token.
workgroups (list) --
The returned array of workgroups.
(dict) --
The collection of computing resources from which an endpoint is created.
baseCapacity (integer) --
The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
configParameters (list) --
An array of parameters to set for finer control over a database. The options are datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .
(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 datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .
parameterValue (string) --
The value of the parameter to set.
creationDate (datetime) --
The creation date of the workgroup.
endpoint (dict) --
The endpoint that is created from the workgroup.
address (string) --
The DNS address of the VPC endpoint.
port (integer) --
The port that Amazon Redshift Serverless listens on.
vpcEndpoints (list) --
An array of VpcEndpoint objects.
(dict) --
The connection endpoint for connecting to Amazon Redshift Serverless through the proxy.
networkInterfaces (list) --
One or more network interfaces of the endpoint. Also known as an interface endpoint.
(dict) --
Contains information about a network interface in an Amazon Redshift Serverless managed VPC endpoint.
availabilityZone (string) --
The availability Zone.
networkInterfaceId (string) --
The unique identifier of the network interface.
privateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
subnetId (string) --
The unique identifier of the subnet.
vpcEndpointId (string) --
The connection endpoint ID for connecting to Amazon Redshift Serverless.
vpcId (string) --
The VPC identifier that the endpoint is associated with.
enhancedVpcRouting (boolean) --
The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
namespaceName (string) --
The namespace the workgroup is associated with.
port (integer) --
The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
publiclyAccessible (boolean) --
A value that specifies whether the workgroup can be accessible from a public network
securityGroupIds (list) --
An array of security group IDs to associate with the workgroup.
(string) --
status (string) --
The status of the workgroup.
subnetIds (list) --
An array of subnet IDs the workgroup is associated with.
(string) --
workgroupArn (string) --
The Amazon Resource Name (ARN) that links to the workgroup.
workgroupId (string) --
The unique identifier of the workgroup.
workgroupName (string) --
The name of the workgroup.
{'port': 'integer'}
Response {'workgroup': {'port': 'integer'}}
Updates a workgroup with the specified configuration settings.
See also: AWS API Documentation
Request Syntax
client.update_workgroup(
baseCapacity=123,
configParameters=[
{
'parameterKey': 'string',
'parameterValue': 'string'
},
],
enhancedVpcRouting=True|False,
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 datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .
(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 datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .
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.
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.
dict
Response Syntax
{
'workgroup': {
'baseCapacity': 123,
'configParameters': [
{
'parameterKey': 'string',
'parameterValue': 'string'
},
],
'creationDate': datetime(2015, 1, 1),
'endpoint': {
'address': 'string',
'port': 123,
'vpcEndpoints': [
{
'networkInterfaces': [
{
'availabilityZone': 'string',
'networkInterfaceId': 'string',
'privateIpAddress': 'string',
'subnetId': 'string'
},
],
'vpcEndpointId': 'string',
'vpcId': 'string'
},
]
},
'enhancedVpcRouting': True|False,
'namespaceName': 'string',
'port': 123,
'publiclyAccessible': True|False,
'securityGroupIds': [
'string',
],
'status': 'CREATING'|'AVAILABLE'|'MODIFYING'|'DELETING',
'subnetIds': [
'string',
],
'workgroupArn': 'string',
'workgroupId': 'string',
'workgroupName': 'string'
}
}
Response Structure
(dict) --
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 finer control over a database. The options are datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .
(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 datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .
parameterValue (string) --
The value of the parameter to set.
creationDate (datetime) --
The creation date of the workgroup.
endpoint (dict) --
The endpoint that is created from the workgroup.
address (string) --
The DNS address of the VPC endpoint.
port (integer) --
The port that Amazon Redshift Serverless listens on.
vpcEndpoints (list) --
An array of VpcEndpoint objects.
(dict) --
The connection endpoint for connecting to Amazon Redshift Serverless through the proxy.
networkInterfaces (list) --
One or more network interfaces of the endpoint. Also known as an interface endpoint.
(dict) --
Contains information about a network interface in an Amazon Redshift Serverless managed VPC endpoint.
availabilityZone (string) --
The availability Zone.
networkInterfaceId (string) --
The unique identifier of the network interface.
privateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
subnetId (string) --
The unique identifier of the subnet.
vpcEndpointId (string) --
The connection endpoint ID for connecting to Amazon Redshift Serverless.
vpcId (string) --
The VPC identifier that the endpoint is associated with.
enhancedVpcRouting (boolean) --
The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
namespaceName (string) --
The namespace the workgroup is associated with.
port (integer) --
The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
publiclyAccessible (boolean) --
A value that specifies whether the workgroup can be accessible from a public network
securityGroupIds (list) --
An array of security group IDs to associate with the workgroup.
(string) --
status (string) --
The status of the workgroup.
subnetIds (list) --
An array of subnet IDs the workgroup is associated with.
(string) --
workgroupArn (string) --
The Amazon Resource Name (ARN) that links to the workgroup.
workgroupId (string) --
The unique identifier of the workgroup.
workgroupName (string) --
The name of the workgroup.