2026/10/21 - Amazon Elastic Compute Cloud - 4 updated api methods
Changes Adds new response fields to DescribeInstanceStatus and Network Insights analysis results.
{'InstanceStatuses': {'PerformanceStatus': {'ImpairedSince': 'timestamp',
'Remediation': 'string',
'Status': 'ok | impaired | '
'insufficient-data | '
'not-applicable | '
'initializing'}}}
Describes the status of the specified instances or all of your instances. By default, only running instances are described, unless you specifically indicate to return the status of all instances.
Instance status includes the following components:
Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status checks for your instances and Troubleshoot instances with failed status checks in the Amazon EC2 User Guide.
Application status checks - Amazon EC2 reports application-level health status for instances, indicating whether applications running on the instance are functioning properly.
Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled events for your instances in the Amazon EC2 User Guide.
Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance lifecycle in the Amazon EC2 User Guide.
The Amazon EC2 API follows an eventual consistency model. This means that the result of an API command you run that creates or modifies resources might not be immediately available to all subsequent commands you run. For guidance on how to manage eventual consistency, see Eventual consistency in the Amazon EC2 API in the Amazon EC2 Developer Guide.
See also: AWS API Documentation
Request Syntax
client.describe_instance_status(
InstanceIds=[
'string',
],
MaxResults=123,
NextToken='string',
IncludeManagedResources=True|False,
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
IncludeAllInstances=True|False
)
list
The instance IDs.
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
(string) --
integer
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
You cannot specify this parameter and the instance IDs parameter in the same request.
string
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
boolean
Indicates whether to include managed resources in the output. If this parameter is set to true, the output includes resources that are managed by Amazon Web Services services, even if managed resource visibility is set to hidden.
boolean
Checks whether you have the required permissions for the operation, 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 filters.
availability-zone - The Availability Zone of the instance.
availability-zone-id - The ID of the Availability Zone of the instance.
event.code - The code for the scheduled event ( instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).
event.description - A description of the event.
event.instance-event-id - The ID of the event whose date and time you are modifying.
event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).
event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).
event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).
instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance ( pending | running | shutting-down | terminated | stopping | stopped).
instance-status.reachability - Filters on instance status where the name is reachability ( passed | failed | initializing | insufficient-data).
instance-status.status - The status of the instance ( ok | impaired | initializing | insufficient-data | not-applicable).
operator.managed - A Boolean that indicates whether this is a managed instance.
operator.principal - The principal that manages the instance. Only valid for managed instances, where managed is true.
system-status.reachability - Filters on system status where the name is reachability ( passed | failed | initializing | insufficient-data).
system-status.status - The system status of the instance ( ok | impaired | initializing | insufficient-data | not-applicable).
attached-ebs-status.status - The status of the attached EBS volume for the instance ( ok | impaired | initializing | insufficient-data | not-applicable).
application-status.status - The application status of the instance ( ok | impaired | initializing | insufficient-data | not-applicable).
(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.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
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) --
boolean
When true, includes the health status for all instances. When false, includes the health status for running instances only.
Default: false
dict
Response Syntax
{
'InstanceStatuses': [
{
'AvailabilityZone': 'string',
'AvailabilityZoneId': 'string',
'OutpostArn': 'string',
'Operator': {
'Managed': True|False,
'Principal': 'string',
'HiddenByDefault': True|False
},
'Events': [
{
'InstanceEventId': 'string',
'Code': 'instance-reboot'|'system-reboot'|'system-maintenance'|'instance-retirement'|'instance-stop',
'Description': 'string',
'NotAfter': datetime(2015, 1, 1),
'NotBefore': datetime(2015, 1, 1),
'NotBeforeDeadline': datetime(2015, 1, 1)
},
],
'InstanceId': 'string',
'InstanceState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
},
'InstanceStatus': {
'Details': [
{
'ImpairedSince': datetime(2015, 1, 1),
'Name': 'reachability',
'Status': 'passed'|'failed'|'insufficient-data'|'initializing'
},
],
'Status': 'ok'|'impaired'|'insufficient-data'|'not-applicable'|'initializing'
},
'SystemStatus': {
'Details': [
{
'ImpairedSince': datetime(2015, 1, 1),
'Name': 'reachability',
'Status': 'passed'|'failed'|'insufficient-data'|'initializing'
},
],
'Status': 'ok'|'impaired'|'insufficient-data'|'not-applicable'|'initializing'
},
'AttachedEbsStatus': {
'Details': [
{
'ImpairedSince': datetime(2015, 1, 1),
'Name': 'reachability',
'Status': 'passed'|'failed'|'insufficient-data'|'initializing'
},
],
'Status': 'ok'|'impaired'|'insufficient-data'|'not-applicable'|'initializing'
},
'ApplicationStatus': {
'Status': 'ok'|'impaired'|'insufficient-data'|'not-applicable'|'initializing',
'ImpairedSince': datetime(2015, 1, 1)
},
'PerformanceStatus': {
'Status': 'ok'|'impaired'|'insufficient-data'|'not-applicable'|'initializing',
'ImpairedSince': datetime(2015, 1, 1),
'Remediation': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
InstanceStatuses (list) --
Information about the status of the instances.
(dict) --
Describes the status of an instance, including system status, instance status, attached EBS status, application status, and performance status.
AvailabilityZone (string) --
The Availability Zone of the instance.
AvailabilityZoneId (string) --
The ID of the Availability Zone of the instance.
OutpostArn (string) --
The Amazon Resource Name (ARN) of the Outpost.
Operator (dict) --
The service provider that manages the instance.
Managed (boolean) --
If true, the resource is managed by a service provider.
Principal (string) --
If managed is true, then the principal is returned. The principal is the service provider that manages the resource.
HiddenByDefault (boolean) --
If true, the resource is hidden by default based on the managed resource visibility settings for the account.
Events (list) --
Any scheduled events associated with the instance.
(dict) --
Describes a scheduled event for an instance.
InstanceEventId (string) --
The ID of the event.
Code (string) --
The event code.
Description (string) --
A description of the event.
After a scheduled event is completed, it can still be described for up to a week. If the event has been completed, this description starts with the following text: [Completed].
NotAfter (datetime) --
The latest scheduled end time for the event.
NotBefore (datetime) --
The earliest scheduled start time for the event.
NotBeforeDeadline (datetime) --
The deadline for starting the event.
InstanceId (string) --
The ID of the instance.
InstanceState (dict) --
The intended state of the instance. DescribeInstanceStatus requires that an instance be in the running state.
Code (integer) --
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
0 : pending
16 : running
32 : shutting-down
48 : terminated
64 : stopping
80 : stopped
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
Name (string) --
The current state of the instance.
InstanceStatus (dict) --
Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.
Details (list) --
The system instance health or application instance health.
(dict) --
Describes the instance status.
ImpairedSince (datetime) --
The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.
Name (string) --
The type of instance status.
Status (string) --
The status.
Status (string) --
The status.
SystemStatus (dict) --
Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.
Details (list) --
The system instance health or application instance health.
(dict) --
Describes the instance status.
ImpairedSince (datetime) --
The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.
Name (string) --
The type of instance status.
Status (string) --
The status.
Status (string) --
The status.
AttachedEbsStatus (dict) --
Reports impaired functionality that stems from an attached Amazon EBS volume that is unreachable and unable to complete I/O operations.
Details (list) --
Details about the attached EBS status check for an instance.
(dict) --
Describes the attached EBS status check for an instance.
ImpairedSince (datetime) --
The date and time when the attached EBS status check failed.
Name (string) --
The name of the attached EBS status check.
Status (string) --
The result of the attached EBS status check.
Status (string) --
The current status.
ApplicationStatus (dict) --
Reports the application-level health status for the instance.
Status (string) --
The current status.
ImpairedSince (datetime) --
The date and time when the application status became impaired.
PerformanceStatus (dict) --
Reports the performance-related health status for the instance. This information is returned only when performance status checks are enabled for the instance.
Status (string) --
The current status.
ImpairedSince (datetime) --
The date and time when the performance status became impaired.
Remediation (string) --
The recommended action to remediate the impaired instance, if one is available. This value is returned only when the instance is impaired.
NextToken (string) --
The token to include in another request to get the next page of items. This value is null when there are no more items to return.
{'NetworkInsightsAnalyses': {'Explanations': {'TransitGatewayPolicyTable': {'Arn': 'string',
'Id': 'string',
'Name': 'string'},
'TransitGatewayPolicyTableEntry': {'DestinationCidr': 'string',
'DestinationPortRange': {'From': 'integer',
'To': 'integer'},
'Protocol': 'string',
'RuleNumber': 'integer',
'SourceCidr': 'string',
'SourcePortRange': {'From': 'integer',
'To': 'integer'},
'TargetRouteTableId': 'string'}},
'ForwardPathComponents': {'Explanations': {'TransitGatewayPolicyTable': {'Arn': 'string',
'Id': 'string',
'Name': 'string'},
'TransitGatewayPolicyTableEntry': {'DestinationCidr': 'string',
'DestinationPortRange': {'From': 'integer',
'To': 'integer'},
'Protocol': 'string',
'RuleNumber': 'integer',
'SourceCidr': 'string',
'SourcePortRange': {'From': 'integer',
'To': 'integer'},
'TargetRouteTableId': 'string'}},
'TransitGatewayPolicyTableEntry': {'DestinationCidr': 'string',
'DestinationPortRange': {'From': 'integer',
'To': 'integer'},
'Protocol': 'string',
'RuleNumber': 'integer',
'SourceCidr': 'string',
'SourcePortRange': {'From': 'integer',
'To': 'integer'},
'TargetRouteTableId': 'string'}},
'ReturnPathComponents': {'Explanations': {'TransitGatewayPolicyTable': {'Arn': 'string',
'Id': 'string',
'Name': 'string'},
'TransitGatewayPolicyTableEntry': {'DestinationCidr': 'string',
'DestinationPortRange': {'From': 'integer',
'To': 'integer'},
'Protocol': 'string',
'RuleNumber': 'integer',
'SourceCidr': 'string',
'SourcePortRange': {'From': 'integer',
'To': 'integer'},
'TargetRouteTableId': 'string'}},
'TransitGatewayPolicyTableEntry': {'DestinationCidr': 'string',
'DestinationPortRange': {'From': 'integer',
'To': 'integer'},
'Protocol': 'string',
'RuleNumber': 'integer',
'SourceCidr': 'string',
'SourcePortRange': {'From': 'integer',
'To': 'integer'},
'TargetRouteTableId': '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.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
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',
],
'FilterOutArns': [
'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'
},
'TransitGatewayPolicyTableEntry': {
'RuleNumber': 123,
'Protocol': 'string',
'SourceCidr': 'string',
'DestinationCidr': 'string',
'SourcePortRange': {
'From': 123,
'To': 123
},
'DestinationPortRange': {
'From': 123,
'To': 123
},
'TargetRouteTableId': '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',
],
'AvailabilityZoneIds': [
'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',
'AvailabilityZoneId': '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'
},
'TransitGatewayPolicyTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayPolicyTableEntry': {
'RuleNumber': 123,
'Protocol': 'string',
'SourceCidr': 'string',
'DestinationCidr': 'string',
'SourcePortRange': {
'From': 123,
'To': 123
},
'DestinationPortRange': {
'From': 123,
'To': 123
},
'TargetRouteTableId': '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'
},
'TransitGatewayPolicyTableEntry': {
'RuleNumber': 123,
'Protocol': 'string',
'SourceCidr': 'string',
'DestinationCidr': 'string',
'SourcePortRange': {
'From': 123,
'To': 123
},
'DestinationPortRange': {
'From': 123,
'To': 123
},
'TargetRouteTableId': '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',
],
'AvailabilityZoneIds': [
'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',
'AvailabilityZoneId': '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'
},
'TransitGatewayPolicyTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayPolicyTableEntry': {
'RuleNumber': 123,
'Protocol': 'string',
'SourceCidr': 'string',
'DestinationCidr': 'string',
'SourcePortRange': {
'From': 123,
'To': 123
},
'DestinationPortRange': {
'From': 123,
'To': 123
},
'TargetRouteTableId': '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',
],
'AvailabilityZoneIds': [
'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',
'AvailabilityZoneId': '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'
},
'TransitGatewayPolicyTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayPolicyTableEntry': {
'RuleNumber': 123,
'Protocol': 'string',
'SourceCidr': 'string',
'DestinationCidr': 'string',
'SourcePortRange': {
'From': 123,
'To': 123
},
'DestinationPortRange': {
'From': 123,
'To': 123
},
'TargetRouteTableId': '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>`_
{'AnalysisFindings': {'FindingComponents': {'Explanations': {'TransitGatewayPolicyTable': {'Arn': 'string',
'Id': 'string',
'Name': 'string'},
'TransitGatewayPolicyTableEntry': {'DestinationCidr': 'string',
'DestinationPortRange': {'From': 'integer',
'To': 'integer'},
'Protocol': 'string',
'RuleNumber': 'integer',
'SourceCidr': 'string',
'SourcePortRange': {'From': 'integer',
'To': 'integer'},
'TargetRouteTableId': 'string'}},
'TransitGatewayPolicyTableEntry': {'DestinationCidr': 'string',
'DestinationPortRange': {'From': 'integer',
'To': 'integer'},
'Protocol': 'string',
'RuleNumber': 'integer',
'SourceCidr': 'string',
'SourcePortRange': {'From': 'integer',
'To': 'integer'},
'TargetRouteTableId': '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'
},
'TransitGatewayPolicyTableEntry': {
'RuleNumber': 123,
'Protocol': 'string',
'SourceCidr': 'string',
'DestinationCidr': 'string',
'SourcePortRange': {
'From': 123,
'To': 123
},
'DestinationPortRange': {
'From': 123,
'To': 123
},
'TargetRouteTableId': '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',
],
'AvailabilityZoneIds': [
'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',
'AvailabilityZoneId': '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'
},
'TransitGatewayPolicyTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayPolicyTableEntry': {
'RuleNumber': 123,
'Protocol': 'string',
'SourceCidr': 'string',
'DestinationCidr': 'string',
'SourcePortRange': {
'From': 123,
'To': 123
},
'DestinationPortRange': {
'From': 123,
'To': 123
},
'TargetRouteTableId': '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 Services 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.
TransitGatewayPolicyTableEntry (dict) --
The entry in a transit gateway policy table.
RuleNumber (integer) --
The rule number for the policy table entry. Entries are evaluated in ascending order of rule number.
Protocol (string) --
The protocol number. A value of -1 means that the entry matches all protocols.
SourceCidr (string) --
The source CIDR block. If this value is not present, the entry matches any source address.
DestinationCidr (string) --
The destination CIDR block. If this value is not present, the entry matches any destination address.
SourcePortRange (dict) --
The source port range. If this value is not present, the entry matches any source port.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
DestinationPortRange (dict) --
The destination port range. If this value is not present, the entry matches any destination port.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
TargetRouteTableId (string) --
The ID of the transit gateway route table to which the entry routes matching traffic.
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) --
AvailabilityZoneIds (list) --
The IDs of 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.
AvailabilityZoneId (string) --
The ID of 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 Services 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.
TransitGatewayPolicyTable (dict) --
The transit gateway policy 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.
TransitGatewayPolicyTableEntry (dict) --
The transit gateway policy table entry.
RuleNumber (integer) --
The rule number for the policy table entry. Entries are evaluated in ascending order of rule number.
Protocol (string) --
The protocol number. A value of -1 means that the entry matches all protocols.
SourceCidr (string) --
The source CIDR block. If this value is not present, the entry matches any source address.
DestinationCidr (string) --
The destination CIDR block. If this value is not present, the entry matches any destination address.
SourcePortRange (dict) --
The source port range. If this value is not present, the entry matches any source port.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
DestinationPortRange (dict) --
The destination port range. If this value is not present, the entry matches any destination port.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
TargetRouteTableId (string) --
The ID of the transit gateway route table to which the entry routes matching traffic.
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': {'TransitGatewayPolicyTable': {'Arn': 'string',
'Id': 'string',
'Name': 'string'},
'TransitGatewayPolicyTableEntry': {'DestinationCidr': 'string',
'DestinationPortRange': {'From': 'integer',
'To': 'integer'},
'Protocol': 'string',
'RuleNumber': 'integer',
'SourceCidr': 'string',
'SourcePortRange': {'From': 'integer',
'To': 'integer'},
'TargetRouteTableId': 'string'}},
'ForwardPathComponents': {'Explanations': {'TransitGatewayPolicyTable': {'Arn': 'string',
'Id': 'string',
'Name': 'string'},
'TransitGatewayPolicyTableEntry': {'DestinationCidr': 'string',
'DestinationPortRange': {'From': 'integer',
'To': 'integer'},
'Protocol': 'string',
'RuleNumber': 'integer',
'SourceCidr': 'string',
'SourcePortRange': {'From': 'integer',
'To': 'integer'},
'TargetRouteTableId': 'string'}},
'TransitGatewayPolicyTableEntry': {'DestinationCidr': 'string',
'DestinationPortRange': {'From': 'integer',
'To': 'integer'},
'Protocol': 'string',
'RuleNumber': 'integer',
'SourceCidr': 'string',
'SourcePortRange': {'From': 'integer',
'To': 'integer'},
'TargetRouteTableId': 'string'}},
'ReturnPathComponents': {'Explanations': {'TransitGatewayPolicyTable': {'Arn': 'string',
'Id': 'string',
'Name': 'string'},
'TransitGatewayPolicyTableEntry': {'DestinationCidr': 'string',
'DestinationPortRange': {'From': 'integer',
'To': 'integer'},
'Protocol': 'string',
'RuleNumber': 'integer',
'SourceCidr': 'string',
'SourcePortRange': {'From': 'integer',
'To': 'integer'},
'TargetRouteTableId': 'string'}},
'TransitGatewayPolicyTableEntry': {'DestinationCidr': 'string',
'DestinationPortRange': {'From': 'integer',
'To': 'integer'},
'Protocol': 'string',
'RuleNumber': 'integer',
'SourceCidr': 'string',
'SourcePortRange': {'From': 'integer',
'To': 'integer'},
'TargetRouteTableId': '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',
],
FilterOutArns=[
'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'|'image-usage-report'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-metering-policy'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'vpc-encryption-control'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task'|'ipam-prefix-list-resolver'|'ipam-policy'|'ipam-prefix-list-resolver-target'|'ipam-internet-registry-association'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator'|'ipam-pool-allocation'|'capacity-reservation-cancellation-quote'|'application-status-check'|'capacity-reservation-modification-quote',
'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) --
list
The Amazon Resource Names (ARN) of the resources that the path will ignore.
(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',
],
'FilterOutArns': [
'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'
},
'TransitGatewayPolicyTableEntry': {
'RuleNumber': 123,
'Protocol': 'string',
'SourceCidr': 'string',
'DestinationCidr': 'string',
'SourcePortRange': {
'From': 123,
'To': 123
},
'DestinationPortRange': {
'From': 123,
'To': 123
},
'TargetRouteTableId': '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',
],
'AvailabilityZoneIds': [
'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',
'AvailabilityZoneId': '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'
},
'TransitGatewayPolicyTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayPolicyTableEntry': {
'RuleNumber': 123,
'Protocol': 'string',
'SourceCidr': 'string',
'DestinationCidr': 'string',
'SourcePortRange': {
'From': 123,
'To': 123
},
'DestinationPortRange': {
'From': 123,
'To': 123
},
'TargetRouteTableId': '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'
},
'TransitGatewayPolicyTableEntry': {
'RuleNumber': 123,
'Protocol': 'string',
'SourceCidr': 'string',
'DestinationCidr': 'string',
'SourcePortRange': {
'From': 123,
'To': 123
},
'DestinationPortRange': {
'From': 123,
'To': 123
},
'TargetRouteTableId': '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',
],
'AvailabilityZoneIds': [
'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',
'AvailabilityZoneId': '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'
},
'TransitGatewayPolicyTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayPolicyTableEntry': {
'RuleNumber': 123,
'Protocol': 'string',
'SourceCidr': 'string',
'DestinationCidr': 'string',
'SourcePortRange': {
'From': 123,
'To': 123
},
'DestinationPortRange': {
'From': 123,
'To': 123
},
'TargetRouteTableId': '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',
],
'AvailabilityZoneIds': [
'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',
'AvailabilityZoneId': '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'
},
'TransitGatewayPolicyTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayPolicyTableEntry': {
'RuleNumber': 123,
'Protocol': 'string',
'SourceCidr': 'string',
'DestinationCidr': 'string',
'SourcePortRange': {
'From': 123,
'To': 123
},
'DestinationPortRange': {
'From': 123,
'To': 123
},
'TargetRouteTableId': '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>`_