Amazon Resource Explorer Search API

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

GitHub OpenAPI

Operations 1

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-resource-explorer:amazon-resource-explorer-search-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-resource-explorer-search-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: AWS Resource Explorer Search API
  version: '2022-07-28'
  description: Generated from AWS's published Smithy model for AWS Resource Explorer. 1 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://resource-explorer-2.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /Search:
    post:
      operationId: Search
      summary: Search
      description: Searches for resources and displays details about all resources that match the specified criteria. You
        must specify a query string. All search queries must use a view. If you don't explicitly specify a view, then Amazon
        Web Services Resource Explorer uses the default view for the Amazon Web Services Region in which you call this operation.
        The results are the logical intersection of the results that match both the QueryString parameter supplied to this
        operation and the SearchFilter parameter attached to the view. For the complete syntax supported by the QueryString
        parameter, see Search query syntax reference for Resource Explorer. If your search results are empty, or are missing
        results that you think should be there, see Troubleshooting Resource Explorer search.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchInput'
      tags:
      - Search
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: resource-explorer-2
  schemas:
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
    Resource:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon resource name (ARN) of the resource.
        OwningAccountId:
          type: string
          description: The Amazon Web Services account that owns the resource.
        Region:
          type: string
          description: The Amazon Web Services Region in which the resource was created and exists.
        ResourceType:
          type: string
          description: The type of the resource.
        Service:
          type: string
          description: The Amazon Web Services service that owns the resource and is responsible for creating and updating
            it.
        CfnResourceType:
          type: string
          description: The CloudFormation resource type identifier for the resource, such as AWS::EC2::Instance or AWS::S3::Bucket.
        LastReportedAt:
          type: string
          description: The date and time that Resource Explorer last queried this resource and updated the index with the
            latest information about the resource.
        Properties:
          type: array
          items:
            $ref: '#/components/schemas/ResourceProperty'
          description: A structure with additional type-specific details about the resource. These properties can be added
            by turning on integration between Resource Explorer and other Amazon Web Services services.
    ResourceCount:
      type: object
      properties:
        TotalResources:
          type: integer
          description: The number of resources that match the search query. This value can't exceed 1,000. If there are more
            than 1,000 resources that match the query, then only 1,000 are counted and the Complete field is set to false.
            We recommend that you refine your query to return a smaller number of results.
        Complete:
          type: boolean
          description: Indicates whether the TotalResources value represents an exhaustive count of search results. If True,
            it indicates that the search was exhaustive. Every resource that matches the query was counted. If False, then
            the search reached the limit of 1,000 matching results, and stopped counting.
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    ResourceProperty:
      type: object
      properties:
        Name:
          type: string
          description: The name of this property of the resource.
        LastReportedAt:
          type: string
          description: The date and time that the information about this resource property was last updated.
        Data:
          type: object
          description: Details about this property. The content of this field is a JSON object that varies based on the resource
            type.
    SearchInput:
      type: object
      properties:
        QueryString:
          type: string
          description: A string that includes keywords and filters that specify the resources that you want to include in
            the results. For the complete syntax supported by the QueryString parameter, see Search query syntax reference
            for Resource Explorer. The search is completely case insensitive. You can specify an empty string to return all
            results up to the limit of 1,000 total results. The operation can return only the first 1,000 results. If the
            resource you want is not included, then use a different value for QueryString to refine the results.
        MaxResults:
          type: integer
          description: 'The maximum number of results that you want included on each page of the response. If you do not include
            this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included
            in the current response, the NextToken response element is present and has a value (is not null). Include that
            value as the NextToken request parameter in the next call to the operation to get the next part of the results.
            An API operation can return fewer results than the maximum even when there are more results available. You should
            check NextToken after every operation to '
        ViewArn:
          type: string
          description: Specifies the Amazon resource name (ARN) of the view to use for the query. If you don't specify a value
            for this parameter, then the operation automatically uses the default view for the Amazon Web Services Region
            in which you called this operation. If the Region either doesn't have a default view or if you don't have permission
            to use the default view, then the operation fails with a 401 Unauthorized exception.
        NextToken:
          type: string
          description: The parameter for receiving additional results if you receive a NextToken response in a previous request.
            A NextToken response indicates that more output is available. Set this parameter to the value of the previous
            call's NextToken response to indicate where the output should continue from. The pagination tokens expire after
            24 hours.
      required:
      - QueryString
    SearchOutput:
      type: object
      properties:
        Resources:
          type: array
          items:
            $ref: '#/components/schemas/Resource'
          description: The list of structures that describe the resources that match the query.
        NextToken:
          type: string
          description: If present, indicates that more output is available than is included in the current response. Use this
            value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output.
            You should repeat this until the NextToken response element comes back as null. The pagination tokens expire after
            24 hours.
        ViewArn:
          type: string
          description: The Amazon resource name (ARN) of the view that this operation used to perform the search.
        Count:
          $ref: '#/components/schemas/ResourceCount'
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
    UnauthorizedException:
      type: object
      properties:
        Message:
          type: string
    ValidationException:
      type: object
      properties:
        Message:
          type: string
        FieldList:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
          description: An array of the request fields that had validation errors.
      required:
      - Message
    ValidationExceptionField:
      type: object
      properties:
        Name:
          type: string
          description: The name of the request field that had a validation error.
        ValidationIssue:
          type: string
          description: The validation error caused by the request field.
      required:
      - Name
      - ValidationIssue
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/resource-explorer-2/service/2022-07-28/resource-explorer-2-2022-07-28.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)