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-shield:amazon-shield-resource-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: AWS Shield Resource API
  version: '2016-06-02'
  description: Generated from AWS's published Smithy model for AWS Shield. 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://shield.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Resource
paths:
  /#ListResourcesInProtectionGroup:
    post:
      operationId: ListResourcesInProtectionGroup
      summary: List Resources In Protection Group
      description: Retrieves the resources that are included in the protection group.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListResourcesInProtectionGroupResponse'
        '500':
          description: InternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
        '400':
          description: InvalidPaginationTokenException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidPaginationTokenException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSShield_20160616.ListResourcesInProtectionGroup
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListResourcesInProtectionGroupRequest'
      tags:
      - Resource
  /#TagResource:
    post:
      operationId: TagResource
      summary: Tag Resource
      description: Adds or updates tags for a resource in Shield.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/TagResourceResponse'
        '500':
          description: InternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
        '400':
          description: InvalidParameterException; InvalidResourceException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSShield_20160616.TagResource
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/TagResourceRequest'
      tags:
      - Resource
  /#UntagResource:
    post:
      operationId: UntagResource
      summary: Untag Resource
      description: Removes tags from a resource in Shield.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UntagResourceResponse'
        '500':
          description: InternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
        '400':
          description: InvalidParameterException; InvalidResourceException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSShield_20160616.UntagResource
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UntagResourceRequest'
      tags:
      - Resource
components:
  schemas:
    UntagResourceRequest:
      type: object
      properties:
        ResourceARN:
          type: string
          description: The Amazon Resource Name (ARN) of the resource that you want to remove tags from.
        TagKeys:
          type: array
          items:
            type: string
          description: The tag key for each tag that you want to remove from the resource.
      required:
      - ResourceARN
      - TagKeys
    InternalErrorException:
      type: object
      properties:
        message:
          type: string
    TagResourceRequest:
      type: object
      properties:
        ResourceARN:
          type: string
          description: The Amazon Resource Name (ARN) of the resource that you want to add or update tags for.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags that you want to modify or add to the resource.
      required:
      - ResourceARN
      - Tags
    ValidationExceptionField:
      type: object
      properties:
        name:
          type: string
          description: The name of the parameter that failed validation.
        message:
          type: string
          description: The message describing why the parameter failed validation.
      required:
      - name
      - message
    ListResourcesInProtectionGroupResponse:
      type: object
      properties:
        ResourceArns:
          type: array
          items:
            type: string
          description: The Amazon Resource Names (ARNs) of the resources that are included in the protection group.
        NextToken:
          type: string
          description: When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request. You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available. W
      required:
      - ResourceArns
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
        Value:
          type: string
          description: Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
    TagResourceResponse:
      type: object
      properties: {}
    InvalidPaginationTokenException:
      type: object
      properties:
        message:
          type: string
    ListResourcesInProtectionGroupRequest:
      type: object
      properties:
        ProtectionGroupId:
          type: string
          description: The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.
        NextToken:
          type: string
          description: When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request. You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available. W
        MaxResults:
          type: integer
          description: The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a NextToken value in the response. The default setting is 20.
      required:
      - ProtectionGroupId
    UntagResourceResponse:
      type: object
      properties: {}
    InvalidParameterException:
      type: object
      properties:
        message:
          type: string
        reason:
          type: string
          enum:
          - FIELD_VALIDATION_FAILED
          - OTHER
          description: Additional information about the exception.
        fields:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
          description: Fields that caused the exception.
  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: shield
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/shield/service/2016-06-02/shield-2016-06-02.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)