2023/11/30 - Redshift Serverless - 10 new 10 updated api methods
Changes This release adds the following support for Amazon Redshift Serverless: 1) cross-account cross-VPCs, 2) copying snapshots across Regions, 3) scheduling snapshot creation, and 4) restoring tables from a recovery point.
Updates a snapshot copy configuration.
See also: AWS API Documentation
Request Syntax
client.update_snapshot_copy_configuration(
snapshotCopyConfigurationId='string',
snapshotRetentionPeriod=123
)
string
[REQUIRED]
The ID of the snapshot copy configuration to update.
integer
The new retention period of how long to keep a snapshot in the destination Amazon Web Services Region.
dict
Response Syntax
{
'snapshotCopyConfiguration': {
'destinationKmsKeyId': 'string',
'destinationRegion': 'string',
'namespaceName': 'string',
'snapshotCopyConfigurationArn': 'string',
'snapshotCopyConfigurationId': 'string',
'snapshotRetentionPeriod': 123
}
}
Response Structure
(dict) --
snapshotCopyConfiguration (dict) --
The updated snapshot copy configuration object.
destinationKmsKeyId (string) --
The ID of the KMS key to use to encrypt your snapshots in the destination Amazon Web Services Region.
destinationRegion (string) --
The destination Amazon Web Services Region to copy snapshots to.
namespaceName (string) --
The name of the namespace to copy snapshots from in the source Amazon Web Services Region.
snapshotCopyConfigurationArn (string) --
The ARN of the snapshot copy configuration object.
snapshotCopyConfigurationId (string) --
The ID of the snapshot copy configuration object.
snapshotRetentionPeriod (integer) --
The retention period of snapshots that are copied to the destination Amazon Web Services Region.
Returns a list of scheduled actions. You can use the flags to filter the list of returned scheduled actions.
See also: AWS API Documentation
Request Syntax
client.list_scheduled_actions(
maxResults=123,
namespaceName='string',
nextToken='string'
)
integer
An optional parameter that specifies the maximum number of results to return. Use nextToken to display the next page of results.
string
The name of namespace associated with the scheduled action to retrieve.
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.
dict
Response Syntax
{
'nextToken': 'string',
'scheduledActions': [
'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.
scheduledActions (list) --
All of the returned scheduled action objects.
(string) --
Creates a scheduled action. A scheduled action contains a schedule and an Amazon Redshift API action. For example, you can create a schedule of when to run the CreateSnapshot API operation.
See also: AWS API Documentation
Request Syntax
client.create_scheduled_action(
enabled=True|False,
endTime=datetime(2015, 1, 1),
namespaceName='string',
roleArn='string',
schedule={
'at': datetime(2015, 1, 1),
'cron': 'string'
},
scheduledActionDescription='string',
scheduledActionName='string',
startTime=datetime(2015, 1, 1),
targetAction={
'createSnapshot': {
'namespaceName': 'string',
'retentionPeriod': 123,
'snapshotNamePrefix': 'string',
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
}
)
boolean
Indicates whether the schedule is enabled. If false, the scheduled action does not trigger. For more information about state of the scheduled action, see ScheduledAction .
datetime
The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.
string
[REQUIRED]
The name of the namespace for which to create a scheduled action.
string
[REQUIRED]
The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide
dict
[REQUIRED]
The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.
Format of at expressions is "at(yyyy-mm-ddThh:mm:ss) ". For example, "at(2016-03-04T17:27:00) ".
Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year) ". For example, "cron(0 10 ? * MON *) ". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide .
at (datetime) --
The timestamp of when Amazon Redshift Serverless should run the scheduled action. Format of at expressions is "at(yyyy-mm-ddThh:mm:ss) ". For example, "at(2016-03-04T17:27:00) ".
cron (string) --
The cron expression to use to schedule a recurring scheduled action. Schedule invocations must be separated by at least one hour.
Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year) ". For example, "cron(0 10 ? * MON *) ". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide .
string
The description of the scheduled action.
string
[REQUIRED]
The name of the scheduled action.
datetime
The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.
dict
[REQUIRED]
A JSON format string of the Amazon Redshift Serverless API operation with input parameters. The following is an example of a target action.
"{"CreateSnapshot": {"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", "retentionPeriod": "1"}}"
createSnapshot (dict) --
The parameters that you can use to configure a scheduled action to create a snapshot. For more information about creating a scheduled action, see CreateScheduledAction .
namespaceName (string) -- [REQUIRED]
The name of the namespace for which you want to configure a scheduled action to create a snapshot.
retentionPeriod (integer) --
The retention period of the snapshot created by the scheduled action.
snapshotNamePrefix (string) -- [REQUIRED]
A string prefix that is attached to the name of the snapshot created by the scheduled action. The final name of the snapshot is the string prefix appended by the date and time of when the snapshot was created.
tags (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
{
'scheduledAction': {
'endTime': datetime(2015, 1, 1),
'namespaceName': 'string',
'nextInvocations': [
datetime(2015, 1, 1),
],
'roleArn': 'string',
'schedule': {
'at': datetime(2015, 1, 1),
'cron': 'string'
},
'scheduledActionDescription': 'string',
'scheduledActionName': 'string',
'scheduledActionUuid': 'string',
'startTime': datetime(2015, 1, 1),
'state': 'ACTIVE'|'DISABLED',
'targetAction': {
'createSnapshot': {
'namespaceName': 'string',
'retentionPeriod': 123,
'snapshotNamePrefix': 'string',
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
}
}
}
Response Structure
(dict) --
scheduledAction (dict) --
The returned ScheduledAction object that describes the properties of a scheduled action.
endTime (datetime) --
The end time of
namespaceName (string) --
The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.
nextInvocations (list) --
An array of timestamps of when the next scheduled actions will trigger.
(datetime) --
roleArn (string) --
The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide
schedule (dict) --
The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.
Format of at expressions is "at(yyyy-mm-ddThh:mm:ss) ". For example, "at(2016-03-04T17:27:00) ".
Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year) ". For example, "cron(0 10 ? * MON *) ". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide .
at (datetime) --
The timestamp of when Amazon Redshift Serverless should run the scheduled action. Format of at expressions is "at(yyyy-mm-ddThh:mm:ss) ". For example, "at(2016-03-04T17:27:00) ".
cron (string) --
The cron expression to use to schedule a recurring scheduled action. Schedule invocations must be separated by at least one hour.
Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year) ". For example, "cron(0 10 ? * MON *) ". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide .
scheduledActionDescription (string) --
The description of the scheduled action.
scheduledActionName (string) --
The name of the scheduled action.
scheduledActionUuid (string) --
The uuid of the scheduled action.
startTime (datetime) --
The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.
state (string) --
The state of the scheduled action.
targetAction (dict) --
A JSON format string of the Amazon Redshift Serverless API operation with input parameters. The following is an example of a target action.
"{"CreateSnapshot": {"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", "retentionPeriod": "1"}}"
createSnapshot (dict) --
The parameters that you can use to configure a scheduled action to create a snapshot. For more information about creating a scheduled action, see CreateScheduledAction .
namespaceName (string) --
The name of the namespace for which you want to configure a scheduled action to create a snapshot.
retentionPeriod (integer) --
The retention period of the snapshot created by the scheduled action.
snapshotNamePrefix (string) --
A string prefix that is attached to the name of the snapshot created by the scheduled action. The final name of the snapshot is the string prefix appended by the date and time of when the snapshot was created.
tags (list) --
An array of Tag objects to associate with the snapshot.
(dict) --
A map of key-value pairs.
key (string) --
The key to use in the tag.
value (string) --
The value of the tag.
Updates a scheduled action.
See also: AWS API Documentation
Request Syntax
client.update_scheduled_action(
enabled=True|False,
endTime=datetime(2015, 1, 1),
roleArn='string',
schedule={
'at': datetime(2015, 1, 1),
'cron': 'string'
},
scheduledActionDescription='string',
scheduledActionName='string',
startTime=datetime(2015, 1, 1),
targetAction={
'createSnapshot': {
'namespaceName': 'string',
'retentionPeriod': 123,
'snapshotNamePrefix': 'string',
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
}
)
boolean
Specifies whether to enable the scheduled action.
datetime
The end time in UTC of the scheduled action to update.
string
The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide
dict
The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.
Format of at expressions is "at(yyyy-mm-ddThh:mm:ss) ". For example, "at(2016-03-04T17:27:00) ".
Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year) ". For example, "cron(0 10 ? * MON *) ". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide .
at (datetime) --
The timestamp of when Amazon Redshift Serverless should run the scheduled action. Format of at expressions is "at(yyyy-mm-ddThh:mm:ss) ". For example, "at(2016-03-04T17:27:00) ".
cron (string) --
The cron expression to use to schedule a recurring scheduled action. Schedule invocations must be separated by at least one hour.
Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year) ". For example, "cron(0 10 ? * MON *) ". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide .
string
The descripion of the scheduled action to update to.
string
[REQUIRED]
The name of the scheduled action to update to.
datetime
The start time in UTC of the scheduled action to update to.
dict
A JSON format string of the Amazon Redshift Serverless API operation with input parameters. The following is an example of a target action.
"{"CreateSnapshot": {"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", "retentionPeriod": "1"}}"
createSnapshot (dict) --
The parameters that you can use to configure a scheduled action to create a snapshot. For more information about creating a scheduled action, see CreateScheduledAction .
namespaceName (string) -- [REQUIRED]
The name of the namespace for which you want to configure a scheduled action to create a snapshot.
retentionPeriod (integer) --
The retention period of the snapshot created by the scheduled action.
snapshotNamePrefix (string) -- [REQUIRED]
A string prefix that is attached to the name of the snapshot created by the scheduled action. The final name of the snapshot is the string prefix appended by the date and time of when the snapshot was created.
tags (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
{
'scheduledAction': {
'endTime': datetime(2015, 1, 1),
'namespaceName': 'string',
'nextInvocations': [
datetime(2015, 1, 1),
],
'roleArn': 'string',
'schedule': {
'at': datetime(2015, 1, 1),
'cron': 'string'
},
'scheduledActionDescription': 'string',
'scheduledActionName': 'string',
'scheduledActionUuid': 'string',
'startTime': datetime(2015, 1, 1),
'state': 'ACTIVE'|'DISABLED',
'targetAction': {
'createSnapshot': {
'namespaceName': 'string',
'retentionPeriod': 123,
'snapshotNamePrefix': 'string',
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
}
}
}
Response Structure
(dict) --
scheduledAction (dict) --
The ScheduledAction object that was updated.
endTime (datetime) --
The end time of
namespaceName (string) --
The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.
nextInvocations (list) --
An array of timestamps of when the next scheduled actions will trigger.
(datetime) --
roleArn (string) --
The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide
schedule (dict) --
The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.
Format of at expressions is "at(yyyy-mm-ddThh:mm:ss) ". For example, "at(2016-03-04T17:27:00) ".
Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year) ". For example, "cron(0 10 ? * MON *) ". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide .
at (datetime) --
The timestamp of when Amazon Redshift Serverless should run the scheduled action. Format of at expressions is "at(yyyy-mm-ddThh:mm:ss) ". For example, "at(2016-03-04T17:27:00) ".
cron (string) --
The cron expression to use to schedule a recurring scheduled action. Schedule invocations must be separated by at least one hour.
Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year) ". For example, "cron(0 10 ? * MON *) ". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide .
scheduledActionDescription (string) --
The description of the scheduled action.
scheduledActionName (string) --
The name of the scheduled action.
scheduledActionUuid (string) --
The uuid of the scheduled action.
startTime (datetime) --
The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.
state (string) --
The state of the scheduled action.
targetAction (dict) --
A JSON format string of the Amazon Redshift Serverless API operation with input parameters. The following is an example of a target action.
"{"CreateSnapshot": {"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", "retentionPeriod": "1"}}"
createSnapshot (dict) --
The parameters that you can use to configure a scheduled action to create a snapshot. For more information about creating a scheduled action, see CreateScheduledAction .
namespaceName (string) --
The name of the namespace for which you want to configure a scheduled action to create a snapshot.
retentionPeriod (integer) --
The retention period of the snapshot created by the scheduled action.
snapshotNamePrefix (string) --
A string prefix that is attached to the name of the snapshot created by the scheduled action. The final name of the snapshot is the string prefix appended by the date and time of when the snapshot was created.
tags (list) --
An array of Tag objects to associate with the snapshot.
(dict) --
A map of key-value pairs.
key (string) --
The key to use in the tag.
value (string) --
The value of the tag.
Deletes a scheduled action.
See also: AWS API Documentation
Request Syntax
client.delete_scheduled_action(
scheduledActionName='string'
)
string
[REQUIRED]
The name of the scheduled action to delete.
dict
Response Syntax
{
'scheduledAction': {
'endTime': datetime(2015, 1, 1),
'namespaceName': 'string',
'nextInvocations': [
datetime(2015, 1, 1),
],
'roleArn': 'string',
'schedule': {
'at': datetime(2015, 1, 1),
'cron': 'string'
},
'scheduledActionDescription': 'string',
'scheduledActionName': 'string',
'scheduledActionUuid': 'string',
'startTime': datetime(2015, 1, 1),
'state': 'ACTIVE'|'DISABLED',
'targetAction': {
'createSnapshot': {
'namespaceName': 'string',
'retentionPeriod': 123,
'snapshotNamePrefix': 'string',
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
}
}
}
Response Structure
(dict) --
scheduledAction (dict) --
The deleted scheduled action object.
endTime (datetime) --
The end time of
namespaceName (string) --
The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.
nextInvocations (list) --
An array of timestamps of when the next scheduled actions will trigger.
(datetime) --
roleArn (string) --
The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide
schedule (dict) --
The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.
Format of at expressions is "at(yyyy-mm-ddThh:mm:ss) ". For example, "at(2016-03-04T17:27:00) ".
Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year) ". For example, "cron(0 10 ? * MON *) ". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide .
at (datetime) --
The timestamp of when Amazon Redshift Serverless should run the scheduled action. Format of at expressions is "at(yyyy-mm-ddThh:mm:ss) ". For example, "at(2016-03-04T17:27:00) ".
cron (string) --
The cron expression to use to schedule a recurring scheduled action. Schedule invocations must be separated by at least one hour.
Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year) ". For example, "cron(0 10 ? * MON *) ". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide .
scheduledActionDescription (string) --
The description of the scheduled action.
scheduledActionName (string) --
The name of the scheduled action.
scheduledActionUuid (string) --
The uuid of the scheduled action.
startTime (datetime) --
The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.
state (string) --
The state of the scheduled action.
targetAction (dict) --
A JSON format string of the Amazon Redshift Serverless API operation with input parameters. The following is an example of a target action.
"{"CreateSnapshot": {"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", "retentionPeriod": "1"}}"
createSnapshot (dict) --
The parameters that you can use to configure a scheduled action to create a snapshot. For more information about creating a scheduled action, see CreateScheduledAction .
namespaceName (string) --
The name of the namespace for which you want to configure a scheduled action to create a snapshot.
retentionPeriod (integer) --
The retention period of the snapshot created by the scheduled action.
snapshotNamePrefix (string) --
A string prefix that is attached to the name of the snapshot created by the scheduled action. The final name of the snapshot is the string prefix appended by the date and time of when the snapshot was created.
tags (list) --
An array of Tag objects to associate with the snapshot.
(dict) --
A map of key-value pairs.
key (string) --
The key to use in the tag.
value (string) --
The value of the tag.
Creates a snapshot copy configuration that lets you copy snapshots to another Amazon Web Services Region.
See also: AWS API Documentation
Request Syntax
client.create_snapshot_copy_configuration(
destinationKmsKeyId='string',
destinationRegion='string',
namespaceName='string',
snapshotRetentionPeriod=123
)
string
The KMS key to use to encrypt your snapshots in the destination Amazon Web Services Region.
string
[REQUIRED]
The destination Amazon Web Services Region that you want to copy snapshots to.
string
[REQUIRED]
The name of the namespace to copy snapshots from.
integer
The retention period of the snapshots that you copy to the destination Amazon Web Services Region.
dict
Response Syntax
{
'snapshotCopyConfiguration': {
'destinationKmsKeyId': 'string',
'destinationRegion': 'string',
'namespaceName': 'string',
'snapshotCopyConfigurationArn': 'string',
'snapshotCopyConfigurationId': 'string',
'snapshotRetentionPeriod': 123
}
}
Response Structure
(dict) --
snapshotCopyConfiguration (dict) --
The snapshot copy configuration object that is returned.
destinationKmsKeyId (string) --
The ID of the KMS key to use to encrypt your snapshots in the destination Amazon Web Services Region.
destinationRegion (string) --
The destination Amazon Web Services Region to copy snapshots to.
namespaceName (string) --
The name of the namespace to copy snapshots from in the source Amazon Web Services Region.
snapshotCopyConfigurationArn (string) --
The ARN of the snapshot copy configuration object.
snapshotCopyConfigurationId (string) --
The ID of the snapshot copy configuration object.
snapshotRetentionPeriod (integer) --
The retention period of snapshots that are copied to the destination Amazon Web Services Region.
Restores a table from a recovery point to your Amazon Redshift Serverless instance. You can't use this operation to restore tables with interleaved sort keys.
See also: AWS API Documentation
Request Syntax
client.restore_table_from_recovery_point(
activateCaseSensitiveIdentifier=True|False,
namespaceName='string',
newTableName='string',
recoveryPointId='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]
Namespace of the recovery point to restore from.
string
[REQUIRED]
The name of the table to create from the restore operation.
string
[REQUIRED]
The ID of the recovery point 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,
'recoveryPointId': 'string',
'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) --
Contains information about a table restore request.
message (string) --
A message that explains the returned status. For example, if the status of the operation is FAILED , the message explains why the operation failed.
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).
recoveryPointId (string) --
The ID of the recovery point being restored from.
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 are SUCCEEDED , FAILED , CANCELED , PENDING , and 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.
Deletes a snapshot copy configuration
See also: AWS API Documentation
Request Syntax
client.delete_snapshot_copy_configuration(
snapshotCopyConfigurationId='string'
)
string
[REQUIRED]
The ID of the snapshot copy configuration to delete.
dict
Response Syntax
{
'snapshotCopyConfiguration': {
'destinationKmsKeyId': 'string',
'destinationRegion': 'string',
'namespaceName': 'string',
'snapshotCopyConfigurationArn': 'string',
'snapshotCopyConfigurationId': 'string',
'snapshotRetentionPeriod': 123
}
}
Response Structure
(dict) --
snapshotCopyConfiguration (dict) --
The deleted snapshot copy configuration object.
destinationKmsKeyId (string) --
The ID of the KMS key to use to encrypt your snapshots in the destination Amazon Web Services Region.
destinationRegion (string) --
The destination Amazon Web Services Region to copy snapshots to.
namespaceName (string) --
The name of the namespace to copy snapshots from in the source Amazon Web Services Region.
snapshotCopyConfigurationArn (string) --
The ARN of the snapshot copy configuration object.
snapshotCopyConfigurationId (string) --
The ID of the snapshot copy configuration object.
snapshotRetentionPeriod (integer) --
The retention period of snapshots that are copied to the destination Amazon Web Services Region.
Returns a list of snapshot copy configurations.
See also: AWS API Documentation
Request Syntax
client.list_snapshot_copy_configurations(
maxResults=123,
namespaceName='string',
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
The namespace from which to list all snapshot copy configurations.
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.
dict
Response Syntax
{
'nextToken': 'string',
'snapshotCopyConfigurations': [
{
'destinationKmsKeyId': 'string',
'destinationRegion': 'string',
'namespaceName': 'string',
'snapshotCopyConfigurationArn': 'string',
'snapshotCopyConfigurationId': 'string',
'snapshotRetentionPeriod': 123
},
]
}
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.
snapshotCopyConfigurations (list) --
All of the returned snapshot copy configurations.
(dict) --
The object that you configure to copy snapshots from one namespace to a namespace in another Amazon Web Services Region.
destinationKmsKeyId (string) --
The ID of the KMS key to use to encrypt your snapshots in the destination Amazon Web Services Region.
destinationRegion (string) --
The destination Amazon Web Services Region to copy snapshots to.
namespaceName (string) --
The name of the namespace to copy snapshots from in the source Amazon Web Services Region.
snapshotCopyConfigurationArn (string) --
The ARN of the snapshot copy configuration object.
snapshotCopyConfigurationId (string) --
The ID of the snapshot copy configuration object.
snapshotRetentionPeriod (integer) --
The retention period of snapshots that are copied to the destination Amazon Web Services Region.
Returns information about a scheduled action.
See also: AWS API Documentation
Request Syntax
client.get_scheduled_action(
scheduledActionName='string'
)
string
[REQUIRED]
The name of the scheduled action.
dict
Response Syntax
{
'scheduledAction': {
'endTime': datetime(2015, 1, 1),
'namespaceName': 'string',
'nextInvocations': [
datetime(2015, 1, 1),
],
'roleArn': 'string',
'schedule': {
'at': datetime(2015, 1, 1),
'cron': 'string'
},
'scheduledActionDescription': 'string',
'scheduledActionName': 'string',
'scheduledActionUuid': 'string',
'startTime': datetime(2015, 1, 1),
'state': 'ACTIVE'|'DISABLED',
'targetAction': {
'createSnapshot': {
'namespaceName': 'string',
'retentionPeriod': 123,
'snapshotNamePrefix': 'string',
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
}
}
}
Response Structure
(dict) --
scheduledAction (dict) --
The returned scheduled action object.
endTime (datetime) --
The end time of
namespaceName (string) --
The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.
nextInvocations (list) --
An array of timestamps of when the next scheduled actions will trigger.
(datetime) --
roleArn (string) --
The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide
schedule (dict) --
The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.
Format of at expressions is "at(yyyy-mm-ddThh:mm:ss) ". For example, "at(2016-03-04T17:27:00) ".
Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year) ". For example, "cron(0 10 ? * MON *) ". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide .
at (datetime) --
The timestamp of when Amazon Redshift Serverless should run the scheduled action. Format of at expressions is "at(yyyy-mm-ddThh:mm:ss) ". For example, "at(2016-03-04T17:27:00) ".
cron (string) --
The cron expression to use to schedule a recurring scheduled action. Schedule invocations must be separated by at least one hour.
Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year) ". For example, "cron(0 10 ? * MON *) ". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide .
scheduledActionDescription (string) --
The description of the scheduled action.
scheduledActionName (string) --
The name of the scheduled action.
scheduledActionUuid (string) --
The uuid of the scheduled action.
startTime (datetime) --
The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.
state (string) --
The state of the scheduled action.
targetAction (dict) --
A JSON format string of the Amazon Redshift Serverless API operation with input parameters. The following is an example of a target action.
"{"CreateSnapshot": {"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", "retentionPeriod": "1"}}"
createSnapshot (dict) --
The parameters that you can use to configure a scheduled action to create a snapshot. For more information about creating a scheduled action, see CreateScheduledAction .
namespaceName (string) --
The name of the namespace for which you want to configure a scheduled action to create a snapshot.
retentionPeriod (integer) --
The retention period of the snapshot created by the scheduled action.
snapshotNamePrefix (string) --
A string prefix that is attached to the name of the snapshot created by the scheduled action. The final name of the snapshot is the string prefix appended by the date and time of when the snapshot was created.
tags (list) --
An array of Tag objects to associate with the snapshot.
(dict) --
A map of key-value pairs.
key (string) --
The key to use in the tag.
value (string) --
The value of the tag.
{'ownerAccount': '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',
'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.
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': {'crossAccountVpcs': ['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,
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 , 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 , 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.
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',
'networkInterfaceId': 'string',
'privateIpAddress': 'string',
'subnetId': 'string'
},
],
'vpcEndpointId': 'string',
'vpcId': 'string'
},
]
},
'enhancedVpcRouting': True|False,
'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 , 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 , 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.
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.
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 <https://docs.aws.amazon.com/redshift/latest/mgmt/cluster-versions.html>`__ .
{'workgroup': {'crossAccountVpcs': ['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',
'networkInterfaceId': 'string',
'privateIpAddress': 'string',
'subnetId': 'string'
},
],
'vpcEndpointId': 'string',
'vpcId': 'string'
},
]
},
'enhancedVpcRouting': True|False,
'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 , 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 , 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.
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.
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 <https://docs.aws.amazon.com/redshift/latest/mgmt/cluster-versions.html>`__ .
{'tableRestoreStatus': {'recoveryPointId': 'string'}}
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,
'recoveryPointId': 'string',
'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 message that explains the returned status. For example, if the status of the operation is FAILED , the message explains why the operation failed.
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).
recoveryPointId (string) --
The ID of the recovery point being restored from.
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 are SUCCEEDED , FAILED , CANCELED , PENDING , and 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.
{'workgroup': {'crossAccountVpcs': ['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',
'networkInterfaceId': 'string',
'privateIpAddress': 'string',
'subnetId': 'string'
},
],
'vpcEndpointId': 'string',
'vpcId': 'string'
},
]
},
'enhancedVpcRouting': True|False,
'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 , 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 , 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.
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.
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 <https://docs.aws.amazon.com/redshift/latest/mgmt/cluster-versions.html>`__ .
{'ownerAccount': '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',
'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.
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.
{'tableRestoreStatuses': {'recoveryPointId': 'string'}}
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,
'recoveryPointId': 'string',
'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 message that explains the returned status. For example, if the status of the operation is FAILED , the message explains why the operation failed.
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).
recoveryPointId (string) --
The ID of the recovery point being restored from.
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 are SUCCEEDED , FAILED , CANCELED , PENDING , and 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.
{'ownerAccount': 'string'}
Response {'workgroups': {'crossAccountVpcs': ['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',
'networkInterfaceId': 'string',
'privateIpAddress': 'string',
'subnetId': 'string'
},
],
'vpcEndpointId': 'string',
'vpcId': 'string'
},
]
},
'enhancedVpcRouting': True|False,
'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 , 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 , 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.
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.
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 <https://docs.aws.amazon.com/redshift/latest/mgmt/cluster-versions.html>`__ .
{'tableRestoreStatus': {'recoveryPointId': 'string'}}
Restores a table from a snapshot to your Amazon Redshift Serverless instance. You can't use this operation to restore tables with interleaved sort keys .
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,
'recoveryPointId': 'string',
'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 message that explains the returned status. For example, if the status of the operation is FAILED , the message explains why the operation failed.
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).
recoveryPointId (string) --
The ID of the recovery point being restored from.
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 are SUCCEEDED , FAILED , CANCELED , PENDING , and 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.
{'workgroup': {'crossAccountVpcs': ['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,
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 , 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 , 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.
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',
'networkInterfaceId': 'string',
'privateIpAddress': 'string',
'subnetId': 'string'
},
],
'vpcEndpointId': 'string',
'vpcId': 'string'
},
]
},
'enhancedVpcRouting': True|False,
'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 , 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 , 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.
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.
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 <https://docs.aws.amazon.com/redshift/latest/mgmt/cluster-versions.html>`__ .