Creates a snapshot of all databases in a namespace. For more information about snapshots, see Working with snapshots and recovery points.
Request Syntax
{
"namespaceName": "string",
"retentionPeriod": number,
"snapshotName": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- namespaceName
-
The namespace to create a snapshot for.
Type: String
Required: Yes
- retentionPeriod
-
How long to retain the created snapshot.
Type: Integer
Required: No
- snapshotName
-
The name of the snapshot.
Type: String
Required: Yes
-
An array of Tag objects to associate with the snapshot.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
Response Syntax
{
"snapshot": {
"accountsWithProvisionedRestoreAccess": [ "string" ],
"accountsWithRestoreAccess": [ "string" ],
"actualIncrementalBackupSizeInMegaBytes": number,
"adminPasswordSecretArn": "string",
"adminPasswordSecretKmsKeyId": "string",
"adminUsername": "string",
"backupProgressInMegaBytes": number,
"currentBackupRateInMegaBytesPerSecond": number,
"elapsedTimeInSeconds": number,
"estimatedSecondsToCompletion": number,
"kmsKeyId": "string",
"namespaceArn": "string",
"namespaceName": "string",
"ownerAccount": "string",
"snapshotArn": "string",
"snapshotCreateTime": "string",
"snapshotName": "string",
"snapshotRemainingDays": number,
"snapshotRetentionPeriod": number,
"snapshotRetentionStartTime": "string",
"status": "string",
"totalBackupSizeInMegaBytes": number
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConflictException
-
The submitted action has conflicts.
HTTP Status Code: 400
- InternalServerException
-
The request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
- ResourceNotFoundException
-
The resource could not be found.
HTTP Status Code: 400
- ServiceQuotaExceededException
-
The service limit was exceeded.
HTTP Status Code: 400
- TooManyTagsException
-
The request exceeded the number of tags allowed for a resource.
HTTP Status Code: 400
- ValidationException
-
The input failed to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
