2023/03/21 - Amazon Elastic Compute Cloud - 5 updated api methods
Changes This release adds support for AWS Network Firewall, AWS PrivateLink, and Gateway Load Balancers to Amazon VPC Reachability Analyzer, and it makes the path destination optional as long as a destination address in the filter at source is provided.
{'FilterAtDestination': {'DestinationAddress': 'string',
'DestinationPortRange': {'FromPort': 'integer',
'ToPort': 'integer'},
'SourceAddress': 'string',
'SourcePortRange': {'FromPort': 'integer',
'ToPort': 'integer'}},
'FilterAtSource': {'DestinationAddress': 'string',
'DestinationPortRange': {'FromPort': 'integer',
'ToPort': 'integer'},
'SourceAddress': 'string',
'SourcePortRange': {'FromPort': 'integer',
'ToPort': 'integer'}}}
Response {'NetworkInsightsPath': {'FilterAtDestination': {'DestinationAddress': 'string',
'DestinationPortRange': {'FromPort': 'integer',
'ToPort': 'integer'},
'SourceAddress': 'string',
'SourcePortRange': {'FromPort': 'integer',
'ToPort': 'integer'}},
'FilterAtSource': {'DestinationAddress': 'string',
'DestinationPortRange': {'FromPort': 'integer',
'ToPort': 'integer'},
'SourceAddress': 'string',
'SourcePortRange': {'FromPort': 'integer',
'ToPort': 'integer'}}}}
Creates a path to analyze for reachability.
Reachability Analyzer enables you to analyze and debug network reachability between two resources in your virtual private cloud (VPC). For more information, see the Reachability Analyzer Guide.
See also: AWS API Documentation
Request Syntax
client.create_network_insights_path(
SourceIp='string',
DestinationIp='string',
Source='string',
Destination='string',
Protocol='tcp'|'udp',
DestinationPort=123,
TagSpecifications=[
{
'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'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-policy-table'|'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'|'ipam-resource-discovery'|'ipam-resource-discovery-association',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DryRun=True|False,
ClientToken='string',
FilterAtSource={
'SourceAddress': 'string',
'SourcePortRange': {
'FromPort': 123,
'ToPort': 123
},
'DestinationAddress': 'string',
'DestinationPortRange': {
'FromPort': 123,
'ToPort': 123
}
},
FilterAtDestination={
'SourceAddress': 'string',
'SourcePortRange': {
'FromPort': 123,
'ToPort': 123
},
'DestinationAddress': 'string',
'DestinationPortRange': {
'FromPort': 123,
'ToPort': 123
}
}
)
string
The IP address of the source.
string
The IP address of the destination.
string
[REQUIRED]
The ID or ARN of the source. If the resource is in another account, you must specify an ARN.
string
The ID or ARN of the destination. If the resource is in another account, you must specify an ARN.
string
[REQUIRED]
The protocol.
integer
The destination port.
list
The tags to add to the path.
(dict) --
The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
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.
boolean
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.
string
[REQUIRED]
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.
dict
Scopes the analysis to network paths that match specific filters at the source. If you specify this parameter, you can't specify the parameters for the source IP address or the destination port.
SourceAddress (string) --
The source IPv4 address.
SourcePortRange (dict) --
The source port range.
FromPort (integer) --
The first port in the range.
ToPort (integer) --
The last port in the range.
DestinationAddress (string) --
The destination IPv4 address.
DestinationPortRange (dict) --
The destination port range.
FromPort (integer) --
The first port in the range.
ToPort (integer) --
The last port in the range.
dict
Scopes the analysis to network paths that match specific filters at the destination. If you specify this parameter, you can't specify the parameter for the destination IP address.
SourceAddress (string) --
The source IPv4 address.
SourcePortRange (dict) --
The source port range.
FromPort (integer) --
The first port in the range.
ToPort (integer) --
The last port in the range.
DestinationAddress (string) --
The destination IPv4 address.
DestinationPortRange (dict) --
The destination port range.
FromPort (integer) --
The first port in the range.
ToPort (integer) --
The last port in the range.
dict
Response Syntax
{
'NetworkInsightsPath': {
'NetworkInsightsPathId': 'string',
'NetworkInsightsPathArn': 'string',
'CreatedDate': datetime(2015, 1, 1),
'Source': 'string',
'Destination': 'string',
'SourceArn': 'string',
'DestinationArn': 'string',
'SourceIp': 'string',
'DestinationIp': 'string',
'Protocol': 'tcp'|'udp',
'DestinationPort': 123,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'FilterAtSource': {
'SourceAddress': 'string',
'SourcePortRange': {
'FromPort': 123,
'ToPort': 123
},
'DestinationAddress': 'string',
'DestinationPortRange': {
'FromPort': 123,
'ToPort': 123
}
},
'FilterAtDestination': {
'SourceAddress': 'string',
'SourcePortRange': {
'FromPort': 123,
'ToPort': 123
},
'DestinationAddress': 'string',
'DestinationPortRange': {
'FromPort': 123,
'ToPort': 123
}
}
}
}
Response Structure
(dict) --
NetworkInsightsPath (dict) --
Information about the path.
NetworkInsightsPathId (string) --
The ID of the path.
NetworkInsightsPathArn (string) --
The Amazon Resource Name (ARN) of the path.
CreatedDate (datetime) --
The time stamp when the path was created.
Source (string) --
The ID of the source.
Destination (string) --
The ID of the destination.
SourceArn (string) --
The Amazon Resource Name (ARN) of the source.
DestinationArn (string) --
The Amazon Resource Name (ARN) of the destination.
SourceIp (string) --
The IP address of the source.
DestinationIp (string) --
The IP address of the destination.
Protocol (string) --
The protocol.
DestinationPort (integer) --
The destination port.
Tags (list) --
The tags associated with the path.
(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.
FilterAtSource (dict) --
Scopes the analysis to network paths that match specific filters at the source.
SourceAddress (string) --
The source IPv4 address.
SourcePortRange (dict) --
The source port range.
FromPort (integer) --
The first port in the range.
ToPort (integer) --
The last port in the range.
DestinationAddress (string) --
The destination IPv4 address.
DestinationPortRange (dict) --
The destination port range.
FromPort (integer) --
The first port in the range.
ToPort (integer) --
The last port in the range.
FilterAtDestination (dict) --
Scopes the analysis to network paths that match specific filters at the destination.
SourceAddress (string) --
The source IPv4 address.
SourcePortRange (dict) --
The source port range.
FromPort (integer) --
The first port in the range.
ToPort (integer) --
The last port in the range.
DestinationAddress (string) --
The destination IPv4 address.
DestinationPortRange (dict) --
The destination port range.
FromPort (integer) --
The first port in the range.
ToPort (integer) --
The last port in the range.
{'NetworkInsightsAnalyses': {'Explanations': {'FirewallStatefulRule': {'DestinationPorts': [{'From': 'integer',
'To': 'integer'}],
'Destinations': ['string'],
'Direction': 'string',
'Protocol': 'string',
'RuleAction': 'string',
'RuleGroupArn': 'string',
'SourcePorts': [{'From': 'integer',
'To': 'integer'}],
'Sources': ['string']},
'FirewallStatelessRule': {'DestinationPorts': [{'From': 'integer',
'To': 'integer'}],
'Destinations': ['string'],
'Priority': 'integer',
'Protocols': ['integer'],
'RuleAction': 'string',
'RuleGroupArn': 'string',
'SourcePorts': [{'From': 'integer',
'To': 'integer'}],
'Sources': ['string']},
'RouteTableRoute': {'CarrierGatewayId': 'string',
'CoreNetworkArn': 'string',
'LocalGatewayId': 'string'}},
'ForwardPathComponents': {'AdditionalDetails': {'LoadBalancers': [{'Arn': 'string',
'Id': 'string',
'Name': 'string'}],
'RuleGroupRuleOptionsPairs': [{'RuleGroupArn': 'string',
'RuleOptions': [{'Keyword': 'string',
'Settings': ['string']}]}],
'RuleGroupTypePairs': [{'RuleGroupArn': 'string',
'RuleGroupType': 'string'}],
'RuleOptions': [{'Keyword': 'string',
'Settings': ['string']}],
'ServiceName': 'string',
'VpcEndpointService': {'Arn': 'string',
'Id': 'string',
'Name': 'string'}},
'Explanations': {'FirewallStatefulRule': {'DestinationPorts': [{'From': 'integer',
'To': 'integer'}],
'Destinations': ['string'],
'Direction': 'string',
'Protocol': 'string',
'RuleAction': 'string',
'RuleGroupArn': 'string',
'SourcePorts': [{'From': 'integer',
'To': 'integer'}],
'Sources': ['string']},
'FirewallStatelessRule': {'DestinationPorts': [{'From': 'integer',
'To': 'integer'}],
'Destinations': ['string'],
'Priority': 'integer',
'Protocols': ['integer'],
'RuleAction': 'string',
'RuleGroupArn': 'string',
'SourcePorts': [{'From': 'integer',
'To': 'integer'}],
'Sources': ['string']},
'RouteTableRoute': {'CarrierGatewayId': 'string',
'CoreNetworkArn': 'string',
'LocalGatewayId': 'string'}},
'FirewallStatefulRule': {'DestinationPorts': [{'From': 'integer',
'To': 'integer'}],
'Destinations': ['string'],
'Direction': 'string',
'Protocol': 'string',
'RuleAction': 'string',
'RuleGroupArn': 'string',
'SourcePorts': [{'From': 'integer',
'To': 'integer'}],
'Sources': ['string']},
'FirewallStatelessRule': {'DestinationPorts': [{'From': 'integer',
'To': 'integer'}],
'Destinations': ['string'],
'Priority': 'integer',
'Protocols': ['integer'],
'RuleAction': 'string',
'RuleGroupArn': 'string',
'SourcePorts': [{'From': 'integer',
'To': 'integer'}],
'Sources': ['string']},
'RouteTableRoute': {'CarrierGatewayId': 'string',
'CoreNetworkArn': 'string',
'LocalGatewayId': 'string'},
'ServiceName': 'string'},
'ReturnPathComponents': {'AdditionalDetails': {'LoadBalancers': [{'Arn': 'string',
'Id': 'string',
'Name': 'string'}],
'RuleGroupRuleOptionsPairs': [{'RuleGroupArn': 'string',
'RuleOptions': [{'Keyword': 'string',
'Settings': ['string']}]}],
'RuleGroupTypePairs': [{'RuleGroupArn': 'string',
'RuleGroupType': 'string'}],
'RuleOptions': [{'Keyword': 'string',
'Settings': ['string']}],
'ServiceName': 'string',
'VpcEndpointService': {'Arn': 'string',
'Id': 'string',
'Name': 'string'}},
'Explanations': {'FirewallStatefulRule': {'DestinationPorts': [{'From': 'integer',
'To': 'integer'}],
'Destinations': ['string'],
'Direction': 'string',
'Protocol': 'string',
'RuleAction': 'string',
'RuleGroupArn': 'string',
'SourcePorts': [{'From': 'integer',
'To': 'integer'}],
'Sources': ['string']},
'FirewallStatelessRule': {'DestinationPorts': [{'From': 'integer',
'To': 'integer'}],
'Destinations': ['string'],
'Priority': 'integer',
'Protocols': ['integer'],
'RuleAction': 'string',
'RuleGroupArn': 'string',
'SourcePorts': [{'From': 'integer',
'To': 'integer'}],
'Sources': ['string']},
'RouteTableRoute': {'CarrierGatewayId': 'string',
'CoreNetworkArn': 'string',
'LocalGatewayId': 'string'}},
'FirewallStatefulRule': {'DestinationPorts': [{'From': 'integer',
'To': 'integer'}],
'Destinations': ['string'],
'Direction': 'string',
'Protocol': 'string',
'RuleAction': 'string',
'RuleGroupArn': 'string',
'SourcePorts': [{'From': 'integer',
'To': 'integer'}],
'Sources': ['string']},
'FirewallStatelessRule': {'DestinationPorts': [{'From': 'integer',
'To': 'integer'}],
'Destinations': ['string'],
'Priority': 'integer',
'Protocols': ['integer'],
'RuleAction': 'string',
'RuleGroupArn': 'string',
'SourcePorts': [{'From': 'integer',
'To': 'integer'}],
'Sources': ['string']},
'RouteTableRoute': {'CarrierGatewayId': 'string',
'CoreNetworkArn': 'string',
'LocalGatewayId': 'string'},
'ServiceName': 'string'}}}
Describes one or more of your network insights analyses.
See also: AWS API Documentation
Request Syntax
client.describe_network_insights_analyses(
NetworkInsightsAnalysisIds=[
'string',
],
NetworkInsightsPathId='string',
AnalysisStartTime=datetime(2015, 1, 1),
AnalysisEndTime=datetime(2015, 1, 1),
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
DryRun=True|False,
NextToken='string'
)
list
The ID of the network insights analyses. You must specify either analysis IDs or a path ID.
(string) --
string
The ID of the path. You must specify either a path ID or analysis IDs.
datetime
The time when the network insights analyses started.
datetime
The time when the network insights analyses ended.
list
The filters. The following are the possible values:
path-found - A Boolean value that indicates whether a feasible path is found.
status - The status of the analysis (running | succeeded | failed).
(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) --
integer
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
boolean
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.
string
The token for the next page of results.
dict
Response Syntax
{
'NetworkInsightsAnalyses': [
{
'NetworkInsightsAnalysisId': 'string',
'NetworkInsightsAnalysisArn': 'string',
'NetworkInsightsPathId': 'string',
'AdditionalAccounts': [
'string',
],
'FilterInArns': [
'string',
],
'StartDate': datetime(2015, 1, 1),
'Status': 'running'|'succeeded'|'failed',
'StatusMessage': 'string',
'WarningMessage': 'string',
'NetworkPathFound': True|False,
'ForwardPathComponents': [
{
'SequenceNumber': 123,
'AclRule': {
'Cidr': 'string',
'Egress': True|False,
'PortRange': {
'From': 123,
'To': 123
},
'Protocol': 'string',
'RuleAction': 'string',
'RuleNumber': 123
},
'AttachedTo': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Component': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'DestinationVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'OutboundHeader': {
'DestinationAddresses': [
'string',
],
'DestinationPortRanges': [
{
'From': 123,
'To': 123
},
],
'Protocol': 'string',
'SourceAddresses': [
'string',
],
'SourcePortRanges': [
{
'From': 123,
'To': 123
},
]
},
'InboundHeader': {
'DestinationAddresses': [
'string',
],
'DestinationPortRanges': [
{
'From': 123,
'To': 123
},
],
'Protocol': 'string',
'SourceAddresses': [
'string',
],
'SourcePortRanges': [
{
'From': 123,
'To': 123
},
]
},
'RouteTableRoute': {
'DestinationCidr': 'string',
'DestinationPrefixListId': 'string',
'EgressOnlyInternetGatewayId': 'string',
'GatewayId': 'string',
'InstanceId': 'string',
'NatGatewayId': 'string',
'NetworkInterfaceId': 'string',
'Origin': 'string',
'TransitGatewayId': 'string',
'VpcPeeringConnectionId': 'string',
'State': 'string',
'CarrierGatewayId': 'string',
'CoreNetworkArn': 'string',
'LocalGatewayId': 'string'
},
'SecurityGroupRule': {
'Cidr': 'string',
'Direction': 'string',
'SecurityGroupId': 'string',
'PortRange': {
'From': 123,
'To': 123
},
'PrefixListId': 'string',
'Protocol': 'string'
},
'SourceVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Subnet': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Vpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AdditionalDetails': [
{
'AdditionalDetailType': 'string',
'Component': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpcEndpointService': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'RuleOptions': [
{
'Keyword': 'string',
'Settings': [
'string',
]
},
],
'RuleGroupTypePairs': [
{
'RuleGroupArn': 'string',
'RuleGroupType': 'string'
},
],
'RuleGroupRuleOptionsPairs': [
{
'RuleGroupArn': 'string',
'RuleOptions': [
{
'Keyword': 'string',
'Settings': [
'string',
]
},
]
},
],
'ServiceName': 'string',
'LoadBalancers': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
]
},
],
'TransitGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTableRoute': {
'DestinationCidr': 'string',
'State': 'string',
'RouteOrigin': 'string',
'PrefixListId': 'string',
'AttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'string'
},
'Explanations': [
{
'Acl': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AclRule': {
'Cidr': 'string',
'Egress': True|False,
'PortRange': {
'From': 123,
'To': 123
},
'Protocol': 'string',
'RuleAction': 'string',
'RuleNumber': 123
},
'Address': 'string',
'Addresses': [
'string',
],
'AttachedTo': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AvailabilityZones': [
'string',
],
'Cidrs': [
'string',
],
'Component': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'CustomerGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Destination': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'DestinationVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Direction': 'string',
'ExplanationCode': 'string',
'IngressRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'InternetGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LoadBalancerArn': 'string',
'ClassicLoadBalancerListener': {
'LoadBalancerPort': 123,
'InstancePort': 123
},
'LoadBalancerListenerPort': 123,
'LoadBalancerTarget': {
'Address': 'string',
'AvailabilityZone': 'string',
'Instance': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Port': 123
},
'LoadBalancerTargetGroup': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LoadBalancerTargetGroups': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'LoadBalancerTargetPort': 123,
'ElasticLoadBalancerListener': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'MissingComponent': 'string',
'NatGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'NetworkInterface': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'PacketField': 'string',
'VpcPeeringConnection': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Port': 123,
'PortRanges': [
{
'From': 123,
'To': 123
},
],
'PrefixList': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Protocols': [
'string',
],
'RouteTableRoute': {
'DestinationCidr': 'string',
'DestinationPrefixListId': 'string',
'EgressOnlyInternetGatewayId': 'string',
'GatewayId': 'string',
'InstanceId': 'string',
'NatGatewayId': 'string',
'NetworkInterfaceId': 'string',
'Origin': 'string',
'TransitGatewayId': 'string',
'VpcPeeringConnectionId': 'string',
'State': 'string',
'CarrierGatewayId': 'string',
'CoreNetworkArn': 'string',
'LocalGatewayId': 'string'
},
'RouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SecurityGroup': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SecurityGroupRule': {
'Cidr': 'string',
'Direction': 'string',
'SecurityGroupId': 'string',
'PortRange': {
'From': 123,
'To': 123
},
'PrefixListId': 'string',
'Protocol': 'string'
},
'SecurityGroups': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'SourceVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'State': 'string',
'Subnet': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SubnetRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Vpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpcEndpoint': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpnConnection': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpnGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTableRoute': {
'DestinationCidr': 'string',
'State': 'string',
'RouteOrigin': 'string',
'PrefixListId': 'string',
'AttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'string'
},
'TransitGatewayAttachment': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'ComponentAccount': 'string',
'ComponentRegion': 'string',
'FirewallStatelessRule': {
'RuleGroupArn': 'string',
'Sources': [
'string',
],
'Destinations': [
'string',
],
'SourcePorts': [
{
'From': 123,
'To': 123
},
],
'DestinationPorts': [
{
'From': 123,
'To': 123
},
],
'Protocols': [
123,
],
'RuleAction': 'string',
'Priority': 123
},
'FirewallStatefulRule': {
'RuleGroupArn': 'string',
'Sources': [
'string',
],
'Destinations': [
'string',
],
'SourcePorts': [
{
'From': 123,
'To': 123
},
],
'DestinationPorts': [
{
'From': 123,
'To': 123
},
],
'Protocol': 'string',
'RuleAction': 'string',
'Direction': 'string'
}
},
],
'ElasticLoadBalancerListener': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'FirewallStatelessRule': {
'RuleGroupArn': 'string',
'Sources': [
'string',
],
'Destinations': [
'string',
],
'SourcePorts': [
{
'From': 123,
'To': 123
},
],
'DestinationPorts': [
{
'From': 123,
'To': 123
},
],
'Protocols': [
123,
],
'RuleAction': 'string',
'Priority': 123
},
'FirewallStatefulRule': {
'RuleGroupArn': 'string',
'Sources': [
'string',
],
'Destinations': [
'string',
],
'SourcePorts': [
{
'From': 123,
'To': 123
},
],
'DestinationPorts': [
{
'From': 123,
'To': 123
},
],
'Protocol': 'string',
'RuleAction': 'string',
'Direction': 'string'
},
'ServiceName': 'string'
},
],
'ReturnPathComponents': [
{
'SequenceNumber': 123,
'AclRule': {
'Cidr': 'string',
'Egress': True|False,
'PortRange': {
'From': 123,
'To': 123
},
'Protocol': 'string',
'RuleAction': 'string',
'RuleNumber': 123
},
'AttachedTo': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Component': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'DestinationVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'OutboundHeader': {
'DestinationAddresses': [
'string',
],
'DestinationPortRanges': [
{
'From': 123,
'To': 123
},
],
'Protocol': 'string',
'SourceAddresses': [
'string',
],
'SourcePortRanges': [
{
'From': 123,
'To': 123
},
]
},
'InboundHeader': {
'DestinationAddresses': [
'string',
],
'DestinationPortRanges': [
{
'From': 123,
'To': 123
},
],
'Protocol': 'string',
'SourceAddresses': [
'string',
],
'SourcePortRanges': [
{
'From': 123,
'To': 123
},
]
},
'RouteTableRoute': {
'DestinationCidr': 'string',
'DestinationPrefixListId': 'string',
'EgressOnlyInternetGatewayId': 'string',
'GatewayId': 'string',
'InstanceId': 'string',
'NatGatewayId': 'string',
'NetworkInterfaceId': 'string',
'Origin': 'string',
'TransitGatewayId': 'string',
'VpcPeeringConnectionId': 'string',
'State': 'string',
'CarrierGatewayId': 'string',
'CoreNetworkArn': 'string',
'LocalGatewayId': 'string'
},
'SecurityGroupRule': {
'Cidr': 'string',
'Direction': 'string',
'SecurityGroupId': 'string',
'PortRange': {
'From': 123,
'To': 123
},
'PrefixListId': 'string',
'Protocol': 'string'
},
'SourceVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Subnet': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Vpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AdditionalDetails': [
{
'AdditionalDetailType': 'string',
'Component': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpcEndpointService': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'RuleOptions': [
{
'Keyword': 'string',
'Settings': [
'string',
]
},
],
'RuleGroupTypePairs': [
{
'RuleGroupArn': 'string',
'RuleGroupType': 'string'
},
],
'RuleGroupRuleOptionsPairs': [
{
'RuleGroupArn': 'string',
'RuleOptions': [
{
'Keyword': 'string',
'Settings': [
'string',
]
},
]
},
],
'ServiceName': 'string',
'LoadBalancers': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
]
},
],
'TransitGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTableRoute': {
'DestinationCidr': 'string',
'State': 'string',
'RouteOrigin': 'string',
'PrefixListId': 'string',
'AttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'string'
},
'Explanations': [
{
'Acl': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AclRule': {
'Cidr': 'string',
'Egress': True|False,
'PortRange': {
'From': 123,
'To': 123
},
'Protocol': 'string',
'RuleAction': 'string',
'RuleNumber': 123
},
'Address': 'string',
'Addresses': [
'string',
],
'AttachedTo': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AvailabilityZones': [
'string',
],
'Cidrs': [
'string',
],
'Component': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'CustomerGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Destination': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'DestinationVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Direction': 'string',
'ExplanationCode': 'string',
'IngressRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'InternetGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LoadBalancerArn': 'string',
'ClassicLoadBalancerListener': {
'LoadBalancerPort': 123,
'InstancePort': 123
},
'LoadBalancerListenerPort': 123,
'LoadBalancerTarget': {
'Address': 'string',
'AvailabilityZone': 'string',
'Instance': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Port': 123
},
'LoadBalancerTargetGroup': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LoadBalancerTargetGroups': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'LoadBalancerTargetPort': 123,
'ElasticLoadBalancerListener': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'MissingComponent': 'string',
'NatGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'NetworkInterface': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'PacketField': 'string',
'VpcPeeringConnection': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Port': 123,
'PortRanges': [
{
'From': 123,
'To': 123
},
],
'PrefixList': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Protocols': [
'string',
],
'RouteTableRoute': {
'DestinationCidr': 'string',
'DestinationPrefixListId': 'string',
'EgressOnlyInternetGatewayId': 'string',
'GatewayId': 'string',
'InstanceId': 'string',
'NatGatewayId': 'string',
'NetworkInterfaceId': 'string',
'Origin': 'string',
'TransitGatewayId': 'string',
'VpcPeeringConnectionId': 'string',
'State': 'string',
'CarrierGatewayId': 'string',
'CoreNetworkArn': 'string',
'LocalGatewayId': 'string'
},
'RouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SecurityGroup': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SecurityGroupRule': {
'Cidr': 'string',
'Direction': 'string',
'SecurityGroupId': 'string',
'PortRange': {
'From': 123,
'To': 123
},
'PrefixListId': 'string',
'Protocol': 'string'
},
'SecurityGroups': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'SourceVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'State': 'string',
'Subnet': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SubnetRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Vpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpcEndpoint': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpnConnection': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpnGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTableRoute': {
'DestinationCidr': 'string',
'State': 'string',
'RouteOrigin': 'string',
'PrefixListId': 'string',
'AttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'string'
},
'TransitGatewayAttachment': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'ComponentAccount': 'string',
'ComponentRegion': 'string',
'FirewallStatelessRule': {
'RuleGroupArn': 'string',
'Sources': [
'string',
],
'Destinations': [
'string',
],
'SourcePorts': [
{
'From': 123,
'To': 123
},
],
'DestinationPorts': [
{
'From': 123,
'To': 123
},
],
'Protocols': [
123,
],
'RuleAction': 'string',
'Priority': 123
},
'FirewallStatefulRule': {
'RuleGroupArn': 'string',
'Sources': [
'string',
],
'Destinations': [
'string',
],
'SourcePorts': [
{
'From': 123,
'To': 123
},
],
'DestinationPorts': [
{
'From': 123,
'To': 123
},
],
'Protocol': 'string',
'RuleAction': 'string',
'Direction': 'string'
}
},
],
'ElasticLoadBalancerListener': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'FirewallStatelessRule': {
'RuleGroupArn': 'string',
'Sources': [
'string',
],
'Destinations': [
'string',
],
'SourcePorts': [
{
'From': 123,
'To': 123
},
],
'DestinationPorts': [
{
'From': 123,
'To': 123
},
],
'Protocols': [
123,
],
'RuleAction': 'string',
'Priority': 123
},
'FirewallStatefulRule': {
'RuleGroupArn': 'string',
'Sources': [
'string',
],
'Destinations': [
'string',
],
'SourcePorts': [
{
'From': 123,
'To': 123
},
],
'DestinationPorts': [
{
'From': 123,
'To': 123
},
],
'Protocol': 'string',
'RuleAction': 'string',
'Direction': 'string'
},
'ServiceName': 'string'
},
],
'Explanations': [
{
'Acl': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AclRule': {
'Cidr': 'string',
'Egress': True|False,
'PortRange': {
'From': 123,
'To': 123
},
'Protocol': 'string',
'RuleAction': 'string',
'RuleNumber': 123
},
'Address': 'string',
'Addresses': [
'string',
],
'AttachedTo': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AvailabilityZones': [
'string',
],
'Cidrs': [
'string',
],
'Component': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'CustomerGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Destination': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'DestinationVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Direction': 'string',
'ExplanationCode': 'string',
'IngressRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'InternetGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LoadBalancerArn': 'string',
'ClassicLoadBalancerListener': {
'LoadBalancerPort': 123,
'InstancePort': 123
},
'LoadBalancerListenerPort': 123,
'LoadBalancerTarget': {
'Address': 'string',
'AvailabilityZone': 'string',
'Instance': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Port': 123
},
'LoadBalancerTargetGroup': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LoadBalancerTargetGroups': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'LoadBalancerTargetPort': 123,
'ElasticLoadBalancerListener': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'MissingComponent': 'string',
'NatGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'NetworkInterface': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'PacketField': 'string',
'VpcPeeringConnection': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Port': 123,
'PortRanges': [
{
'From': 123,
'To': 123
},
],
'PrefixList': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Protocols': [
'string',
],
'RouteTableRoute': {
'DestinationCidr': 'string',
'DestinationPrefixListId': 'string',
'EgressOnlyInternetGatewayId': 'string',
'GatewayId': 'string',
'InstanceId': 'string',
'NatGatewayId': 'string',
'NetworkInterfaceId': 'string',
'Origin': 'string',
'TransitGatewayId': 'string',
'VpcPeeringConnectionId': 'string',
'State': 'string',
'CarrierGatewayId': 'string',
'CoreNetworkArn': 'string',
'LocalGatewayId': 'string'
},
'RouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SecurityGroup': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SecurityGroupRule': {
'Cidr': 'string',
'Direction': 'string',
'SecurityGroupId': 'string',
'PortRange': {
'From': 123,
'To': 123
},
'PrefixListId': 'string',
'Protocol': 'string'
},
'SecurityGroups': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'SourceVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'State': 'string',
'Subnet': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SubnetRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Vpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpcEndpoint': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpnConnection': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpnGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTableRoute': {
'DestinationCidr': 'string',
'State': 'string',
'RouteOrigin': 'string',
'PrefixListId': 'string',
'AttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'string'
},
'TransitGatewayAttachment': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'ComponentAccount': 'string',
'ComponentRegion': 'string',
'FirewallStatelessRule': {
'RuleGroupArn': 'string',
'Sources': [
'string',
],
'Destinations': [
'string',
],
'SourcePorts': [
{
'From': 123,
'To': 123
},
],
'DestinationPorts': [
{
'From': 123,
'To': 123
},
],
'Protocols': [
123,
],
'RuleAction': 'string',
'Priority': 123
},
'FirewallStatefulRule': {
'RuleGroupArn': 'string',
'Sources': [
'string',
],
'Destinations': [
'string',
],
'SourcePorts': [
{
'From': 123,
'To': 123
},
],
'DestinationPorts': [
{
'From': 123,
'To': 123
},
],
'Protocol': 'string',
'RuleAction': 'string',
'Direction': 'string'
}
},
],
'AlternatePathHints': [
{
'ComponentId': 'string',
'ComponentArn': 'string'
},
],
'SuggestedAccounts': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
**Response Structure**
::
# This section is too large to render.
# Please see the AWS API Documentation linked below.
`AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DescribeNetworkInsightsAnalyses>`_
{'NetworkInsightsPaths': {'FilterAtDestination': {'DestinationAddress': 'string',
'DestinationPortRange': {'FromPort': 'integer',
'ToPort': 'integer'},
'SourceAddress': 'string',
'SourcePortRange': {'FromPort': 'integer',
'ToPort': 'integer'}},
'FilterAtSource': {'DestinationAddress': 'string',
'DestinationPortRange': {'FromPort': 'integer',
'ToPort': 'integer'},
'SourceAddress': 'string',
'SourcePortRange': {'FromPort': 'integer',
'ToPort': 'integer'}}}}
Describes one or more of your paths.
See also: AWS API Documentation
Request Syntax
client.describe_network_insights_paths(
NetworkInsightsPathIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
DryRun=True|False,
NextToken='string'
)
list
The IDs of the paths.
(string) --
list
The filters. The following are the possible values:
destination - The ID of the resource.
filter-at-source.source-address - The source IPv4 address at the source.
filter-at-source.source-port-range - The source port range at the source.
filter-at-source.destination-address - The destination IPv4 address at the source.
filter-at-source.destination-port-range - The destination port range at the source.
filter-at-destination.source-address - The source IPv4 address at the destination.
filter-at-destination.source-port-range - The source port range at the destination.
filter-at-destination.destination-address - The destination IPv4 address at the destination.
filter-at-destination.destination-port-range - The destination port range at the destination.
protocol - The protocol.
source - The ID of the resource.
(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) --
integer
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
boolean
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.
string
The token for the next page of results.
dict
Response Syntax
{
'NetworkInsightsPaths': [
{
'NetworkInsightsPathId': 'string',
'NetworkInsightsPathArn': 'string',
'CreatedDate': datetime(2015, 1, 1),
'Source': 'string',
'Destination': 'string',
'SourceArn': 'string',
'DestinationArn': 'string',
'SourceIp': 'string',
'DestinationIp': 'string',
'Protocol': 'tcp'|'udp',
'DestinationPort': 123,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'FilterAtSource': {
'SourceAddress': 'string',
'SourcePortRange': {
'FromPort': 123,
'ToPort': 123
},
'DestinationAddress': 'string',
'DestinationPortRange': {
'FromPort': 123,
'ToPort': 123
}
},
'FilterAtDestination': {
'SourceAddress': 'string',
'SourcePortRange': {
'FromPort': 123,
'ToPort': 123
},
'DestinationAddress': 'string',
'DestinationPortRange': {
'FromPort': 123,
'ToPort': 123
}
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
NetworkInsightsPaths (list) --
Information about the paths.
(dict) --
Describes a path.
NetworkInsightsPathId (string) --
The ID of the path.
NetworkInsightsPathArn (string) --
The Amazon Resource Name (ARN) of the path.
CreatedDate (datetime) --
The time stamp when the path was created.
Source (string) --
The ID of the source.
Destination (string) --
The ID of the destination.
SourceArn (string) --
The Amazon Resource Name (ARN) of the source.
DestinationArn (string) --
The Amazon Resource Name (ARN) of the destination.
SourceIp (string) --
The IP address of the source.
DestinationIp (string) --
The IP address of the destination.
Protocol (string) --
The protocol.
DestinationPort (integer) --
The destination port.
Tags (list) --
The tags associated with the path.
(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.
FilterAtSource (dict) --
Scopes the analysis to network paths that match specific filters at the source.
SourceAddress (string) --
The source IPv4 address.
SourcePortRange (dict) --
The source port range.
FromPort (integer) --
The first port in the range.
ToPort (integer) --
The last port in the range.
DestinationAddress (string) --
The destination IPv4 address.
DestinationPortRange (dict) --
The destination port range.
FromPort (integer) --
The first port in the range.
ToPort (integer) --
The last port in the range.
FilterAtDestination (dict) --
Scopes the analysis to network paths that match specific filters at the destination.
SourceAddress (string) --
The source IPv4 address.
SourcePortRange (dict) --
The source port range.
FromPort (integer) --
The first port in the range.
ToPort (integer) --
The last port in the range.
DestinationAddress (string) --
The destination IPv4 address.
DestinationPortRange (dict) --
The destination port range.
FromPort (integer) --
The first port in the range.
ToPort (integer) --
The last port in the range.
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
{'AnalysisFindings': {'FindingComponents': {'AdditionalDetails': {'LoadBalancers': [{'Arn': 'string',
'Id': 'string',
'Name': 'string'}],
'RuleGroupRuleOptionsPairs': [{'RuleGroupArn': 'string',
'RuleOptions': [{'Keyword': 'string',
'Settings': ['string']}]}],
'RuleGroupTypePairs': [{'RuleGroupArn': 'string',
'RuleGroupType': 'string'}],
'RuleOptions': [{'Keyword': 'string',
'Settings': ['string']}],
'ServiceName': 'string',
'VpcEndpointService': {'Arn': 'string',
'Id': 'string',
'Name': 'string'}},
'Explanations': {'FirewallStatefulRule': {'DestinationPorts': [{'From': 'integer',
'To': 'integer'}],
'Destinations': ['string'],
'Direction': 'string',
'Protocol': 'string',
'RuleAction': 'string',
'RuleGroupArn': 'string',
'SourcePorts': [{'From': 'integer',
'To': 'integer'}],
'Sources': ['string']},
'FirewallStatelessRule': {'DestinationPorts': [{'From': 'integer',
'To': 'integer'}],
'Destinations': ['string'],
'Priority': 'integer',
'Protocols': ['integer'],
'RuleAction': 'string',
'RuleGroupArn': 'string',
'SourcePorts': [{'From': 'integer',
'To': 'integer'}],
'Sources': ['string']},
'RouteTableRoute': {'CarrierGatewayId': 'string',
'CoreNetworkArn': 'string',
'LocalGatewayId': 'string'}},
'FirewallStatefulRule': {'DestinationPorts': [{'From': 'integer',
'To': 'integer'}],
'Destinations': ['string'],
'Direction': 'string',
'Protocol': 'string',
'RuleAction': 'string',
'RuleGroupArn': 'string',
'SourcePorts': [{'From': 'integer',
'To': 'integer'}],
'Sources': ['string']},
'FirewallStatelessRule': {'DestinationPorts': [{'From': 'integer',
'To': 'integer'}],
'Destinations': ['string'],
'Priority': 'integer',
'Protocols': ['integer'],
'RuleAction': 'string',
'RuleGroupArn': 'string',
'SourcePorts': [{'From': 'integer',
'To': 'integer'}],
'Sources': ['string']},
'RouteTableRoute': {'CarrierGatewayId': 'string',
'CoreNetworkArn': 'string',
'LocalGatewayId': 'string'},
'ServiceName': 'string'}}}
Gets the findings for the specified Network Access Scope analysis.
See also: AWS API Documentation
Request Syntax
client.get_network_insights_access_scope_analysis_findings(
NetworkInsightsAccessScopeAnalysisId='string',
MaxResults=123,
NextToken='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the Network Access Scope analysis.
integer
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
string
The token for the next page of results.
boolean
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.
dict
Response Syntax
{
'NetworkInsightsAccessScopeAnalysisId': 'string',
'AnalysisStatus': 'running'|'succeeded'|'failed',
'AnalysisFindings': [
{
'NetworkInsightsAccessScopeAnalysisId': 'string',
'NetworkInsightsAccessScopeId': 'string',
'FindingId': 'string',
'FindingComponents': [
{
'SequenceNumber': 123,
'AclRule': {
'Cidr': 'string',
'Egress': True|False,
'PortRange': {
'From': 123,
'To': 123
},
'Protocol': 'string',
'RuleAction': 'string',
'RuleNumber': 123
},
'AttachedTo': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Component': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'DestinationVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'OutboundHeader': {
'DestinationAddresses': [
'string',
],
'DestinationPortRanges': [
{
'From': 123,
'To': 123
},
],
'Protocol': 'string',
'SourceAddresses': [
'string',
],
'SourcePortRanges': [
{
'From': 123,
'To': 123
},
]
},
'InboundHeader': {
'DestinationAddresses': [
'string',
],
'DestinationPortRanges': [
{
'From': 123,
'To': 123
},
],
'Protocol': 'string',
'SourceAddresses': [
'string',
],
'SourcePortRanges': [
{
'From': 123,
'To': 123
},
]
},
'RouteTableRoute': {
'DestinationCidr': 'string',
'DestinationPrefixListId': 'string',
'EgressOnlyInternetGatewayId': 'string',
'GatewayId': 'string',
'InstanceId': 'string',
'NatGatewayId': 'string',
'NetworkInterfaceId': 'string',
'Origin': 'string',
'TransitGatewayId': 'string',
'VpcPeeringConnectionId': 'string',
'State': 'string',
'CarrierGatewayId': 'string',
'CoreNetworkArn': 'string',
'LocalGatewayId': 'string'
},
'SecurityGroupRule': {
'Cidr': 'string',
'Direction': 'string',
'SecurityGroupId': 'string',
'PortRange': {
'From': 123,
'To': 123
},
'PrefixListId': 'string',
'Protocol': 'string'
},
'SourceVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Subnet': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Vpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AdditionalDetails': [
{
'AdditionalDetailType': 'string',
'Component': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpcEndpointService': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'RuleOptions': [
{
'Keyword': 'string',
'Settings': [
'string',
]
},
],
'RuleGroupTypePairs': [
{
'RuleGroupArn': 'string',
'RuleGroupType': 'string'
},
],
'RuleGroupRuleOptionsPairs': [
{
'RuleGroupArn': 'string',
'RuleOptions': [
{
'Keyword': 'string',
'Settings': [
'string',
]
},
]
},
],
'ServiceName': 'string',
'LoadBalancers': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
]
},
],
'TransitGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTableRoute': {
'DestinationCidr': 'string',
'State': 'string',
'RouteOrigin': 'string',
'PrefixListId': 'string',
'AttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'string'
},
'Explanations': [
{
'Acl': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AclRule': {
'Cidr': 'string',
'Egress': True|False,
'PortRange': {
'From': 123,
'To': 123
},
'Protocol': 'string',
'RuleAction': 'string',
'RuleNumber': 123
},
'Address': 'string',
'Addresses': [
'string',
],
'AttachedTo': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AvailabilityZones': [
'string',
],
'Cidrs': [
'string',
],
'Component': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'CustomerGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Destination': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'DestinationVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Direction': 'string',
'ExplanationCode': 'string',
'IngressRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'InternetGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LoadBalancerArn': 'string',
'ClassicLoadBalancerListener': {
'LoadBalancerPort': 123,
'InstancePort': 123
},
'LoadBalancerListenerPort': 123,
'LoadBalancerTarget': {
'Address': 'string',
'AvailabilityZone': 'string',
'Instance': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Port': 123
},
'LoadBalancerTargetGroup': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LoadBalancerTargetGroups': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'LoadBalancerTargetPort': 123,
'ElasticLoadBalancerListener': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'MissingComponent': 'string',
'NatGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'NetworkInterface': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'PacketField': 'string',
'VpcPeeringConnection': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Port': 123,
'PortRanges': [
{
'From': 123,
'To': 123
},
],
'PrefixList': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Protocols': [
'string',
],
'RouteTableRoute': {
'DestinationCidr': 'string',
'DestinationPrefixListId': 'string',
'EgressOnlyInternetGatewayId': 'string',
'GatewayId': 'string',
'InstanceId': 'string',
'NatGatewayId': 'string',
'NetworkInterfaceId': 'string',
'Origin': 'string',
'TransitGatewayId': 'string',
'VpcPeeringConnectionId': 'string',
'State': 'string',
'CarrierGatewayId': 'string',
'CoreNetworkArn': 'string',
'LocalGatewayId': 'string'
},
'RouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SecurityGroup': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SecurityGroupRule': {
'Cidr': 'string',
'Direction': 'string',
'SecurityGroupId': 'string',
'PortRange': {
'From': 123,
'To': 123
},
'PrefixListId': 'string',
'Protocol': 'string'
},
'SecurityGroups': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'SourceVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'State': 'string',
'Subnet': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SubnetRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Vpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpcEndpoint': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpnConnection': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpnGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTableRoute': {
'DestinationCidr': 'string',
'State': 'string',
'RouteOrigin': 'string',
'PrefixListId': 'string',
'AttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'string'
},
'TransitGatewayAttachment': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'ComponentAccount': 'string',
'ComponentRegion': 'string',
'FirewallStatelessRule': {
'RuleGroupArn': 'string',
'Sources': [
'string',
],
'Destinations': [
'string',
],
'SourcePorts': [
{
'From': 123,
'To': 123
},
],
'DestinationPorts': [
{
'From': 123,
'To': 123
},
],
'Protocols': [
123,
],
'RuleAction': 'string',
'Priority': 123
},
'FirewallStatefulRule': {
'RuleGroupArn': 'string',
'Sources': [
'string',
],
'Destinations': [
'string',
],
'SourcePorts': [
{
'From': 123,
'To': 123
},
],
'DestinationPorts': [
{
'From': 123,
'To': 123
},
],
'Protocol': 'string',
'RuleAction': 'string',
'Direction': 'string'
}
},
],
'ElasticLoadBalancerListener': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'FirewallStatelessRule': {
'RuleGroupArn': 'string',
'Sources': [
'string',
],
'Destinations': [
'string',
],
'SourcePorts': [
{
'From': 123,
'To': 123
},
],
'DestinationPorts': [
{
'From': 123,
'To': 123
},
],
'Protocols': [
123,
],
'RuleAction': 'string',
'Priority': 123
},
'FirewallStatefulRule': {
'RuleGroupArn': 'string',
'Sources': [
'string',
],
'Destinations': [
'string',
],
'SourcePorts': [
{
'From': 123,
'To': 123
},
],
'DestinationPorts': [
{
'From': 123,
'To': 123
},
],
'Protocol': 'string',
'RuleAction': 'string',
'Direction': 'string'
},
'ServiceName': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
NetworkInsightsAccessScopeAnalysisId (string) --
The ID of the Network Access Scope analysis.
AnalysisStatus (string) --
The status of Network Access Scope Analysis.
AnalysisFindings (list) --
The findings associated with Network Access Scope Analysis.
(dict) --
Describes a finding for a Network Access Scope.
NetworkInsightsAccessScopeAnalysisId (string) --
The ID of the Network Access Scope analysis.
NetworkInsightsAccessScopeId (string) --
The ID of the Network Access Scope.
FindingId (string) --
The ID of the finding.
FindingComponents (list) --
The finding components.
(dict) --
Describes a path component.
SequenceNumber (integer) --
The sequence number.
AclRule (dict) --
The network ACL rule.
Cidr (string) --
The IPv4 address range, in CIDR notation.
Egress (boolean) --
Indicates whether the rule is an outbound rule.
PortRange (dict) --
The range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
Protocol (string) --
The protocol.
RuleAction (string) --
Indicates whether to allow or deny traffic that matches the rule.
RuleNumber (integer) --
The rule number.
AttachedTo (dict) --
The resource to which the path component is attached.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
Component (dict) --
The component.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
DestinationVpc (dict) --
The destination VPC.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
OutboundHeader (dict) --
The outbound header.
DestinationAddresses (list) --
The destination addresses.
(string) --
DestinationPortRanges (list) --
The destination port ranges.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
Protocol (string) --
The protocol.
SourceAddresses (list) --
The source addresses.
(string) --
SourcePortRanges (list) --
The source port ranges.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
InboundHeader (dict) --
The inbound header.
DestinationAddresses (list) --
The destination addresses.
(string) --
DestinationPortRanges (list) --
The destination port ranges.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
Protocol (string) --
The protocol.
SourceAddresses (list) --
The source addresses.
(string) --
SourcePortRanges (list) --
The source port ranges.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
RouteTableRoute (dict) --
The route table route.
DestinationCidr (string) --
The destination IPv4 address, in CIDR notation.
DestinationPrefixListId (string) --
The prefix of the Amazon Web Service.
EgressOnlyInternetGatewayId (string) --
The ID of an egress-only internet gateway.
GatewayId (string) --
The ID of the gateway, such as an internet gateway or virtual private gateway.
InstanceId (string) --
The ID of the instance, such as a NAT instance.
NatGatewayId (string) --
The ID of a NAT gateway.
NetworkInterfaceId (string) --
The ID of a network interface.
Origin (string) --
Describes how the route was created. The following are the possible values:
CreateRouteTable - The route was automatically created when the route table was created.
CreateRoute - The route was manually added to the route table.
EnableVgwRoutePropagation - The route was propagated by route propagation.
TransitGatewayId (string) --
The ID of a transit gateway.
VpcPeeringConnectionId (string) --
The ID of a VPC peering connection.
State (string) --
The state. The following are the possible values:
active
blackhole
CarrierGatewayId (string) --
The ID of a carrier gateway.
CoreNetworkArn (string) --
The Amazon Resource Name (ARN) of a core network.
LocalGatewayId (string) --
The ID of a local gateway.
SecurityGroupRule (dict) --
The security group rule.
Cidr (string) --
The IPv4 address range, in CIDR notation.
Direction (string) --
The direction. The following are the possible values:
egress
ingress
SecurityGroupId (string) --
The security group ID.
PortRange (dict) --
The port range.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
PrefixListId (string) --
The prefix list ID.
Protocol (string) --
The protocol name.
SourceVpc (dict) --
The source VPC.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
Subnet (dict) --
The subnet.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
Vpc (dict) --
The component VPC.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
AdditionalDetails (list) --
The additional details.
(dict) --
Describes an additional detail for a path analysis. For more information, see Reachability Analyzer additional detail codes.
AdditionalDetailType (string) --
The additional detail code.
Component (dict) --
The path component.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
VpcEndpointService (dict) --
The VPC endpoint service.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
RuleOptions (list) --
The rule options.
(dict) --
Describes additional settings for a stateful rule.
Keyword (string) --
The Suricata keyword.
Settings (list) --
The settings for the keyword.
(string) --
RuleGroupTypePairs (list) --
The rule group type.
(dict) --
Describes the type of a stateful rule group.
RuleGroupArn (string) --
The ARN of the rule group.
RuleGroupType (string) --
The rule group type. The possible values are Domain List and Suricata.
RuleGroupRuleOptionsPairs (list) --
The rule options.
(dict) --
Describes the rule options for a stateful rule group.
RuleGroupArn (string) --
The ARN of the rule group.
RuleOptions (list) --
The rule options.
(dict) --
Describes additional settings for a stateful rule.
Keyword (string) --
The Suricata keyword.
Settings (list) --
The settings for the keyword.
(string) --
ServiceName (string) --
The name of the VPC endpoint service.
LoadBalancers (list) --
The load balancers.
(dict) --
Describes a path component.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
TransitGateway (dict) --
The transit gateway.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
TransitGatewayRouteTableRoute (dict) --
The route in a transit gateway route table.
DestinationCidr (string) --
The CIDR block used for destination matches.
State (string) --
The state of the route.
RouteOrigin (string) --
The route origin. The following are the possible values:
static
propagated
PrefixListId (string) --
The ID of the prefix list.
AttachmentId (string) --
The ID of the route attachment.
ResourceId (string) --
The ID of the resource for the route attachment.
ResourceType (string) --
The resource type for the route attachment.
Explanations (list) --
The explanation codes.
(dict) --
Describes an explanation code for an unreachable path. For more information, see Reachability Analyzer explanation codes.
Acl (dict) --
The network ACL.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
AclRule (dict) --
The network ACL rule.
Cidr (string) --
The IPv4 address range, in CIDR notation.
Egress (boolean) --
Indicates whether the rule is an outbound rule.
PortRange (dict) --
The range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
Protocol (string) --
The protocol.
RuleAction (string) --
Indicates whether to allow or deny traffic that matches the rule.
RuleNumber (integer) --
The rule number.
Address (string) --
The IPv4 address, in CIDR notation.
Addresses (list) --
The IPv4 addresses, in CIDR notation.
(string) --
AttachedTo (dict) --
The resource to which the component is attached.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
AvailabilityZones (list) --
The Availability Zones.
(string) --
Cidrs (list) --
The CIDR ranges.
(string) --
Component (dict) --
The component.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
CustomerGateway (dict) --
The customer gateway.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
Destination (dict) --
The destination.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
DestinationVpc (dict) --
The destination VPC.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
Direction (string) --
The direction. The following are the possible values:
egress
ingress
ExplanationCode (string) --
The explanation code.
IngressRouteTable (dict) --
The route table.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
InternetGateway (dict) --
The internet gateway.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
LoadBalancerArn (string) --
The Amazon Resource Name (ARN) of the load balancer.
ClassicLoadBalancerListener (dict) --
The listener for a Classic Load Balancer.
LoadBalancerPort (integer) --
The port on which the load balancer is listening.
InstancePort (integer) --
[Classic Load Balancers] The back-end port for the listener.
LoadBalancerListenerPort (integer) --
The listener port of the load balancer.
LoadBalancerTarget (dict) --
The target.
Address (string) --
The IP address.
AvailabilityZone (string) --
The Availability Zone.
Instance (dict) --
Information about the instance.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
Port (integer) --
The port on which the target is listening.
LoadBalancerTargetGroup (dict) --
The target group.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
LoadBalancerTargetGroups (list) --
The target groups.
(dict) --
Describes a path component.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
LoadBalancerTargetPort (integer) --
The target port.
ElasticLoadBalancerListener (dict) --
The load balancer listener.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
MissingComponent (string) --
The missing component.
NatGateway (dict) --
The NAT gateway.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
NetworkInterface (dict) --
The network interface.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
PacketField (string) --
The packet field.
VpcPeeringConnection (dict) --
The VPC peering connection.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
Port (integer) --
The port.
PortRanges (list) --
The port ranges.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
PrefixList (dict) --
The prefix list.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
Protocols (list) --
The protocols.
(string) --
RouteTableRoute (dict) --
The route table route.
DestinationCidr (string) --
The destination IPv4 address, in CIDR notation.
DestinationPrefixListId (string) --
The prefix of the Amazon Web Service.
EgressOnlyInternetGatewayId (string) --
The ID of an egress-only internet gateway.
GatewayId (string) --
The ID of the gateway, such as an internet gateway or virtual private gateway.
InstanceId (string) --
The ID of the instance, such as a NAT instance.
NatGatewayId (string) --
The ID of a NAT gateway.
NetworkInterfaceId (string) --
The ID of a network interface.
Origin (string) --
Describes how the route was created. The following are the possible values:
CreateRouteTable - The route was automatically created when the route table was created.
CreateRoute - The route was manually added to the route table.
EnableVgwRoutePropagation - The route was propagated by route propagation.
TransitGatewayId (string) --
The ID of a transit gateway.
VpcPeeringConnectionId (string) --
The ID of a VPC peering connection.
State (string) --
The state. The following are the possible values:
active
blackhole
CarrierGatewayId (string) --
The ID of a carrier gateway.
CoreNetworkArn (string) --
The Amazon Resource Name (ARN) of a core network.
LocalGatewayId (string) --
The ID of a local gateway.
RouteTable (dict) --
The route table.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
SecurityGroup (dict) --
The security group.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
SecurityGroupRule (dict) --
The security group rule.
Cidr (string) --
The IPv4 address range, in CIDR notation.
Direction (string) --
The direction. The following are the possible values:
egress
ingress
SecurityGroupId (string) --
The security group ID.
PortRange (dict) --
The port range.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
PrefixListId (string) --
The prefix list ID.
Protocol (string) --
The protocol name.
SecurityGroups (list) --
The security groups.
(dict) --
Describes a path component.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
SourceVpc (dict) --
The source VPC.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
State (string) --
The state.
Subnet (dict) --
The subnet.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
SubnetRouteTable (dict) --
The route table for the subnet.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
Vpc (dict) --
The component VPC.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
VpcEndpoint (dict) --
The VPC endpoint.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
VpnConnection (dict) --
The VPN connection.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
VpnGateway (dict) --
The VPN gateway.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
TransitGateway (dict) --
The transit gateway.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
TransitGatewayRouteTable (dict) --
The transit gateway route table.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
TransitGatewayRouteTableRoute (dict) --
The transit gateway route table route.
DestinationCidr (string) --
The CIDR block used for destination matches.
State (string) --
The state of the route.
RouteOrigin (string) --
The route origin. The following are the possible values:
static
propagated
PrefixListId (string) --
The ID of the prefix list.
AttachmentId (string) --
The ID of the route attachment.
ResourceId (string) --
The ID of the resource for the route attachment.
ResourceType (string) --
The resource type for the route attachment.
TransitGatewayAttachment (dict) --
The transit gateway attachment.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
ComponentAccount (string) --
The Amazon Web Services account for the component.
ComponentRegion (string) --
The Region for the component.
FirewallStatelessRule (dict) --
The Network Firewall stateless rule.
RuleGroupArn (string) --
The ARN of the stateless rule group.
Sources (list) --
The source IP addresses, in CIDR notation.
(string) --
Destinations (list) --
The destination IP addresses, in CIDR notation.
(string) --
SourcePorts (list) --
The source ports.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
DestinationPorts (list) --
The destination ports.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
Protocols (list) --
The protocols.
(integer) --
RuleAction (string) --
The rule action. The possible values are pass, drop, and forward_to_site.
Priority (integer) --
The rule priority.
FirewallStatefulRule (dict) --
The Network Firewall stateful rule.
RuleGroupArn (string) --
The ARN of the stateful rule group.
Sources (list) --
The source IP addresses, in CIDR notation.
(string) --
Destinations (list) --
The destination IP addresses, in CIDR notation.
(string) --
SourcePorts (list) --
The source ports.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
DestinationPorts (list) --
The destination ports.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
Protocol (string) --
The protocol.
RuleAction (string) --
The rule action. The possible values are pass, drop, and alert.
Direction (string) --
The direction. The possible values are FORWARD and ANY.
ElasticLoadBalancerListener (dict) --
The load balancer listener.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Name (string) --
The name of the analysis component.
FirewallStatelessRule (dict) --
The Network Firewall stateless rule.
RuleGroupArn (string) --
The ARN of the stateless rule group.
Sources (list) --
The source IP addresses, in CIDR notation.
(string) --
Destinations (list) --
The destination IP addresses, in CIDR notation.
(string) --
SourcePorts (list) --
The source ports.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
DestinationPorts (list) --
The destination ports.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
Protocols (list) --
The protocols.
(integer) --
RuleAction (string) --
The rule action. The possible values are pass, drop, and forward_to_site.
Priority (integer) --
The rule priority.
FirewallStatefulRule (dict) --
The Network Firewall stateful rule.
RuleGroupArn (string) --
The ARN of the stateful rule group.
Sources (list) --
The source IP addresses, in CIDR notation.
(string) --
Destinations (list) --
The destination IP addresses, in CIDR notation.
(string) --
SourcePorts (list) --
The source ports.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
DestinationPorts (list) --
The destination ports.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
Protocol (string) --
The protocol.
RuleAction (string) --
The rule action. The possible values are pass, drop, and alert.
Direction (string) --
The direction. The possible values are FORWARD and ANY.
ServiceName (string) --
The name of the VPC endpoint service.
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
{'NetworkInsightsAnalysis': {'Explanations': {'FirewallStatefulRule': {'DestinationPorts': [{'From': 'integer',
'To': 'integer'}],
'Destinations': ['string'],
'Direction': 'string',
'Protocol': 'string',
'RuleAction': 'string',
'RuleGroupArn': 'string',
'SourcePorts': [{'From': 'integer',
'To': 'integer'}],
'Sources': ['string']},
'FirewallStatelessRule': {'DestinationPorts': [{'From': 'integer',
'To': 'integer'}],
'Destinations': ['string'],
'Priority': 'integer',
'Protocols': ['integer'],
'RuleAction': 'string',
'RuleGroupArn': 'string',
'SourcePorts': [{'From': 'integer',
'To': 'integer'}],
'Sources': ['string']},
'RouteTableRoute': {'CarrierGatewayId': 'string',
'CoreNetworkArn': 'string',
'LocalGatewayId': 'string'}},
'ForwardPathComponents': {'AdditionalDetails': {'LoadBalancers': [{'Arn': 'string',
'Id': 'string',
'Name': 'string'}],
'RuleGroupRuleOptionsPairs': [{'RuleGroupArn': 'string',
'RuleOptions': [{'Keyword': 'string',
'Settings': ['string']}]}],
'RuleGroupTypePairs': [{'RuleGroupArn': 'string',
'RuleGroupType': 'string'}],
'RuleOptions': [{'Keyword': 'string',
'Settings': ['string']}],
'ServiceName': 'string',
'VpcEndpointService': {'Arn': 'string',
'Id': 'string',
'Name': 'string'}},
'Explanations': {'FirewallStatefulRule': {'DestinationPorts': [{'From': 'integer',
'To': 'integer'}],
'Destinations': ['string'],
'Direction': 'string',
'Protocol': 'string',
'RuleAction': 'string',
'RuleGroupArn': 'string',
'SourcePorts': [{'From': 'integer',
'To': 'integer'}],
'Sources': ['string']},
'FirewallStatelessRule': {'DestinationPorts': [{'From': 'integer',
'To': 'integer'}],
'Destinations': ['string'],
'Priority': 'integer',
'Protocols': ['integer'],
'RuleAction': 'string',
'RuleGroupArn': 'string',
'SourcePorts': [{'From': 'integer',
'To': 'integer'}],
'Sources': ['string']},
'RouteTableRoute': {'CarrierGatewayId': 'string',
'CoreNetworkArn': 'string',
'LocalGatewayId': 'string'}},
'FirewallStatefulRule': {'DestinationPorts': [{'From': 'integer',
'To': 'integer'}],
'Destinations': ['string'],
'Direction': 'string',
'Protocol': 'string',
'RuleAction': 'string',
'RuleGroupArn': 'string',
'SourcePorts': [{'From': 'integer',
'To': 'integer'}],
'Sources': ['string']},
'FirewallStatelessRule': {'DestinationPorts': [{'From': 'integer',
'To': 'integer'}],
'Destinations': ['string'],
'Priority': 'integer',
'Protocols': ['integer'],
'RuleAction': 'string',
'RuleGroupArn': 'string',
'SourcePorts': [{'From': 'integer',
'To': 'integer'}],
'Sources': ['string']},
'RouteTableRoute': {'CarrierGatewayId': 'string',
'CoreNetworkArn': 'string',
'LocalGatewayId': 'string'},
'ServiceName': 'string'},
'ReturnPathComponents': {'AdditionalDetails': {'LoadBalancers': [{'Arn': 'string',
'Id': 'string',
'Name': 'string'}],
'RuleGroupRuleOptionsPairs': [{'RuleGroupArn': 'string',
'RuleOptions': [{'Keyword': 'string',
'Settings': ['string']}]}],
'RuleGroupTypePairs': [{'RuleGroupArn': 'string',
'RuleGroupType': 'string'}],
'RuleOptions': [{'Keyword': 'string',
'Settings': ['string']}],
'ServiceName': 'string',
'VpcEndpointService': {'Arn': 'string',
'Id': 'string',
'Name': 'string'}},
'Explanations': {'FirewallStatefulRule': {'DestinationPorts': [{'From': 'integer',
'To': 'integer'}],
'Destinations': ['string'],
'Direction': 'string',
'Protocol': 'string',
'RuleAction': 'string',
'RuleGroupArn': 'string',
'SourcePorts': [{'From': 'integer',
'To': 'integer'}],
'Sources': ['string']},
'FirewallStatelessRule': {'DestinationPorts': [{'From': 'integer',
'To': 'integer'}],
'Destinations': ['string'],
'Priority': 'integer',
'Protocols': ['integer'],
'RuleAction': 'string',
'RuleGroupArn': 'string',
'SourcePorts': [{'From': 'integer',
'To': 'integer'}],
'Sources': ['string']},
'RouteTableRoute': {'CarrierGatewayId': 'string',
'CoreNetworkArn': 'string',
'LocalGatewayId': 'string'}},
'FirewallStatefulRule': {'DestinationPorts': [{'From': 'integer',
'To': 'integer'}],
'Destinations': ['string'],
'Direction': 'string',
'Protocol': 'string',
'RuleAction': 'string',
'RuleGroupArn': 'string',
'SourcePorts': [{'From': 'integer',
'To': 'integer'}],
'Sources': ['string']},
'FirewallStatelessRule': {'DestinationPorts': [{'From': 'integer',
'To': 'integer'}],
'Destinations': ['string'],
'Priority': 'integer',
'Protocols': ['integer'],
'RuleAction': 'string',
'RuleGroupArn': 'string',
'SourcePorts': [{'From': 'integer',
'To': 'integer'}],
'Sources': ['string']},
'RouteTableRoute': {'CarrierGatewayId': 'string',
'CoreNetworkArn': 'string',
'LocalGatewayId': 'string'},
'ServiceName': 'string'}}}
Starts analyzing the specified path. If the path is reachable, the operation returns the shortest feasible path.
See also: AWS API Documentation
Request Syntax
client.start_network_insights_analysis(
NetworkInsightsPathId='string',
AdditionalAccounts=[
'string',
],
FilterInArns=[
'string',
],
DryRun=True|False,
TagSpecifications=[
{
'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'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-policy-table'|'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'|'ipam-resource-discovery'|'ipam-resource-discovery-association',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
ClientToken='string'
)
string
[REQUIRED]
The ID of the path.
list
The member accounts that contain resources that the path can traverse.
(string) --
list
The Amazon Resource Names (ARN) of the resources that the path must traverse.
(string) --
boolean
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.
list
The tags to apply.
(dict) --
The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
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.
string
[REQUIRED]
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.
dict
Response Syntax
{
'NetworkInsightsAnalysis': {
'NetworkInsightsAnalysisId': 'string',
'NetworkInsightsAnalysisArn': 'string',
'NetworkInsightsPathId': 'string',
'AdditionalAccounts': [
'string',
],
'FilterInArns': [
'string',
],
'StartDate': datetime(2015, 1, 1),
'Status': 'running'|'succeeded'|'failed',
'StatusMessage': 'string',
'WarningMessage': 'string',
'NetworkPathFound': True|False,
'ForwardPathComponents': [
{
'SequenceNumber': 123,
'AclRule': {
'Cidr': 'string',
'Egress': True|False,
'PortRange': {
'From': 123,
'To': 123
},
'Protocol': 'string',
'RuleAction': 'string',
'RuleNumber': 123
},
'AttachedTo': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Component': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'DestinationVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'OutboundHeader': {
'DestinationAddresses': [
'string',
],
'DestinationPortRanges': [
{
'From': 123,
'To': 123
},
],
'Protocol': 'string',
'SourceAddresses': [
'string',
],
'SourcePortRanges': [
{
'From': 123,
'To': 123
},
]
},
'InboundHeader': {
'DestinationAddresses': [
'string',
],
'DestinationPortRanges': [
{
'From': 123,
'To': 123
},
],
'Protocol': 'string',
'SourceAddresses': [
'string',
],
'SourcePortRanges': [
{
'From': 123,
'To': 123
},
]
},
'RouteTableRoute': {
'DestinationCidr': 'string',
'DestinationPrefixListId': 'string',
'EgressOnlyInternetGatewayId': 'string',
'GatewayId': 'string',
'InstanceId': 'string',
'NatGatewayId': 'string',
'NetworkInterfaceId': 'string',
'Origin': 'string',
'TransitGatewayId': 'string',
'VpcPeeringConnectionId': 'string',
'State': 'string',
'CarrierGatewayId': 'string',
'CoreNetworkArn': 'string',
'LocalGatewayId': 'string'
},
'SecurityGroupRule': {
'Cidr': 'string',
'Direction': 'string',
'SecurityGroupId': 'string',
'PortRange': {
'From': 123,
'To': 123
},
'PrefixListId': 'string',
'Protocol': 'string'
},
'SourceVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Subnet': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Vpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AdditionalDetails': [
{
'AdditionalDetailType': 'string',
'Component': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpcEndpointService': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'RuleOptions': [
{
'Keyword': 'string',
'Settings': [
'string',
]
},
],
'RuleGroupTypePairs': [
{
'RuleGroupArn': 'string',
'RuleGroupType': 'string'
},
],
'RuleGroupRuleOptionsPairs': [
{
'RuleGroupArn': 'string',
'RuleOptions': [
{
'Keyword': 'string',
'Settings': [
'string',
]
},
]
},
],
'ServiceName': 'string',
'LoadBalancers': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
]
},
],
'TransitGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTableRoute': {
'DestinationCidr': 'string',
'State': 'string',
'RouteOrigin': 'string',
'PrefixListId': 'string',
'AttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'string'
},
'Explanations': [
{
'Acl': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AclRule': {
'Cidr': 'string',
'Egress': True|False,
'PortRange': {
'From': 123,
'To': 123
},
'Protocol': 'string',
'RuleAction': 'string',
'RuleNumber': 123
},
'Address': 'string',
'Addresses': [
'string',
],
'AttachedTo': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AvailabilityZones': [
'string',
],
'Cidrs': [
'string',
],
'Component': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'CustomerGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Destination': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'DestinationVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Direction': 'string',
'ExplanationCode': 'string',
'IngressRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'InternetGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LoadBalancerArn': 'string',
'ClassicLoadBalancerListener': {
'LoadBalancerPort': 123,
'InstancePort': 123
},
'LoadBalancerListenerPort': 123,
'LoadBalancerTarget': {
'Address': 'string',
'AvailabilityZone': 'string',
'Instance': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Port': 123
},
'LoadBalancerTargetGroup': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LoadBalancerTargetGroups': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'LoadBalancerTargetPort': 123,
'ElasticLoadBalancerListener': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'MissingComponent': 'string',
'NatGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'NetworkInterface': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'PacketField': 'string',
'VpcPeeringConnection': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Port': 123,
'PortRanges': [
{
'From': 123,
'To': 123
},
],
'PrefixList': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Protocols': [
'string',
],
'RouteTableRoute': {
'DestinationCidr': 'string',
'DestinationPrefixListId': 'string',
'EgressOnlyInternetGatewayId': 'string',
'GatewayId': 'string',
'InstanceId': 'string',
'NatGatewayId': 'string',
'NetworkInterfaceId': 'string',
'Origin': 'string',
'TransitGatewayId': 'string',
'VpcPeeringConnectionId': 'string',
'State': 'string',
'CarrierGatewayId': 'string',
'CoreNetworkArn': 'string',
'LocalGatewayId': 'string'
},
'RouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SecurityGroup': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SecurityGroupRule': {
'Cidr': 'string',
'Direction': 'string',
'SecurityGroupId': 'string',
'PortRange': {
'From': 123,
'To': 123
},
'PrefixListId': 'string',
'Protocol': 'string'
},
'SecurityGroups': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'SourceVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'State': 'string',
'Subnet': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SubnetRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Vpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpcEndpoint': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpnConnection': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpnGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTableRoute': {
'DestinationCidr': 'string',
'State': 'string',
'RouteOrigin': 'string',
'PrefixListId': 'string',
'AttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'string'
},
'TransitGatewayAttachment': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'ComponentAccount': 'string',
'ComponentRegion': 'string',
'FirewallStatelessRule': {
'RuleGroupArn': 'string',
'Sources': [
'string',
],
'Destinations': [
'string',
],
'SourcePorts': [
{
'From': 123,
'To': 123
},
],
'DestinationPorts': [
{
'From': 123,
'To': 123
},
],
'Protocols': [
123,
],
'RuleAction': 'string',
'Priority': 123
},
'FirewallStatefulRule': {
'RuleGroupArn': 'string',
'Sources': [
'string',
],
'Destinations': [
'string',
],
'SourcePorts': [
{
'From': 123,
'To': 123
},
],
'DestinationPorts': [
{
'From': 123,
'To': 123
},
],
'Protocol': 'string',
'RuleAction': 'string',
'Direction': 'string'
}
},
],
'ElasticLoadBalancerListener': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'FirewallStatelessRule': {
'RuleGroupArn': 'string',
'Sources': [
'string',
],
'Destinations': [
'string',
],
'SourcePorts': [
{
'From': 123,
'To': 123
},
],
'DestinationPorts': [
{
'From': 123,
'To': 123
},
],
'Protocols': [
123,
],
'RuleAction': 'string',
'Priority': 123
},
'FirewallStatefulRule': {
'RuleGroupArn': 'string',
'Sources': [
'string',
],
'Destinations': [
'string',
],
'SourcePorts': [
{
'From': 123,
'To': 123
},
],
'DestinationPorts': [
{
'From': 123,
'To': 123
},
],
'Protocol': 'string',
'RuleAction': 'string',
'Direction': 'string'
},
'ServiceName': 'string'
},
],
'ReturnPathComponents': [
{
'SequenceNumber': 123,
'AclRule': {
'Cidr': 'string',
'Egress': True|False,
'PortRange': {
'From': 123,
'To': 123
},
'Protocol': 'string',
'RuleAction': 'string',
'RuleNumber': 123
},
'AttachedTo': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Component': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'DestinationVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'OutboundHeader': {
'DestinationAddresses': [
'string',
],
'DestinationPortRanges': [
{
'From': 123,
'To': 123
},
],
'Protocol': 'string',
'SourceAddresses': [
'string',
],
'SourcePortRanges': [
{
'From': 123,
'To': 123
},
]
},
'InboundHeader': {
'DestinationAddresses': [
'string',
],
'DestinationPortRanges': [
{
'From': 123,
'To': 123
},
],
'Protocol': 'string',
'SourceAddresses': [
'string',
],
'SourcePortRanges': [
{
'From': 123,
'To': 123
},
]
},
'RouteTableRoute': {
'DestinationCidr': 'string',
'DestinationPrefixListId': 'string',
'EgressOnlyInternetGatewayId': 'string',
'GatewayId': 'string',
'InstanceId': 'string',
'NatGatewayId': 'string',
'NetworkInterfaceId': 'string',
'Origin': 'string',
'TransitGatewayId': 'string',
'VpcPeeringConnectionId': 'string',
'State': 'string',
'CarrierGatewayId': 'string',
'CoreNetworkArn': 'string',
'LocalGatewayId': 'string'
},
'SecurityGroupRule': {
'Cidr': 'string',
'Direction': 'string',
'SecurityGroupId': 'string',
'PortRange': {
'From': 123,
'To': 123
},
'PrefixListId': 'string',
'Protocol': 'string'
},
'SourceVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Subnet': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Vpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AdditionalDetails': [
{
'AdditionalDetailType': 'string',
'Component': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpcEndpointService': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'RuleOptions': [
{
'Keyword': 'string',
'Settings': [
'string',
]
},
],
'RuleGroupTypePairs': [
{
'RuleGroupArn': 'string',
'RuleGroupType': 'string'
},
],
'RuleGroupRuleOptionsPairs': [
{
'RuleGroupArn': 'string',
'RuleOptions': [
{
'Keyword': 'string',
'Settings': [
'string',
]
},
]
},
],
'ServiceName': 'string',
'LoadBalancers': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
]
},
],
'TransitGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTableRoute': {
'DestinationCidr': 'string',
'State': 'string',
'RouteOrigin': 'string',
'PrefixListId': 'string',
'AttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'string'
},
'Explanations': [
{
'Acl': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AclRule': {
'Cidr': 'string',
'Egress': True|False,
'PortRange': {
'From': 123,
'To': 123
},
'Protocol': 'string',
'RuleAction': 'string',
'RuleNumber': 123
},
'Address': 'string',
'Addresses': [
'string',
],
'AttachedTo': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AvailabilityZones': [
'string',
],
'Cidrs': [
'string',
],
'Component': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'CustomerGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Destination': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'DestinationVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Direction': 'string',
'ExplanationCode': 'string',
'IngressRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'InternetGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LoadBalancerArn': 'string',
'ClassicLoadBalancerListener': {
'LoadBalancerPort': 123,
'InstancePort': 123
},
'LoadBalancerListenerPort': 123,
'LoadBalancerTarget': {
'Address': 'string',
'AvailabilityZone': 'string',
'Instance': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Port': 123
},
'LoadBalancerTargetGroup': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LoadBalancerTargetGroups': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'LoadBalancerTargetPort': 123,
'ElasticLoadBalancerListener': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'MissingComponent': 'string',
'NatGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'NetworkInterface': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'PacketField': 'string',
'VpcPeeringConnection': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Port': 123,
'PortRanges': [
{
'From': 123,
'To': 123
},
],
'PrefixList': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Protocols': [
'string',
],
'RouteTableRoute': {
'DestinationCidr': 'string',
'DestinationPrefixListId': 'string',
'EgressOnlyInternetGatewayId': 'string',
'GatewayId': 'string',
'InstanceId': 'string',
'NatGatewayId': 'string',
'NetworkInterfaceId': 'string',
'Origin': 'string',
'TransitGatewayId': 'string',
'VpcPeeringConnectionId': 'string',
'State': 'string',
'CarrierGatewayId': 'string',
'CoreNetworkArn': 'string',
'LocalGatewayId': 'string'
},
'RouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SecurityGroup': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SecurityGroupRule': {
'Cidr': 'string',
'Direction': 'string',
'SecurityGroupId': 'string',
'PortRange': {
'From': 123,
'To': 123
},
'PrefixListId': 'string',
'Protocol': 'string'
},
'SecurityGroups': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'SourceVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'State': 'string',
'Subnet': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SubnetRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Vpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpcEndpoint': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpnConnection': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpnGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTableRoute': {
'DestinationCidr': 'string',
'State': 'string',
'RouteOrigin': 'string',
'PrefixListId': 'string',
'AttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'string'
},
'TransitGatewayAttachment': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'ComponentAccount': 'string',
'ComponentRegion': 'string',
'FirewallStatelessRule': {
'RuleGroupArn': 'string',
'Sources': [
'string',
],
'Destinations': [
'string',
],
'SourcePorts': [
{
'From': 123,
'To': 123
},
],
'DestinationPorts': [
{
'From': 123,
'To': 123
},
],
'Protocols': [
123,
],
'RuleAction': 'string',
'Priority': 123
},
'FirewallStatefulRule': {
'RuleGroupArn': 'string',
'Sources': [
'string',
],
'Destinations': [
'string',
],
'SourcePorts': [
{
'From': 123,
'To': 123
},
],
'DestinationPorts': [
{
'From': 123,
'To': 123
},
],
'Protocol': 'string',
'RuleAction': 'string',
'Direction': 'string'
}
},
],
'ElasticLoadBalancerListener': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'FirewallStatelessRule': {
'RuleGroupArn': 'string',
'Sources': [
'string',
],
'Destinations': [
'string',
],
'SourcePorts': [
{
'From': 123,
'To': 123
},
],
'DestinationPorts': [
{
'From': 123,
'To': 123
},
],
'Protocols': [
123,
],
'RuleAction': 'string',
'Priority': 123
},
'FirewallStatefulRule': {
'RuleGroupArn': 'string',
'Sources': [
'string',
],
'Destinations': [
'string',
],
'SourcePorts': [
{
'From': 123,
'To': 123
},
],
'DestinationPorts': [
{
'From': 123,
'To': 123
},
],
'Protocol': 'string',
'RuleAction': 'string',
'Direction': 'string'
},
'ServiceName': 'string'
},
],
'Explanations': [
{
'Acl': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AclRule': {
'Cidr': 'string',
'Egress': True|False,
'PortRange': {
'From': 123,
'To': 123
},
'Protocol': 'string',
'RuleAction': 'string',
'RuleNumber': 123
},
'Address': 'string',
'Addresses': [
'string',
],
'AttachedTo': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AvailabilityZones': [
'string',
],
'Cidrs': [
'string',
],
'Component': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'CustomerGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Destination': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'DestinationVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Direction': 'string',
'ExplanationCode': 'string',
'IngressRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'InternetGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LoadBalancerArn': 'string',
'ClassicLoadBalancerListener': {
'LoadBalancerPort': 123,
'InstancePort': 123
},
'LoadBalancerListenerPort': 123,
'LoadBalancerTarget': {
'Address': 'string',
'AvailabilityZone': 'string',
'Instance': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Port': 123
},
'LoadBalancerTargetGroup': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LoadBalancerTargetGroups': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'LoadBalancerTargetPort': 123,
'ElasticLoadBalancerListener': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'MissingComponent': 'string',
'NatGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'NetworkInterface': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'PacketField': 'string',
'VpcPeeringConnection': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Port': 123,
'PortRanges': [
{
'From': 123,
'To': 123
},
],
'PrefixList': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Protocols': [
'string',
],
'RouteTableRoute': {
'DestinationCidr': 'string',
'DestinationPrefixListId': 'string',
'EgressOnlyInternetGatewayId': 'string',
'GatewayId': 'string',
'InstanceId': 'string',
'NatGatewayId': 'string',
'NetworkInterfaceId': 'string',
'Origin': 'string',
'TransitGatewayId': 'string',
'VpcPeeringConnectionId': 'string',
'State': 'string',
'CarrierGatewayId': 'string',
'CoreNetworkArn': 'string',
'LocalGatewayId': 'string'
},
'RouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SecurityGroup': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SecurityGroupRule': {
'Cidr': 'string',
'Direction': 'string',
'SecurityGroupId': 'string',
'PortRange': {
'From': 123,
'To': 123
},
'PrefixListId': 'string',
'Protocol': 'string'
},
'SecurityGroups': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'SourceVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'State': 'string',
'Subnet': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SubnetRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Vpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpcEndpoint': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpnConnection': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpnGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTableRoute': {
'DestinationCidr': 'string',
'State': 'string',
'RouteOrigin': 'string',
'PrefixListId': 'string',
'AttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'string'
},
'TransitGatewayAttachment': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'ComponentAccount': 'string',
'ComponentRegion': 'string',
'FirewallStatelessRule': {
'RuleGroupArn': 'string',
'Sources': [
'string',
],
'Destinations': [
'string',
],
'SourcePorts': [
{
'From': 123,
'To': 123
},
],
'DestinationPorts': [
{
'From': 123,
'To': 123
},
],
'Protocols': [
123,
],
'RuleAction': 'string',
'Priority': 123
},
'FirewallStatefulRule': {
'RuleGroupArn': 'string',
'Sources': [
'string',
],
'Destinations': [
'string',
],
'SourcePorts': [
{
'From': 123,
'To': 123
},
],
'DestinationPorts': [
{
'From': 123,
'To': 123
},
],
'Protocol': 'string',
'RuleAction': 'string',
'Direction': 'string'
}
},
],
'AlternatePathHints': [
{
'ComponentId': 'string',
'ComponentArn': 'string'
},
],
'SuggestedAccounts': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
**Response Structure**
::
# This section is too large to render.
# Please see the AWS API Documentation linked below.
`AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/StartNetworkInsightsAnalysis>`_