2023/10/16 - Redshift Serverless - 13 updated api methods
Changes Added support for managing credentials of serverless namespace admin using AWS Secrets Manager.
{'snapshot': {'adminPasswordSecretArn': 'string',
'adminPasswordSecretKmsKeyId': '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,
'adminPasswordSecretArn': 'string',
'adminPasswordSecretKmsKeyId': 'string',
'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.
adminPasswordSecretArn (string) --
The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.
adminPasswordSecretKmsKeyId (string) --
The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
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.
{'adminPasswordSecretKmsKeyId': 'string', 'manageAdminPassword': 'boolean'}
Response {'namespace': {'adminPasswordSecretArn': 'string',
'adminPasswordSecretKmsKeyId': 'string'}}
Creates a namespace in Amazon Redshift Serverless.
See also: AWS API Documentation
Request Syntax
client.create_namespace(
adminPasswordSecretKmsKeyId='string',
adminUserPassword='string',
adminUsername='string',
dbName='string',
defaultIamRoleArn='string',
iamRoles=[
'string',
],
kmsKeyId='string',
logExports=[
'useractivitylog'|'userlog'|'connectionlog',
],
manageAdminPassword=True|False,
namespaceName='string',
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
string
The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. You can only use this parameter if manageAdminPassword is true.
string
The password of the administrator for the first database created in the namespace.
You can't use adminUserPassword if manageAdminPassword is true.
string
The username of the administrator for the first database created in the namespace.
string
The name of the first database created in the namespace.
string
The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
list
A list of IAM roles to associate with the namespace.
(string) --
string
The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
list
The types of logs the namespace can export. Available export types are userlog, connectionlog, and useractivitylog.
(string) --
boolean
If true, Amazon Redshift uses Secrets Manager to manage the namespace's admin credentials. You can't use adminUserPassword if manageAdminPassword is true. If manageAdminPassword is false or not set, Amazon Redshift uses adminUserPassword for the admin user account's password.
string
[REQUIRED]
The name of the namespace.
list
A list 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.
dict
Response Syntax
{
'namespace': {
'adminPasswordSecretArn': 'string',
'adminPasswordSecretKmsKeyId': 'string',
'adminUsername': 'string',
'creationDate': datetime(2015, 1, 1),
'dbName': 'string',
'defaultIamRoleArn': 'string',
'iamRoles': [
'string',
],
'kmsKeyId': 'string',
'logExports': [
'useractivitylog'|'userlog'|'connectionlog',
],
'namespaceArn': 'string',
'namespaceId': 'string',
'namespaceName': 'string',
'status': 'AVAILABLE'|'MODIFYING'|'DELETING'
}
}
Response Structure
(dict) --
namespace (dict) --
The created namespace object.
adminPasswordSecretArn (string) --
The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.
adminPasswordSecretKmsKeyId (string) --
The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
adminUsername (string) --
The username of the administrator for the first database created in the namespace.
creationDate (datetime) --
The date of when the namespace was created.
dbName (string) --
The name of the first database created in the namespace.
defaultIamRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
iamRoles (list) --
A list of IAM roles to associate with the namespace.
(string) --
kmsKeyId (string) --
The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
logExports (list) --
The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.
(string) --
namespaceArn (string) --
The Amazon Resource Name (ARN) associated with a namespace.
namespaceId (string) --
The unique identifier of a namespace.
namespaceName (string) --
The name of the namespace. Must be between 3-64 alphanumeric characters in lowercase, and it cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
status (string) --
The status of the namespace.
{'snapshot': {'adminPasswordSecretArn': 'string',
'adminPasswordSecretKmsKeyId': '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,
'adminPasswordSecretArn': 'string',
'adminPasswordSecretKmsKeyId': 'string',
'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.
adminPasswordSecretArn (string) --
The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.
adminPasswordSecretKmsKeyId (string) --
The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
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.
{'namespace': {'adminPasswordSecretArn': 'string',
'adminPasswordSecretKmsKeyId': 'string'}}
Deletes a namespace from Amazon Redshift Serverless. Before you delete the namespace, you can create a final snapshot that has all of the data within the namespace.
See also: AWS API Documentation
Request Syntax
client.delete_namespace(
finalSnapshotName='string',
finalSnapshotRetentionPeriod=123,
namespaceName='string'
)
string
The name of the snapshot to be created before the namespace is deleted.
integer
How long to retain the final snapshot.
string
[REQUIRED]
The name of the namespace to delete.
dict
Response Syntax
{
'namespace': {
'adminPasswordSecretArn': 'string',
'adminPasswordSecretKmsKeyId': 'string',
'adminUsername': 'string',
'creationDate': datetime(2015, 1, 1),
'dbName': 'string',
'defaultIamRoleArn': 'string',
'iamRoles': [
'string',
],
'kmsKeyId': 'string',
'logExports': [
'useractivitylog'|'userlog'|'connectionlog',
],
'namespaceArn': 'string',
'namespaceId': 'string',
'namespaceName': 'string',
'status': 'AVAILABLE'|'MODIFYING'|'DELETING'
}
}
Response Structure
(dict) --
namespace (dict) --
The deleted namespace object.
adminPasswordSecretArn (string) --
The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.
adminPasswordSecretKmsKeyId (string) --
The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
adminUsername (string) --
The username of the administrator for the first database created in the namespace.
creationDate (datetime) --
The date of when the namespace was created.
dbName (string) --
The name of the first database created in the namespace.
defaultIamRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
iamRoles (list) --
A list of IAM roles to associate with the namespace.
(string) --
kmsKeyId (string) --
The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
logExports (list) --
The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.
(string) --
namespaceArn (string) --
The Amazon Resource Name (ARN) associated with a namespace.
namespaceId (string) --
The unique identifier of a namespace.
namespaceName (string) --
The name of the namespace. Must be between 3-64 alphanumeric characters in lowercase, and it cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
status (string) --
The status of the namespace.
{'snapshot': {'adminPasswordSecretArn': 'string',
'adminPasswordSecretKmsKeyId': 'string'}}
Deletes a snapshot from Amazon Redshift Serverless.
See also: AWS API Documentation
Request Syntax
client.delete_snapshot(
snapshotName='string'
)
string
[REQUIRED]
The name of the snapshot to be deleted.
dict
Response Syntax
{
'snapshot': {
'accountsWithProvisionedRestoreAccess': [
'string',
],
'accountsWithRestoreAccess': [
'string',
],
'actualIncrementalBackupSizeInMegaBytes': 123.0,
'adminPasswordSecretArn': 'string',
'adminPasswordSecretKmsKeyId': 'string',
'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 deleted 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.
adminPasswordSecretArn (string) --
The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.
adminPasswordSecretKmsKeyId (string) --
The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
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.
{'namespace': {'adminPasswordSecretArn': 'string',
'adminPasswordSecretKmsKeyId': 'string'}}
Returns information about a namespace in Amazon Redshift Serverless.
See also: AWS API Documentation
Request Syntax
client.get_namespace(
namespaceName='string'
)
string
[REQUIRED]
The name of the namespace to retrieve information for.
dict
Response Syntax
{
'namespace': {
'adminPasswordSecretArn': 'string',
'adminPasswordSecretKmsKeyId': 'string',
'adminUsername': 'string',
'creationDate': datetime(2015, 1, 1),
'dbName': 'string',
'defaultIamRoleArn': 'string',
'iamRoles': [
'string',
],
'kmsKeyId': 'string',
'logExports': [
'useractivitylog'|'userlog'|'connectionlog',
],
'namespaceArn': 'string',
'namespaceId': 'string',
'namespaceName': 'string',
'status': 'AVAILABLE'|'MODIFYING'|'DELETING'
}
}
Response Structure
(dict) --
namespace (dict) --
The returned namespace object.
adminPasswordSecretArn (string) --
The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.
adminPasswordSecretKmsKeyId (string) --
The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
adminUsername (string) --
The username of the administrator for the first database created in the namespace.
creationDate (datetime) --
The date of when the namespace was created.
dbName (string) --
The name of the first database created in the namespace.
defaultIamRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
iamRoles (list) --
A list of IAM roles to associate with the namespace.
(string) --
kmsKeyId (string) --
The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
logExports (list) --
The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.
(string) --
namespaceArn (string) --
The Amazon Resource Name (ARN) associated with a namespace.
namespaceId (string) --
The unique identifier of a namespace.
namespaceName (string) --
The name of the namespace. Must be between 3-64 alphanumeric characters in lowercase, and it cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
status (string) --
The status of the namespace.
{'snapshot': {'adminPasswordSecretArn': 'string',
'adminPasswordSecretKmsKeyId': 'string'}}
Returns information about a specific snapshot.
See also: AWS API Documentation
Request Syntax
client.get_snapshot(
ownerAccount='string',
snapshotArn='string',
snapshotName='string'
)
string
The owner Amazon Web Services account of a snapshot shared with another user.
string
The Amazon Resource Name (ARN) of the snapshot to return.
string
The name of the snapshot to return.
dict
Response Syntax
{
'snapshot': {
'accountsWithProvisionedRestoreAccess': [
'string',
],
'accountsWithRestoreAccess': [
'string',
],
'actualIncrementalBackupSizeInMegaBytes': 123.0,
'adminPasswordSecretArn': 'string',
'adminPasswordSecretKmsKeyId': 'string',
'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 returned 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.
adminPasswordSecretArn (string) --
The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.
adminPasswordSecretKmsKeyId (string) --
The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
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.
{'namespaces': {'adminPasswordSecretArn': 'string',
'adminPasswordSecretKmsKeyId': 'string'}}
Returns information about a list of specified namespaces.
See also: AWS API Documentation
Request Syntax
client.list_namespaces(
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 ListNamespaces operation returns a nextToken, you can include the returned nextToken in following ListNamespaces operations, which returns results in the next page.
dict
Response Syntax
{
'namespaces': [
{
'adminPasswordSecretArn': 'string',
'adminPasswordSecretKmsKeyId': 'string',
'adminUsername': 'string',
'creationDate': datetime(2015, 1, 1),
'dbName': 'string',
'defaultIamRoleArn': 'string',
'iamRoles': [
'string',
],
'kmsKeyId': 'string',
'logExports': [
'useractivitylog'|'userlog'|'connectionlog',
],
'namespaceArn': 'string',
'namespaceId': 'string',
'namespaceName': 'string',
'status': 'AVAILABLE'|'MODIFYING'|'DELETING'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
namespaces (list) --
The list of returned namespaces.
(dict) --
A collection of database objects and users.
adminPasswordSecretArn (string) --
The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.
adminPasswordSecretKmsKeyId (string) --
The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
adminUsername (string) --
The username of the administrator for the first database created in the namespace.
creationDate (datetime) --
The date of when the namespace was created.
dbName (string) --
The name of the first database created in the namespace.
defaultIamRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
iamRoles (list) --
A list of IAM roles to associate with the namespace.
(string) --
kmsKeyId (string) --
The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
logExports (list) --
The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.
(string) --
namespaceArn (string) --
The Amazon Resource Name (ARN) associated with a namespace.
namespaceId (string) --
The unique identifier of a namespace.
namespaceName (string) --
The name of the namespace. Must be between 3-64 alphanumeric characters in lowercase, and it cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
status (string) --
The status of the namespace.
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.
{'snapshots': {'adminPasswordSecretArn': 'string',
'adminPasswordSecretKmsKeyId': 'string'}}
Returns a list of snapshots.
See also: AWS API Documentation
Request Syntax
client.list_snapshots(
endTime=datetime(2015, 1, 1),
maxResults=123,
namespaceArn='string',
namespaceName='string',
nextToken='string',
ownerAccount='string',
startTime=datetime(2015, 1, 1)
)
datetime
The timestamp showing when the snapshot creation 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 all snapshots.
string
The namespace from which to list all snapshots.
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.
string
The owner Amazon Web Services account of the snapshot.
datetime
The time when the creation of the snapshot was initiated.
dict
Response Syntax
{
'nextToken': 'string',
'snapshots': [
{
'accountsWithProvisionedRestoreAccess': [
'string',
],
'accountsWithRestoreAccess': [
'string',
],
'actualIncrementalBackupSizeInMegaBytes': 123.0,
'adminPasswordSecretArn': 'string',
'adminPasswordSecretKmsKeyId': 'string',
'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) --
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.
snapshots (list) --
All of the returned snapshot objects.
(dict) --
A snapshot object that contains databases.
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.
adminPasswordSecretArn (string) --
The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.
adminPasswordSecretKmsKeyId (string) --
The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
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.
{'namespace': {'adminPasswordSecretArn': 'string',
'adminPasswordSecretKmsKeyId': 'string'}}
Restore the data from a recovery point.
See also: AWS API Documentation
Request Syntax
client.restore_from_recovery_point(
namespaceName='string',
recoveryPointId='string',
workgroupName='string'
)
string
[REQUIRED]
The name of the namespace to restore data into.
string
[REQUIRED]
The unique identifier of the recovery point to restore from.
string
[REQUIRED]
The name of the workgroup used to restore data.
dict
Response Syntax
{
'namespace': {
'adminPasswordSecretArn': 'string',
'adminPasswordSecretKmsKeyId': 'string',
'adminUsername': 'string',
'creationDate': datetime(2015, 1, 1),
'dbName': 'string',
'defaultIamRoleArn': 'string',
'iamRoles': [
'string',
],
'kmsKeyId': 'string',
'logExports': [
'useractivitylog'|'userlog'|'connectionlog',
],
'namespaceArn': 'string',
'namespaceId': 'string',
'namespaceName': 'string',
'status': 'AVAILABLE'|'MODIFYING'|'DELETING'
},
'recoveryPointId': 'string'
}
Response Structure
(dict) --
namespace (dict) --
The namespace that data was restored into.
adminPasswordSecretArn (string) --
The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.
adminPasswordSecretKmsKeyId (string) --
The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
adminUsername (string) --
The username of the administrator for the first database created in the namespace.
creationDate (datetime) --
The date of when the namespace was created.
dbName (string) --
The name of the first database created in the namespace.
defaultIamRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
iamRoles (list) --
A list of IAM roles to associate with the namespace.
(string) --
kmsKeyId (string) --
The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
logExports (list) --
The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.
(string) --
namespaceArn (string) --
The Amazon Resource Name (ARN) associated with a namespace.
namespaceId (string) --
The unique identifier of a namespace.
namespaceName (string) --
The name of the namespace. Must be between 3-64 alphanumeric characters in lowercase, and it cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
status (string) --
The status of the namespace.
recoveryPointId (string) --
The unique identifier of the recovery point used for the restore.
{'adminPasswordSecretKmsKeyId': 'string', 'manageAdminPassword': 'boolean'}
Response {'namespace': {'adminPasswordSecretArn': 'string',
'adminPasswordSecretKmsKeyId': 'string'}}
Restores a namespace from a snapshot.
See also: AWS API Documentation
Request Syntax
client.restore_from_snapshot(
adminPasswordSecretKmsKeyId='string',
manageAdminPassword=True|False,
namespaceName='string',
ownerAccount='string',
snapshotArn='string',
snapshotName='string',
workgroupName='string'
)
string
The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
boolean
If true, Amazon Redshift uses Secrets Manager to manage the restored snapshot's admin credentials. If MmanageAdminPassword is false or not set, Amazon Redshift uses the admin credentials that the namespace or cluster had at the time the snapshot was taken.
string
[REQUIRED]
The name of the namespace to restore the snapshot to.
string
The Amazon Web Services account that owns the snapshot.
string
The Amazon Resource Name (ARN) of the snapshot to restore from. Required if restoring from Amazon Redshift Serverless to a provisioned cluster. Must not be specified at the same time as snapshotName.
The format of the ARN is arn:aws:redshift:<region>:<account_id>:snapshot:<cluster_identifier>/<snapshot_identifier>.
string
The name of the snapshot to restore from. Must not be specified at the same time as snapshotArn.
string
[REQUIRED]
The name of the workgroup used to restore the snapshot.
dict
Response Syntax
{
'namespace': {
'adminPasswordSecretArn': 'string',
'adminPasswordSecretKmsKeyId': 'string',
'adminUsername': 'string',
'creationDate': datetime(2015, 1, 1),
'dbName': 'string',
'defaultIamRoleArn': 'string',
'iamRoles': [
'string',
],
'kmsKeyId': 'string',
'logExports': [
'useractivitylog'|'userlog'|'connectionlog',
],
'namespaceArn': 'string',
'namespaceId': 'string',
'namespaceName': 'string',
'status': 'AVAILABLE'|'MODIFYING'|'DELETING'
},
'ownerAccount': 'string',
'snapshotName': 'string'
}
Response Structure
(dict) --
namespace (dict) --
A collection of database objects and users.
adminPasswordSecretArn (string) --
The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.
adminPasswordSecretKmsKeyId (string) --
The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
adminUsername (string) --
The username of the administrator for the first database created in the namespace.
creationDate (datetime) --
The date of when the namespace was created.
dbName (string) --
The name of the first database created in the namespace.
defaultIamRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
iamRoles (list) --
A list of IAM roles to associate with the namespace.
(string) --
kmsKeyId (string) --
The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
logExports (list) --
The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.
(string) --
namespaceArn (string) --
The Amazon Resource Name (ARN) associated with a namespace.
namespaceId (string) --
The unique identifier of a namespace.
namespaceName (string) --
The name of the namespace. Must be between 3-64 alphanumeric characters in lowercase, and it cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
status (string) --
The status of the namespace.
ownerAccount (string) --
The owner Amazon Web Services; account of the snapshot that was restored.
snapshotName (string) --
The name of the snapshot used to restore the namespace.
{'adminPasswordSecretKmsKeyId': 'string', 'manageAdminPassword': 'boolean'}
Response {'namespace': {'adminPasswordSecretArn': 'string',
'adminPasswordSecretKmsKeyId': 'string'}}
Updates a namespace with the specified settings. Unless required, you can't update multiple parameters in one request. For example, you must specify both adminUsername and adminUserPassword to update either field, but you can't update both kmsKeyId and logExports in a single request.
See also: AWS API Documentation
Request Syntax
client.update_namespace(
adminPasswordSecretKmsKeyId='string',
adminUserPassword='string',
adminUsername='string',
defaultIamRoleArn='string',
iamRoles=[
'string',
],
kmsKeyId='string',
logExports=[
'useractivitylog'|'userlog'|'connectionlog',
],
manageAdminPassword=True|False,
namespaceName='string'
)
string
The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. You can only use this parameter if manageAdminPassword is true.
string
The password of the administrator for the first database created in the namespace. This parameter must be updated together with adminUsername.
You can't use adminUserPassword if manageAdminPassword is true.
string
The username of the administrator for the first database created in the namespace. This parameter must be updated together with adminUserPassword.
string
The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace. This parameter must be updated together with iamRoles.
list
A list of IAM roles to associate with the namespace. This parameter must be updated together with defaultIamRoleArn.
(string) --
string
The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
list
The types of logs the namespace can export. The export types are userlog, connectionlog, and useractivitylog.
(string) --
boolean
If true, Amazon Redshift uses Secrets Manager to manage the namespace's admin credentials. You can't use adminUserPassword if manageAdminPassword is true. If manageAdminPassword is false or not set, Amazon Redshift uses adminUserPassword for the admin user account's password.
string
[REQUIRED]
The name of the namespace to update. You can't update the name of a namespace once it is created.
dict
Response Syntax
{
'namespace': {
'adminPasswordSecretArn': 'string',
'adminPasswordSecretKmsKeyId': 'string',
'adminUsername': 'string',
'creationDate': datetime(2015, 1, 1),
'dbName': 'string',
'defaultIamRoleArn': 'string',
'iamRoles': [
'string',
],
'kmsKeyId': 'string',
'logExports': [
'useractivitylog'|'userlog'|'connectionlog',
],
'namespaceArn': 'string',
'namespaceId': 'string',
'namespaceName': 'string',
'status': 'AVAILABLE'|'MODIFYING'|'DELETING'
}
}
Response Structure
(dict) --
namespace (dict) --
A list of tag instances.
adminPasswordSecretArn (string) --
The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.
adminPasswordSecretKmsKeyId (string) --
The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
adminUsername (string) --
The username of the administrator for the first database created in the namespace.
creationDate (datetime) --
The date of when the namespace was created.
dbName (string) --
The name of the first database created in the namespace.
defaultIamRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
iamRoles (list) --
A list of IAM roles to associate with the namespace.
(string) --
kmsKeyId (string) --
The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
logExports (list) --
The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.
(string) --
namespaceArn (string) --
The Amazon Resource Name (ARN) associated with a namespace.
namespaceId (string) --
The unique identifier of a namespace.
namespaceName (string) --
The name of the namespace. Must be between 3-64 alphanumeric characters in lowercase, and it cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
status (string) --
The status of the namespace.
{'snapshot': {'adminPasswordSecretArn': 'string',
'adminPasswordSecretKmsKeyId': 'string'}}
Updates a snapshot.
See also: AWS API Documentation
Request Syntax
client.update_snapshot(
retentionPeriod=123,
snapshotName='string'
)
integer
The new retention period of the snapshot.
string
[REQUIRED]
The name of the snapshot.
dict
Response Syntax
{
'snapshot': {
'accountsWithProvisionedRestoreAccess': [
'string',
],
'accountsWithRestoreAccess': [
'string',
],
'actualIncrementalBackupSizeInMegaBytes': 123.0,
'adminPasswordSecretArn': 'string',
'adminPasswordSecretKmsKeyId': 'string',
'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 updated 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.
adminPasswordSecretArn (string) --
The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.
adminPasswordSecretKmsKeyId (string) --
The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
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.