Restore a DynamoDB table
Restores the specified DynamoDB table backup to the specified target destination.
Query Parameters
- embed string
Embeds the details of each associated resource. Set the parameter to one of the following embeddable links to include additional details associated with the resource.
For more information about embedded links, refer to the Embedding Referenced Resources section of this guide.Embeddable Link Description read-task Embeds the associated task in the response. For example, ?embed=read-task
- application/json
Request Body required
source object required
target object required
Responses
- 202
- default
Success
- application/api.clumio.restored-aws-dynamodb-tables=v1+json
- Schema
- Example (from schema)
Schema
_embedded object
_links object
- task_id string
The Clumio-assigned ID of the task created by this restore request. The progress of the task can be monitored using the
GET /tasks/{task_id}
endpoint.
{
"_embedded": {},
"_links": {
"_self": {
"href": "string",
"templated": true,
"type": "string"
},
"read-task": {
"href": "string",
"templated": true,
"type": "string"
}
},
"task_id": "string"
}
Error
- application/json
- Schema
- Example (from schema)
Schema
errors object[]
{
"errors": [
{
"error_code": 0,
"error_message": "string"
}
]
}
POST /restores/aws/dynamodb-tables
Authorization
Request
Request
curl -L -X POST 'https://us-west-2.api.clumio.com/restores/aws/dynamodb-tables' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-aws-dynamodb-tables=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"source": {
"continuous_backup": {
"table_id": "string",
"timestamp": "string",
"type": "aws_pitr",
"use_latest_restorable_time": true
},
"securevault_backup": {
"backup_id": "string"
}
},
"target": {
"billing_mode": "string",
"environment_id": "string",
"global_secondary_indexes": [
{
"index_name": "string",
"key_schema": [
{
"attribute_name": "string",
"key_type": "string"
}
],
"projection": {
"non_key_attributes": [
"string"
],
"projection_type": "string"
},
"provisioned_throughput": {
"read_capacity_units": 0,
"write_capacity_units": 0
}
}
],
"global_table_version": "string",
"local_secondary_indexes": [
{
"index_name": "string",
"key_schema": [
{
"attribute_name": "string",
"key_type": "string"
}
],
"projection": {
"non_key_attributes": [
"string"
],
"projection_type": "string"
}
}
],
"pitr_status": true,
"provisioned_throughput": {
"read_capacity_units": 0,
"write_capacity_units": 0
},
"replicas": [
{
"global_secondary_indexes": [
{
"index_name": "string",
"provisioned_throughput_override": {
"read_capacity_units": 0
}
}
],
"kms_master_key_id": "string",
"provisioned_throughput_override": {
"read_capacity_units": 0
},
"region_name": "string"
}
],
"sse_specification": {
"kms_key_type": "string",
"kms_master_key_id": "string"
},
"stream_specification": {
"enabled": true,
"view_type": "string"
},
"table_class": "string",
"table_name": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
}'
curl -L -X POST 'https://us-west-2.api.clumio.com/restores/aws/dynamodb-tables' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-aws-dynamodb-tables=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"source": {
"continuous_backup": {
"table_id": "string",
"timestamp": "string",
"type": "aws_pitr",
"use_latest_restorable_time": true
},
"securevault_backup": {
"backup_id": "string"
}
},
"target": {
"billing_mode": "string",
"environment_id": "string",
"global_secondary_indexes": [
{
"index_name": "string",
"key_schema": [
{
"attribute_name": "string",
"key_type": "string"
}
],
"projection": {
"non_key_attributes": [
"string"
],
"projection_type": "string"
},
"provisioned_throughput": {
"read_capacity_units": 0,
"write_capacity_units": 0
}
}
],
"global_table_version": "string",
"local_secondary_indexes": [
{
"index_name": "string",
"key_schema": [
{
"attribute_name": "string",
"key_type": "string"
}
],
"projection": {
"non_key_attributes": [
"string"
],
"projection_type": "string"
}
}
],
"pitr_status": true,
"provisioned_throughput": {
"read_capacity_units": 0,
"write_capacity_units": 0
},
"replicas": [
{
"global_secondary_indexes": [
{
"index_name": "string",
"provisioned_throughput_override": {
"read_capacity_units": 0
}
}
],
"kms_master_key_id": "string",
"provisioned_throughput_override": {
"read_capacity_units": 0
},
"region_name": "string"
}
],
"sse_specification": {
"kms_key_type": "string",
"kms_master_key_id": "string"
},
"stream_specification": {
"enabled": true,
"view_type": "string"
},
"table_class": "string",
"table_name": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
}'
curl -L -X POST 'https://us-west-2.api.clumio.com/restores/aws/dynamodb-tables' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-aws-dynamodb-tables=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"source": {
"continuous_backup": {
"table_id": "string",
"timestamp": "string",
"type": "aws_pitr",
"use_latest_restorable_time": true
},
"securevault_backup": {
"backup_id": "string"
}
},
"target": {
"billing_mode": "string",
"environment_id": "string",
"global_secondary_indexes": [
{
"index_name": "string",
"key_schema": [
{
"attribute_name": "string",
"key_type": "string"
}
],
"projection": {
"non_key_attributes": [
"string"
],
"projection_type": "string"
},
"provisioned_throughput": {
"read_capacity_units": 0,
"write_capacity_units": 0
}
}
],
"global_table_version": "string",
"local_secondary_indexes": [
{
"index_name": "string",
"key_schema": [
{
"attribute_name": "string",
"key_type": "string"
}
],
"projection": {
"non_key_attributes": [
"string"
],
"projection_type": "string"
}
}
],
"pitr_status": true,
"provisioned_throughput": {
"read_capacity_units": 0,
"write_capacity_units": 0
},
"replicas": [
{
"global_secondary_indexes": [
{
"index_name": "string",
"provisioned_throughput_override": {
"read_capacity_units": 0
}
}
],
"kms_master_key_id": "string",
"provisioned_throughput_override": {
"read_capacity_units": 0
},
"region_name": "string"
}
],
"sse_specification": {
"kms_key_type": "string",
"kms_master_key_id": "string"
},
"stream_specification": {
"enabled": true,
"view_type": "string"
},
"table_class": "string",
"table_name": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
}'
curl -L -X POST 'https://us-west-2.api.clumio.com/restores/aws/dynamodb-tables' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-aws-dynamodb-tables=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"source": {
"continuous_backup": {
"table_id": "string",
"timestamp": "string",
"type": "aws_pitr",
"use_latest_restorable_time": true
},
"securevault_backup": {
"backup_id": "string"
}
},
"target": {
"billing_mode": "string",
"environment_id": "string",
"global_secondary_indexes": [
{
"index_name": "string",
"key_schema": [
{
"attribute_name": "string",
"key_type": "string"
}
],
"projection": {
"non_key_attributes": [
"string"
],
"projection_type": "string"
},
"provisioned_throughput": {
"read_capacity_units": 0,
"write_capacity_units": 0
}
}
],
"global_table_version": "string",
"local_secondary_indexes": [
{
"index_name": "string",
"key_schema": [
{
"attribute_name": "string",
"key_type": "string"
}
],
"projection": {
"non_key_attributes": [
"string"
],
"projection_type": "string"
}
}
],
"pitr_status": true,
"provisioned_throughput": {
"read_capacity_units": 0,
"write_capacity_units": 0
},
"replicas": [
{
"global_secondary_indexes": [
{
"index_name": "string",
"provisioned_throughput_override": {
"read_capacity_units": 0
}
}
],
"kms_master_key_id": "string",
"provisioned_throughput_override": {
"read_capacity_units": 0
},
"region_name": "string"
}
],
"sse_specification": {
"kms_key_type": "string",
"kms_master_key_id": "string"
},
"stream_specification": {
"enabled": true,
"view_type": "string"
},
"table_class": "string",
"table_name": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
}'
curl -L -X POST 'https://us-west-2.api.clumio.com/restores/aws/dynamodb-tables' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-aws-dynamodb-tables=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"source": {
"continuous_backup": {
"table_id": "string",
"timestamp": "string",
"type": "aws_pitr",
"use_latest_restorable_time": true
},
"securevault_backup": {
"backup_id": "string"
}
},
"target": {
"billing_mode": "string",
"environment_id": "string",
"global_secondary_indexes": [
{
"index_name": "string",
"key_schema": [
{
"attribute_name": "string",
"key_type": "string"
}
],
"projection": {
"non_key_attributes": [
"string"
],
"projection_type": "string"
},
"provisioned_throughput": {
"read_capacity_units": 0,
"write_capacity_units": 0
}
}
],
"global_table_version": "string",
"local_secondary_indexes": [
{
"index_name": "string",
"key_schema": [
{
"attribute_name": "string",
"key_type": "string"
}
],
"projection": {
"non_key_attributes": [
"string"
],
"projection_type": "string"
}
}
],
"pitr_status": true,
"provisioned_throughput": {
"read_capacity_units": 0,
"write_capacity_units": 0
},
"replicas": [
{
"global_secondary_indexes": [
{
"index_name": "string",
"provisioned_throughput_override": {
"read_capacity_units": 0
}
}
],
"kms_master_key_id": "string",
"provisioned_throughput_override": {
"read_capacity_units": 0
},
"region_name": "string"
}
],
"sse_specification": {
"kms_key_type": "string",
"kms_master_key_id": "string"
},
"stream_specification": {
"enabled": true,
"view_type": "string"
},
"table_class": "string",
"table_name": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
}'
curl -L -X POST 'https://us-west-2.api.clumio.com/restores/aws/dynamodb-tables' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-aws-dynamodb-tables=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"source": {
"continuous_backup": {
"table_id": "string",
"timestamp": "string",
"type": "aws_pitr",
"use_latest_restorable_time": true
},
"securevault_backup": {
"backup_id": "string"
}
},
"target": {
"billing_mode": "string",
"environment_id": "string",
"global_secondary_indexes": [
{
"index_name": "string",
"key_schema": [
{
"attribute_name": "string",
"key_type": "string"
}
],
"projection": {
"non_key_attributes": [
"string"
],
"projection_type": "string"
},
"provisioned_throughput": {
"read_capacity_units": 0,
"write_capacity_units": 0
}
}
],
"global_table_version": "string",
"local_secondary_indexes": [
{
"index_name": "string",
"key_schema": [
{
"attribute_name": "string",
"key_type": "string"
}
],
"projection": {
"non_key_attributes": [
"string"
],
"projection_type": "string"
}
}
],
"pitr_status": true,
"provisioned_throughput": {
"read_capacity_units": 0,
"write_capacity_units": 0
},
"replicas": [
{
"global_secondary_indexes": [
{
"index_name": "string",
"provisioned_throughput_override": {
"read_capacity_units": 0
}
}
],
"kms_master_key_id": "string",
"provisioned_throughput_override": {
"read_capacity_units": 0
},
"region_name": "string"
}
],
"sse_specification": {
"kms_key_type": "string",
"kms_master_key_id": "string"
},
"stream_specification": {
"enabled": true,
"view_type": "string"
},
"table_class": "string",
"table_name": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
}'
curl -L -X POST 'https://us-west-2.api.clumio.com/restores/aws/dynamodb-tables' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-aws-dynamodb-tables=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"source": {
"continuous_backup": {
"table_id": "string",
"timestamp": "string",
"type": "aws_pitr",
"use_latest_restorable_time": true
},
"securevault_backup": {
"backup_id": "string"
}
},
"target": {
"billing_mode": "string",
"environment_id": "string",
"global_secondary_indexes": [
{
"index_name": "string",
"key_schema": [
{
"attribute_name": "string",
"key_type": "string"
}
],
"projection": {
"non_key_attributes": [
"string"
],
"projection_type": "string"
},
"provisioned_throughput": {
"read_capacity_units": 0,
"write_capacity_units": 0
}
}
],
"global_table_version": "string",
"local_secondary_indexes": [
{
"index_name": "string",
"key_schema": [
{
"attribute_name": "string",
"key_type": "string"
}
],
"projection": {
"non_key_attributes": [
"string"
],
"projection_type": "string"
}
}
],
"pitr_status": true,
"provisioned_throughput": {
"read_capacity_units": 0,
"write_capacity_units": 0
},
"replicas": [
{
"global_secondary_indexes": [
{
"index_name": "string",
"provisioned_throughput_override": {
"read_capacity_units": 0
}
}
],
"kms_master_key_id": "string",
"provisioned_throughput_override": {
"read_capacity_units": 0
},
"region_name": "string"
}
],
"sse_specification": {
"kms_key_type": "string",
"kms_master_key_id": "string"
},
"stream_specification": {
"enabled": true,
"view_type": "string"
},
"table_class": "string",
"table_name": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
}'