@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSOrganizations extends Object implements AWSOrganizations
AWSOrganizations
. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
AcceptHandshakeResult |
acceptHandshake(AcceptHandshakeRequest request)
Sends a response to the originator of a handshake agreeing to the action proposed by the handshake request.
|
AttachPolicyResult |
attachPolicy(AttachPolicyRequest request)
Attaches a policy to a root, an organizational unit, or an individual account.
|
CancelHandshakeResult |
cancelHandshake(CancelHandshakeRequest request)
Cancels a handshake.
|
CreateAccountResult |
createAccount(CreateAccountRequest request)
Creates an AWS account that is automatically a member of the organization whose credentials made the request.
|
CreateOrganizationResult |
createOrganization(CreateOrganizationRequest request)
Creates an AWS organization.
|
CreateOrganizationalUnitResult |
createOrganizationalUnit(CreateOrganizationalUnitRequest request)
Creates an organizational unit (OU) within a root or parent OU.
|
CreatePolicyResult |
createPolicy(CreatePolicyRequest request)
Creates a policy of a specified type that you can attach to a root, an organizational unit (OU), or an individual
AWS account.
|
DeclineHandshakeResult |
declineHandshake(DeclineHandshakeRequest request)
Declines a handshake request.
|
DeleteOrganizationResult |
deleteOrganization(DeleteOrganizationRequest request)
Deletes the organization.
|
DeleteOrganizationalUnitResult |
deleteOrganizationalUnit(DeleteOrganizationalUnitRequest request)
Deletes an organizational unit from a root or another OU.
|
DeletePolicyResult |
deletePolicy(DeletePolicyRequest request)
Deletes the specified policy from your organization.
|
DescribeAccountResult |
describeAccount(DescribeAccountRequest request)
Retrieves Organizations-related information about the specified account.
|
DescribeCreateAccountStatusResult |
describeCreateAccountStatus(DescribeCreateAccountStatusRequest request)
Retrieves the current status of an asynchronous request to create an account.
|
DescribeHandshakeResult |
describeHandshake(DescribeHandshakeRequest request)
Retrieves information about a previously requested handshake.
|
DescribeOrganizationResult |
describeOrganization(DescribeOrganizationRequest request)
Retrieves information about the organization that the user's account belongs to.
|
DescribeOrganizationalUnitResult |
describeOrganizationalUnit(DescribeOrganizationalUnitRequest request)
Retrieves information about an organizational unit (OU).
|
DescribePolicyResult |
describePolicy(DescribePolicyRequest request)
Retrieves information about a policy.
|
DetachPolicyResult |
detachPolicy(DetachPolicyRequest request)
Detaches a policy from a target root, organizational unit, or account.
|
DisablePolicyTypeResult |
disablePolicyType(DisablePolicyTypeRequest request)
Disables an organizational control policy type in a root.
|
EnableAllFeaturesResult |
enableAllFeatures(EnableAllFeaturesRequest request)
Enables all features in an organization.
|
EnablePolicyTypeResult |
enablePolicyType(EnablePolicyTypeRequest request)
Enables a policy type in a root.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
InviteAccountToOrganizationResult |
inviteAccountToOrganization(InviteAccountToOrganizationRequest request)
Sends an invitation to another account to join your organization as a member account.
|
LeaveOrganizationResult |
leaveOrganization(LeaveOrganizationRequest request)
Removes a member account from its parent organization.
|
ListAccountsResult |
listAccounts(ListAccountsRequest request)
Lists all the accounts in the organization.
|
ListAccountsForParentResult |
listAccountsForParent(ListAccountsForParentRequest request)
Lists the accounts in an organization that are contained by the specified target root or organizational unit
(OU).
|
ListChildrenResult |
listChildren(ListChildrenRequest request)
Lists all of the OUs or accounts that are contained in the specified parent OU or root.
|
ListCreateAccountStatusResult |
listCreateAccountStatus(ListCreateAccountStatusRequest request)
Lists the account creation requests that match the specified status that is currently being tracked for the
organization.
|
ListHandshakesForAccountResult |
listHandshakesForAccount(ListHandshakesForAccountRequest request)
Lists the current handshakes that are associated with the account of the requesting user.
|
ListHandshakesForOrganizationResult |
listHandshakesForOrganization(ListHandshakesForOrganizationRequest request)
Lists the handshakes that are associated with the organization that the requesting user is part of.
|
ListOrganizationalUnitsForParentResult |
listOrganizationalUnitsForParent(ListOrganizationalUnitsForParentRequest request)
Lists the organizational units (OUs) in a parent organizational unit or root.
|
ListParentsResult |
listParents(ListParentsRequest request)
Lists the root or organizational units (OUs) that serve as the immediate parent of the specified child OU or
account.
|
ListPoliciesResult |
listPolicies(ListPoliciesRequest request)
Retrieves the list of all policies in an organization of a specified type.
|
ListPoliciesForTargetResult |
listPoliciesForTarget(ListPoliciesForTargetRequest request)
Lists the policies that are directly attached to the specified target root, organizational unit (OU), or account.
|
ListRootsResult |
listRoots(ListRootsRequest request)
Lists the roots that are defined in the current organization.
|
ListTargetsForPolicyResult |
listTargetsForPolicy(ListTargetsForPolicyRequest request)
Lists all the roots, OUs, and accounts to which the specified policy is attached.
|
MoveAccountResult |
moveAccount(MoveAccountRequest request)
Moves an account from its current source parent root or OU to the specified destination parent root or OU.
|
RemoveAccountFromOrganizationResult |
removeAccountFromOrganization(RemoveAccountFromOrganizationRequest request)
Removes the specified account from the organization.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("organizations.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
AWSOrganizations.setEndpoint(String) , sets the regional endpoint for this client's
service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
UpdateOrganizationalUnitResult |
updateOrganizationalUnit(UpdateOrganizationalUnitRequest request)
Renames the specified organizational unit (OU).
|
UpdatePolicyResult |
updatePolicy(UpdatePolicyRequest request)
Updates an existing policy with a new name, description, or content.
|
public void setEndpoint(String endpoint)
AWSOrganizations
Callers can pass in just the endpoint (ex: "organizations.us-east-1.amazonaws.com") or a full URL, including the
protocol (ex: "organizations.us-east-1.amazonaws.com"). If the protocol is not specified here, the default
protocol from this client's ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint
in interface AWSOrganizations
endpoint
- The endpoint (ex: "organizations.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"organizations.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate
with.public void setRegion(Region region)
AWSOrganizations
AWSOrganizations.setEndpoint(String)
, sets the regional endpoint for this client's
service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion
in interface AWSOrganizations
region
- The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
public AcceptHandshakeResult acceptHandshake(AcceptHandshakeRequest request)
AWSOrganizations
Sends a response to the originator of a handshake agreeing to the action proposed by the handshake request.
This operation can be called only by the following principals when they also have the relevant IAM permissions:
Invitation to join or Approve all features request handshakes: only a principal from the member account.
The user who calls the API for an invitation to join must have the organizations:AcceptHandshake
permission. If you enabled all features in the organization, then the user must also have the
iam:CreateServiceLinkedRole
permission so that Organizations can create the required service-linked
role named OrgsServiceLinkedRoleName. For more information, see AWS Organizations and Service-Linked Roles in the AWS Organizations User Guide.
Enable all features final confirmation handshake: only a principal from the master account.
For more information about invitations, see Inviting an AWS Account to Join Your Organization in the AWS Organizations User Guide. For more information about requests to enable all features in the organization, see Enabling All Features in Your Organization in the AWS Organizations User Guide.
After you accept a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that it is deleted.
acceptHandshake
in interface AWSOrganizations
public AttachPolicyResult attachPolicy(AttachPolicyRequest request)
AWSOrganizations
Attaches a policy to a root, an organizational unit, or an individual account. How the policy affects accounts depends on the type of policy:
Service control policy (SCP) - An SCP specifies what permissions can be delegated to users in affected member accounts. The scope of influence for a policy depends on what you attach the policy to:
If you attach an SCP to a root, it affects all accounts in the organization.
If you attach an SCP to an OU, it affects all accounts in that OU and in any child OUs.
If you attach the policy directly to an account, then it affects only that account.
SCPs essentially are permission "filters". When you attach one SCP to a higher level root or OU, and you also attach a different SCP to a child OU or to an account, the child policy can further restrict only the permissions that pass through the parent filter and are available to the child. An SCP that is attached to a child cannot grant a permission that is not already granted by the parent. For example, imagine that the parent SCP allows permissions A, B, C, D, and E. The child SCP allows C, D, E, F, and G. The result is that the accounts affected by the child SCP are allowed to use only C, D, and E. They cannot use A or B because they were filtered out by the child OU. They also cannot use F and G because they were filtered out by the parent OU. They cannot be granted back by the child SCP; child SCPs can only filter the permissions they receive from the parent SCP.
AWS Organizations attaches a default SCP named "FullAWSAccess
to every root, OU, and account. This
default SCP allows all services and actions, enabling any new child OU or account to inherit the permissions of
the parent root or OU. If you detach the default policy, you must replace it with a policy that specifies the
permissions that you want to allow in that OU or account.
For more information about how Organizations policies permissions work, see Using Service Control Policies in the AWS Organizations User Guide.
This operation can be called only from the organization's master account.
attachPolicy
in interface AWSOrganizations
public CancelHandshakeResult cancelHandshake(CancelHandshakeRequest request)
AWSOrganizations
Cancels a handshake. Canceling a handshake sets the handshake state to CANCELED
.
This operation can be called only from the account that originated the handshake. The recipient of the handshake can't cancel it, but can use DeclineHandshake instead. After a handshake is canceled, the recipient can no longer respond to that handshake.
After you cancel a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that it is deleted.
cancelHandshake
in interface AWSOrganizations
public CreateAccountResult createAccount(CreateAccountRequest request)
AWSOrganizations
Creates an AWS account that is automatically a member of the organization whose credentials made the request.
This is an asynchronous request that AWS performs in the background. If you want to check the status of the
request later, you need the OperationId
response element from this operation to provide as a
parameter to the DescribeCreateAccountStatus operation.
The user who calls the API for an invitation to join must have the organizations:CreateAccount
permission. If you enabled all features in the organization, then the user must also have the
iam:CreateServiceLinkedRole
permission so that Organizations can create the required service-linked
role named OrgsServiceLinkedRoleName. For more information, see AWS Organizations and Service-Linked Roles in the AWS Organizations User Guide.
The user in the master account who calls this API must also have the iam:CreateRole
permission
because AWS Organizations preconfigures the new member account with a role (named
OrganizationAccountAccessRole
) that grants users in the master account administrator permissions in
the new member account. Principals in the master account can assume the role. AWS Organizations clones the
company name and address information for the new account from the organization's master account.
This operation can be called only from the organization's master account.
For more information about creating accounts, see Creating an AWS Account in Your Organization in the AWS Organizations User Guide.
When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required for the account to operate as a standalone account, such as a payment method and signing the End User Licence Agreement (EULA) is not automatically collected. If you must remove an account from your organization later, you can do so only after you provide the missing information. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
When you create a member account with this operation, you can choose whether to create the account with the IAM User and Role Access to Billing Information switch enabled. If you enable it, IAM users and roles that have appropriate permissions can view billing information for the account. If you disable this, then only the account root user can access billing information. For information about how to disable this for an account, see Granting Access to Your Billing Information and Tools.
If you get an exception that indicates that you exceeded your account limits for the organization or that you can"t add an account because your organization is still initializing, please contact AWS Customer Support.
createAccount
in interface AWSOrganizations
public CreateOrganizationResult createOrganization(CreateOrganizationRequest request)
AWSOrganizations
Creates an AWS organization. The account whose user is calling the CreateOrganization operation automatically becomes the master account of the new organization.
This operation must be called using credentials from the account that is to become the new organization's master account. The principal must also have the relevant IAM permissions.
By default (or if you set the FeatureSet
parameter to ALL
), the new organization is
created with all features enabled and service control policies automatically enabled in the root. If you instead
choose to create the organization supporting only the consolidated billing features by setting the
FeatureSet
parameter to CONSOLIDATED_BILLING"
, then no policy types are enabled by
default and you cannot use organization policies.
createOrganization
in interface AWSOrganizations
public CreateOrganizationalUnitResult createOrganizationalUnit(CreateOrganizationalUnitRequest request)
AWSOrganizations
Creates an organizational unit (OU) within a root or parent OU. An OU is a container for accounts that enables you to organize your accounts to apply policies according to your business requirements. The number of levels deep that you can nest OUs is dependent upon the policy types enabled for that root. For service control policies, the limit is five.
For more information about OUs, see Managing Organizational Units in the AWS Organizations User Guide.
This operation can be called only from the organization's master account.
createOrganizationalUnit
in interface AWSOrganizations
public CreatePolicyResult createPolicy(CreatePolicyRequest request)
AWSOrganizations
Creates a policy of a specified type that you can attach to a root, an organizational unit (OU), or an individual AWS account.
For more information about policies and their use, see Managing Organization Policies.
This operation can be called only from the organization's master account.
createPolicy
in interface AWSOrganizations
public DeclineHandshakeResult declineHandshake(DeclineHandshakeRequest request)
AWSOrganizations
Declines a handshake request. This sets the handshake state to DECLINED
and effectively deactivates
the request.
This operation can be called only from the account that received the handshake. The originator of the handshake can use CancelHandshake instead. The originator can't reactivate a declined request, but can re-initiate the process with a new handshake request.
After you decline a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that it is deleted.
declineHandshake
in interface AWSOrganizations
public DeleteOrganizationResult deleteOrganization(DeleteOrganizationRequest request)
AWSOrganizations
Deletes the organization. You can delete an organization only by using credentials from the master account. The organization must be empty of member accounts, OUs, and policies.
deleteOrganization
in interface AWSOrganizations
public DeleteOrganizationalUnitResult deleteOrganizationalUnit(DeleteOrganizationalUnitRequest request)
AWSOrganizations
Deletes an organizational unit from a root or another OU. You must first remove all accounts and child OUs from the OU that you want to delete.
This operation can be called only from the organization's master account.
deleteOrganizationalUnit
in interface AWSOrganizations
public DeletePolicyResult deletePolicy(DeletePolicyRequest request)
AWSOrganizations
Deletes the specified policy from your organization. Before you perform this operation, you must first detach the policy from all OUs, roots, and accounts.
This operation can be called only from the organization's master account.
deletePolicy
in interface AWSOrganizations
public DescribeAccountResult describeAccount(DescribeAccountRequest request)
AWSOrganizations
Retrieves Organizations-related information about the specified account.
This operation can be called only from the organization's master account.
describeAccount
in interface AWSOrganizations
public DescribeCreateAccountStatusResult describeCreateAccountStatus(DescribeCreateAccountStatusRequest request)
AWSOrganizations
Retrieves the current status of an asynchronous request to create an account.
This operation can be called only from the organization's master account.
describeCreateAccountStatus
in interface AWSOrganizations
public DescribeHandshakeResult describeHandshake(DescribeHandshakeRequest request)
AWSOrganizations
Retrieves information about a previously requested handshake. The handshake ID comes from the response to the original InviteAccountToOrganization operation that generated the handshake.
You can access handshakes that are ACCEPTED, DECLINED, or CANCELED for only 30 days after they change to that state. They are then deleted and no longer accessible.
This operation can be called from any account in the organization.
describeHandshake
in interface AWSOrganizations
public DescribeOrganizationResult describeOrganization(DescribeOrganizationRequest request)
AWSOrganizations
Retrieves information about the organization that the user's account belongs to.
This operation can be called from any account in the organization.
describeOrganization
in interface AWSOrganizations
public DescribeOrganizationalUnitResult describeOrganizationalUnit(DescribeOrganizationalUnitRequest request)
AWSOrganizations
Retrieves information about an organizational unit (OU).
This operation can be called only from the organization's master account.
describeOrganizationalUnit
in interface AWSOrganizations
public DescribePolicyResult describePolicy(DescribePolicyRequest request)
AWSOrganizations
Retrieves information about a policy.
This operation can be called only from the organization's master account.
describePolicy
in interface AWSOrganizations
public DetachPolicyResult detachPolicy(DetachPolicyRequest request)
AWSOrganizations
Detaches a policy from a target root, organizational unit, or account. If the policy being detached is a service control policy (SCP), the changes to permissions for IAM users and roles in affected accounts are immediate.
Note: Every root, OU, and account must have at least one SCP attached. If you want to replace the default
FullAWSAccess
policy with one that limits the permissions that can be delegated, then you must
attach the replacement policy before you can remove the default one. This is the authorization strategy of whitelisting. If you instead attach a second SCP and leave the FullAWSAccess
SCP still
attached, and specify "Effect": "Deny"
in the second SCP to override the
"Effect": "Allow"
in the FullAWSAccess
policy (or any other attached SCP), then you are
using the authorization strategy of blacklisting.
This operation can be called only from the organization's master account.
detachPolicy
in interface AWSOrganizations
public DisablePolicyTypeResult disablePolicyType(DisablePolicyTypeRequest request)
AWSOrganizations
Disables an organizational control policy type in a root. A policy of a certain type can be attached to entities in a root only if that type is enabled in the root. After you perform this operation, you no longer can attach policies of the specified type to that root or to any OU or account in that root. You can undo this by using the EnablePolicyType operation.
This operation can be called only from the organization's master account.
disablePolicyType
in interface AWSOrganizations
public EnableAllFeaturesResult enableAllFeatures(EnableAllFeaturesRequest request)
AWSOrganizations
Enables all features in an organization. This enables the use of organization policies that can restrict the services and actions that can be called in each account. Until you enable all features, you have access only to consolidated billing, and you can't use any of the advanced account administration features that AWS Organizations supports. For more information, see Enabling All Features in Your Organization in the AWS Organizations User Guide.
This operation is required only for organizations that were created explicitly with only the consolidated billing features enabled, or that were migrated from a Consolidated Billing account family to Organizations. Calling this operation sends a handshake to every invited account in the organization. The feature set change can be finalized and the additional features enabled only after all administrators in the invited accounts approve the change by accepting the handshake.
After all invited member accounts accept the handshake, you finalize the feature set change by accepting the
handshake that contains "Action": "ENABLE_ALL_FEATURES"
. This completes the change.
After you enable all features in your organization, the master account in the organization can apply policies on all member accounts. These policies can restrict what users and even administrators in those accounts can do. The master account can apply policies that prevent accounts from leaving the organization. Ensure that your account administrators are aware of this.
This operation can be called only from the organization's master account.
enableAllFeatures
in interface AWSOrganizations
public EnablePolicyTypeResult enablePolicyType(EnablePolicyTypeRequest request)
AWSOrganizations
Enables a policy type in a root. After you enable a policy type in a root, you can attach policies of that type to the root, any OU, or account in that root. You can undo this by using the DisablePolicyType operation.
This operation can be called only from the organization's master account.
enablePolicyType
in interface AWSOrganizations
public InviteAccountToOrganizationResult inviteAccountToOrganization(InviteAccountToOrganizationRequest request)
AWSOrganizations
Sends an invitation to another account to join your organization as a member account. Organizations sends email on your behalf to the email address that is associated with the other account's owner. The invitation is implemented as a Handshake whose details are in the response.
You can invite AWS accounts only from the same seller as the master account. For example, if your organization's master account was created by Amazon Internet Services Pvt. Ltd (AISPL), an AWS seller in India, then you can only invite other AISPL accounts to your organization. You can't combine accounts from AISPL and AWS, or any other AWS seller. For more information, see Consolidated Billing in India.
This operation can be called only from the organization's master account.
If you get an exception that indicates that you exceeded your account limits for the organization or that you can"t add an account because your organization is still initializing, please contact AWS Customer Support.
inviteAccountToOrganization
in interface AWSOrganizations
public LeaveOrganizationResult leaveOrganization(LeaveOrganizationRequest request)
AWSOrganizations
Removes a member account from its parent organization. This version of the operation is performed by the account that wants to leave. To remove a member account as a user in the master account, use RemoveAccountFromOrganization instead.
This operation can be called only from a member account in the organization.
The master account in an organization with all features enabled can set service control policies (SCPs) that can
restrict what administrators of member accounts can do, including preventing them from successfully calling
LeaveOrganization
and leaving the organization.
You can leave an organization as a member account only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required of standalone accounts is not automatically collected. For each account that you want to make standalone, you must accept the End User License Agreement (EULA), choose a support plan, provide and verify the required contact information, and provide a current payment method. AWS uses the payment method to charge for any billable (not free tier) AWS activity that occurs while the account is not attached to an organization. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
You can leave an organization only after you enable IAM user access to billing in your account. For more information, see Activating Access to the Billing and Cost Management Console in the AWS Billing and Cost Management User Guide.
leaveOrganization
in interface AWSOrganizations
public ListAccountsResult listAccounts(ListAccountsRequest request)
AWSOrganizations
Lists all the accounts in the organization. To request only the accounts in a root or OU, use the ListAccountsForParent operation instead.
This operation can be called only from the organization's master account.
listAccounts
in interface AWSOrganizations
public ListAccountsForParentResult listAccountsForParent(ListAccountsForParentRequest request)
AWSOrganizations
Lists the accounts in an organization that are contained by the specified target root or organizational unit (OU). If you specify the root, you get a list of all the accounts that are not in any OU. If you specify an OU, you get a list of all the accounts in only that OU, and not in any child OUs. To get a list of all accounts in the organization, use the ListAccounts operation.
This operation can be called only from the organization's master account.
listAccountsForParent
in interface AWSOrganizations
public ListChildrenResult listChildren(ListChildrenRequest request)
AWSOrganizations
Lists all of the OUs or accounts that are contained in the specified parent OU or root. This operation, along with ListParents enables you to traverse the tree structure that makes up this root.
This operation can be called only from the organization's master account.
listChildren
in interface AWSOrganizations
public ListCreateAccountStatusResult listCreateAccountStatus(ListCreateAccountStatusRequest request)
AWSOrganizations
Lists the account creation requests that match the specified status that is currently being tracked for the organization.
This operation can be called only from the organization's master account.
listCreateAccountStatus
in interface AWSOrganizations
public ListHandshakesForAccountResult listHandshakesForAccount(ListHandshakesForAccountRequest request)
AWSOrganizations
Lists the current handshakes that are associated with the account of the requesting user.
Handshakes that are ACCEPTED, DECLINED, or CANCELED appear in the results of this API for only 30 days after changing to that state. After that they are deleted and no longer accessible.
This operation can be called from any account in the organization.
listHandshakesForAccount
in interface AWSOrganizations
public ListHandshakesForOrganizationResult listHandshakesForOrganization(ListHandshakesForOrganizationRequest request)
AWSOrganizations
Lists the handshakes that are associated with the organization that the requesting user is part of. The
ListHandshakesForOrganization
operation returns a list of handshake structures. Each structure
contains details and status about a handshake.
Handshakes that are ACCEPTED, DECLINED, or CANCELED appear in the results of this API for only 30 days after changing to that state. After that they are deleted and no longer accessible.
This operation can be called only from the organization's master account.
listHandshakesForOrganization
in interface AWSOrganizations
public ListOrganizationalUnitsForParentResult listOrganizationalUnitsForParent(ListOrganizationalUnitsForParentRequest request)
AWSOrganizations
Lists the organizational units (OUs) in a parent organizational unit or root.
This operation can be called only from the organization's master account.
listOrganizationalUnitsForParent
in interface AWSOrganizations
public ListParentsResult listParents(ListParentsRequest request)
AWSOrganizations
Lists the root or organizational units (OUs) that serve as the immediate parent of the specified child OU or account. This operation, along with ListChildren enables you to traverse the tree structure that makes up this root.
This operation can be called only from the organization's master account.
In the current release, a child can have only a single parent.
listParents
in interface AWSOrganizations
public ListPoliciesResult listPolicies(ListPoliciesRequest request)
AWSOrganizations
Retrieves the list of all policies in an organization of a specified type.
This operation can be called only from the organization's master account.
listPolicies
in interface AWSOrganizations
public ListPoliciesForTargetResult listPoliciesForTarget(ListPoliciesForTargetRequest request)
AWSOrganizations
Lists the policies that are directly attached to the specified target root, organizational unit (OU), or account. You must specify the policy type that you want included in the returned list.
This operation can be called only from the organization's master account.
listPoliciesForTarget
in interface AWSOrganizations
public ListRootsResult listRoots(ListRootsRequest request)
AWSOrganizations
Lists the roots that are defined in the current organization.
This operation can be called only from the organization's master account.
listRoots
in interface AWSOrganizations
public ListTargetsForPolicyResult listTargetsForPolicy(ListTargetsForPolicyRequest request)
AWSOrganizations
Lists all the roots, OUs, and accounts to which the specified policy is attached.
This operation can be called only from the organization's master account.
listTargetsForPolicy
in interface AWSOrganizations
public MoveAccountResult moveAccount(MoveAccountRequest request)
AWSOrganizations
Moves an account from its current source parent root or OU to the specified destination parent root or OU.
This operation can be called only from the organization's master account.
moveAccount
in interface AWSOrganizations
public RemoveAccountFromOrganizationResult removeAccountFromOrganization(RemoveAccountFromOrganizationRequest request)
AWSOrganizations
Removes the specified account from the organization.
The removed account becomes a stand-alone account that is not a member of any organization. It is no longer subject to any policies and is responsible for its own bill payments. The organization's master account is no longer charged for any expenses accrued by the member account after it is removed from the organization.
This operation can be called only from the organization's master account. Member accounts can remove themselves with LeaveOrganization instead.
You can remove an account from your organization only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required of standalone accounts is not automatically collected. For an account that you want to make standalone, you must accept the End User License Agreement (EULA), choose a support plan, provide and verify the required contact information, and provide a current payment method. AWS uses the payment method to charge for any billable (not free tier) AWS activity that occurs while the account is not attached to an organization. To remove an account that does not yet have this information, you must sign in as the member account and follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
You can remove a member account only after you enable IAM user access to billing in the member account. For more information, see Activating Access to the Billing and Cost Management Console in the AWS Billing and Cost Management User Guide.
removeAccountFromOrganization
in interface AWSOrganizations
public UpdateOrganizationalUnitResult updateOrganizationalUnit(UpdateOrganizationalUnitRequest request)
AWSOrganizations
Renames the specified organizational unit (OU). The ID and ARN do not change. The child OUs and accounts remain in place, and any attached policies of the OU remain attached.
This operation can be called only from the organization's master account.
updateOrganizationalUnit
in interface AWSOrganizations
public UpdatePolicyResult updatePolicy(UpdatePolicyRequest request)
AWSOrganizations
Updates an existing policy with a new name, description, or content. If any parameter is not supplied, that value remains unchanged. Note that you cannot change a policy's type.
This operation can be called only from the organization's master account.
updatePolicy
in interface AWSOrganizations
public void shutdown()
AWSOrganizations
shutdown
in interface AWSOrganizations
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSOrganizations
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AWSOrganizations
request
- The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.