EC2 / Client / describe_aws_network_performance_metric_subscriptions

describe_aws_network_performance_metric_subscriptions#

EC2.Client.describe_aws_network_performance_metric_subscriptions(**kwargs)#

Describes the current Infrastructure Performance metric subscriptions.

See also: AWS API Documentation

Request Syntax

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

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

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

  • Filters (list) –

    One or more filters.

    • (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) –

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

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'Subscriptions': [
        {
            'Source': 'string',
            'Destination': 'string',
            'Metric': 'aggregate-latency',
            'Statistic': 'p50',
            'Period': 'five-minutes'|'fifteen-minutes'|'one-hour'|'three-hours'|'one-day'|'one-week'
        },
    ]
}

Response Structure

  • (dict) –

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

    • Subscriptions (list) –

      Describes the current Infrastructure Performance subscriptions.

      • (dict) –

        Describes an Infrastructure Performance subscription.

        • Source (string) –

          The Region or Availability Zone that’s the source for the subscription. For example, us-east-1.

        • Destination (string) –

          The Region or Availability Zone that’s the target for the subscription. For example, eu-west-1.

        • Metric (string) –

          The metric used for the subscription.

        • Statistic (string) –

          The statistic used for the subscription.

        • Period (string) –

          The data aggregation time for the subscription.