organizations_describe_create_account_status: Retrieves the current status of an asynchronous request to...

Description Usage Arguments Value Request syntax Examples

View source: R/organizations_operations.R

Description

Retrieves the current status of an asynchronous request to create an 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

CreateAccountRequestId

[required] Specifies the Id value that uniquely identifies the create_account request. You can get the value from the CreateAccountStatus.Id response in an earlier create_account request, or from the list_create_account_status operation.

The regex pattern for a create account request ID string requires "car-" followed by from 8 to 32 lowercase letters or digits.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
list(
  CreateAccountStatus = list(
    Id = "string",
    AccountName = "string",
    State = "IN_PROGRESS"|"SUCCEEDED"|"FAILED",
    RequestedTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    CompletedTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    AccountId = "string",
    GovCloudAccountId = "string",
    FailureReason = "ACCOUNT_LIMIT_EXCEEDED"|"EMAIL_ALREADY_EXISTS"|"INVALID_ADDRESS"|"INVALID_EMAIL"|"CONCURRENT_ACCOUNT_MODIFICATION"|"INTERNAL_FAILURE"|"GOVCLOUD_ACCOUNT_ALREADY_EXISTS"|"MISSING_BUSINESS_VALIDATION"|"MISSING_PAYMENT_INSTRUMENT"
  )
)

Request syntax

1
2
3
svc$describe_create_account_status(
  CreateAccountRequestId = "string"
)

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
## Not run: 
# The following example shows how to request the status about a previous
# request to create an account in an organization. This operation can be
# called only by a principal from the organization's master account. In
# the example, the specified "createAccountRequestId" comes from the
# response of the original call to "CreateAccount":
svc$describe_create_account_status(
  CreateAccountRequestId = "car-exampleaccountcreationrequestid"
)

## End(Not run)

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