Amazon Firewall Manager Resources API

openapi: 3.1.0
info:
  title: AWS Firewall Manager Admin Accounts Resources API
  description: AWS Firewall Manager is a security management service that enables you to centrally configure and manage firewall rules across your accounts and applications in AWS Organizations.
  version: '2018-01-01'
  contact:
    name: AWS Support
    url: https://aws.amazon.com/premiumsupport/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://fms.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- awsSigV4: []
tags:
- name: Resources
  description: Resource sets and tags
paths:
  /fms/2018-01-01/resource-set:
    put:
      operationId: putResourceSet
      summary: Put Resource Set
      description: Creates or updates a resource set.
      tags:
      - Resources
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutResourceSetRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutResourceSetResponse'
              examples:
                default:
                  x-microcks-default: true
                  value:
                    ResourceSet:
                      Id: rs-abc123
                      Name: MyResourceSet
                      ResourceTypeList:
                      - AWS::ElasticLoadBalancingV2::LoadBalancer
                    ResourceSetArn: arn:aws:fms:us-east-1:123456789012:resource-set/rs-abc123
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /fms/2018-01-01/resource-set/list:
    post:
      operationId: listResourceSets
      summary: List Resource Sets
      description: Returns an array of ResourceSetSummary objects.
      tags:
      - Resources
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                NextToken:
                  type: string
                MaxResults:
                  type: integer
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListResourceSetsResponse'
              examples:
                default:
                  x-microcks-default: true
                  value:
                    ResourceSets:
                    - Id: rs-abc123
                      Name: MyResourceSet
                    NextToken: null
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /fms/2018-01-01/tags/{resourceArn}:
    get:
      operationId: listTagsForResource
      summary: List Tags For Resource
      description: Retrieves the list of tags for the specified AWS resource.
      tags:
      - Resources
      parameters:
      - name: resourceArn
        in: path
        required: true
        schema:
          type: string
        description: The Amazon Resource Name (ARN) of the resource.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTagsForResourceResponse'
              examples:
                default:
                  x-microcks-default: true
                  value:
                    TagList:
                    - Key: Environment
                      Value: Production
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: tagResource
      summary: Tag Resource
      description: Adds one or more tags to an AWS resource.
      tags:
      - Resources
      parameters:
      - name: resourceArn
        in: path
        required: true
        schema:
          type: string
        description: The ARN of the resource.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                TagList:
                  type: array
                  items:
                    $ref: '#/components/schemas/Tag'
              required:
              - TagList
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    Tag:
      type: object
      description: A collection of key-value pairs.
      properties:
        Key:
          type: string
        Value:
          type: string
      required:
      - Key
      - Value
    ListTagsForResourceResponse:
      type: object
      properties:
        TagList:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
    PutResourceSetRequest:
      type: object
      required:
      - ResourceSet
      properties:
        ResourceSet:
          $ref: '#/components/schemas/ResourceSet'
        TagList:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
    ListResourceSetsResponse:
      type: object
      properties:
        ResourceSets:
          type: array
          items:
            $ref: '#/components/schemas/ResourceSet'
        NextToken:
          type: string
    ResourceSet:
      type: object
      description: A set of resources to include in a Firewall Manager policy.
      properties:
        Id:
          type: string
        Name:
          type: string
        Description:
          type: string
        UpdateToken:
          type: string
        ResourceTypeList:
          type: array
          items:
            type: string
        LastUpdateTime:
          type: string
          format: date-time
        ResourceSetStatus:
          type: string
          enum:
          - ACTIVE
          - OUT_OF_ADMIN_SCOPE
      required:
      - Name
      - ResourceTypeList
    PutResourceSetResponse:
      type: object
      properties:
        ResourceSet:
          $ref: '#/components/schemas/ResourceSet'
        ResourceSetArn:
          type: string
    ErrorResponse:
      type: object
      description: Standard error response from the Firewall Manager API.
      properties:
        Message:
          type: string
        Code:
          type: string
  securitySchemes:
    awsSigV4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4 authentication