AWS Account¶

Description¶

Operations for Amazon Web Services Account Management

Usage¶

account(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.
- credentials:
  - creds:
    - access_key_id: AWS access key ID
    - secret_access_key: AWS secret access key
    - session_token: AWS temporary session token
  - profile: The name of a profile to use. If not given, then the default profile is used.
  - anonymous: Set anonymous credentials.
- endpoint: The complete URL to use for the constructed client.
- region: The AWS Region used in instantiating the client.
- close_connection: Immediately close all HTTP connections.
- timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
- s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.
- sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
- use_dual_stack: Set this to true to use the dualstack (IPv4 and IPv6) endpoint for a service, where available, falling back to the regular endpoint when it isn't. Defaults to the AWS_USE_DUALSTACK_ENDPOINT environment variable when unset.
credentials

Optional credentials shorthand for the config parameter
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint

Optional shorthand for complete URL to use for the constructed client.
region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- account(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string",
    use_dual_stack = "logical"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

`accept_primary_email_update`	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
`delete_alternate_contact`	Deletes the specified alternate contact from an Amazon Web Services account
`disable_region`	Disables (opts-out) a particular Region for an account
`enable_region`	Enables (opts-in) a particular Region for an account
`get_account_information`	Retrieves information about the specified account including its account name, account ID, account creation date and time, and account state
`get_alternate_contact`	Retrieves the specified alternate contact attached to an Amazon Web Services account
`get_contact_information`	Retrieves the primary contact information of an Amazon Web Services account
`get_gov_cloud_account_information`	Retrieves information about the GovCloud account linked to the specified standard account (if it exists) including the GovCloud account ID and state
`get_primary_email`	Retrieves the primary email address for the specified account
`get_primary_email_update_status`	Retrieves the status of the most recent primary email update for the specified account
`get_region_opt_status`	Retrieves the opt-in status of a particular Region
`list_regions`	Lists all the Regions for a given account and their respective opt-in statuses
`put_account_name`	Updates the account name of the specified account
`put_alternate_contact`	Modifies the specified alternate contact attached to an Amazon Web Services account
`put_contact_information`	Updates the primary contact information of an Amazon Web Services account
`send_phone_number_verification`	Sends a one-time passcode to the phone number in the primary contact information of an Amazon Web Services account
`start_primary_email_update`	Starts the process to update the primary email address for the specified account
`verify_phone_number`	Verifies the phone number in the primary contact information of an Amazon Web Services account by submitting the one-time passcode that SendPhoneNumberVerification sent to that phone number

Examples¶

svc <- account()
svc$accept_primary_email_update(
  Foo = 123
)