Amazon EC2 Ec2 Transit Gateway Multicast Domain API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Transit Gateway Multicast…
  version: '2016-11-15'
  description: Generated from AWS's published Smithy model for Amazon Elastic Compute Cloud. 5 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 Multicast Domain
paths:
  /?Action=AssociateTransitGatewayMulticastDomain:
    post:
      operationId: AssociateTransitGatewayMulticastDomain
      summary: Associate Transit Gateway Multicast Domain
      description: Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain. The transit gateway attachment must be in the available state before you can add a resource. Use DescribeTransitGatewayAttachments to see the state of the attachment.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/AssociateTransitGatewayMulticastDomainResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: AssociateTransitGatewayMulticastDomain
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/AssociateTransitGatewayMulticastDomainRequest'
      tags:
      - Transit Gateway Multicast Domain
  /?Action=CreateTransitGatewayMulticastDomain:
    post:
      operationId: CreateTransitGatewayMulticastDomain
      summary: Create Transit Gateway Multicast Domain
      description: Creates a multicast domain using the specified transit gateway. The transit gateway must be in the available state before you create a domain. Use DescribeTransitGateways to see the state of transit gateway.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateTransitGatewayMulticastDomainResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateTransitGatewayMulticastDomain
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateTransitGatewayMulticastDomainRequest'
      tags:
      - Transit Gateway Multicast Domain
  /?Action=DeleteTransitGatewayMulticastDomain:
    post:
      operationId: DeleteTransitGatewayMulticastDomain
      summary: Delete Transit Gateway Multicast Domain
      description: Deletes the specified transit gateway multicast domain.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteTransitGatewayMulticastDomainResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteTransitGatewayMulticastDomain
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteTransitGatewayMulticastDomainRequest'
      tags:
      - Transit Gateway Multicast Domain
  /?Action=DescribeTransitGatewayMulticastDomains:
    post:
      operationId: DescribeTransitGatewayMulticastDomains
      summary: Describe Transit Gateway Multicast Domains
      description: Describes one or more transit gateway multicast domains.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeTransitGatewayMulticastDomainsResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeTransitGatewayMulticastDomains
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeTransitGatewayMulticastDomainsRequest'
      tags:
      - Transit Gateway Multicast Domain
  /?Action=DisassociateTransitGatewayMulticastDomain:
    post:
      operationId: DisassociateTransitGatewayMulticastDomain
      summary: Disassociate Transit Gateway Multicast Domain
      description: Disassociates the specified subnets from the transit gateway multicast domain.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DisassociateTransitGatewayMulticastDomainResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DisassociateTransitGatewayMulticastDomain
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DisassociateTransitGatewayMulticastDomainRequest'
      tags:
      - Transit Gateway Multicast Domain
