Start a DynamoDB backup records retrieval query

Start a DynamoDB backup records retrieval query with the query filters provided in user input. If the query preview flag is set in the input then the result will be returned to the response otherwise the query will run in background and a task id will be returned.

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.

  Embeddable Link	Description
  read-task	Embeds the associated task in the response. For example, ?embed=read-task

  For more information about embedded links, refer to the Embedding Referenced Resources section of this guide.

application/json

Request Body

• query_filter object required

  Filters based on which DynamoDB backup records are filtered in the query.

  attribute_filters object[]

  Attribute filters of the DynamoDB table.

  condition string

  Filter condition on the DynamoDB attribute.

  Condition	Usage
  EqualTo	Compares the filter attribute to be equal to the operand value. It expects only one operand value. Supported types are: String, Number, Binary and Boolean.
  NotEqualTo	Compares the filter attribute to not be equal to the operand value. It expects only one operand value. Supported types are: String, Number, Binary and Boolean.
  LessThanOrEqualTo	Compares the filter attribute to be less than or equal to the operand value. It expects only one operand value. Supported types are: String, Number and Binary.
  LessThan	Compares the filter attribute to be less than the operand value. It expects only one operand value. Supported types are: String, Number and Binary.
  GreaterThanOrEqualTo	Compares the filter attribute to be greater than or equal to the operand value. It expects only one operand value. Supported types are: String, Number and Binary.
  GreaterThan	Compares the filter attribute to be greater than the operand value. It expects only one operand value. Supported types are: String, Number and Binary.
  Between	Compares the filter attribute to be between the operand values. It expects two operand values. Supported types are: String, Number and Binary.
  Exists	Checks the filter attribute to exist. It does not expect any operand value. Supported types are: String, Number, Binary, Boolean and Null.
  NotExists	Checks the filter attribute to not exist. It does not expect any operand value. Supported types are: String, Number, Binary, Boolean and Null.
  Contains	Checks the filter attribute to contain the operand value. It expects only one operand value. Supported types are: String and Binary.
  NotContains	Checks the filter attribute to not contain the operand value. It expects only one operand value. Supported types are: String and Binary.
  BeginsWith	Checks the filter attribute to begin with the operand value. It expects only one operand value. Supported types are: String and Binary.

  name string

  DynamoDB attribute name.

  type string

  Data-type of the DynamoDB attribute.

  Allowed values
  String
  Number
  Binary
  Boolean
  Null

  values string[]

  Values for the attribute filter.

  partition_key string required

  Partition Key value of the DynamoDB table.

  sort_key_filter object

  Sort Key filter of the DynamoDB table.

  condition string

  Filter condition on the DynamoDB sort key.

  Condition	Usage
  EqualTo	Compares the filter attribute to be equal to the operand value. It expects only one operand value. Supported types are: String, Number and Binary.
  NotEqualTo	Compares the filter attribute to not be equal to the operand value. It expects only one operand value. Supported types are: String, Number and Binary.
  LessThanOrEqualTo	Compares the filter attribute to be less than or equal to the operand value. It expects only one operand value. Supported types are: String, Number and Binary.
  LessThan	Compares the filter attribute to be less than the operand value. It expects only one operand value. Supported types are: String, Number and Binary.
  GreaterThanOrEqualTo	Compares the filter attribute to be greater than or equal to the operand value. It expects only one operand value. Supported types are: String, Number and Binary.
  GreaterThan	Compares the filter attribute to be greater than the operand value. It expects only one operand value. Supported types are: String, Number and Binary.
  Between	Compares the filter attribute to be between the operand values. It expects two operand values. Supported types are: String, Number and Binary.
  Exists	Checks the filter attribute to exist. It does not expect any operand value. Supported types are: String, Number and Binary.
  NotExists	Checks the filter attribute to not exist. It does not expect any operand value. Supported types are: String, Number and Binary.
  Contains	Checks the filter attribute to contain the operand value. It expects only one operand value. Supported types are: String and Binary.
  NotContains	Checks the filter attribute to not contain the operand value. It expects only one operand value. Supported types are: String and Binary.
  BeginsWith	Checks the filter attribute to begin with the operand value. It expects only one operand value. Supported types are: String and Binary.

  values string[]

  Values for the attribute filter.

