create_network_insights_path

create_network_insights_path(**kwargs)

Creates a path to analyze for reachability.

Reachability Analyzer enables you to analyze and debug network reachability between two resources in your virtual private cloud (VPC). For more information, see What is Reachability Analyzer.

See also: AWS API Documentation

Request Syntax

response = client.create_network_insights_path(
    SourceIp='string',
    DestinationIp='string',
    Source='string',
    Destination='string',
    Protocol='tcp'|'udp',
    DestinationPort=123,
    TagSpecifications=[
        {
            'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'ipam-resource-discovery'|'ipam-resource-discovery-association',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    DryRun=True|False,
    ClientToken='string'
)
Parameters
  • SourceIp (string) -- The IP address of the Amazon Web Services resource that is the source of the path.
  • DestinationIp (string) -- The IP address of the Amazon Web Services resource that is the destination of the path.
  • Source (string) --

    [REQUIRED]

    The Amazon Web Services resource that is the source of the path.

  • Destination (string) --

    [REQUIRED]

    The Amazon Web Services resource that is the destination of the path.

  • Protocol (string) --

    [REQUIRED]

    The protocol.

  • DestinationPort (integer) -- The destination port.
  • TagSpecifications (list) --

    The tags to add to the path.

    • (dict) --

      The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.

      Note

      The Valid Values lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error.

      • ResourceType (string) --

        The type of resource to tag on creation.

      • Tags (list) --

        The tags to apply to the resource.

        • (dict) --

          Describes a tag.

          • Key (string) --

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

          • Value (string) --

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

  • DryRun (boolean) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .
  • ClientToken (string) --

    [REQUIRED]

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

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'NetworkInsightsPath': {
        'NetworkInsightsPathId': 'string',
        'NetworkInsightsPathArn': 'string',
        'CreatedDate': datetime(2015, 1, 1),
        'Source': 'string',
        'Destination': 'string',
        'SourceArn': 'string',
        'DestinationArn': 'string',
        'SourceIp': 'string',
        'DestinationIp': 'string',
        'Protocol': 'tcp'|'udp',
        'DestinationPort': 123,
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • NetworkInsightsPath (dict) --

      Information about the path.

      • NetworkInsightsPathId (string) --

        The ID of the path.

      • NetworkInsightsPathArn (string) --

        The Amazon Resource Name (ARN) of the path.

      • CreatedDate (datetime) --

        The time stamp when the path was created.

      • Source (string) --

        The Amazon Web Services resource that is the source of the path.

      • Destination (string) --

        The Amazon Web Services resource that is the destination of the path.

      • SourceArn (string) --

        The Amazon Resource Name (ARN) of the source.

      • DestinationArn (string) --

        The Amazon Resource Name (ARN) of the destination.

      • SourceIp (string) --

        The IP address of the Amazon Web Services resource that is the source of the path.

      • DestinationIp (string) --

        The IP address of the Amazon Web Services resource that is the destination of the path.

      • Protocol (string) --

        The protocol.

      • DestinationPort (integer) --

        The destination port.

      • Tags (list) --

        The tags associated with the path.

        • (dict) --

          Describes a tag.

          • Key (string) --

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

          • Value (string) --

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.