Struct Client

Source

pub struct Client { /* private fields */ }

Expand description

Client for AWS Identity and Access Management

Client for invoking operations on AWS Identity and Access Management. Each operation on AWS Identity and Access Management 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_iam::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_iam::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 AddClientIDToOpenIDConnectProvider operation has a Client::add_client_id_to_open_id_connect_provider, 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.add_client_id_to_open_id_connect_provider()
    .open_id_connect_provider_arn("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.

§Waiters

This client provides wait_until methods behind the Waiters trait. To use them, simply import the trait, and then call one of the wait_until methods. This will return a waiter fluent builder that takes various parameters, which are documented on the builder type. Once parameters have been provided, the wait method can be called to initiate waiting.

For example, if there was a wait_until_thing method, it could look like:

let result = client.wait_until_thing()
    .thing_id("someId")
    .wait(Duration::from_secs(120))
    .await;

Struct ClientCopy item path

§Constructing a Client

§Using the Client

§Waiters

Implementations§

impl Client

pub fn add_client_id_to_open_id_connect_provider( &self, ) -> AddClientIDToOpenIDConnectProviderFluentBuilder

impl Client

pub fn add_role_to_instance_profile( &self, ) -> AddRoleToInstanceProfileFluentBuilder

impl Client

pub fn add_user_to_group(&self) -> AddUserToGroupFluentBuilder

impl Client

pub fn attach_group_policy(&self) -> AttachGroupPolicyFluentBuilder

impl Client

pub fn attach_role_policy(&self) -> AttachRolePolicyFluentBuilder

impl Client

pub fn attach_user_policy(&self) -> AttachUserPolicyFluentBuilder

impl Client

pub fn change_password(&self) -> ChangePasswordFluentBuilder

impl Client

pub fn create_access_key(&self) -> CreateAccessKeyFluentBuilder

impl Client

pub fn create_account_alias(&self) -> CreateAccountAliasFluentBuilder

impl Client

pub fn create_group(&self) -> CreateGroupFluentBuilder

impl Client

pub fn create_instance_profile(&self) -> CreateInstanceProfileFluentBuilder

impl Client

pub fn create_login_profile(&self) -> CreateLoginProfileFluentBuilder

impl Client

pub fn create_open_id_connect_provider( &self, ) -> CreateOpenIDConnectProviderFluentBuilder

impl Client

pub fn create_policy(&self) -> CreatePolicyFluentBuilder

impl Client

pub fn create_policy_version(&self) -> CreatePolicyVersionFluentBuilder

impl Client

pub fn create_role(&self) -> CreateRoleFluentBuilder

impl Client

pub fn create_saml_provider(&self) -> CreateSAMLProviderFluentBuilder

impl Client

pub fn create_service_linked_role(&self) -> CreateServiceLinkedRoleFluentBuilder

impl Client

pub fn create_service_specific_credential( &self, ) -> CreateServiceSpecificCredentialFluentBuilder

impl Client

pub fn create_user(&self) -> CreateUserFluentBuilder

impl Client

pub fn create_virtual_mfa_device(&self) -> CreateVirtualMFADeviceFluentBuilder

impl Client

pub fn deactivate_mfa_device(&self) -> DeactivateMFADeviceFluentBuilder

impl Client

pub fn delete_access_key(&self) -> DeleteAccessKeyFluentBuilder

impl Client

pub fn delete_account_alias(&self) -> DeleteAccountAliasFluentBuilder

impl Client

pub fn delete_account_password_policy( &self, ) -> DeleteAccountPasswordPolicyFluentBuilder

impl Client

pub fn delete_group(&self) -> DeleteGroupFluentBuilder

impl Client

pub fn delete_group_policy(&self) -> DeleteGroupPolicyFluentBuilder

impl Client

pub fn delete_instance_profile(&self) -> DeleteInstanceProfileFluentBuilder

impl Client

pub fn delete_login_profile(&self) -> DeleteLoginProfileFluentBuilder

impl Client

pub fn delete_open_id_connect_provider( &self, ) -> DeleteOpenIDConnectProviderFluentBuilder

impl Client

pub fn delete_policy(&self) -> DeletePolicyFluentBuilder

impl Client

pub fn delete_policy_version(&self) -> DeletePolicyVersionFluentBuilder

impl Client

pub fn delete_role(&self) -> DeleteRoleFluentBuilder

impl Client

pub fn delete_role_permissions_boundary( &self, ) -> DeleteRolePermissionsBoundaryFluentBuilder

impl Client

pub fn delete_role_policy(&self) -> DeleteRolePolicyFluentBuilder

impl Client

pub fn delete_saml_provider(&self) -> DeleteSAMLProviderFluentBuilder

impl Client

pub fn delete_server_certificate(&self) -> DeleteServerCertificateFluentBuilder

impl Client

Struct Client

§Constructing a `Client`

§Using the `Client`