• source object required

  The parameters for initiating a DynamoDB table backup query from a backup.

  backup_id string required

  Performs the operation on a DynamoDB table within the specified backup. Use the GET /backups/aws/dynamodb-tables endpoint to fetch valid values.

• target object required

  The destination information for the operation, representing the access option for the query results. Users can access the query results by direct download or by email. The direct download (direct_download) option allows users to directly download the restored file from the Clumio UI. The email (email) option allows users to access the restored file using a downloadable link they receive by email. If a target is not specified, then target defaults to direct_download.

  direct_download object

  Specifies the Clumio UI as the restore target for direct download. Optionally set direct_download: {}. If a target is not specified, then target defaults to direct_download.

  email object

  Specifies a download link (accessible via emails) as the restore target. If not specified, target defaults to direct_download.

  message string

  The optional message sent as part of the email.

  recipient_emails string[]

  The recipient email addresses who will receive the download link to the restored records.

  preview boolean

  Determines whether the query is preview only. If true, a preview of the query results will be provided in the response immediately. If false or omitted, a task will be queued to make results of the query available for asynchronous download.

Responses

• 200
• 202
• default

---

Records preview success

application/api.clumio.restored-records-aws-dynamodb-tables=v1+json

• Schema
• Example (from schema)

---

Schema

• _links object

  URLs to pages related to the resource.

  _self object

  The HATEOAS link to this resource.

  href string

  The URI for the referenced operation.

  templated boolean

  Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  type string

  The HTTP method to be used with the "href" link for the referenced operation.

• preview_result object

  If preview was not set to true in the request, then the result of the query will be available for download asynchronously and this field has a value of null.

  attributes string[]

  The columns of the previewed query result.

  items array[]

  The rows of the previewed query result.

{
  "_links": {
    "_self": {
      "href": "string",
      "templated": true,
      "type": "string"
    }
  },
  "preview_result": {
    "attributes": [
      "string"
    ],
    "items": [
      [
        "string"
      ]
    ]
  }
}

Records restore request accepted

application/api.clumio.restored-records-aws-dynamodb-tables=v1+json

• Schema
• Example (from schema)

---

Schema

• _embedded object

  Embedded responses related to the resource.

  read-task Embeds the associated task of a resource in the response if requested using the `embed` query parameter.

  Embeds the associated task of a resource in the response if requested using the embed query parameter.

• _links object

  URLs to pages related to the resource.

  _self object

  The HATEOAS link to this resource.

  href string

  The URI for the referenced operation.

  templated boolean

  Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  type string

  The HTTP method to be used with the "href" link for the referenced operation.

  read-task object

  A HATEOAS link to the task associated with this resource.

  href string

  The URI for the referenced operation.

  templated boolean

  Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  type string

  The HTTP method to be used with the "href" link for the referenced operation.

• passcode string

  passcode that the end-user must use to access the restored file, in case when restored file was emailed to the end-user as part of transparent data access.

• task_id string

  The Clumio-assigned ID of the task generated by this request. The requested records will be available for asynchronous download when the Task completes. Use the GET /restores/aws/dynamodb-tables/records endpoint to list the records available for download.
  If "preview":true was set in the request, then a preview of the result will be given instead of a Task ID, and this field will be omitted.

{
  "_embedded": {},
  "_links": {
    "_self": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "read-task": {
      "href": "string",
      "templated": true,
      "type": "string"
    }
  },
  "passcode": "string",
  "task_id": "string"
}

Error

application/json

• Schema
• Example (from schema)

---

Schema

• errors object[]

  A list of errors encountered during runtime.

  error_code uint32

  error_message string

  The reason for the error.

{
  "errors": [
    {
      "error_code": 0,
      "error_message": "string"
    }
  ]
}

Loading...