Amazon Resource Explorer Search API

The Search API from Amazon Resource Explorer — 1 operation(s) for search.

OpenAPI Specification

amazon-resource-explorer-search-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Amazon Resource Explorer Index Search API
  description: AWS Resource Explorer is a resource search and discovery service that provides a unified view of your AWS resources across Regions.
  version: 2022-07-28
  contact:
    name: AWS Support
    url: https://aws.amazon.com/premiumsupport/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://resource-explorer-2.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
      description: AWS region
security:
- sigv4: []
tags:
- name: Search
paths:
  /Search:
    post:
      operationId: Search
      summary: Search Resources
      description: Searches for resources using the Resource Explorer query syntax.
      tags:
      - Search
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchResponse'
components:
  schemas:
    SearchResponse:
      type: object
      properties:
        Count:
          type: object
          description: The count of matching resources.
        NextToken:
          type: string
          description: The token for the next page of results.
        Resources:
          type: array
          items:
            $ref: '#/components/schemas/Resource'
        ViewArn:
          type: string
          description: The ARN of the view used for the search.
    SearchRequest:
      type: object
      required:
      - QueryString
      properties:
        QueryString:
          type: string
          description: A string that includes keywords and filters to search for resources.
        MaxResults:
          type: integer
          description: The maximum number of results to include in the response.
        NextToken:
          type: string
          description: The token for the next page of results.
        ViewArn:
          type: string
          description: The ARN of the view to search.
    Resource:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the resource.
        LastReportedAt:
          type: string
          format: date-time
          description: The date and time the resource was last updated.
        OwningAccountId:
          type: string
          description: The AWS account ID of the account that owns the resource.
        Region:
          type: string
          description: The AWS Region where the resource exists.
        ResourceType:
          type: string
          description: The type of the resource.
        Service:
          type: string
          description: The AWS service that owns the resource.
  securitySchemes:
    sigv4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4