Note:
You are viewing the documentation for an older major version of the AWS CLI (version 1).AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . redshift-serverless ]
restore-from-recovery-point¶
Synopsis¶
restore-from-recovery-point
--namespace-name <value>
--recovery-point-id <value>
--workgroup-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
Options¶
--namespace-name (string)
The name of the namespace to restore data into.
--recovery-point-id (string)
The unique identifier of the recovery point to restore from.
--workgroup-name (string)
The name of the workgroup used to restore data.
--cli-input-json (string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command's default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
- json
- text
- table
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
Output¶
namespace -> (structure)
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 -> (timestamp)
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.