organizations_describe_account: Retrieves AWS Organizations-related information about the...

Description Usage Arguments Value Request syntax Examples

View source: R/organizations_operations.R

Description

Retrieves AWS Organizations-related information about the specified account.

This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an AWS service.

Usage

1

Arguments

AccountId

[required] The unique identifier (ID) of the AWS 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:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
list(
  Account = list(
    Id = "string",
    Arn = "string",
    Email = "string",
    Name = "string",
    Status = "ACTIVE"|"SUSPENDED",
    JoinedMethod = "INVITED"|"CREATED",
    JoinedTimestamp = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax

1
2
3
svc$describe_account(
  AccountId = "string"
)

Examples

1
2
3
4
5
6
7
8
## 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)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.