organizations_move_account: Moves an account from its current source parent root or...

Description Usage Arguments Value Request syntax Examples

View source: R/organizations_operations.R

Description

Moves an account from its current source parent root or organizational unit (OU) to the specified destination parent root or OU.

This operation can be called only from the organization's management account.

Usage

1
2
organizations_move_account(AccountId, SourceParentId,
  DestinationParentId)

Arguments

AccountId

[required] The unique identifier (ID) of the account that you want to move.

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

SourceParentId

[required] The unique identifier (ID) of the root or organizational unit that you want to move the account from.

The regex pattern for a parent ID string requires one of the following:

  • Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.

  • Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

DestinationParentId

[required] The unique identifier (ID) of the root or organizational unit that you want to move the account to.

The regex pattern for a parent ID string requires one of the following:

  • Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.

  • Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

Value

An empty list.

Request syntax

1
2
3
4
5
svc$move_account(
  AccountId = "string",
  SourceParentId = "string",
  DestinationParentId = "string"
)

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## Not run: 
# The following example shows how to move a member account from the root
# to an OU:/n/n
svc$move_account(
  AccountId = "333333333333",
  DestinationParentId = "ou-examplerootid111-exampleouid111",
  SourceParentId = "r-examplerootid111"
)

## End(Not run)

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