AWS Backup Backup Search Jobs API

openapi: 3.1.0
info:
  title: AWS Backup Search Jobs API
  version: '2018-11-15'
  description: Generated from AWS's published Smithy model for AWS Backup. 3 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://backup-search.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /search-jobs:
    put:
      operationId: StartSearchJob
      summary: Start Search Job
      description: This operation creates a search job which returns recovery points filtered by SearchScope and items filtered
        by ItemFilters. You can optionally include ClientToken, EncryptionKeyArn, Name, and/or Tags.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartSearchJobOutput'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupSearchConflictException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupSearchResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupSearchAccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupSearchInternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupSearchThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupSearchValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartSearchJobInput'
      tags:
      - Search Jobs
    get:
      operationId: ListSearchJobs
      summary: List Search Jobs
      description: This operation returns a list of search jobs belonging to an account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSearchJobsOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupSearchAccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupSearchInternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupSearchThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupSearchValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListSearchJobsInput'
      tags:
      - Search Jobs
  /search-jobs/{SearchJobIdentifier}:
    get:
      operationId: GetSearchJob
      summary: Get Search Job
      description: This operation retrieves metadata of a search job, including its progress.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSearchJobOutput'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupSearchResourceNotFoundException'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupSearchAccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupSearchInternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupSearchThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupSearchValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetSearchJobInput'
      tags:
      - Search Jobs
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: backup-search
  schemas:
    BackupCreationTimeFilter:
      type: object
      properties:
        CreatedAfter:
          type: string
          description: This timestamp includes recovery points only created after the specified time.
        CreatedBefore:
          type: string
          description: This timestamp includes recovery points only created before the specified time.
    BackupSearchAccessDeniedException:
      type: object
      properties:
        message:
          type: string
          description: User does not have sufficient access to perform this action.
      required:
      - message
    BackupSearchConflictException:
      type: object
      properties:
        message:
          type: string
          description: Updating or deleting a resource can cause an inconsistent state.
        resourceId:
          type: string
          description: Identifier of the resource affected.
        resourceType:
          type: string
          description: Type of the resource affected.
      required:
      - message
      - resourceId
      - resourceType
    BackupSearchInternalServerException:
      type: object
      properties:
        message:
          type: string
          description: Unexpected error during processing of request.
        retryAfterSeconds:
          type: integer
          description: Retry the call after number of seconds.
      required:
      - message
    BackupSearchResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
          description: Request references a resource which does not exist.
        resourceId:
          type: string
          description: Hypothetical identifier of the resource affected.
        resourceType:
          type: string
          description: Hypothetical type of the resource affected.
      required:
      - message
      - resourceId
      - resourceType
    BackupSearchThrottlingException:
      type: object
      properties:
        message:
          type: string
          description: Request was unsuccessful due to request throttling.
        serviceCode:
          type: string
          description: This is the code unique to the originating service.
        quotaCode:
          type: string
          description: This is the code unique to the originating service with the quota.
        retryAfterSeconds:
          type: integer
          description: Retry the call after number of seconds.
      required:
      - message
    BackupSearchValidationException:
      type: object
      properties:
        message:
          type: string
          description: The input fails to satisfy the constraints specified by an Amazon service.
      required:
      - message
    CurrentSearchProgress:
      type: object
      properties:
        RecoveryPointsScannedCount:
          type: integer
          description: This number is the sum of all backups that have been scanned so far during a search job.
        ItemsScannedCount:
          type: integer
          description: This number is the sum of all items that have been scanned so far during a search job.
        ItemsMatchedCount:
          type: integer
          description: This number is the sum of all items that match the item filters in a search job in progress.
    EBSItemFilter:
      type: object
      properties:
        FilePaths:
          type: array
          items:
            $ref: '#/components/schemas/StringCondition'
          description: You can include 1 to 10 values. If one file path is included, the results will return only items that
            match the file path. If more than one file path is included, the results will return all items that match any
            of the file paths.
        Sizes:
          type: array
          items:
            $ref: '#/components/schemas/LongCondition'
          description: You can include 1 to 10 values. If one is included, the results will return only items that match.
            If more than one is included, the results will return all items that match any of the included values.
        CreationTimes:
          type: array
          items:
            $ref: '#/components/schemas/TimeCondition'
          description: You can include 1 to 10 values. If one is included, the results will return only items that match.
            If more than one is included, the results will return all items that match any of the included values.
        LastModificationTimes:
          type: array
          items:
            $ref: '#/components/schemas/TimeCondition'
          description: You can include 1 to 10 values. If one is included, the results will return only items that match.
            If more than one is included, the results will return all items that match any of the included values.
    GetSearchJobInput:
      type: object
      properties:
        SearchJobIdentifier:
          type: string
          description: Required unique string that specifies the search job.
      required:
      - SearchJobIdentifier
    GetSearchJobOutput:
      type: object
      properties:
        Name:
          type: string
          description: Returned name of the specified search job.
        SearchScopeSummary:
          $ref: '#/components/schemas/SearchScopeSummary'
        CurrentSearchProgress:
          $ref: '#/components/schemas/CurrentSearchProgress'
        StatusMessage:
          type: string
          description: A status message will be returned for either a earch job with a status of ERRORED or a status of COMPLETED
            jobs with issues. For example, a message may say that a search contained recovery points unable to be scanned
            because of a permissions issue.
        EncryptionKeyArn:
          type: string
          description: 'The encryption key for the specified search job. Example: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.'
        CompletionTime:
          type: string
          description: The date and time that a search job completed, in Unix format and Coordinated Universal Time (UTC).
            The value of CompletionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday,
            January 26, 2018 12:11:30.087 AM.
        Status:
          type: string
          enum:
          - RUNNING
          - COMPLETED
          - STOPPING
          - STOPPED
          - FAILED
          description: 'The current status of the specified search job. A search job may have one of the following statuses:
            RUNNING; COMPLETED; STOPPED; FAILED; TIMED_OUT; or EXPIRED .'
        SearchScope:
          $ref: '#/components/schemas/SearchScope'
        ItemFilters:
          $ref: '#/components/schemas/ItemFilters'
        CreationTime:
          type: string
          description: The date and time that a search job was created, in Unix format and Coordinated Universal Time (UTC).
            The value of CompletionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday,
            January 26, 2018 12:11:30.087 AM.
        SearchJobIdentifier:
          type: string
          description: The unique string that identifies the specified search job.
        SearchJobArn:
          type: string
          description: The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.
      required:
      - Status
      - SearchScope
      - ItemFilters
      - CreationTime
      - SearchJobIdentifier
      - SearchJobArn
    ItemFilters:
      type: object
      properties:
        S3ItemFilters:
          type: array
          items:
            $ref: '#/components/schemas/S3ItemFilter'
          description: This array can contain CreationTimes, ETags, ObjectKeys, Sizes, or VersionIds objects.
        EBSItemFilters:
          type: array
          items:
            $ref: '#/components/schemas/EBSItemFilter'
          description: This array can contain CreationTimes, FilePaths, LastModificationTimes, or Sizes objects.
    ListSearchJobsInput:
      type: object
      properties:
        ByStatus:
          type: string
          enum:
          - RUNNING
          - COMPLETED
          - STOPPING
          - STOPPED
          - FAILED
          description: Include this parameter to filter list by search job status.
        NextToken:
          type: string
          description: The next item following a partial list of returned search jobs. For example, if a request is made to
            return MaxResults number of backups, NextToken allows you to return more items in your list starting at the location
            pointed to by the next token.
        MaxResults:
          type: integer
          description: The maximum number of resource list items to be returned.
    ListSearchJobsOutput:
      type: object
      properties:
        SearchJobs:
          type: array
          items:
            $ref: '#/components/schemas/SearchJobSummary'
          description: The search jobs among the list, with details of the returned search jobs.
        NextToken:
          type: string
          description: The next item following a partial list of returned backups included in a search job. For example, if
            a request is made to return MaxResults number of backups, NextToken allows you to return more items in your list
            starting at the location pointed to by the next token.
      required:
      - SearchJobs
    LongCondition:
      type: object
      properties:
        Value:
          type: integer
          description: The value of an item included in one of the search item filters.
        Operator:
          type: string
          enum:
          - EQUALS_TO
          - NOT_EQUALS_TO
          - LESS_THAN_EQUAL_TO
          - GREATER_THAN_EQUAL_TO
          description: A string that defines what values will be returned. If this is included, avoid combinations of operators
            that will return all possible values. For example, including both EQUALS_TO and NOT_EQUALS_TO with a value of
            4 will return all values.
      required:
      - Value
    S3ItemFilter:
      type: object
      properties:
        ObjectKeys:
          type: array
          items:
            $ref: '#/components/schemas/StringCondition'
          description: You can include 1 to 10 values. If one value is included, the results will return only items that match
            the value. If more than one value is included, the results will return all items that match any of the values.
        Sizes:
          type: array
          items:
            $ref: '#/components/schemas/LongCondition'
          description: You can include 1 to 10 values. If one value is included, the results will return only items that match
            the value. If more than one value is included, the results will return all items that match any of the values.
        CreationTimes:
          type: array
          items:
            $ref: '#/components/schemas/TimeCondition'
          description: You can include 1 to 10 values. If one value is included, the results will return only items that match
            the value. If more than one value is included, the results will return all items that match any of the values.
        VersionIds:
          type: array
          items:
            $ref: '#/components/schemas/StringCondition'
          description: You can include 1 to 10 values. If one value is included, the results will return only items that match
            the value. If more than one value is included, the results will return all items that match any of the values.
        ETags:
          type: array
          items:
            $ref: '#/components/schemas/StringCondition'
          description: You can include 1 to 10 values. If one value is included, the results will return only items that match
            the value. If more than one value is included, the results will return all items that match any of the values.
    SearchJobSummary:
      type: object
      properties:
        SearchJobIdentifier:
          type: string
          description: The unique string that specifies the search job.
        SearchJobArn:
          type: string
          description: The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.
        Name:
          type: string
          description: This is the name of the search job.
        Status:
          type: string
          enum:
          - RUNNING
          - COMPLETED
          - STOPPING
          - STOPPED
          - FAILED
          description: This is the status of the search job.
        CreationTime:
          type: string
          description: This is the creation time of the search job.
        CompletionTime:
          type: string
          description: This is the completion time of the search job.
        SearchScopeSummary:
          $ref: '#/components/schemas/SearchScopeSummary'
        StatusMessage:
          type: string
          description: A status message will be returned for either a earch job with a status of ERRORED or a status of COMPLETED
            jobs with issues. For example, a message may say that a search contained recovery points unable to be scanned
            because of a permissions issue.
    SearchScope:
      type: object
      properties:
        BackupResourceTypes:
          type: array
          items:
            type: string
            enum:
            - S3
            - EBS
          description: The resource types included in a search. Eligible resource types include S3 and EBS.
        BackupResourceCreationTime:
          $ref: '#/components/schemas/BackupCreationTimeFilter'
        SourceResourceArns:
          type: array
          items:
            type: string
          description: The Amazon Resource Name (ARN) that uniquely identifies the source resources.
        BackupResourceArns:
          type: array
          items:
            type: string
          description: The Amazon Resource Name (ARN) that uniquely identifies the backup resources.
        BackupResourceTags:
          type: object
          additionalProperties:
            type: string
          description: These are one or more tags on the backup (recovery point).
      required:
      - BackupResourceTypes
    SearchScopeSummary:
      type: object
      properties:
        TotalRecoveryPointsToScanCount:
          type: integer
          description: This is the count of the total number of backups that will be scanned in a search.
        TotalItemsToScanCount:
          type: integer
          description: This is the count of the total number of items that will be scanned in a search.
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
          description: This request was not successful due to a service quota exceeding limits.
        resourceId:
          type: string
          description: Identifier of the resource.
        resourceType:
          type: string
          description: Type of resource.
        serviceCode:
          type: string
          description: This is the code unique to the originating service with the quota.
        quotaCode:
          type: string
          description: This is the code specific to the quota type.
      required:
      - message
      - resourceId
      - resourceType
      - serviceCode
      - quotaCode
    StartSearchJobInput:
      type: object
      properties:
        Tags:
          type: object
          additionalProperties:
            type: string
          description: List of tags returned by the operation.
        Name:
          type: string
          description: Include alphanumeric characters to create a name for this search job.
        EncryptionKeyArn:
          type: string
          description: The encryption key for the specified search job.
        ClientToken:
          type: string
          description: Include this parameter to allow multiple identical calls for idempotency. A client token is valid for
            8 hours after the first request that uses it is completed. After this time, any request with the same token is
            treated as a new request.
        SearchScope:
          $ref: '#/components/schemas/SearchScope'
        ItemFilters:
          $ref: '#/components/schemas/ItemFilters'
      required:
      - SearchScope
    StartSearchJobOutput:
      type: object
      properties:
        SearchJobArn:
          type: string
          description: The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.
        CreationTime:
          type: string
          description: The date and time that a job was created, in Unix format and Coordinated Universal Time (UTC). The
            value of CompletionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday,
            January 26, 2018 12:11:30.087 AM.
        SearchJobIdentifier:
          type: string
          description: The unique string that specifies the search job.
    StringCondition:
      type: object
      properties:
        Value:
          type: string
          description: The value of the string.
        Operator:
          type: string
          enum:
          - EQUALS_TO
          - NOT_EQUALS_TO
          - CONTAINS
          - DOES_NOT_CONTAIN
          - BEGINS_WITH
          - ENDS_WITH
          - DOES_NOT_BEGIN_WITH
          - DOES_NOT_END_WITH
          description: A string that defines what values will be returned. If this is included, avoid combinations of operators
            that will return all possible values. For example, including both EQUALS_TO and NOT_EQUALS_TO with a value of
            4 will return all values.
      required:
      - Value
    TimeCondition:
      type: object
      properties:
        Value:
          type: string
          description: This is the timestamp value of the time condition.
        Operator:
          type: string
          enum:
          - EQUALS_TO
          - NOT_EQUALS_TO
          - LESS_THAN_EQUAL_TO
          - GREATER_THAN_EQUAL_TO
          description: A string that defines what values will be returned. If this is included, avoid combinations of operators
            that will return all possible values. For example, including both EQUALS_TO and NOT_EQUALS_TO with a value of
            4 will return all values.
      required:
      - Value
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/backupsearch/service/2018-05-10/backupsearch-2018-05-10.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)