account/aws.sdk.kotlin.services.account/AccountClient

AccountClient

Operations for Amazon Web Services Account Management

Types

class Builder : AbstractSdkClientBuilder<AccountClient.Config, AccountClient.Config.Builder, AccountClient>

object Companion : AbstractAwsSdkClientFactory<AccountClient.Config, AccountClient.Config.Builder, AccountClient, AccountClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: AccountClient.Config

AccountClient's configuration

Functions

acceptPrimaryEmailUpdate

abstract suspend fun acceptPrimaryEmailUpdate(input: AcceptPrimaryEmailUpdateRequest): AcceptPrimaryEmailUpdateResponse

Accepts the request that originated from StartPrimaryEmailUpdate to update the primary email address (also known as the root user email address) for the specified account.

deleteAlternateContact

abstract suspend fun deleteAlternateContact(input: DeleteAlternateContactRequest): DeleteAlternateContactResponse

Deletes the specified alternate contact from an Amazon Web Services account.

disableRegion

abstract suspend fun disableRegion(input: DisableRegionRequest): DisableRegionResponse

Disables (opts-out) a particular Region for an account.

enableRegion

abstract suspend fun enableRegion(input: EnableRegionRequest): EnableRegionResponse

Enables (opts-in) a particular Region for an account.

getAccountInformation

abstract suspend fun getAccountInformation(input: GetAccountInformationRequest = GetAccountInformationRequest { }): GetAccountInformationResponse

Retrieves information about the specified account including its account name, account ID, and account creation date and time. To use this API, an IAM user or role must have the account:GetAccountInformation IAM permission.

getAlternateContact

abstract suspend fun getAlternateContact(input: GetAlternateContactRequest): GetAlternateContactResponse

Retrieves the specified alternate contact attached to an Amazon Web Services account.

getContactInformation

abstract suspend fun getContactInformation(input: GetContactInformationRequest = GetContactInformationRequest { }): GetContactInformationResponse

Retrieves the primary contact information of an Amazon Web Services account.

getPrimaryEmail

abstract suspend fun getPrimaryEmail(input: GetPrimaryEmailRequest): GetPrimaryEmailResponse

Retrieves the primary email address for the specified account.

getRegionOptStatus

abstract suspend fun getRegionOptStatus(input: GetRegionOptStatusRequest): GetRegionOptStatusResponse

Retrieves the opt-in status of a particular Region.

listRegions

abstract suspend fun listRegions(input: ListRegionsRequest = ListRegionsRequest { }): ListRegionsResponse

Lists all the Regions for a given account and their respective opt-in statuses. Optionally, this list can be filtered by the region-opt-status-contains parameter.

putAccountName

abstract suspend fun putAccountName(input: PutAccountNameRequest): PutAccountNameResponse

Updates the account name of the specified account. To use this API, IAM principals must have the account:PutAccountName IAM permission.

putAlternateContact

abstract suspend fun putAlternateContact(input: PutAlternateContactRequest): PutAlternateContactResponse

Modifies the specified alternate contact attached to an Amazon Web Services account.

putContactInformation

abstract suspend fun putContactInformation(input: PutContactInformationRequest): PutContactInformationResponse

Updates the primary contact information of an Amazon Web Services account.

startPrimaryEmailUpdate

abstract suspend fun startPrimaryEmailUpdate(input: StartPrimaryEmailUpdateRequest): StartPrimaryEmailUpdateResponse

Starts the process to update the primary email address for the specified account.

Inherited functions

acceptPrimaryEmailUpdate

inline suspend fun AccountClient.acceptPrimaryEmailUpdate(crossinline block: AcceptPrimaryEmailUpdateRequest.Builder.() -> Unit): AcceptPrimaryEmailUpdateResponse

Accepts the request that originated from StartPrimaryEmailUpdate to update the primary email address (also known as the root user email address) for the specified account.

expect abstract fun close()

deleteAlternateContact

inline suspend fun AccountClient.deleteAlternateContact(crossinline block: DeleteAlternateContactRequest.Builder.() -> Unit): DeleteAlternateContactResponse

Deletes the specified alternate contact from an Amazon Web Services account.

disableRegion

inline suspend fun AccountClient.disableRegion(crossinline block: DisableRegionRequest.Builder.() -> Unit): DisableRegionResponse

Disables (opts-out) a particular Region for an account.

enableRegion

inline suspend fun AccountClient.enableRegion(crossinline block: EnableRegionRequest.Builder.() -> Unit): EnableRegionResponse

Enables (opts-in) a particular Region for an account.

getAccountInformation

inline suspend fun AccountClient.getAccountInformation(crossinline block: GetAccountInformationRequest.Builder.() -> Unit): GetAccountInformationResponse

getAlternateContact

inline suspend fun AccountClient.getAlternateContact(crossinline block: GetAlternateContactRequest.Builder.() -> Unit): GetAlternateContactResponse

Retrieves the specified alternate contact attached to an Amazon Web Services account.

getContactInformation

inline suspend fun AccountClient.getContactInformation(crossinline block: GetContactInformationRequest.Builder.() -> Unit): GetContactInformationResponse

Retrieves the primary contact information of an Amazon Web Services account.

getPrimaryEmail

inline suspend fun AccountClient.getPrimaryEmail(crossinline block: GetPrimaryEmailRequest.Builder.() -> Unit): GetPrimaryEmailResponse

Retrieves the primary email address for the specified account.

getRegionOptStatus

inline suspend fun AccountClient.getRegionOptStatus(crossinline block: GetRegionOptStatusRequest.Builder.() -> Unit): GetRegionOptStatusResponse

Retrieves the opt-in status of a particular Region.

listRegions

inline suspend fun AccountClient.listRegions(crossinline block: ListRegionsRequest.Builder.() -> Unit): ListRegionsResponse

Lists all the Regions for a given account and their respective opt-in statuses. Optionally, this list can be filtered by the region-opt-status-contains parameter.

listRegionsPaginated

fun AccountClient.listRegionsPaginated(initialRequest: ListRegionsRequest = ListRegionsRequest { }): Flow<ListRegionsResponse>

fun AccountClient.listRegionsPaginated(block: ListRegionsRequest.Builder.() -> Unit): Flow<ListRegionsResponse>

Paginate over ListRegionsResponse results.

putAccountName

inline suspend fun AccountClient.putAccountName(crossinline block: PutAccountNameRequest.Builder.() -> Unit): PutAccountNameResponse

Updates the account name of the specified account. To use this API, IAM principals must have the account:PutAccountName IAM permission.

putAlternateContact

inline suspend fun AccountClient.putAlternateContact(crossinline block: PutAlternateContactRequest.Builder.() -> Unit): PutAlternateContactResponse

Modifies the specified alternate contact attached to an Amazon Web Services account.

putContactInformation

inline suspend fun AccountClient.putContactInformation(crossinline block: PutContactInformationRequest.Builder.() -> Unit): PutContactInformationResponse

Updates the primary contact information of an Amazon Web Services account.

startPrimaryEmailUpdate

inline suspend fun AccountClient.startPrimaryEmailUpdate(crossinline block: StartPrimaryEmailUpdateRequest.Builder.() -> Unit): StartPrimaryEmailUpdateResponse

Starts the process to update the primary email address for the specified account.

withConfig

fun AccountClient.withConfig(block: AccountClient.Config.Builder.() -> Unit): AccountClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.