Struct Client 

pub struct Client { /* private fields */ }

Client for Account Access Runtime

Client for invoking operations on Account Access Runtime. Each operation on Account Access Runtime 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_accountaccessruntime::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 Builder 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_accountaccessruntime::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 GetRoleCredentials operation has a Client::get_role_credentials, 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.get_role_credentials()
    .tenant_id("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

impl Client

pub fn get_role_credentials(&self) -> GetRoleCredentialsFluentBuilder

Constructs a fluent builder for the GetRoleCredentials operation.

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

    The identifier of the tenant that the request applies to. A tenant ID begins with aa- and is 3 to 24 characters long. It can contain lowercase letters, numbers, and hyphens.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the role to retrieve credentials for. You must be entitled to assume this role.

    
    
  • access_type(AccessType) / set_access_type(Option<AccessType>):
    required: true
    

    The type of access to request for the role. Specify PROGRAMMATIC_ACCESS to receive access key credentials for use with the CLI or an Amazon Web Services SDK.

    
    
  • session_name(impl Into<String>) / set_session_name(Option<String>):
    required: false
    

    An optional name for the role session. The name can be 2 to 64 characters and can contain alphanumeric characters and the following symbols: plus (+), equal (=), comma (,), period (.), at (@), and hyphen (-). The session name appears in CloudTrail logs for the assumed role session.

    
    
  • session_duration(i32) / set_session_duration(Option<i32>):
    required: false
    

    The duration, in seconds, that the returned credentials remain valid. If you don’t specify a value, the service uses the default session duration. The maximum value can’t exceed the maximum session duration configured for the role.

    
    
• On success, responds with GetRoleCredentialsOutput with field(s):
  • credentials_details(Option<CredentialsDetails>):

    The temporary credentials that the service returns for the requested role.

• On failure, responds with SdkError<GetRoleCredentialsError>

impl Client

pub fn list_roles(&self) -> ListRolesFluentBuilder

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

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

    The identifier of the tenant whose roles you want to list. A tenant ID begins with aa- and is 3 to 24 characters long. It can contain lowercase letters, numbers, and hyphens.

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

    The maximum number of roles to return in a single response. If more roles are available than the specified value, the response includes a nextToken value that you can use to retrieve the next page of results. If you don’t specify a value, the service uses a default page size.

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

    The pagination token from a previous ListRoles response. Use it to retrieve the next page of results. Omit this parameter on the first call.

    
    
• On success, responds with ListRolesOutput with field(s):
  • roles(Vec::<AccessDetails>):

    The list of roles that you can access in the tenant. Each entry describes an Amazon Web Services account and a role.

  • next_token(Option<String>):

    The pagination token to include in a subsequent ListRoles request to retrieve the next page of results. This value is absent when there are no more results to return.

• On failure, responds with SdkError<ListRolesError>

impl Client

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.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

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

impl Clone for Client

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.