Struct aws_sdk_apigateway::client::fluent_builders::GetUsage

pub struct GetUsage { /* private fields */ }

Fluent builder constructing a request to GetUsage.

Gets the usage data of a usage plan in a specified time interval.

Implementations

impl GetUsage

pub async fn customize(
    self
) -> Result<CustomizableOperation<GetUsage, AwsResponseRetryClassifier>, SdkError<GetUsageError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(self) -> Result<GetUsageOutput, SdkError<GetUsageError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn into_paginator(self) -> GetUsagePaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn usage_plan_id(self, input: impl Into<String>) -> Self

The Id of the usage plan associated with the usage data.

pub fn set_usage_plan_id(self, input: Option<String>) -> Self

The Id of the usage plan associated with the usage data.

pub fn key_id(self, input: impl Into<String>) -> Self

The Id of the API key associated with the resultant usage data.

pub fn set_key_id(self, input: Option<String>) -> Self

The Id of the API key associated with the resultant usage data.

pub fn start_date(self, input: impl Into<String>) -> Self

The starting date (e.g., 2016-01-01) of the usage data.

pub fn set_start_date(self, input: Option<String>) -> Self

The starting date (e.g., 2016-01-01) of the usage data.

pub fn end_date(self, input: impl Into<String>) -> Self

The ending date (e.g., 2016-12-31) of the usage data.

pub fn set_end_date(self, input: Option<String>) -> Self

The ending date (e.g., 2016-12-31) of the usage data.

pub fn position(self, input: impl Into<String>) -> Self

The current pagination position in the paged result set.

pub fn set_position(self, input: Option<String>) -> Self

The current pagination position in the paged result set.

pub fn limit(self, input: i32) -> Self

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

pub fn set_limit(self, input: Option<i32>) -> Self

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Trait Implementations

impl Clone for GetUsage

fn clone(&self) -> GetUsage

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetUsage

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.