Amazon Route 53 Resolver Route53 Resolver Operations API

openapi: 3.2.0
info:
  title: Amazon Route 53 Resolver Operations API
  version: '2018-04-01'
  description: Generated from AWS's published Smithy model for Amazon Route 53 Resolver. 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://route53resolver.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Operations
paths:
  /#ListFirewallRuleTypes:
    post:
      operationId: ListFirewallRuleTypes
      summary: List Firewall Rule Types
      description: Retrieves the rule-type variants that can be used in the FirewallRuleType field of CreateFirewallRule and UpdateFirewallRule. Each returned FirewallRuleTypeDefinition identifies one variant + value combination — for example, FirewallAdvancedContentCategory + VIOLENCE_AND_HATE_SPEECH, or PartnerThreatProtection + a partner-managed feed. The supported RuleType filter values are FirewallAdvancedContentCategory, FirewallAdvancedThreatCategory, DnsThreatProtection, and PartnerThreatProtection. When a returned definition's variant requires an external subscription (currently only PartnerThreatProtection), the response also includes a SubscriptionInfo identifying the Amazon Web Services Marketplace product that backs it; absence of SubscriptionInfo means the variant is fully managed by Amazon Web Services and requires no separate subscription.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListFirewallRuleTypesResponse'
        '400':
          description: AccessDeniedException; InternalServiceErrorException; ThrottlingException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Route53Resolver.ListFirewallRuleTypes
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListFirewallRuleTypesRequest'
      tags:
      - Operations
components:
  schemas:
    ListFirewallRuleTypesRequest:
      type: object
      properties:
        RuleType:
          type: string
          description: 'An optional filter that restricts the response to a single FirewallRuleType variant. Supported values: FirewallAdvancedContentCategory, FirewallAdvancedThreatCategory, DnsThreatProtection, and PartnerThreatProtection. If omitted, definitions across all variants are returned.'
        MaxResults:
          type: integer
          description: The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken value that you can use in a subsequent call to get the next batch of objects.
        NextToken:
          type: string
          description: For the first call to this list request, omit this value. When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver provides a NextToken value in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.
    FirewallRuleTypeDefinition:
      type: object
      properties:
        RuleType:
          type: string
          description: The category or class of the rule type, such as FirewallAdvancedContentCategory or FirewallAdvancedThreatCategory.
        Value:
          type: string
          description: The specific identifier within the rule type category, such as VIOLENCE_AND_HATE_SPEECH or PHISHING.
        DisplayName:
          type: string
          description: The display name of the rule type.
        Description:
          type: string
          description: A description of the rule type.
        SubscriptionInfo:
          $ref: '#/components/schemas/SubscriptionInfo'
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    ListFirewallRuleTypesResponse:
      type: object
      properties:
        FirewallRuleTypes:
          type: array
          items:
            $ref: '#/components/schemas/FirewallRuleTypeDefinition'
          description: A list of the available rule type definitions.
        NextToken:
          type: string
          description: If objects are still available for retrieval, Resolver returns this token in the response. To retrieve the next batch of objects, provide this token in your next request.
    SubscriptionInfo:
      type: object
      properties:
        VendorName:
          type: string
          description: The name of the Amazon Web Services Marketplace seller (vendor) that publishes the partner threat-protection product (for example, Palo Alto Networks).
        ProductId:
          type: string
          description: The Amazon Web Services Marketplace product identifier of the partner threat-protection product. Use this value to verify or manage the calling account's subscription in Amazon Web Services Marketplace.
  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: route53resolver
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/route53resolver/service/2018-04-01/route53resolver-2018-04-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)