RedshiftServerless / Client / restore_from_snapshot

restore_from_snapshot

RedshiftServerless.Client.restore_from_snapshot(**kwargs)

Restores a namespace from a snapshot.

See also: AWS API Documentation

Request Syntax

response = client.restore_from_snapshot(
    adminPasswordSecretKmsKeyId='string',
    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.

• 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 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>.

• 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',
        '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.

Exceptions

• RedshiftServerless.Client.exceptions.InternalServerException

• RedshiftServerless.Client.exceptions.ResourceNotFoundException

• RedshiftServerless.Client.exceptions.ConflictException

• RedshiftServerless.Client.exceptions.ValidationException

• RedshiftServerless.Client.exceptions.ServiceQuotaExceededException