Struct aws_sdk_account::client::Client

pub struct Client { /* private fields */ }

Client for AWS Account

Client for invoking operations on AWS Account. Each operation on AWS Account 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_account::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_account::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.

Implementations

impl Client

pub fn delete_alternate_contact(&self) -> DeleteAlternateContactFluentBuilder

Constructs a fluent builder for the DeleteAlternateContact operation.

• The fluent builder is configurable:
  • alternate_contact_type(AlternateContactType) / set_alternate_contact_type(Option<AlternateContactType>):
    required: true
    

    Specifies which of the alternate contacts to delete.

    
    
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: false
    

    Specifies the 12 digit account ID number of the Amazon Web Services account that you want to access or modify with this operation.

    If you do not specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation.

    To use this parameter, the caller must be an identity in the organization’s management account or a delegated administrator account, and the specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.

    The management account can’t specify its own AccountId; it must call the operation in standalone context by not including the AccountId parameter.

    To call this operation on an account that is not a member of an organization, then don’t specify this parameter, and call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.

    
    
• On success, responds with DeleteAlternateContactOutput
• On failure, responds with SdkError<DeleteAlternateContactError>

impl Client

pub fn disable_region(&self) -> DisableRegionFluentBuilder

Constructs a fluent builder for the DisableRegion operation.

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

    Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don’t specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization’s management account or a delegated administrator account. The specified account ID must also be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.

    The management account can’t specify its own AccountId. It must call the operation in standalone context by not including the AccountId parameter.

    To call this operation on an account that is not a member of an organization, don’t specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.

    
    
  • region_name(impl Into<String>) / set_region_name(Option<String>):
    required: true
    

    Specifies the Region-code for a given Region name (for example, af-south-1). When you disable a Region, Amazon Web Services performs actions to deactivate that Region in your account, such as destroying IAM resources in the Region. This process takes a few minutes for most accounts, but this can take several hours. You cannot enable the Region until the disabling process is fully completed.

    
    
• On success, responds with DisableRegionOutput
• On failure, responds with SdkError<DisableRegionError>

impl Client

pub fn enable_region(&self) -> EnableRegionFluentBuilder

Constructs a fluent builder for the EnableRegion operation.

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

    Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don’t specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization’s management account or a delegated administrator account. The specified account ID must also be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.

    The management account can’t specify its own AccountId. It must call the operation in standalone context by not including the AccountId parameter.

    To call this operation on an account that is not a member of an organization, don’t specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.

    
    
  • region_name(impl Into<String>) / set_region_name(Option<String>):
    required: true
    

    Specifies the Region-code for a given Region name (for example, af-south-1). When you enable a Region, Amazon Web Services performs actions to prepare your account in that Region, such as distributing your IAM resources to the Region. This process takes a few minutes for most accounts, but it can take several hours. You cannot use the Region until this process is complete. Furthermore, you cannot disable the Region until the enabling process is fully completed.

    
    
• On success, responds with EnableRegionOutput
• On failure, responds with SdkError<EnableRegionError>

impl Client

pub fn get_alternate_contact(&self) -> GetAlternateContactFluentBuilder

Constructs a fluent builder for the GetAlternateContact operation.

• The fluent builder is configurable:
  • alternate_contact_type(AlternateContactType) / set_alternate_contact_type(Option<AlternateContactType>):
    required: true
    

    Specifies which alternate contact you want to retrieve.

    
    
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: false
    

    Specifies the 12 digit account ID number of the Amazon Web Services account that you want to access or modify with this operation.

    If you do not specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation.

    To use this parameter, the caller must be an identity in the organization’s management account or a delegated administrator account, and the specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.

    The management account can’t specify its own AccountId; it must call the operation in standalone context by not including the AccountId parameter.

    To call this operation on an account that is not a member of an organization, then don’t specify this parameter, and call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.

    
    
• On success, responds with GetAlternateContactOutput with field(s):
  • alternate_contact(Option<AlternateContact>):

    A structure that contains the details for the specified alternate contact.

• On failure, responds with SdkError<GetAlternateContactError>

impl Client

pub fn get_contact_information(&self) -> GetContactInformationFluentBuilder

Constructs a fluent builder for the GetContactInformation operation.

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

    Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don’t specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization’s management account or a delegated administrator account. The specified account ID must also be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.

    The management account can’t specify its own AccountId. It must call the operation in standalone context by not including the AccountId parameter.

    To call this operation on an account that is not a member of an organization, don’t specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.

    
    
• On success, responds with GetContactInformationOutput with field(s):
  • contact_information(Option<ContactInformation>):

    Contains the details of the primary contact information associated with an Amazon Web Services account.

