Amazon Firewall Manager Resources API

openapi: 3.1.0
info:
  title: Firewall Management Service Resources API
  version: '2018-01-01'
  description: Generated from AWS's published Smithy model for Firewall Management Service. 7 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://fms.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#BatchAssociateResource:
    post:
      operationId: BatchAssociateResource
      summary: Batch Associate Resource
      description: Associate resources to a Firewall Manager resource set.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BatchAssociateResourceResponse'
        '400':
          description: InternalErrorException; InvalidInputException; InvalidOperationException; LimitExceededException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSFMS_20180101.BatchAssociateResource
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/BatchAssociateResourceRequest'
      tags:
      - Resources
  /#BatchDisassociateResource:
    post:
      operationId: BatchDisassociateResource
      summary: Batch Disassociate Resource
      description: Disassociates resources from a Firewall Manager resource set.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BatchDisassociateResourceResponse'
        '400':
          description: InternalErrorException; InvalidInputException; InvalidOperationException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSFMS_20180101.BatchDisassociateResource
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/BatchDisassociateResourceRequest'
      tags:
      - Resources
  /#TagResource:
    post:
      operationId: TagResource
      summary: Tag Resource
      description: Adds one or more tags to an Amazon Web Services resource.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/TagResourceResponse'
        '400':
          description: InternalErrorException; InvalidInputException; InvalidOperationException; LimitExceededException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSFMS_20180101.TagResource
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/TagResourceRequest'
      tags:
      - Resources
  /#UntagResource:
    post:
      operationId: UntagResource
      summary: Untag Resource
      description: Removes one or more tags from an Amazon Web Services resource.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UntagResourceResponse'
        '400':
          description: InternalErrorException; InvalidInputException; InvalidOperationException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSFMS_20180101.UntagResource
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UntagResourceRequest'
      tags:
      - Resources
  /#ListResourceSets:
    post:
      operationId: ListResourceSets
      summary: List Resource Sets
      description: Returns an array of ResourceSetSummary objects.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListResourceSetsResponse'
        '400':
          description: InternalErrorException; InvalidInputException; InvalidOperationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSFMS_20180101.ListResourceSets
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListResourceSetsRequest'
      tags:
      - Resources
  /#PutResourceSet:
    post:
      operationId: PutResourceSet
      summary: Put Resource Set
      description: Creates the resource set. An Firewall Manager resource set defines the resources to import into an Firewall
        Manager policy from another Amazon Web Services service.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/PutResourceSetResponse'
        '400':
          description: InternalErrorException; InvalidInputException; InvalidOperationException; LimitExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSFMS_20180101.PutResourceSet
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/PutResourceSetRequest'
      tags:
      - Resources
  /#ListTagsForResource:
    post:
      operationId: ListTagsForResource
      summary: List Tags For Resource
      description: Retrieves the list of tags for the specified Amazon Web Services resource.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListTagsForResourceResponse'
        '400':
          description: InternalErrorException; InvalidInputException; InvalidOperationException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSFMS_20180101.ListTagsForResource
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListTagsForResourceRequest'
      tags:
      - Resources
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: fms
  schemas:
    BatchAssociateResourceRequest:
      type: object
      properties:
        ResourceSetIdentifier:
          type: string
          description: A unique identifier for the resource set, used in a request to refer to the resource set.
        Items:
          type: array
          items:
            type: string
          description: The uniform resource identifiers (URIs) of resources that should be associated to the resource set.
            The URIs must be Amazon Resource Names (ARNs).
      required:
      - ResourceSetIdentifier
      - Items
    BatchAssociateResourceResponse:
      type: object
      properties:
        ResourceSetIdentifier:
          type: string
          description: A unique identifier for the resource set, used in a request to refer to the resource set.
        FailedItems:
          type: array
          items:
            $ref: '#/components/schemas/FailedItem'
          description: The resources that failed to associate to the resource set.
      required:
      - ResourceSetIdentifier
      - FailedItems
    BatchDisassociateResourceRequest:
      type: object
      properties:
        ResourceSetIdentifier:
          type: string
          description: A unique identifier for the resource set, used in a request to refer to the resource set.
        Items:
          type: array
          items:
            type: string
          description: The uniform resource identifiers (URI) of resources that should be disassociated from the resource
            set. The URIs must be Amazon Resource Names (ARNs).
      required:
      - ResourceSetIdentifier
      - Items
    BatchDisassociateResourceResponse:
      type: object
      properties:
        ResourceSetIdentifier:
          type: string
          description: A unique identifier for the resource set, used in a request to refer to the resource set.
        FailedItems:
          type: array
          items:
            $ref: '#/components/schemas/FailedItem'
          description: The resources that failed to disassociate from the resource set.
      required:
      - ResourceSetIdentifier
      - FailedItems
    FailedItem:
      type: object
      properties:
        URI:
          type: string
          description: The univeral resource indicator (URI) of the resource that failed.
        Reason:
          type: string
          enum:
          - NOT_VALID_ARN
          - NOT_VALID_PARTITION
          - NOT_VALID_REGION
          - NOT_VALID_SERVICE
          - NOT_VALID_RESOURCE_TYPE
          - NOT_VALID_ACCOUNT_ID
          description: The reason the resource's association could not be updated.
    InternalErrorException:
      type: object
      properties:
        Message:
          type: string
    ListResourceSetsRequest:
      type: object
      properties:
        NextToken:
          type: string
          description: When you request a list of objects with a MaxResults setting, if the number of objects that are still
            available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response.
            To retrieve the next batch of objects, use the token returned from the prior request in your next request.
        MaxResults:
          type: integer
          description: The maximum number of objects that you want Firewall Manager to return for this request. If more objects
            are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call
            to get the next batch of objects.
    ListResourceSetsResponse:
      type: object
      properties:
        ResourceSets:
          type: array
          items:
            $ref: '#/components/schemas/ResourceSetSummary'
          description: An array of ResourceSetSummary objects.
        NextToken:
          type: string
          description: When you request a list of objects with a MaxResults setting, if the number of objects that are still
            available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response.
            To retrieve the next batch of objects, use the token returned from the prior request in your next request.
    ListTagsForResourceRequest:
      type: object
      properties:
        ResourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the resource to return tags for. The Firewall Manager resources that
            support tagging are policies, applications lists, and protocols lists.
      required:
      - ResourceArn
    ListTagsForResourceResponse:
      type: object
      properties:
        TagList:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags associated with the resource.
    PutResourceSetRequest:
      type: object
      properties:
        ResourceSet:
          $ref: '#/components/schemas/ResourceSet'
        TagList:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Retrieves the tags associated with the specified resource set. Tags are key:value pairs that you can
            use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key
            to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon
            Web Services resource, up to 50 tags for a resource.
      required:
      - ResourceSet
    PutResourceSetResponse:
      type: object
      properties:
        ResourceSet:
          $ref: '#/components/schemas/ResourceSet'
        ResourceSetArn:
          type: string
          description: The Amazon Resource Name (ARN) of the resource set.
      required:
      - ResourceSet
      - ResourceSetArn
    ResourceSet:
      type: object
      properties:
        Id:
          type: string
          description: A unique identifier for the resource set. This ID is returned in the responses to create and list commands.
            You provide it to operations like update and delete.
        Name:
          type: string
          description: The descriptive name of the resource set. You can't change the name of a resource set after you create
            it.
        Description:
          type: string
          description: A description of the resource set.
        UpdateToken:
          type: string
          description: An optional token that you can use for optimistic locking. Firewall Manager returns a token to your
            requests that access the resource set. The token marks the state of the resource set resource at the time of the
            request. Update tokens are not allowed when creating a resource set. After creation, each subsequent update call
            to the resource set requires the update token. To make an unconditional change to the resource set, omit the token
            in your update request. Without the token, Firewall Manager performs your updates regardless of whether the resource
            set has changed since you last retrieved i
        ResourceTypeList:
          type: array
          items:
            type: string
          description: Determines the resources that can be associated to the resource set. Depending on your setting for
            max results and the number of resource sets, a single call might not return the full list.
        LastUpdateTime:
          type: string
          format: date-time
          description: The last time that the resource set was changed.
        ResourceSetStatus:
          type: string
          enum:
          - ACTIVE
          - OUT_OF_ADMIN_SCOPE
          description: Indicates whether the resource set is in or out of an admin's Region scope. ACTIVE - The administrator
            can manage and delete the resource set. OUT_OF_ADMIN_SCOPE - The administrator can view the resource set, but
            they can't edit or delete the resource set. Existing protections stay in place. Any new resource that come into
            scope of the resource set won't be protected.
      required:
      - Name
      - ResourceTypeList
    ResourceSetSummary:
      type: object
      properties:
        Id:
          type: string
          description: A unique identifier for the resource set. This ID is returned in the responses to create and list commands.
            You provide it to operations like update and delete.
        Name:
          type: string
          description: The descriptive name of the resource set. You can't change the name of a resource set after you create
            it.
        Description:
          type: string
          description: A description of the resource set.
        LastUpdateTime:
          type: string
          format: date-time
          description: The last time that the resource set was changed.
        ResourceSetStatus:
          type: string
          enum:
          - ACTIVE
          - OUT_OF_ADMIN_SCOPE
          description: Indicates whether the resource set is in or out of an admin's Region scope. ACTIVE - The administrator
            can manage and delete the resource set. OUT_OF_ADMIN_SCOPE - The administrator can view the resource set, but
            they can't edit or delete the resource set. Existing protections stay in place. Any new resource that come into
            scope of the resource set won't be protected.
    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.
      required:
      - Key
      - Value
    TagResourceRequest:
      type: object
      properties:
        ResourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the resource to return tags for. The Firewall Manager resources that
            support tagging are policies, applications lists, and protocols lists.
        TagList:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags to add to the resource.
      required:
      - ResourceArn
      - TagList
    TagResourceResponse:
      type: object
      properties: {}
    UntagResourceRequest:
      type: object
      properties:
        ResourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the resource to return tags for. The Firewall Manager resources that
            support tagging are policies, applications lists, and protocols lists.
        TagKeys:
          type: array
          items:
            type: string
          description: The keys of the tags to remove from the resource.
      required:
      - ResourceArn
      - TagKeys
    UntagResourceResponse:
      type: object
      properties: {}
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/fms/service/2018-01-01/fms-2018-01-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)