Skip to content

get_aws_network_performance_data

get_aws_network_performance_data(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    data_queries: Optional[DataQueries] = None,
    start_time: Optional[MillisecondDateTime] = None,
    end_time: Optional[MillisecondDateTime] = None,
    max_results: Optional[Integer] = None,
    next_token: Optional[String] = None,
    dry_run: Optional[Boolean] = None,
) -> GetAwsNetworkPerformanceDataResult

Gets network performance data.

Parameters:

  • data_queries (Optional[DataQueries], default: None ) –

    A list of network performance data queries.

  • start_time (Optional[MillisecondDateTime], default: None ) –

    The starting time for the performance data request. The starting time must be formatted as yyyy-mm-ddThh:mm:ss. For example, 2022-06-10T12:00:00.000Z.

  • end_time (Optional[MillisecondDateTime], default: None ) –

    The ending time for the performance data request. The end time must be formatted as yyyy-mm-ddThh:mm:ss. For example, 2022-06-12T12:00:00.000Z.

  • max_results (Optional[Integer], default: None ) –

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

  • next_token (Optional[String], default: None ) –

    The token for the next page of results.

  • dry_run (Optional[Boolean], default: None ) –

    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.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def get_aws_network_performance_data(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    data_queries: Optional["capo_ec2.types.data_queries.DataQueries"] = None,
    start_time: Optional[
        "capo_ec2.types.millisecond_date_time.MillisecondDateTime"
    ] = None,
    end_time: Optional[
        "capo_ec2.types.millisecond_date_time.MillisecondDateTime"
    ] = None,
    max_results: Optional["capo_ec2.types.integer.Integer"] = None,
    next_token: Optional["capo_ec2.types.string.String"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.get_aws_network_performance_data_result.GetAwsNetworkPerformanceDataResult":
    """<p>Gets network performance data.</p>

    Args:
        data_queries: <p>A list of network performance data queries.</p>
        start_time: <p>The starting time for the performance data request. The starting time must be formatted as <code>yyyy-mm-ddThh:mm:ss</code>. For example, <code>2022-06-10T12:00:00.000Z</code>.</p>
        end_time: <p>The ending time for the performance data request. The end time must be formatted as <code>yyyy-mm-ddThh:mm:ss</code>. For example, <code>2022-06-12T12:00:00.000Z</code>.</p>
        max_results: <p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
        next_token: <p>The token for the next page of results.</p>
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.get_aws_network_performance_data_request.GetAwsNetworkPerformanceDataRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.get_aws_network_performance_data_result.GetAwsNetworkPerformanceDataResult"
    ]:
        import capo_ec2._operations.amazon_ec2.get_aws_network_performance_data

        output, http_response = (
            capo_ec2._operations.amazon_ec2.get_aws_network_performance_data.get_aws_network_performance_data(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetAwsNetworkPerformanceData")
    )
    input_: capo_ec2.types.get_aws_network_performance_data_request.GetAwsNetworkPerformanceDataRequest = {}
    if data_queries is not None:
        input_["data_queries"] = data_queries
    if start_time is not None:
        input_["start_time"] = start_time
    if end_time is not None:
        input_["end_time"] = end_time
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if dry_run is not None:
        input_["dry_run"] = dry_run

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output