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-firewall-manager:amazon-firewall-manager-protocols-list-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: Firewall Management Service Protocols List API
  version: '2018-01-01'
  description: Generated from AWS's published Smithy model for Firewall Management Service. 4 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: []
tags:
- name: Protocols List
paths:
  /#DeleteProtocolsList:
    post:
      operationId: DeleteProtocolsList
      summary: Delete Protocols List
      description: Permanently deletes an Firewall Manager protocols list.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '400':
          description: InternalErrorException; 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.DeleteProtocolsList
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteProtocolsListRequest'
      tags:
      - Protocols List
  /#GetProtocolsList:
    post:
      operationId: GetProtocolsList
      summary: Get Protocols List
      description: Returns information about the specified Firewall Manager protocols list.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetProtocolsListResponse'
        '400':
          description: InternalErrorException; 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.GetProtocolsList
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetProtocolsListRequest'
      tags:
      - Protocols List
  /#ListProtocolsLists:
    post:
      operationId: ListProtocolsLists
      summary: List Protocols Lists
      description: Returns an array of ProtocolsListDataSummary objects.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListProtocolsListsResponse'
        '400':
          description: InternalErrorException; 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.ListProtocolsLists
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListProtocolsListsRequest'
      tags:
      - Protocols List
  /#PutProtocolsList:
    post:
      operationId: PutProtocolsList
      summary: Put Protocols List
      description: Creates an Firewall Manager protocols list.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/PutProtocolsListResponse'
        '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.PutProtocolsList
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/PutProtocolsListRequest'
      tags:
      - Protocols List
components:
  schemas:
    GetProtocolsListRequest:
      type: object
      properties:
        ListId:
          type: string
          description: The ID of the Firewall Manager protocols list that you want the details for.
        DefaultList:
          type: boolean
          description: Specifies whether the list to retrieve is a default list owned by Firewall Manager.
      required:
      - ListId
    ProtocolsListData:
      type: object
      properties:
        ListId:
          type: string
          description: The ID of the Firewall Manager protocols list.
        ListName:
          type: string
          description: The name of the Firewall Manager protocols list.
        ListUpdateToken:
          type: string
          description: A unique identifier for each update to the list. When you update the list, the update token must match the token of the current version of the application list. You can retrieve the update token by getting the list.
        CreateTime:
          type: string
          format: date-time
          description: The time that the Firewall Manager protocols list was created.
        LastUpdateTime:
          type: string
          format: date-time
          description: The time that the Firewall Manager protocols list was last updated.
        ProtocolsList:
          type: array
          items:
            type: string
          description: An array of protocols in the Firewall Manager protocols list.
        PreviousProtocolsList:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: A map of previous version numbers to their corresponding protocol arrays.
      required:
      - ListName
      - ProtocolsList
    ListProtocolsListsResponse:
      type: object
      properties:
        ProtocolsLists:
          type: array
          items:
            $ref: '#/components/schemas/ProtocolsListDataSummary'
          description: An array of ProtocolsListDataSummary objects.
        NextToken:
          type: string
          description: If you specify a value for MaxResults in your list request, and you have more objects than the maximum, Firewall Manager returns this token in the response. You can use this token in subsequent requests to retrieve the next batch of objects.
    PutProtocolsListRequest:
      type: object
      properties:
        ProtocolsList:
          $ref: '#/components/schemas/ProtocolsListData'
        TagList:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags associated with the resource.
      required:
      - ProtocolsList
    ListProtocolsListsRequest:
      type: object
      properties:
        DefaultLists:
          type: boolean
          description: Specifies whether the lists to retrieve are default lists owned by Firewall Manager.
        NextToken:
          type: string
          description: If you specify a value for MaxResults in your list request, and you have more objects than the maximum, Firewall Manager returns this token in the response. For all but the first request, you provide the token returned by the prior request in the request parameters, to retrieve the next batch of objects.
        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. If you don't specify this, Firewall Manager returns all available objects.
      required:
      - MaxResults
    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
    ProtocolsListDataSummary:
      type: object
      properties:
        ListArn:
          type: string
          description: The Amazon Resource Name (ARN) of the specified protocols list.
        ListId:
          type: string
          description: The ID of the specified protocols list.
        ListName:
          type: string
          description: The name of the specified protocols list.
        ProtocolsList:
          type: array
          items:
            type: string
          description: An array of protocols in the Firewall Manager protocols list.
    DeleteProtocolsListRequest:
      type: object
      properties:
        ListId:
          type: string
          description: The ID of the protocols list that you want to delete. You can retrieve this ID from PutProtocolsList, ListProtocolsLists, and GetProtocolsLost.
      required:
      - ListId
    GetProtocolsListResponse:
      type: object
      properties:
        ProtocolsList:
          $ref: '#/components/schemas/ProtocolsListData'
        ProtocolsListArn:
          type: string
          description: The Amazon Resource Name (ARN) of the specified protocols list.
    PutProtocolsListResponse:
      type: object
      properties:
        ProtocolsList:
          $ref: '#/components/schemas/ProtocolsListData'
        ProtocolsListArn:
          type: string
          description: The Amazon Resource Name (ARN) of the protocols list.
    InternalErrorException:
      type: object
      properties:
        Message:
          type: string
  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
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/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)