Amazon EC2 Ec2 Transit Gateway Metering Policy 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. 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://ec2.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Transit Gateway Metering Policy
paths:
  /?Action=CreateTransitGatewayMeteringPolicy:
    post:
      operationId: CreateTransitGatewayMeteringPolicy
      summary: Create Transit Gateway Metering Policy
      description: Creates a metering policy for a transit gateway to track and measure network traffic.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateTransitGatewayMeteringPolicyResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateTransitGatewayMeteringPolicy
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateTransitGatewayMeteringPolicyRequest'
      tags:
      - Transit Gateway Metering Policy
  /?Action=DeleteTransitGatewayMeteringPolicy:
    post:
      operationId: DeleteTransitGatewayMeteringPolicy
      summary: Delete Transit Gateway Metering Policy
      description: Deletes a transit gateway metering policy.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteTransitGatewayMeteringPolicyResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteTransitGatewayMeteringPolicy
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteTransitGatewayMeteringPolicyRequest'
      tags:
      - Transit Gateway Metering Policy
  /?Action=DescribeTransitGatewayMeteringPolicies:
    post:
      operationId: DescribeTransitGatewayMeteringPolicies
      summary: Describe Transit Gateway Metering Policies
      description: Describes one or more transit gateway metering policies.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeTransitGatewayMeteringPoliciesResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeTransitGatewayMeteringPolicies
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeTransitGatewayMeteringPoliciesRequest'
      tags:
      - Transit Gateway Metering Policy
  /?Action=ModifyTransitGatewayMeteringPolicy:
    post:
      operationId: ModifyTransitGatewayMeteringPolicy
      summary: Modify Transit Gateway Metering Policy
      description: Modifies a transit gateway metering policy.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ModifyTransitGatewayMeteringPolicyResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ModifyTransitGatewayMeteringPolicy
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/ModifyTransitGatewayMeteringPolicyRequest'
      tags:
      - Transit Gateway Metering Policy
