Amazon EC2 Ec2 Transit Gateway Metering Policy Entry API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Transit Gateway Metering…
  version: '2016-11-15'
  description: Generated from AWS's published Smithy model for Amazon Elastic Compute Cloud. 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://ec2.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Transit Gateway Metering Policy Entry
paths:
  /?Action=CreateTransitGatewayMeteringPolicyEntry:
    post:
      operationId: CreateTransitGatewayMeteringPolicyEntry
      summary: Create Transit Gateway Metering Policy Entry
      description: Creates an entry in a transit gateway metering policy to define traffic measurement rules.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateTransitGatewayMeteringPolicyEntryResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateTransitGatewayMeteringPolicyEntry
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateTransitGatewayMeteringPolicyEntryRequest'
      tags:
      - Transit Gateway Metering Policy Entry
  /?Action=DeleteTransitGatewayMeteringPolicyEntry:
    post:
      operationId: DeleteTransitGatewayMeteringPolicyEntry
      summary: Delete Transit Gateway Metering Policy Entry
      description: Deletes an entry from a transit gateway metering policy.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteTransitGatewayMeteringPolicyEntryResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteTransitGatewayMeteringPolicyEntry
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteTransitGatewayMeteringPolicyEntryRequest'
      tags:
      - Transit Gateway Metering Policy Entry
  /?Action=GetTransitGatewayMeteringPolicyEntries:
    post:
      operationId: GetTransitGatewayMeteringPolicyEntries
      summary: Get Transit Gateway Metering Policy Entries
      description: Retrieves the entries for a transit gateway metering policy.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GetTransitGatewayMeteringPolicyEntriesResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: GetTransitGatewayMeteringPolicyEntries
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/GetTransitGatewayMeteringPolicyEntriesRequest'
      tags:
      - Transit Gateway Metering Policy Entry
