EC2 / Client / describe_network_insights_paths

describe_network_insights_paths

EC2.Client.describe_network_insights_paths(**kwargs)

Describes one or more of your paths.

See also: AWS API Documentation

Request Syntax

response = client.describe_network_insights_paths(
    NetworkInsightsPathIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    DryRun=True|False,
    NextToken='string'
)

Parameters:

• NetworkInsightsPathIds (list) –

  The IDs of the paths.

  • (string) –

• Filters (list) –

  The filters. The following are the possible values:

  • destination - The ID of the resource.

  • filter-at-source.source-address - The source IPv4 address at the source.

  • filter-at-source.source-port-range - The source port range at the source.

  • filter-at-source.destination-address - The destination IPv4 address at the source.

  • filter-at-source.destination-port-range - The destination port range at the source.

  • filter-at-destination.source-address - The source IPv4 address at the destination.

  • filter-at-destination.source-port-range - The source port range at the destination.

  • filter-at-destination.destination-address - The destination IPv4 address at the destination.

  • filter-at-destination.destination-port-range - The destination port range at the destination.

  • protocol - The protocol.

  • source - The ID of the resource.

  • (dict) –

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

    • Name (string) –

      The name of the filter. Filter names are case-sensitive.

    • Values (list) –

      The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

      • (string) –

• MaxResults (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.

• 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.

• NextToken (string) – The token for the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'NetworkInsightsPaths': [
        {
            'NetworkInsightsPathId': 'string',
            'NetworkInsightsPathArn': 'string',
            'CreatedDate': datetime(2015, 1, 1),
            'Source': 'string',
            'Destination': 'string',
            'SourceArn': 'string',
            'DestinationArn': 'string',
            'SourceIp': 'string',
            'DestinationIp': 'string',
            'Protocol': 'tcp'|'udp',
            'DestinationPort': 123,
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'FilterAtSource': {
                'SourceAddress': 'string',
                'SourcePortRange': {
                    'FromPort': 123,
                    'ToPort': 123
                },
                'DestinationAddress': 'string',
                'DestinationPortRange': {
                    'FromPort': 123,
                    'ToPort': 123
                }
            },
            'FilterAtDestination': {
                'SourceAddress': 'string',
                'SourcePortRange': {
                    'FromPort': 123,
                    'ToPort': 123
                },
                'DestinationAddress': 'string',
                'DestinationPortRange': {
                    'FromPort': 123,
                    'ToPort': 123
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • NetworkInsightsPaths (list) –

    Information about the paths.

    • (dict) –

      Describes a path.

      • NetworkInsightsPathId (string) –

        The ID of the path.

      • NetworkInsightsPathArn (string) –

        The Amazon Resource Name (ARN) of the path.

      • CreatedDate (datetime) –

        The time stamp when the path was created.

      • Source (string) –

        The ID of the source.

      • Destination (string) –

        The ID of the destination.

      • SourceArn (string) –

        The Amazon Resource Name (ARN) of the source.

      • DestinationArn (string) –

        The Amazon Resource Name (ARN) of the destination.

      • SourceIp (string) –

        The IP address of the source.

      • DestinationIp (string) –

        The IP address of the destination.

      • Protocol (string) –

        The protocol.

      • DestinationPort (integer) –

        The destination port.

      • Tags (list) –

        The tags associated with the path.

        • (dict) –

          Describes a tag.

          • Key (string) –

            The key of the tag.

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

          • Value (string) –

            The value of the tag.

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

      • FilterAtSource (dict) –

        Scopes the analysis to network paths that match specific filters at the source.

        • SourceAddress (string) –

          The source IPv4 address.

        • SourcePortRange (dict) –

          The source port range.

          • FromPort (integer) –

            The first port in the range.

          • ToPort (integer) –

            The last port in the range.

        • DestinationAddress (string) –

          The destination IPv4 address.

        • DestinationPortRange (dict) –

          The destination port range.

          • FromPort (integer) –

            The first port in the range.

          • ToPort (integer) –

            The last port in the range.

      • FilterAtDestination (dict) –

        Scopes the analysis to network paths that match specific filters at the destination.

        • SourceAddress (string) –

          The source IPv4 address.

        • SourcePortRange (dict) –

          The source port range.

          • FromPort (integer) –

            The first port in the range.

          • ToPort (integer) –

            The last port in the range.

        • DestinationAddress (string) –

          The destination IPv4 address.

        • DestinationPortRange (dict) –

          The destination port range.

          • FromPort (integer) –

            The first port in the range.

          • ToPort (integer) –

            The last port in the range.

  • NextToken (string) –

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.