components:
  schemas:
    CreateTransitGatewayMeteringPolicyRequest:
      type: object
      properties:
        TransitGatewayId:
          type: string
          description: The ID of the transit gateway for which to create the metering policy.
        MiddleboxAttachmentIds:
          type: array
          items:
            type: string
          description: The IDs of the middlebox attachments to include in the metering policy.
        TagSpecifications:
          type: array
          items:
            $ref: '#/components/schemas/TagSpecification'
          description: The tags to assign to the metering policy.
        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:
      - TransitGatewayId
    DeleteTransitGatewayMeteringPolicyRequest:
      type: object
      properties:
        TransitGatewayMeteringPolicyId:
          type: string
          description: The ID of the transit gateway metering policy 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
    DescribeTransitGatewayMeteringPoliciesResult:
      type: object
      properties:
        TransitGatewayMeteringPolicies:
          type: array
          items:
            $ref: '#/components/schemas/TransitGatewayMeteringPolicy'
          description: Information about the transit gateway metering policies.
        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.
    ModifyTransitGatewayMeteringPolicyResult:
      type: object
      properties:
        TransitGatewayMeteringPolicy:
          $ref: '#/components/schemas/TransitGatewayMeteringPolicy'
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: 'The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.'
        Value:
          type: string
          description: 'The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.'
    ModifyTransitGatewayMeteringPolicyRequest:
      type: object
      properties:
        TransitGatewayMeteringPolicyId:
          type: string
          description: The ID of the transit gateway metering policy to modify.
        AddMiddleboxAttachmentIds:
          type: array
          items:
            type: string
          description: The IDs of middlebox attachments to add to the metering policy.
        RemoveMiddleboxAttachmentIds:
          type: array
          items:
            type: string
          description: The IDs of middlebox attachments to remove from the metering policy.
        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
    DeleteTransitGatewayMeteringPolicyResult:
      type: object
      properties:
        TransitGatewayMeteringPolicy:
          $ref: '#/components/schemas/TransitGatewayMeteringPolicy'
    DescribeTransitGatewayMeteringPoliciesRequest:
      type: object
      properties:
        TransitGatewayMeteringPolicyIds:
          type: array
          items:
            type: string
          description: The IDs of the transit gateway metering policies to describe.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: One or more filters to apply when describing transit gateway metering policies.
        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.
    TransitGatewayMeteringPolicy:
      type: object
      properties:
        TransitGatewayMeteringPolicyId:
          type: string
          description: The ID of the transit gateway metering policy.
        TransitGatewayId:
          type: string
          description: The ID of the transit gateway associated with the metering policy.
        MiddleboxAttachmentIds:
          type: array
          items:
            type: string
          description: The IDs of the middlebox attachments associated with the metering policy.
        State:
          type: string
          enum:
          - available
          - deleted
          - pending
          - modifying
          - deleting
          description: The state of the transit gateway metering policy.
        UpdateEffectiveAt:
          type: string
          format: date-time
          description: The date and time when the metering policy update becomes effective.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags assigned to the transit gateway metering policy.
    TagSpecification:
      type: object
      properties:
        ResourceType:
          type: string
          enum:
          - capacity-reservation
          - client-vpn-endpoint
          - customer-gateway
          - carrier-gateway
          - coip-pool
          - declarative-policies-report
          - dedicated-host
          - dhcp-options
          - egress-only-internet-gateway
          - elastic-ip
          - elastic-gpu
          - export-image-task
          - export-instance-task
          - fleet
          - fpga-image
          - host-reservation
          - image
          - image-usage-report
          - import-image-task
          - import-snapshot-task
          - instance
          - instance-event-window
          - internet-gateway
          - ipam
          - ipam-pool
          - ipam-scope
          - ipv4pool-ec2
          - ipv6pool-ec2
          - key-pair
          - launch-template
          - local-gateway
          - local-gateway-route-table
          - local-gateway-virtual-interface
          - local-gateway-virtual-interface-group
          - local-gateway-route-table-vpc-association
          - local-gateway-route-table-virtual-interface-group-association
          - natgateway
          - network-acl
          - network-interface
          - network-insights-analysis
          - network-insights-path
          - network-insights-access-scope
          - network-insights-access-scope-analysis
          - outpost-lag
          - placement-group
          - prefix-list
          - replace-root-volume-task
          - reserved-instances
          - route-table
          - security-group
          - security-group-rule
          - service-link-virtual-interface
          - snapshot
          - spot-fleet-request
          - spot-instances-request
          - subnet
          - subnet-cidr-reservation
          - traffic-mirror-filter
          - traffic-mirror-session
          - traffic-mirror-target
          - transit-gateway
          - transit-gateway-attachment
          - transit-gateway-connect-peer
          - transit-gateway-multicast-domain
          - transit-gateway-policy-table
          - transit-gateway-metering-policy
          - transit-gateway-route-table
          - transit-gateway-route-table-announcement
          - volume
          - vpc
          - vpc-endpoint
          - vpc-endpoint-connection
          - vpc-endpoint-service
          - vpc-endpoint-service-permission
          - vpc-peering-connection
          - vpn-connection
          - vpn-gateway
          - vpc-flow-log
          - capacity-reservation-fleet
          - traffic-mirror-filter-rule
          - vpc-endpoint-connection-device-type
          - verified-access-instance
          - verified-access-group
          - verified-access-endpoint
          - verified-access-policy
          - verified-access-trust-provider
          - vpn-connection-device-type
          - vpc-block-public-access-exclusion
          - vpc-encryption-control
          - route-server
          - route-server-endpoint
          - route-server-peer
          - ipam-resource-discovery
          - ipam-resource-discovery-association
          - instance-connect-endpoint
          - verified-access-endpoint-target
          - ipam-external-resource-verification-token
          - capacity-block
          - mac-modification-task
          - ipam-prefix-list-resolver
          - ipam-policy
          - ipam-prefix-list-resolver-target
          - ipam-internet-registry-association
          - secondary-interface
          - secondary-network
          - secondary-subnet
          - capacity-manager-data-export
          - vpn-concentrator
          - ipam-pool-allocation
          - capacity-reservation-cancellation-quote
          - application-status-check
          - capacity-reservation-modification-quote
          description: The type of resource to tag on creation.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags to apply to the resource.
    CreateTransitGatewayMeteringPolicyResult:
      type: object
      properties:
        TransitGatewayMeteringPolicy:
          $ref: '#/components/schemas/TransitGatewayMeteringPolicy'
    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)