Struct aws_sdk_servicequotas::client::Client

source ·
pub struct Client { /* private fields */ }
Expand description

Client for Service Quotas

Client for invoking operations on Service Quotas. Each operation on Service Quotas is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

§Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_servicequotas::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_servicequotas::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

§Using the Client

A client has a function for every operation that can be performed by the service. For example, the DeleteServiceQuotaIncreaseRequestFromTemplate operation has a Client::delete_service_quota_increase_request_from_template, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.delete_service_quota_increase_request_from_template()
    .service_code("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations§

source§

impl Client

source

pub fn associate_service_quota_template( &self ) -> AssociateServiceQuotaTemplateFluentBuilder

Constructs a fluent builder for the AssociateServiceQuotaTemplate operation.

source§

impl Client

source

pub fn delete_service_quota_increase_request_from_template( &self ) -> DeleteServiceQuotaIncreaseRequestFromTemplateFluentBuilder

Constructs a fluent builder for the DeleteServiceQuotaIncreaseRequestFromTemplate operation.

source§

impl Client

source

pub fn disassociate_service_quota_template( &self ) -> DisassociateServiceQuotaTemplateFluentBuilder

Constructs a fluent builder for the DisassociateServiceQuotaTemplate operation.

source§

impl Client

source

pub fn get_association_for_service_quota_template( &self ) -> GetAssociationForServiceQuotaTemplateFluentBuilder

Constructs a fluent builder for the GetAssociationForServiceQuotaTemplate operation.

source§

impl Client

source

pub fn get_aws_default_service_quota( &self ) -> GetAWSDefaultServiceQuotaFluentBuilder

Constructs a fluent builder for the GetAWSDefaultServiceQuota operation.

source§

impl Client

source

pub fn get_requested_service_quota_change( &self ) -> GetRequestedServiceQuotaChangeFluentBuilder

Constructs a fluent builder for the GetRequestedServiceQuotaChange operation.

source§

impl Client

source

pub fn get_service_quota(&self) -> GetServiceQuotaFluentBuilder

Constructs a fluent builder for the GetServiceQuota operation.

source§

impl Client

source

pub fn get_service_quota_increase_request_from_template( &self ) -> GetServiceQuotaIncreaseRequestFromTemplateFluentBuilder

Constructs a fluent builder for the GetServiceQuotaIncreaseRequestFromTemplate operation.

source§

impl Client

source

pub fn list_aws_default_service_quotas( &self ) -> ListAWSDefaultServiceQuotasFluentBuilder

Constructs a fluent builder for the ListAWSDefaultServiceQuotas operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • service_code(impl Into<String>) / set_service_code(Option<String>):
      required: true

      Specifies the service identifier. To find the service code value for an Amazon Web Services service, use the ListServices operation.


    • next_token(impl Into<String>) / set_next_token(Option<String>):
      required: false

      Specifies a value for receiving additional results after you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call’s NextToken response to indicate where the output should continue from.


    • max_results(i32) / set_max_results(Option<i32>):
      required: false

      Specifies the maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.

      An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.


  • On success, responds with ListAwsDefaultServiceQuotasOutput with field(s):
    • next_token(Option<String>):

      If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

    • quotas(Option<Vec::<ServiceQuota>>):

      Information about the quotas.

  • On failure, responds with SdkError<ListAWSDefaultServiceQuotasError>
source§

impl Client

source

pub fn list_requested_service_quota_change_history( &self ) -> ListRequestedServiceQuotaChangeHistoryFluentBuilder

Constructs a fluent builder for the ListRequestedServiceQuotaChangeHistory operation. This operation supports pagination; See into_paginator().

source§

impl Client

source

pub fn list_requested_service_quota_change_history_by_quota( &self ) -> ListRequestedServiceQuotaChangeHistoryByQuotaFluentBuilder

Constructs a fluent builder for the ListRequestedServiceQuotaChangeHistoryByQuota operation. This operation supports pagination; See into_paginator().

source§

impl Client

source

pub fn list_service_quota_increase_requests_in_template( &self ) -> ListServiceQuotaIncreaseRequestsInTemplateFluentBuilder

Constructs a fluent builder for the ListServiceQuotaIncreaseRequestsInTemplate operation. This operation supports pagination; See into_paginator().

source§

impl Client

source

pub fn list_service_quotas(&self) -> ListServiceQuotasFluentBuilder

Constructs a fluent builder for the ListServiceQuotas operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • service_code(impl Into<String>) / set_service_code(Option<String>):
      required: true

      Specifies the service identifier. To find the service code value for an Amazon Web Services service, use the ListServices operation.


    • next_token(impl Into<String>) / set_next_token(Option<String>):
      required: false

      Specifies a value for receiving additional results after you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call’s NextToken response to indicate where the output should continue from.


    • max_results(i32) / set_max_results(Option<i32>):
      required: false

      Specifies the maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.

      An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.


    • quota_code(impl Into<String>) / set_quota_code(Option<String>):
      required: false

      Specifies the quota identifier. To find the quota code for a specific quota, use the ListServiceQuotas operation, and look for the QuotaCode response in the output for the quota you want.


    • quota_applied_at_level(AppliedLevelEnum) / set_quota_applied_at_level(Option<AppliedLevelEnum>):
      required: false

      Specifies at which level of granularity that the quota value is applied.


  • On success, responds with ListServiceQuotasOutput with field(s):
    • next_token(Option<String>):

      If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

    • quotas(Option<Vec::<ServiceQuota>>):

      Information about the quotas.

  • On failure, responds with SdkError<ListServiceQuotasError>
source§

impl Client

source

pub fn list_services(&self) -> ListServicesFluentBuilder

Constructs a fluent builder for the ListServices operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • next_token(impl Into<String>) / set_next_token(Option<String>):
      required: false

      Specifies a value for receiving additional results after you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call’s NextToken response to indicate where the output should continue from.


    • max_results(i32) / set_max_results(Option<i32>):
      required: false

      Specifies the maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.

      An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.


  • On success, responds with ListServicesOutput with field(s):
    • next_token(Option<String>):

      If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

    • services(Option<Vec::<ServiceInfo>>):

      The list of the Amazon Web Service names and service codes.

  • On failure, responds with SdkError<ListServicesError>
source§

impl Client

source

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

source§

impl Client

source

pub fn put_service_quota_increase_request_into_template( &self ) -> PutServiceQuotaIncreaseRequestIntoTemplateFluentBuilder

Constructs a fluent builder for the PutServiceQuotaIncreaseRequestIntoTemplate operation.

source§

impl Client

source

pub fn request_service_quota_increase( &self ) -> RequestServiceQuotaIncreaseFluentBuilder

Constructs a fluent builder for the RequestServiceQuotaIncrease operation.

source§

impl Client

source

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

source§

impl Client

source

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

source§

impl Client

source

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

§Panics

This method will panic in the following cases:

  • Retries or timeouts are enabled without a sleep_impl configured.
  • Identity caching is enabled without a sleep_impl and time_source configured.
  • No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

source

pub fn config(&self) -> &Config

Returns the client’s configuration.

source§

impl Client

source

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

§Panics
  • This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
  • This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
  • This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations§

source§

impl Clone for Client

source§

fn clone(&self) -> Client

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Client

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more