EC2.Paginator.DescribeNetworkInsightsAnalyses¶paginator = client.get_paginator('describe_network_insights_analyses')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from EC2.Client.describe_network_insights_analyses().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
NetworkInsightsAnalysisIds=[
'string',
],
NetworkInsightsPathId='string',
AnalysisStartTime=datetime(2015, 1, 1),
AnalysisEndTime=datetime(2015, 1, 1),
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The ID of the network insights analyses. You must specify either analysis IDs or a path ID.
The filters. The following are the possible values:
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.
The name of the filter. Filter names are case-sensitive.
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.
DryRunOperation . Otherwise, it is UnauthorizedOperation .A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'NetworkInsightsAnalyses': [
{
'NetworkInsightsAnalysisId': 'string',
'NetworkInsightsAnalysisArn': 'string',
'NetworkInsightsPathId': 'string',
'AdditionalAccounts': [
'string',
],
'FilterInArns': [
'string',
],
'StartDate': datetime(2015, 1, 1),
'Status': 'running'|'succeeded'|'failed',
'StatusMessage': 'string',
'WarningMessage': 'string',
'NetworkPathFound': True|False,
'ForwardPathComponents': [
{
'SequenceNumber': 123,
'AclRule': {
'Cidr': 'string',
'Egress': True|False,
'PortRange': {
'From': 123,
'To': 123
},
'Protocol': 'string',
'RuleAction': 'string',
'RuleNumber': 123
},
'AttachedTo': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Component': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'DestinationVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'OutboundHeader': {
'DestinationAddresses': [
'string',
],
'DestinationPortRanges': [
{
'From': 123,
'To': 123
},
],
'Protocol': 'string',
'SourceAddresses': [
'string',
],
'SourcePortRanges': [
{
'From': 123,
'To': 123
},
]
},
'InboundHeader': {
'DestinationAddresses': [
'string',
],
'DestinationPortRanges': [
{
'From': 123,
'To': 123
},
],
'Protocol': 'string',
'SourceAddresses': [
'string',
],
'SourcePortRanges': [
{
'From': 123,
'To': 123
},
]
},
'RouteTableRoute': {
'DestinationCidr': 'string',
'DestinationPrefixListId': 'string',
'EgressOnlyInternetGatewayId': 'string',
'GatewayId': 'string',
'InstanceId': 'string',
'NatGatewayId': 'string',
'NetworkInterfaceId': 'string',
'Origin': 'string',
'TransitGatewayId': 'string',
'VpcPeeringConnectionId': 'string',
'State': 'string'
},
'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'
}
},
],
'TransitGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTableRoute': {
'DestinationCidr': 'string',
'State': 'string',
'RouteOrigin': 'string',
'PrefixListId': 'string',
'AttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'string'
},
'Explanations': [
{
'Acl': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AclRule': {
'Cidr': 'string',
'Egress': True|False,
'PortRange': {
'From': 123,
'To': 123
},
'Protocol': 'string',
'RuleAction': 'string',
'RuleNumber': 123
},
'Address': 'string',
'Addresses': [
'string',
],
'AttachedTo': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AvailabilityZones': [
'string',
],
'Cidrs': [
'string',
],
'Component': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'CustomerGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Destination': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'DestinationVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Direction': 'string',
'ExplanationCode': 'string',
'IngressRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'InternetGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LoadBalancerArn': 'string',
'ClassicLoadBalancerListener': {
'LoadBalancerPort': 123,
'InstancePort': 123
},
'LoadBalancerListenerPort': 123,
'LoadBalancerTarget': {
'Address': 'string',
'AvailabilityZone': 'string',
'Instance': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Port': 123
},
'LoadBalancerTargetGroup': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LoadBalancerTargetGroups': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'LoadBalancerTargetPort': 123,
'ElasticLoadBalancerListener': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'MissingComponent': 'string',
'NatGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'NetworkInterface': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'PacketField': 'string',
'VpcPeeringConnection': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Port': 123,
'PortRanges': [
{
'From': 123,
'To': 123
},
],
'PrefixList': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Protocols': [
'string',
],
'RouteTableRoute': {
'DestinationCidr': 'string',
'DestinationPrefixListId': 'string',
'EgressOnlyInternetGatewayId': 'string',
'GatewayId': 'string',
'InstanceId': 'string',
'NatGatewayId': 'string',
'NetworkInterfaceId': 'string',
'Origin': 'string',
'TransitGatewayId': 'string',
'VpcPeeringConnectionId': 'string',
'State': 'string'
},
'RouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SecurityGroup': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SecurityGroupRule': {
'Cidr': 'string',
'Direction': 'string',
'SecurityGroupId': 'string',
'PortRange': {
'From': 123,
'To': 123
},
'PrefixListId': 'string',
'Protocol': 'string'
},
'SecurityGroups': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'SourceVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'State': 'string',
'Subnet': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SubnetRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Vpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpcEndpoint': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpnConnection': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpnGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTableRoute': {
'DestinationCidr': 'string',
'State': 'string',
'RouteOrigin': 'string',
'PrefixListId': 'string',
'AttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'string'
},
'TransitGatewayAttachment': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'ComponentAccount': 'string',
'ComponentRegion': 'string'
},
],
'ElasticLoadBalancerListener': {
'Id': 'string',
'Arn': 'string',
'Name': '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'
},
'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'
}
},
],
'TransitGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTableRoute': {
'DestinationCidr': 'string',
'State': 'string',
'RouteOrigin': 'string',
'PrefixListId': 'string',
'AttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'string'
},
'Explanations': [
{
'Acl': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AclRule': {
'Cidr': 'string',
'Egress': True|False,
'PortRange': {
'From': 123,
'To': 123
},
'Protocol': 'string',
'RuleAction': 'string',
'RuleNumber': 123
},
'Address': 'string',
'Addresses': [
'string',
],
'AttachedTo': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AvailabilityZones': [
'string',
],
'Cidrs': [
'string',
],
'Component': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'CustomerGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Destination': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'DestinationVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Direction': 'string',
'ExplanationCode': 'string',
'IngressRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'InternetGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LoadBalancerArn': 'string',
'ClassicLoadBalancerListener': {
'LoadBalancerPort': 123,
'InstancePort': 123
},
'LoadBalancerListenerPort': 123,
'LoadBalancerTarget': {
'Address': 'string',
'AvailabilityZone': 'string',
'Instance': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Port': 123
},
'LoadBalancerTargetGroup': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LoadBalancerTargetGroups': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'LoadBalancerTargetPort': 123,
'ElasticLoadBalancerListener': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'MissingComponent': 'string',
'NatGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'NetworkInterface': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'PacketField': 'string',
'VpcPeeringConnection': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Port': 123,
'PortRanges': [
{
'From': 123,
'To': 123
},
],
'PrefixList': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Protocols': [
'string',
],
'RouteTableRoute': {
'DestinationCidr': 'string',
'DestinationPrefixListId': 'string',
'EgressOnlyInternetGatewayId': 'string',
'GatewayId': 'string',
'InstanceId': 'string',
'NatGatewayId': 'string',
'NetworkInterfaceId': 'string',
'Origin': 'string',
'TransitGatewayId': 'string',
'VpcPeeringConnectionId': 'string',
'State': 'string'
},
'RouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SecurityGroup': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SecurityGroupRule': {
'Cidr': 'string',
'Direction': 'string',
'SecurityGroupId': 'string',
'PortRange': {
'From': 123,
'To': 123
},
'PrefixListId': 'string',
'Protocol': 'string'
},
'SecurityGroups': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'SourceVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'State': 'string',
'Subnet': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SubnetRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Vpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpcEndpoint': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpnConnection': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpnGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTableRoute': {
'DestinationCidr': 'string',
'State': 'string',
'RouteOrigin': 'string',
'PrefixListId': 'string',
'AttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'string'
},
'TransitGatewayAttachment': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'ComponentAccount': 'string',
'ComponentRegion': 'string'
},
],
'ElasticLoadBalancerListener': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
}
},
],
'Explanations': [
{
'Acl': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AclRule': {
'Cidr': 'string',
'Egress': True|False,
'PortRange': {
'From': 123,
'To': 123
},
'Protocol': 'string',
'RuleAction': 'string',
'RuleNumber': 123
},
'Address': 'string',
'Addresses': [
'string',
],
'AttachedTo': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AvailabilityZones': [
'string',
],
'Cidrs': [
'string',
],
'Component': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'CustomerGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Destination': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'DestinationVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Direction': 'string',
'ExplanationCode': 'string',
'IngressRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'InternetGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LoadBalancerArn': 'string',
'ClassicLoadBalancerListener': {
'LoadBalancerPort': 123,
'InstancePort': 123
},
'LoadBalancerListenerPort': 123,
'LoadBalancerTarget': {
'Address': 'string',
'AvailabilityZone': 'string',
'Instance': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Port': 123
},
'LoadBalancerTargetGroup': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LoadBalancerTargetGroups': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'LoadBalancerTargetPort': 123,
'ElasticLoadBalancerListener': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'MissingComponent': 'string',
'NatGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'NetworkInterface': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'PacketField': 'string',
'VpcPeeringConnection': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Port': 123,
'PortRanges': [
{
'From': 123,
'To': 123
},
],
'PrefixList': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Protocols': [
'string',
],
'RouteTableRoute': {
'DestinationCidr': 'string',
'DestinationPrefixListId': 'string',
'EgressOnlyInternetGatewayId': 'string',
'GatewayId': 'string',
'InstanceId': 'string',
'NatGatewayId': 'string',
'NetworkInterfaceId': 'string',
'Origin': 'string',
'TransitGatewayId': 'string',
'VpcPeeringConnectionId': 'string',
'State': 'string'
},
'RouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SecurityGroup': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SecurityGroupRule': {
'Cidr': 'string',
'Direction': 'string',
'SecurityGroupId': 'string',
'PortRange': {
'From': 123,
'To': 123
},
'PrefixListId': 'string',
'Protocol': 'string'
},
'SecurityGroups': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'SourceVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'State': 'string',
'Subnet': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SubnetRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Vpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpcEndpoint': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpnConnection': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpnGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTableRoute': {
'DestinationCidr': 'string',
'State': 'string',
'RouteOrigin': 'string',
'PrefixListId': 'string',
'AttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'string'
},
'TransitGatewayAttachment': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'ComponentAccount': 'string',
'ComponentRegion': 'string'
},
],
'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.