components:
  schemas:
    TransitGatewayMulticastDomainAssociations:
      type: object
      properties:
        TransitGatewayMulticastDomainId:
          type: string
          description: The ID of the transit gateway multicast domain.
        TransitGatewayAttachmentId:
          type: string
          description: The ID of the transit gateway attachment.
        ResourceId:
          type: string
          description: The ID of the resource.
        ResourceType:
          type: string
          enum:
          - vpc
          - vpn
          - vpn-concentrator
          - direct-connect-gateway
          - connect
          - peering
          - tgw-peering
          - network-function
          - client-vpn
          description: The type of resource, for example a VPC attachment.
        ResourceOwnerId:
          type: string
          description: The ID of the Amazon Web Services account that owns the resource.
        Subnets:
          type: array
          items:
            $ref: '#/components/schemas/SubnetAssociation'
          description: The subnets associated with the multicast domain.
    TransitGatewayMulticastDomain:
      type: object
      properties:
        TransitGatewayMulticastDomainId:
          type: string
          description: The ID of the transit gateway multicast domain.
        TransitGatewayId:
          type: string
          description: The ID of the transit gateway.
        TransitGatewayMulticastDomainArn:
          type: string
          description: The Amazon Resource Name (ARN) of the transit gateway multicast domain.
        OwnerId:
          type: string
          description: The ID of the Amazon Web Services account that owns the transit gateway multicast domain.
        Options:
          $ref: '#/components/schemas/TransitGatewayMulticastDomainOptions'
        State:
          type: string
          enum:
          - pending
          - available
          - deleting
          - deleted
          description: The state of the transit gateway multicast domain.
        CreationTime:
          type: string
          format: date-time
          description: The time the transit gateway multicast domain was created.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags for the transit gateway multicast domain.
    DisassociateTransitGatewayMulticastDomainRequest:
      type: object
      properties:
        TransitGatewayMulticastDomainId:
          type: string
          description: The ID of the transit gateway multicast domain.
        TransitGatewayAttachmentId:
          type: string
          description: The ID of the attachment.
        SubnetIds:
          type: array
          items:
            type: string
          description: The IDs of the subnets;
        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:
      - TransitGatewayMulticastDomainId
      - TransitGatewayAttachmentId
      - SubnetIds
    CreateTransitGatewayMulticastDomainRequest:
      type: object
      properties:
        TransitGatewayId:
          type: string
          description: The ID of the transit gateway.
        Options:
          $ref: '#/components/schemas/CreateTransitGatewayMulticastDomainRequestOptions'
        TagSpecifications:
          type: array
          items:
            $ref: '#/components/schemas/TagSpecification'
          description: The tags for the transit gateway multicast domain.
        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
    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.'
    AssociateTransitGatewayMulticastDomainRequest:
      type: object
      properties:
        TransitGatewayMulticastDomainId:
          type: string
          description: The ID of the transit gateway multicast domain.
        TransitGatewayAttachmentId:
          type: string
          description: The ID of the transit gateway attachment to associate with the transit gateway multicast domain.
        SubnetIds:
          type: array
          items:
            type: string
          description: The IDs of the subnets to associate with the transit gateway multicast domain.
        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:
      - TransitGatewayMulticastDomainId
      - TransitGatewayAttachmentId
      - SubnetIds
    CreateTransitGatewayMulticastDomainRequestOptions:
      type: object
      properties:
        Igmpv2Support:
          type: string
          enum:
          - enable
          - disable
          description: Specify whether to enable Internet Group Management Protocol (IGMP) version 2 for the transit gateway multicast domain.
        StaticSourcesSupport:
          type: string
          enum:
          - enable
          - disable
          description: Specify whether to enable support for statically configuring multicast group sources for a domain.
        AutoAcceptSharedAssociations:
          type: string
          enum:
          - enable
          - disable
          description: Indicates whether to automatically accept cross-account subnet associations that are associated with the transit gateway multicast domain.
    DisassociateTransitGatewayMulticastDomainResult:
      type: object
      properties:
        Associations:
          $ref: '#/components/schemas/TransitGatewayMulticastDomainAssociations'
    TransitGatewayMulticastDomainOptions:
      type: object
      properties:
        Igmpv2Support:
          type: string
          enum:
          - enable
          - disable
          description: Indicates whether Internet Group Management Protocol (IGMP) version 2 is turned on for the transit gateway multicast domain.
        StaticSourcesSupport:
          type: string
          enum:
          - enable
          - disable
          description: Indicates whether support for statically configuring transit gateway multicast group sources is turned on.
        AutoAcceptSharedAssociations:
          type: string
          enum:
          - enable
          - disable
          description: Indicates whether to automatically cross-account subnet associations that are associated with the transit gateway multicast domain.
    CreateTransitGatewayMulticastDomainResult:
      type: object
      properties:
        TransitGatewayMulticastDomain:
          $ref: '#/components/schemas/TransitGatewayMulticastDomain'
    SubnetAssociation:
      type: object
      properties:
        SubnetId:
          type: string
          description: The ID of the subnet.
        State:
          type: string
          enum:
          - pendingAcceptance
          - associating
          - associated
          - disassociating
          - disassociated
          - rejected
          - failed
          description: The state of the subnet association.
    DescribeTransitGatewayMulticastDomainsRequest:
      type: object
      properties:
        TransitGatewayMulticastDomainIds:
          type: array
          items:
            type: string
          description: The ID of the transit gateway multicast domain.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: 'One or more filters. The possible values are: state - The state of the transit gateway multicast domain. Valid values are pending | available | deleting | deleted. transit-gateway-id - The ID of the transit gateway. transit-gateway-multicast-domain-id - The ID of the transit gateway multicast domain.'
        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.
    AssociateTransitGatewayMulticastDomainResult:
      type: object
      properties:
        Associations:
          $ref: '#/components/schemas/TransitGatewayMulticastDomainAssociations'
    DescribeTransitGatewayMulticastDomainsResult:
      type: object
      properties:
        TransitGatewayMulticastDomains:
          type: array
          items:
            $ref: '#/components/schemas/TransitGatewayMulticastDomain'
          description: Information about the transit gateway multicast domains.
        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.
    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.
    DeleteTransitGatewayMulticastDomainResult:
      type: object
      properties:
        TransitGatewayMulticastDomain:
          $ref: '#/components/schemas/TransitGatewayMulticastDomain'
    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.
    DeleteTransitGatewayMulticastDomainRequest:
      type: object
      properties:
        TransitGatewayMulticastDomainId:
          type: string
          description: The ID of the transit gateway multicast domain.
        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:
      - TransitGatewayMulticastDomainId
  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)