AWS WAF Waf Api Key API

openapi: 3.1.0
info:
  title: AWS WAFV2 Api Key API
  version: '2019-07-29'
  description: Generated from AWS's published Smithy model for AWS WAFV2. 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://wafv2.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#CreateAPIKey:
    post:
      operationId: CreateAPIKey
      summary: Create APIKey
      description: Creates an API key that contains a set of token domains. API keys are required for the integration of the
        CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of
        the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see WAF client
        application integration in the WAF Developer Guide. You can use a single key for up to 5 domains. After you generate
        a key, you can copy it for use in your JavaScript integration.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateAPIKeyResponse'
        '500':
          description: WAFInternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/WAFInternalErrorException'
        '400':
          description: WAFInvalidOperationException; WAFInvalidParameterException; WAFLimitsExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/WAFInvalidOperationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSWAF_20190729.CreateAPIKey
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateAPIKeyRequest'
      tags:
      - Api Key
  /#DeleteAPIKey:
    post:
      operationId: DeleteAPIKey
      summary: Delete APIKey
      description: Deletes the specified API key. After you delete a key, it can take up to 24 hours for WAF to disallow use
        of the key in all regions.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteAPIKeyResponse'
        '500':
          description: WAFInternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/WAFInternalErrorException'
        '400':
          description: WAFInvalidOperationException; WAFInvalidParameterException; WAFNonexistentItemException; WAFOptimisticLockException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/WAFInvalidOperationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSWAF_20190729.DeleteAPIKey
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteAPIKeyRequest'
      tags:
      - Api Key
  /#ListAPIKeys:
    post:
      operationId: ListAPIKeys
      summary: List APIKeys
      description: Retrieves a list of the API keys that you've defined for the specified scope. API keys are required for
        the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement
        and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration,
        see WAF client application integration in the WAF Developer Guide.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListAPIKeysResponse'
        '500':
          description: WAFInternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/WAFInternalErrorException'
        '400':
          description: WAFInvalidOperationException; WAFInvalidParameterException; WAFInvalidResourceException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/WAFInvalidOperationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSWAF_20190729.ListAPIKeys
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListAPIKeysRequest'
      tags:
      - Api Key
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: wafv2
  schemas:
    APIKeySummary:
      type: object
      properties:
        TokenDomains:
          type: array
          items:
            type: string
          description: The token domains that are defined in this API key.
        APIKey:
          type: string
          description: The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.
        CreationTimestamp:
          type: string
          format: date-time
          description: The date and time that the key was created.
        Version:
          type: integer
          description: Internal value used by WAF to manage the key.
    CreateAPIKeyRequest:
      type: object
      properties:
        Scope:
          type: string
          enum:
          - CLOUDFRONT
          - REGIONAL
          description: 'Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For
            an Amplify application, use CLOUDFRONT. To work with CloudFront, you must also specify the Region US East (N.
            Virginia) as follows: CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
            API and SDKs - For all calls, use the Region endpoint us-east-1.'
        TokenDomains:
          type: array
          items:
            type: string
          description: 'The client application domains that you want to use this API key for. Example JSON: "TokenDomains":
            ["abc.com", "store.abc.com"] Public suffixes aren''t allowed. For example, you can''t use gov.au or co.uk as token
            domains.'
      required:
      - Scope
      - TokenDomains
    CreateAPIKeyResponse:
      type: object
      properties:
        APIKey:
          type: string
          description: The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.
    DeleteAPIKeyRequest:
      type: object
      properties:
        Scope:
          type: string
          enum:
          - CLOUDFRONT
          - REGIONAL
          description: 'Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For
            an Amplify application, use CLOUDFRONT. To work with CloudFront, you must also specify the Region US East (N.
            Virginia) as follows: CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
            API and SDKs - For all calls, use the Region endpoint us-east-1.'
        APIKey:
          type: string
          description: The encrypted API key that you want to delete.
      required:
      - Scope
      - APIKey
    DeleteAPIKeyResponse:
      type: object
      properties: {}
    ListAPIKeysRequest:
      type: object
      properties:
        Scope:
          type: string
          enum:
          - CLOUDFRONT
          - REGIONAL
          description: 'Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For
            an Amplify application, use CLOUDFRONT. To work with CloudFront, you must also specify the Region US East (N.
            Virginia) as follows: CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
            API and SDKs - For all calls, use the Region endpoint us-east-1.'
        NextMarker:
          type: string
          description: When you request a list of objects with a Limit setting, if the number of objects that are still available
            for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of
            objects, provide the marker from the prior call in your next request.
        Limit:
          type: integer
          description: The maximum number of objects that you want WAF to return for this request. If more objects are available,
            in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of
            objects.
      required:
      - Scope
    ListAPIKeysResponse:
      type: object
      properties:
        NextMarker:
          type: string
          description: When you request a list of objects with a Limit setting, if the number of objects that are still available
            for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of
            objects, provide the marker from the prior call in your next request.
        APIKeySummaries:
          type: array
          items:
            $ref: '#/components/schemas/APIKeySummary'
          description: The array of key summaries. If you specified a Limit in your request, this might not be the full list.
        ApplicationIntegrationURL:
          type: string
          description: The CAPTCHA application integration URL, for use in your JavaScript implementation.
    WAFInternalErrorException:
      type: object
      properties:
        Message:
          type: string
    WAFInvalidOperationException:
      type: object
      properties:
        Message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/wafv2/service/2019-07-29/wafv2-2019-07-29.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)