Describe Account

organizations_describe_account

R Documentation

Description¶

Retrieves Organizations-related information about the specified account.

You can only call this operation from the management account or a member account that is a delegated administrator.

Usage¶

organizations_describe_account(AccountId)

Arguments¶

AccountId

[required] The unique identifier (ID) of the Amazon Web Services account that you want information about. You can get the ID from the list_accounts or list_accounts_for_parent operations.

The regex pattern for an account ID string requires exactly 12 digits.

Value¶

A list with the following syntax:

list(
  Account = list(
    Id = "string",
    Arn = "string",
    Email = "string",
    Name = "string",
    Status = "ACTIVE"|"SUSPENDED"|"PENDING_CLOSURE",
    State = "PENDING_ACTIVATION"|"ACTIVE"|"SUSPENDED"|"PENDING_CLOSURE"|"CLOSED",
    Paths = list(
      "string"
    ),
    JoinedMethod = "INVITED"|"CREATED",
    JoinedTimestamp = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax¶

svc$describe_account(
  AccountId = "string"
)

Examples¶

## Not run: 
# The following example shows a user in the master account (111111111111)
# asking for details about account 555555555555:
svc$describe_account(
  AccountId = "555555555555"
)

## End(Not run)