RedshiftServerless / Client / restore_from_snapshot

restore_from_snapshot¶

RedshiftServerless.Client.restore_from_snapshot(**kwargs)¶

Restores a namespace from a snapshot.

Request Syntax

response = client.restore_from_snapshot(
    adminPasswordSecretKmsKeyId='string',
    maintainIntegration=True|False,
    manageAdminPassword=True|False,
    namespaceName='string',
    ownerAccount='string',
    snapshotArn='string',
    snapshotName='string',
    workgroupName='string'
)

Parameters:

adminPasswordSecretKmsKeyId (string) – The ID of the Key Management Service (KMS) key used to encrypt and store the namespace’s admin credentials secret.
maintainIntegration (boolean) –
If true, maintain existing data sharing, zero-ETL and S3 event integrations when restoring. Otherwise, integrations will not be maintained after the restore operation. Integrations are only maintained when restored to the same serverless namespace.

Default: true
manageAdminPassword (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.
namespaceName (string) –
[REQUIRED]

The name of the namespace to restore the snapshot to.
ownerAccount (string) – The Amazon Web Services account that owns the snapshot.
snapshotArn (string) –
The Amazon Resource Name (ARN) of the snapshot to restore from. Required if restoring from a provisioned cluster to Amazon Redshift Serverless. 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>.
snapshotName (string) – The name of the snapshot to restore from. Must not be specified at the same time as snapshotArn.
workgroupName (string) –
[REQUIRED]

The name of the workgroup used to restore the snapshot.

Return type:

dict

Returns:

Response Syntax

{
    'namespace': {
        'adminPasswordSecretArn': 'string',
        'adminPasswordSecretKmsKeyId': 'string',
        'adminUsername': 'string',
        'catalogArn': 'string',
        'creationDate': datetime(2015, 1, 1),
        'dbName': 'string',
        'defaultIamRoleArn': 'string',
        'iamRoles': [
            'string',
        ],
        'kmsKeyId': 'string',
        'lakehouseRegistrationStatus': 'string',
        'logExports': [
            'useractivitylog'|'userlog'|'connectionlog',
        ],
        'namespaceArn': 'string',
        'namespaceId': 'string',
        'namespaceName': 'string',
        's3TablePublishStatus': {
            'enabledAll': True|False,
            'lastIngestionTimes': {
                'string': 'string'
            },
            's3TableGranularity': 'namespace'|'account',
            's3TableNamespace': 'string',
            's3Tables': [
                '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.
  - catalogArn (string) –
    
    The Amazon Resource Name (ARN) of the Glue Data Catalog associated with the namespace enabled with Amazon Redshift federated permissions.
  - 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.
  - lakehouseRegistrationStatus (string) –
    
    The status of the lakehouse registration for the namespace. Indicates whether the namespace is successfully registered with Amazon Redshift federated permissions.
  - 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.
  - s3TablePublishStatus (dict) –
    
    The current Amazon S3 Tables log-publishing status for the namespace. Not returned when S3 Tables publishing has never been configured for the namespace.
    - enabledAll (boolean) –
      
      true when the namespace is enrolled in every current and future system table rather than an explicit list of tables.
    - lastIngestionTimes (dict) –
      
      A map of system table name to the time that table last received data, as an ISO-8601 timestamp. A table that has not yet been ingested is absent from the map. Use it to judge data freshness.
      - (string) –
        
        (string) –
    - s3TableGranularity (string) –
      
      The scope currently in effect. Values are namespace or account.
    - s3TableNamespace (string) –
      
      The identifier of the namespace in the S3 table bucket that holds the published tables.
    - s3Tables (list) –
      
      The system tables currently being published.
      - (string) –
        
        A system-table view name to publish to S3 Tables (e.g. “sys_query_history”), or the keyword “all” to publish every current and future system table.
  - 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.

Exceptions

RedshiftServerless.Client.exceptions.InternalServerException
RedshiftServerless.Client.exceptions.ResourceNotFoundException
RedshiftServerless.Client.exceptions.ValidationException
RedshiftServerless.Client.exceptions.ConflictException
RedshiftServerless.Client.exceptions.ServiceQuotaExceededException