AWS API Changes

2022/05/12 - Amazon Elastic Compute Cloud - 2 updated api methods

Changes This release introduces a target type Gateway Load Balancer Endpoint for mirrored traffic. Customers can now specify GatewayLoadBalancerEndpoint option during the creation of a traffic mirror target.

CreateTrafficMirrorTarget (updated)

Link ¶
Changes (request, response)
Request

{'GatewayLoadBalancerEndpointId': 'string'}

Response

{'TrafficMirrorTarget': {'GatewayLoadBalancerEndpointId': 'string',
                         'Type': {'gateway-load-balancer-endpoint'}}}

Creates a target for your Traffic Mirror session.

A Traffic Mirror target is the destination for mirrored traffic. The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in different VPCs connected via VPC peering or a transit gateway.

A Traffic Mirror target can be a network interface, a Network Load Balancer, or a Gateway Load Balancer endpoint.

To use the target in a Traffic Mirror session, use CreateTrafficMirrorSession.

See also: AWS API Documentation

Request Syntax

client.create_traffic_mirror_target(
    NetworkInterfaceId='string',
    NetworkLoadBalancerArn='string',
    Description='string',
    TagSpecifications=[
        {
            'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'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'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'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-route-table'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-service'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    DryRun=True|False,
    ClientToken='string',
    GatewayLoadBalancerEndpointId='string'
)

type NetworkInterfaceId

string

param NetworkInterfaceId

The network interface ID that is associated with the target.

type NetworkLoadBalancerArn

string

param NetworkLoadBalancerArn

The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target.

type Description

string

param Description

The description of the Traffic Mirror target.

type TagSpecifications

list

param TagSpecifications

The tags to assign to the Traffic Mirror target.

(dict) --

The tags to apply to a resource when the resource is being created.
- ResourceType (string) --
  
  The type of resource to tag on creation.
- Tags (list) --
  
  The tags to apply to the resource.
  - (dict) --
    
    Describes a tag.
    - Key (string) --
      
      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 (string) --
      
      The value of the tag.
      
      Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

type DryRun

boolean

param DryRun

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 .

type ClientToken

string

param ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

This field is autopopulated if not provided.

type GatewayLoadBalancerEndpointId

string

param GatewayLoadBalancerEndpointId

The ID of the Gateway Load Balancer endpoint.

rtype

dict

returns

Response Syntax

{
    'TrafficMirrorTarget': {
        'TrafficMirrorTargetId': 'string',
        'NetworkInterfaceId': 'string',
        'NetworkLoadBalancerArn': 'string',
        'Type': 'network-interface'|'network-load-balancer'|'gateway-load-balancer-endpoint',
        'Description': 'string',
        'OwnerId': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'GatewayLoadBalancerEndpointId': 'string'
    },
    'ClientToken': 'string'
}

Response Structure

(dict) --
- TrafficMirrorTarget (dict) --
  
  Information about the Traffic Mirror target.
  - TrafficMirrorTargetId (string) --
    
    The ID of the Traffic Mirror target.
  - NetworkInterfaceId (string) --
    
    The network interface ID that is attached to the target.
  - NetworkLoadBalancerArn (string) --
    
    The Amazon Resource Name (ARN) of the Network Load Balancer.
  - Type (string) --
    
    The type of Traffic Mirror target.
  - Description (string) --
    
    Information about the Traffic Mirror target.
  - OwnerId (string) --
    
    The ID of the account that owns the Traffic Mirror target.
  - Tags (list) --
    
    The tags assigned to the Traffic Mirror target.
    - (dict) --
      
      Describes a tag.
      - Key (string) --
        
        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 (string) --
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
  - GatewayLoadBalancerEndpointId (string) --
    
    The ID of the Gateway Load Balancer endpoint.
- ClientToken (string) --
  
  Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

DescribeTrafficMirrorTargets (updated)

Link ¶
Changes (response)

{'TrafficMirrorTargets': {'GatewayLoadBalancerEndpointId': 'string',
                          'Type': {'gateway-load-balancer-endpoint'}}}

Information about one or more Traffic Mirror targets.

See also: AWS API Documentation

Request Syntax

client.describe_traffic_mirror_targets(
    TrafficMirrorTargetIds=[
        'string',
    ],
    DryRun=True|False,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)

type TrafficMirrorTargetIds

list

param TrafficMirrorTargetIds

The ID of the Traffic Mirror targets.

(string) --

type DryRun

boolean

param DryRun

type Filters

list

param Filters

One or more filters. The possible values are:

description : The Traffic Mirror target description.
network-interface-id : The ID of the Traffic Mirror session network interface.
network-load-balancer-arn : The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the session.
owner-id : The ID of the account that owns the Traffic Mirror session.
traffic-mirror-target-id : The ID of the Traffic Mirror target.

(dict) --

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

If you specify multiple filters, the filters are joined with an AND , and the request returns only results that match all of the specified filters.
- Name (string) --
  
  The name of the filter. Filter names are case-sensitive.
- Values (list) --
  
  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.
  - (string) --

type MaxResults

integer

param MaxResults

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

type NextToken

string

param NextToken

The token for the next page of results.

rtype

dict

returns

Response Syntax

{
    'TrafficMirrorTargets': [
        {
            'TrafficMirrorTargetId': 'string',
            'NetworkInterfaceId': 'string',
            'NetworkLoadBalancerArn': 'string',
            'Type': 'network-interface'|'network-load-balancer'|'gateway-load-balancer-endpoint',
            'Description': 'string',
            'OwnerId': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'GatewayLoadBalancerEndpointId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- TrafficMirrorTargets (list) --
  
  Information about one or more Traffic Mirror targets.
  - (dict) --
    
    Describes a Traffic Mirror target.
    - TrafficMirrorTargetId (string) --
      
      The ID of the Traffic Mirror target.
    - NetworkInterfaceId (string) --
      
      The network interface ID that is attached to the target.
    - NetworkLoadBalancerArn (string) --
      
      The Amazon Resource Name (ARN) of the Network Load Balancer.
    - Type (string) --
      
      The type of Traffic Mirror target.
    - Description (string) --
      
      Information about the Traffic Mirror target.
    - OwnerId (string) --
      
      The ID of the account that owns the Traffic Mirror target.
    - Tags (list) --
      
      The tags assigned to the Traffic Mirror target.
      - (dict) --
        
        Describes a tag.
        
        Key (string) --
        
        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 (string) --
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
    - GatewayLoadBalancerEndpointId (string) --
      
      The ID of the Gateway Load Balancer endpoint.
- NextToken (string) --
  
  The token to use to retrieve the next page of results. The value is null when there are no more results to return.