• On failure, responds with SdkError<GetContactInformationError>

impl Client

pub fn get_region_opt_status(&self) -> GetRegionOptStatusFluentBuilder

Constructs a fluent builder for the GetRegionOptStatus operation.

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

    Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don’t specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization’s management account or a delegated administrator account. The specified account ID must also be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.

    The management account can’t specify its own AccountId. It must call the operation in standalone context by not including the AccountId parameter.

    To call this operation on an account that is not a member of an organization, don’t specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.

    
    
  • region_name(impl Into<String>) / set_region_name(Option<String>):
    required: true
    

    Specifies the Region-code for a given Region name (for example, af-south-1). This function will return the status of whatever Region you pass into this parameter.

    
    
• On success, responds with GetRegionOptStatusOutput with field(s):
  • region_name(Option<String>):

    The Region code that was passed in.

  • region_opt_status(Option<RegionOptStatus>):

    One of the potential statuses a Region can undergo (Enabled, Enabling, Disabled, Disabling, Enabled_By_Default).

• On failure, responds with SdkError<GetRegionOptStatusError>

impl Client

pub fn list_regions(&self) -> ListRegionsFluentBuilder

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

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

    Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don’t specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization’s management account or a delegated administrator account. The specified account ID must also be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.

    The management account can’t specify its own AccountId. It must call the operation in standalone context by not including the AccountId parameter.

    To call this operation on an account that is not a member of an organization, don’t specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.

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

    The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the Amazon Web Services CLI. For usage examples, see Pagination in the Amazon Web Services Command Line Interface User Guide.

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

    A token used to specify where to start paginating. This is the NextToken from a previously truncated response. For usage examples, see Pagination in the Amazon Web Services Command Line Interface User Guide.

    
    
  • region_opt_status_contains(RegionOptStatus) / set_region_opt_status_contains(Option<Vec::<RegionOptStatus>>):
    required: false
    

    A list of Region statuses (Enabling, Enabled, Disabling, Disabled, Enabled_by_default) to use to filter the list of Regions for a given account. For example, passing in a value of ENABLING will only return a list of Regions with a Region status of ENABLING.

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

    If there is more data to be returned, this will be populated. It should be passed into the next-token request parameter of list-regions.

  • regions(Option<Vec::<Region>>):

    This is a list of Regions for a given account, or if the filtered parameter was used, a list of Regions that match the filter criteria set in the filter parameter.

• On failure, responds with SdkError<ListRegionsError>

impl Client

pub fn put_alternate_contact(&self) -> PutAlternateContactFluentBuilder

Constructs a fluent builder for the PutAlternateContact operation.

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

    Specifies a name for the alternate contact.

    
    
  • title(impl Into<String>) / set_title(Option<String>):
    required: true
    

    Specifies a title for the alternate contact.

    
    
  • email_address(impl Into<String>) / set_email_address(Option<String>):
    required: true
    

    Specifies an email address for the alternate contact.

    
    
  • phone_number(impl Into<String>) / set_phone_number(Option<String>):
    required: true
    

    Specifies a phone number for the alternate contact.

    
    
  • alternate_contact_type(AlternateContactType) / set_alternate_contact_type(Option<AlternateContactType>):
    required: true
    

    Specifies which alternate contact you want to create or update.

    
    
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: false
    

    Specifies the 12 digit account ID number of the Amazon Web Services account that you want to access or modify with this operation.

    If you do not specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation.

    To use this parameter, the caller must be an identity in the organization’s management account or a delegated administrator account, and the specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.

    The management account can’t specify its own AccountId; it must call the operation in standalone context by not including the AccountId parameter.

    To call this operation on an account that is not a member of an organization, then don’t specify this parameter, and call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.

    
    
• On success, responds with PutAlternateContactOutput
• On failure, responds with SdkError<PutAlternateContactError>

impl Client

pub fn put_contact_information(&self) -> PutContactInformationFluentBuilder

Constructs a fluent builder for the PutContactInformation operation.

• The fluent builder is configurable:
  • contact_information(ContactInformation) / set_contact_information(Option<ContactInformation>):
    required: true
    

    Contains the details of the primary contact information associated with an Amazon Web Services account.

    
    
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: false
    

    Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don’t specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization’s management account or a delegated administrator account. The specified account ID must also be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.

    The management account can’t specify its own AccountId. It must call the operation in standalone context by not including the AccountId parameter.

    To call this operation on an account that is not a member of an organization, don’t specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.

    
    
• On success, responds with PutContactInformationOutput
• On failure, responds with SdkError<PutContactInformationError>

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 copy 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.