components:
  schemas:
    CreateTransitGatewayMeteringPolicyEntryRequest:
      type: object
      properties:
        TransitGatewayMeteringPolicyId:
          type: string
          description: The ID of the transit gateway metering policy to add the entry to.
        PolicyRuleNumber:
          type: integer
          description: The rule number for the metering policy entry. Rules are processed in order from lowest to highest number.
        SourceTransitGatewayAttachmentId:
          type: string
          description: The ID of the source transit gateway attachment for traffic matching.
        SourceTransitGatewayAttachmentType:
          type: string
          enum:
          - vpc
          - vpn
          - vpn-concentrator
          - direct-connect-gateway
          - connect
          - peering
          - tgw-peering
          - network-function
          - client-vpn
          description: The type of the source transit gateway attachment for traffic matching. Note that the tgw-peering resource type has been deprecated. To configure metering policies for Connect, use the transport attachment type.
        SourceCidrBlock:
          type: string
          description: The source CIDR block for traffic matching.
        SourcePortRange:
          type: string
          description: The source port range for traffic matching.
        DestinationTransitGatewayAttachmentId:
          type: string
          description: The ID of the destination transit gateway attachment for traffic matching.
        DestinationTransitGatewayAttachmentType:
          type: string
          enum:
          - vpc
          - vpn
          - vpn-concentrator
          - direct-connect-gateway
          - connect
          - peering
          - tgw-peering
          - network-function
          - client-vpn
          description: The type of the destination transit gateway attachment for traffic matching. Note that the tgw-peering resource type has been deprecated. To configure metering policies for Connect, use the transport attachment type.
        DestinationCidrBlock:
          type: string
          description: The destination CIDR block for traffic matching.
        DestinationPortRange:
          type: string
          description: The destination port range for traffic matching.
        Protocol:
          type: string
          description: The protocol for traffic matching (1, 6, 17, etc.).
        MeteredAccount:
          type: string
          enum:
          - source-attachment-owner
          - destination-attachment-owner
          - transit-gateway-owner
          description: The Amazon Web Services account ID to which the metered traffic should be attributed.
        DryRun:
          type: boolean
          description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
      required:
      - TransitGatewayMeteringPolicyId
      - PolicyRuleNumber
      - MeteredAccount
    CreateTransitGatewayMeteringPolicyEntryResult:
      type: object
      properties:
        TransitGatewayMeteringPolicyEntry:
          $ref: '#/components/schemas/TransitGatewayMeteringPolicyEntry'
    GetTransitGatewayMeteringPolicyEntriesResult:
      type: object
      properties:
        TransitGatewayMeteringPolicyEntries:
          type: array
          items:
            $ref: '#/components/schemas/TransitGatewayMeteringPolicyEntry'
          description: Information about the transit gateway metering policy entries.
        NextToken:
          type: string
          description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
    GetTransitGatewayMeteringPolicyEntriesRequest:
      type: object
      properties:
        TransitGatewayMeteringPolicyId:
          type: string
          description: The ID of the transit gateway metering policy to retrieve entries for.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: One or more filters to apply when retrieving metering policy entries.
        MaxResults:
          type: integer
          description: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
        NextToken:
          type: string
          description: The token for the next page of results.
        DryRun:
          type: boolean
          description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
      required:
      - TransitGatewayMeteringPolicyId
    TransitGatewayMeteringPolicyRule:
      type: object
      properties:
        SourceTransitGatewayAttachmentId:
          type: string
          description: The ID of the source transit gateway attachment.
        SourceTransitGatewayAttachmentType:
          type: string
          enum:
          - vpc
          - vpn
          - vpn-concentrator
          - direct-connect-gateway
          - connect
          - peering
          - tgw-peering
          - network-function
          - client-vpn
          description: The type of the source transit gateway attachment. Note that the tgw-peering resource type has been deprecated. To configure metering policies for Connect, use the transport attachment type.
        SourceCidrBlock:
          type: string
          description: The source CIDR block for the rule.
        SourcePortRange:
          type: string
          description: The source port range for the rule.
        DestinationTransitGatewayAttachmentId:
          type: string
          description: The ID of the destination transit gateway attachment.
        DestinationTransitGatewayAttachmentType:
          type: string
          enum:
          - vpc
          - vpn
          - vpn-concentrator
          - direct-connect-gateway
          - connect
          - peering
          - tgw-peering
          - network-function
          - client-vpn
          description: The type of the destination transit gateway attachment. Note that the tgw-peering resource type has been deprecated. To configure metering policies for Connect, use the transport attachment type.
        DestinationCidrBlock:
          type: string
          description: The destination CIDR block for the rule.
        DestinationPortRange:
          type: string
          description: The destination port range for the rule.
        Protocol:
          type: string
          description: The protocol for the rule (1, 6, 17, etc.).
    DeleteTransitGatewayMeteringPolicyEntryResult:
      type: object
      properties:
        TransitGatewayMeteringPolicyEntry:
          $ref: '#/components/schemas/TransitGatewayMeteringPolicyEntry'
    TransitGatewayMeteringPolicyEntry:
      type: object
      properties:
        PolicyRuleNumber:
          type: string
          description: The rule number of the metering policy entry.
        MeteredAccount:
          type: string
          enum:
          - source-attachment-owner
          - destination-attachment-owner
          - transit-gateway-owner
          description: The Amazon Web Services account ID to which the metered traffic is attributed.
        State:
          type: string
          enum:
          - available
          - deleted
          description: The state of the metering policy entry.
        UpdatedAt:
          type: string
          format: date-time
          description: The date and time when the metering policy entry was last updated.
        UpdateEffectiveAt:
          type: string
          format: date-time
          description: The date and time when the metering policy entry update becomes effective.
        MeteringPolicyRule:
          $ref: '#/components/schemas/TransitGatewayMeteringPolicyRule'
    DeleteTransitGatewayMeteringPolicyEntryRequest:
      type: object
      properties:
        TransitGatewayMeteringPolicyId:
          type: string
          description: The ID of the transit gateway metering policy containing the entry to delete.
        PolicyRuleNumber:
          type: integer
          description: The rule number of the metering policy entry to delete.
        DryRun:
          type: boolean
          description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
      required:
      - TransitGatewayMeteringPolicyId
      - PolicyRuleNumber
    Filter:
      type: object
      properties:
        Name:
          type: string
          description: The name of the filter. Filter names are case-sensitive.
        Values:
          type: array
          items:
            type: string
          description: The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
  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: ec2
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/ec2/service/2016-11-15/ec2-2016-11-15.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)