Struct Client 

pub struct Client { /* private fields */ }

Client for Account Access

Client for invoking operations on Account Access. Each operation on Account Access 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_accountaccess::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_accountaccess::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 CreateEntitlement operation has a Client::create_entitlement, 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.create_entitlement()
    .application_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;

Implementations

impl Client

pub fn create_application(&self) -> CreateApplicationFluentBuilder

Constructs a fluent builder for the CreateApplication operation.

• The fluent builder is configurable:
  • identity_source(IdentitySource) / set_identity_source(Option<IdentitySource>):
    required: true
    

    Specifies the identity source for the application. The identity source defines the IAM Identity Center instance that provides principals for entitlements.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Specifies the tags to assign to the application.

    
    
• On success, responds with CreateApplicationOutput with field(s):
  • application_arn(String):

    The Amazon Resource Name (ARN) of the created application.

• On failure, responds with SdkError<CreateApplicationError>

impl Client

pub fn create_entitlement(&self) -> CreateEntitlementFluentBuilder

Constructs a fluent builder for the CreateEntitlement operation.

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

    Specifies the ARN of the application to create the entitlement for.

    
    
  • entitlement(Entitlement) / set_entitlement(Option<Entitlement>):
    required: true
    

    Specifies the entitlement configuration, including the principal and the IAM role to grant access to.

    
    
• On success, responds with CreateEntitlementOutput with field(s):
  • entitlement_id(String):

    The unique identifier of the created entitlement.

• On failure, responds with SdkError<CreateEntitlementError>

impl Client

pub fn delete_application(&self) -> DeleteApplicationFluentBuilder

Constructs a fluent builder for the DeleteApplication operation.

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

    Specifies the ARN of the application to delete.

    
    
• On success, responds with DeleteApplicationOutput
• On failure, responds with SdkError<DeleteApplicationError>

impl Client

pub fn delete_entitlement(&self) -> DeleteEntitlementFluentBuilder

Constructs a fluent builder for the DeleteEntitlement operation.

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

    Specifies the ARN of the application that the entitlement belongs to.

    
    
  • entitlement_id(impl Into<String>) / set_entitlement_id(Option<String>):
    required: true
    

    Specifies the unique identifier of the entitlement to delete.

    
    
• On success, responds with DeleteEntitlementOutput
• On failure, responds with SdkError<DeleteEntitlementError>

impl Client

pub fn get_application(&self) -> GetApplicationFluentBuilder

Constructs a fluent builder for the GetApplication operation.

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

    Specifies the ARN of the application to retrieve.

    
    
• On success, responds with GetApplicationOutput with field(s):
  • identity_source(Option<IdentitySourceDetails>):

    The identity source details for the application, including the IAM Identity Center instance configuration.

  • status(Status):

    The current status of the application.

  • tenant_id(Option<String>):

    The tenant identifier associated with the application.

  • created_at(DateTime):

    The date and time when the application was created.

  • updated_at(DateTime):

    The date and time when the application was last updated.

  • tags(Option<HashMap::<String, String>>):

    The tags associated with the application.

  • error(Option<ErrorDetails>):

    The error details if the application is in a failed state.

• On failure, responds with SdkError<GetApplicationError>

impl Client

pub fn get_entitlement(&self) -> GetEntitlementFluentBuilder

Constructs a fluent builder for the GetEntitlement operation.

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

    Specifies the ARN of the application that the entitlement belongs to.

    
    
  • entitlement_id(impl Into<String>) / set_entitlement_id(Option<String>):
    required: true
    

    Specifies the unique identifier of the entitlement to retrieve.

    
    
• On success, responds with GetEntitlementOutput with field(s):
  • application_arn(String):

    The ARN of the application that the entitlement belongs to.

  • entitlement_id(String):

    The unique identifier of the entitlement.

  • entitlement(Option<EntitlementDetails>):

    The entitlement details, including the principal, IAM role, and target account.

  • created_at(DateTime):

    The date and time when the entitlement was created.

• On failure, responds with SdkError<GetEntitlementError>

impl Client

pub fn list_applications(&self) -> ListApplicationsFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Specifies the maximum number of results to return in a single call.

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

    Specifies the pagination token from a previous call to retrieve the next set of results.

    
    
• On success, responds with ListApplicationsOutput with field(s):
  • applications(Vec::<ApplicationSummary>):

    The list of applications.

  • next_token(Option<String>):

    The pagination token to use in a subsequent request to retrieve the next set of results. This value is null when there are no more results to return.

• On failure, responds with SdkError<ListApplicationsError>

impl Client

pub fn list_entitlements(&self) -> ListEntitlementsFluentBuilder

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

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

    Specifies the ARN of the application to list entitlements for.

    
    
  • filter(EntitlementFilter) / set_filter(Option<EntitlementFilter>):
    required: true
    

    Specifies filter criteria to narrow the entitlements returned. You can filter by principal, IAM role, or account.

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

    Specifies the pagination token from a previous call to retrieve the next set of results.

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

    Specifies the maximum number of results to return in a single call.

    
    
• On success, responds with ListEntitlementsOutput with field(s):
  • entitlements(Vec::<EntitlementsListMember>):

    The list of entitlements for the specified application.

  • next_token(Option<String>):

    The pagination token to use in a subsequent request to retrieve the next set of results. This value is null when there are no more results to return.

• On failure, responds with SdkError<ListEntitlementsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

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

    Specifies the ARN of the resource to list tags for.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap::<String, String>>):

    The tags associated with the resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

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

    Specifies the ARN of the resource to add tags to.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    Specifies the tags to add to the resource.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

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

    Specifies the ARN of the resource to remove tags from.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    Specifies the tag keys to remove from the resource.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

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) -> Client

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.

impl Waiters for Client

fn wait_until_application_active(&self) -> ApplicationActiveFluentBuilder

Wait for application_active