EC2 / Client / start_network_insights_analysis
start_network_insights_analysis#
- EC2.Client.start_network_insights_analysis(**kwargs)#
Starts analyzing the specified path. If the path is reachable, the operation returns the shortest feasible path.
See also: AWS API Documentation
Request Syntax
response = 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'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'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'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], ClientToken='string' )
- Parameters:
NetworkInsightsPathId (string) –
[REQUIRED]
The ID of the path.
AdditionalAccounts (list) –
The member accounts that contain resources that the path can traverse.
(string) –
FilterInArns (list) –
The Amazon Resource Names (ARN) of the resources that the path must traverse.
(string) –
DryRun (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 isUnauthorizedOperation.TagSpecifications (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.
Note
The
Valid Valueslists all the resource types that can be tagged. However, the action you’re using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you’re using, you’ll get an error.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.
ClientToken (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.
- Return type:
dict
- Returns:
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.