Amazon Web Services, Inc.

AWS Backup Search

Backup Search Backup Search is the recovery point and item level search for Backup. For additional information, see: Backup API Reference Backup Developer Guide

Data & analytics#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Backup Search Backup Search is the recovery point and item level search for Backup. For additional information, see: Backup API Reference Backup Developer Guide

Endpoints 12

Search job

  • GETGet search job/search-jobs/:SearchJobIdentifierThis operation retrieves metadata of a search job, including its progress.
  • GETList search jobs/search-jobs?Status=string&NextToken=string&MaxResults=0This operation returns a list of search jobs belonging to an account.
  • PUTStart search job/search-jobsThis operation creates a search job which returns recovery points filtered by SearchScope and items filtered by ItemFilters. You can optionally include…
  • PUTStop search job/search-jobs/:SearchJobIdentifier/actions/cancelThis operations ends a search job. Only a search job with a status of RUNNING can be stopped.

Search result export job

  • GETGet search result export job/export-search-jobs/:ExportJobIdentifierThis operation retrieves the metadata of an export job. An export job is an operation that transmits the results of a search job to a specified S3 bucket in a…
  • GETList search result export jobs/export-search-jobs?Status=string&SearchJobIdentifier=string&NextToken=string&MaxResults=0This operation exports search results of a search job to a specified destination S3 bucket.
  • PUTStart search result export job/export-search-jobsThis operations starts a job to export the results of search job to a designated S3 bucket.
  • GETList search job backups/search-jobs/:SearchJobIdentifier/backups?nextToken=string&maxResults=0This operation returns a list of all backups (recovery points) in a paginated format that were included in the search job. If a search does not display an…
  • GETList search job results/search-jobs/:SearchJobIdentifier/search-results?nextToken=string&maxResults=0This operation returns a list of a specified search job.
  • GETList tags for resource/tags/:ResourceArnThis operation returns the tags for a resource type.
  • POSTTag resource/tags/:ResourceArnThis operation puts tags on the resource you indicate.
  • DELETEUntag resource/tags/:ResourceArn?tagKeys=This operation removes tags from the specified resource.

API details

Base URL
https://backup-search.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
12 operations on 8 pathsGET 7PUT 3POST 1DELETE 1
Main resources
Search job 4Search result export job 3
Description format
AWS Smithy model, API version 2018-05-10

How to test the AWS Backup Search in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Backup Search collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get search job” (GET /search-jobs/:SearchJobIdentifier), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS Backup Search?

Backup Search Backup Search is the recovery point and item level search for Backup. For additional information, see: Backup API Reference Backup Developer Guide It is listed under Data & analytics and has 12 endpoints.

Who publishes the AWS Backup Search?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS Backup Search?

Requests go to https://backup-search.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS Backup Search?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS Backup Search have?

12 operations on 8 paths (7 GET, 3 PUT, 1 POST, 1 DELETE). The largest groups are Search job, Search result export job.

Is forking the AWS Backup Search free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.