Amazon EC2 Ec2 Network Insights Access Scope API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Network Insights Access Scope…
  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: Network Insights Access Scope
paths:
  /?Action=CreateNetworkInsightsAccessScope:
    post:
      operationId: CreateNetworkInsightsAccessScope
      summary: Create Network Insights Access Scope
      description: Creates a Network Access Scope. Amazon Web Services Network Access Analyzer enables cloud networking and cloud operations teams to verify that their networks on Amazon Web Services conform to their network security and governance objectives. For more information, see the Amazon Web Services Network Access Analyzer Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateNetworkInsightsAccessScopeResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateNetworkInsightsAccessScope
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateNetworkInsightsAccessScopeRequest'
      tags:
      - Network Insights Access Scope
  /?Action=DeleteNetworkInsightsAccessScope:
    post:
      operationId: DeleteNetworkInsightsAccessScope
      summary: Delete Network Insights Access Scope
      description: Deletes the specified Network Access Scope.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteNetworkInsightsAccessScopeResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteNetworkInsightsAccessScope
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteNetworkInsightsAccessScopeRequest'
      tags:
      - Network Insights Access Scope
  /?Action=DescribeNetworkInsightsAccessScopes:
    post:
      operationId: DescribeNetworkInsightsAccessScopes
      summary: Describe Network Insights Access Scopes
      description: Describes the specified Network Access Scopes.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeNetworkInsightsAccessScopesResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeNetworkInsightsAccessScopes
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeNetworkInsightsAccessScopesRequest'
      tags:
      - Network Insights Access Scope
components:
  schemas:
    AccessScopePathRequest:
      type: object
      properties:
        Source:
          $ref: '#/components/schemas/PathStatementRequest'
        Destination:
          $ref: '#/components/schemas/PathStatementRequest'
        ThroughResources:
          type: array
          items:
            $ref: '#/components/schemas/ThroughResourcesStatementRequest'
          description: The through resources.
    ThroughResourcesStatementRequest:
      type: object
      properties:
        ResourceStatement:
          $ref: '#/components/schemas/ResourceStatementRequest'
    DeleteNetworkInsightsAccessScopeRequest:
      type: object
      properties:
        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.
        NetworkInsightsAccessScopeId:
          type: string
          description: The ID of the Network Access Scope.
      required:
      - NetworkInsightsAccessScopeId
    ResourceStatementRequest:
      type: object
      properties:
        Resources:
          type: array
          items:
            type: string
          description: The resources.
        ResourceTypes:
          type: array
          items:
            type: string
          description: The resource types.
    PathStatementRequest:
      type: object
      properties:
        PacketHeaderStatement:
          $ref: '#/components/schemas/PacketHeaderStatementRequest'
        ResourceStatement:
          $ref: '#/components/schemas/ResourceStatementRequest'
    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.
    NetworkInsightsAccessScope:
      type: object
      properties:
        NetworkInsightsAccessScopeId:
          type: string
          description: The ID of the Network Access Scope.
        NetworkInsightsAccessScopeArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Network Access Scope.
        CreatedDate:
          type: string
          format: date-time
          description: The creation date.
        UpdatedDate:
          type: string
          format: date-time
          description: The last updated date.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags.
    NetworkInsightsAccessScopeContent:
      type: object
      properties:
        NetworkInsightsAccessScopeId:
          type: string
          description: The ID of the Network Access Scope.
        MatchPaths:
          type: array
          items:
            $ref: '#/components/schemas/AccessScopePath'
          description: The paths to match.
        ExcludePaths:
          type: array
          items:
            $ref: '#/components/schemas/AccessScopePath'
          description: The paths to exclude.
    PacketHeaderStatementRequest:
      type: object
      properties:
        SourceAddresses:
          type: array
          items:
            type: string
          description: The source addresses.
        DestinationAddresses:
          type: array
          items:
            type: string
          description: The destination addresses.
        SourcePorts:
          type: array
          items:
            type: string
          description: The source ports.
        DestinationPorts:
          type: array
          items:
            type: string
          description: The destination ports.
        SourcePrefixLists:
          type: array
          items:
            type: string
          description: The source prefix lists.
        DestinationPrefixLists:
          type: array
          items:
            type: string
          description: The destination prefix lists.
        Protocols:
          type: array
          items:
            type: string
            enum:
            - tcp
            - udp
          description: The protocols.
    CreateNetworkInsightsAccessScopeResult:
      type: object
      properties:
        NetworkInsightsAccessScope:
          $ref: '#/components/schemas/NetworkInsightsAccessScope'
        NetworkInsightsAccessScopeContent:
          $ref: '#/components/schemas/NetworkInsightsAccessScopeContent'
    DescribeNetworkInsightsAccessScopesResult:
      type: object
      properties:
        NetworkInsightsAccessScopes:
          type: array
          items:
            $ref: '#/components/schemas/NetworkInsightsAccessScope'
          description: The Network Access Scopes.
        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.
    PathStatement:
      type: object
      properties:
        PacketHeaderStatement:
          $ref: '#/components/schemas/PacketHeaderStatement'
        ResourceStatement:
          $ref: '#/components/schemas/ResourceStatement'
    ThroughResourcesStatement:
      type: object
      properties:
        ResourceStatement:
          $ref: '#/components/schemas/ResourceStatement'
    DeleteNetworkInsightsAccessScopeResult:
      type: object
      properties:
        NetworkInsightsAccessScopeId:
          type: string
          description: The ID of the Network Access Scope.
    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.
    DescribeNetworkInsightsAccessScopesRequest:
      type: object
      properties:
        NetworkInsightsAccessScopeIds:
          type: array
          items:
            type: string
          description: The IDs of the Network Access Scopes.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: There are no supported filters.
        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.
        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.
        NextToken:
          type: string
          description: The token for the next page of results.
    ResourceStatement:
      type: object
      properties:
        Resources:
          type: array
          items:
            type: string
          description: The resources.
        ResourceTypes:
          type: array
          items:
            type: string
          description: The resource types.
    AccessScopePath:
      type: object
      properties:
        Source:
          $ref: '#/components/schemas/PathStatement'
        Destination:
          $ref: '#/components/schemas/PathStatement'
        ThroughResources:
          type: array
          items:
            $ref: '#/components/schemas/ThroughResourcesStatement'
          description: The through resources.
    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.'
    CreateNetworkInsightsAccessScopeRequest:
      type: object
      properties:
        MatchPaths:
          type: array
          items:
            $ref: '#/components/schemas/AccessScopePathRequest'
          description: The paths to match.
        ExcludePaths:
          type: array
          items:
            $ref: '#/components/schemas/AccessScopePathRequest'
          description: The paths to exclude.
        ClientToken:
          type: string
          description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
        TagSpecifications:
          type: array
          items:
            $ref: '#/components/schemas/TagSpecification'
          description: The tags to apply.
        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:
      - ClientToken
    PacketHeaderStatement:
      type: object
      properties:
        SourceAddresses:
          type: array
          items:
            type: string
          description: The source addresses.
        DestinationAddresses:
          type: array
          items:
            type: string
          description: The destination addresses.
        SourcePorts:
          type: array
          items:
            type: string
          description: The source ports.
        DestinationPorts:
          type: array
          items:
            type: string
          description: The destination ports.
        SourcePrefixLists:
          type: array
          items:
            type: string
          description: The source prefix lists.
        DestinationPrefixLists:
          type: array
          items:
            type: string
          description: The destination prefix lists.
        Protocols:
          type: array
          items:
            type: string
            enum:
            - tcp
            - udp
          description: The protocols.
  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)