Struct rusoto_organizations::OrganizationsClient

pub struct OrganizationsClient<P, D> where
    P: ProvideAwsCredentials,
    D: DispatchSignedRequest,  { /* fields omitted */ }

A client for the Organizations API.

Methods

impl<P, D> OrganizationsClient<P, D> where
    P: ProvideAwsCredentials,
    D: DispatchSignedRequest, 

fn new(request_dispatcher: D, credentials_provider: P, region: Region) -> Self

Trait Implementations

impl<P, D> Organizations for OrganizationsClient<P, D> where
    P: ProvideAwsCredentials,
    D: DispatchSignedRequest, 

fn accept_handshake(
    &self,
    input: &AcceptHandshakeRequest
) -> Result<AcceptHandshakeResponse, AcceptHandshakeError>

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.

• 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.

fn attach_policy(
    &self,
    input: &AttachPolicyRequest
) -> Result<(), AttachPolicyError>

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.

fn cancel_handshake(
    &self,
    input: &CancelHandshakeRequest
) -> Result<CancelHandshakeResponse, CancelHandshakeError>

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.

fn create_account(
    &self,
    input: &CreateAccountRequest
) -> Result<CreateAccountResponse, CreateAccountError>

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.

AWS Organizations preconfigures the new member account with a role (named OrganizationAccountAccessRole by default) that grants administrator permissions to the new 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.

For more information about creating accounts, see Creating an AWS Account in Your Organization in the AWS Organizations User Guide.

You cannot remove accounts that are created with this operation from an organization. That also means that you cannot delete an organization that contains an account that is created with this operation.

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.

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

fn create_organization(
    &self,
    input: &CreateOrganizationRequest
) -> Result<CreateOrganizationResponse, CreateOrganizationError>

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.

fn create_organizational_unit(
    &self,
    input: &CreateOrganizationalUnitRequest
) -> Result<CreateOrganizationalUnitResponse, CreateOrganizationalUnitError>

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.

fn create_policy(
    &self,
    input: &CreatePolicyRequest
) -> Result<CreatePolicyResponse, CreatePolicyError>

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.

fn decline_handshake(
    &self,
    input: &DeclineHandshakeRequest
) -> Result<DeclineHandshakeResponse, DeclineHandshakeError>

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.

fn delete_organization(&self) -> Result<(), DeleteOrganizationError>

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.

If you create any accounts using Organizations operations or the Organizations console, you can't remove those accounts from the organization, which means that you can't delete the organization.

fn delete_organizational_unit(
    &self,
    input: &DeleteOrganizationalUnitRequest
) -> Result<(), DeleteOrganizationalUnitError>

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.

fn delete_policy(
    &self,
    input: &DeletePolicyRequest
) -> Result<(), DeletePolicyError>

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.

fn describe_account(
    &self,
    input: &DescribeAccountRequest
) -> Result<DescribeAccountResponse, DescribeAccountError>

Retrieves Organizations-related information about the specified account.

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

fn describe_create_account_status(
    &self,
    input: &DescribeCreateAccountStatusRequest
) -> Result<DescribeCreateAccountStatusResponse, DescribeCreateAccountStatusError>

Retrieves the current status of an asynchronous request to create an account.

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

fn describe_handshake(
    &self,
    input: &DescribeHandshakeRequest
) -> Result<DescribeHandshakeResponse, DescribeHandshakeError>

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.

fn describe_organization(
    &self
) -> Result<DescribeOrganizationResponse, DescribeOrganizationError>

Retrieves information about the organization that the user's account belongs to.

This operation can be called from any account in the organization.

fn describe_organizational_unit(
    &self,
    input: &DescribeOrganizationalUnitRequest
) -> Result<DescribeOrganizationalUnitResponse, DescribeOrganizationalUnitError>

Retrieves information about an organizational unit (OU).

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

fn describe_policy(
    &self,
    input: &DescribePolicyRequest
) -> Result<DescribePolicyResponse, DescribePolicyError>

Retrieves information about a policy.

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

fn detach_policy(
    &self,
    input: &DetachPolicyRequest
) -> Result<(), DetachPolicyError>

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.

fn disable_policy_type(
    &self,
    input: &DisablePolicyTypeRequest
) -> Result<DisablePolicyTypeResponse, DisablePolicyTypeError>

Disables an organizational control policy type in a root. A poicy 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.

fn enable_all_features(
    &self
) -> Result<EnableAllFeaturesResponse, EnableAllFeaturesError>

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.

fn enable_policy_type(
    &self,
    input: &EnablePolicyTypeRequest
) -> Result<EnablePolicyTypeResponse, EnablePolicyTypeError>

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.

fn invite_account_to_organization(
    &self,
    input: &InviteAccountToOrganizationRequest
) -> Result<InviteAccountToOrganizationResponse, InviteAccountToOrganizationError>

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 reseller as the master account. For example, if your organization's master account was created by Amazon Internet Services Pvt. Ltd (AISPL), an AWS reseller in India, then you can only invite other AISPL accounts to your organization. You can't combine accounts from AISPL and AWS. For more information, see Consolidated Billing in India.

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

fn leave_organization(&self) -> Result<(), LeaveOrganizationError>

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.

• If you created the account using the AWS Organizations console, the Organizations API, or the Organizations CLI commands, then you cannot remove the account.

• 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.

fn list_accounts(
    &self,
    input: &ListAccountsRequest
) -> Result<ListAccountsResponse, ListAccountsError>

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.

fn list_accounts_for_parent(
    &self,
    input: &ListAccountsForParentRequest
) -> Result<ListAccountsForParentResponse, ListAccountsForParentError>

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.

fn list_children(
    &self,
    input: &ListChildrenRequest
) -> Result<ListChildrenResponse, ListChildrenError>

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.

fn list_create_account_status(
    &self,
    input: &ListCreateAccountStatusRequest
) -> Result<ListCreateAccountStatusResponse, ListCreateAccountStatusError>

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.

fn list_handshakes_for_account(
    &self,
    input: &ListHandshakesForAccountRequest
) -> Result<ListHandshakesForAccountResponse, ListHandshakesForAccountError>

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.

fn list_handshakes_for_organization(
    &self,
    input: &ListHandshakesForOrganizationRequest
) -> Result<ListHandshakesForOrganizationResponse, ListHandshakesForOrganizationError>

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.

fn list_organizational_units_for_parent(
    &self,
    input: &ListOrganizationalUnitsForParentRequest
) -> Result<ListOrganizationalUnitsForParentResponse, ListOrganizationalUnitsForParentError>

Lists the organizational units (OUs) in a parent organizational unit or root.

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

fn list_parents(
    &self,
    input: &ListParentsRequest
) -> Result<ListParentsResponse, ListParentsError>

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.

fn list_policies(
    &self,
    input: &ListPoliciesRequest
) -> Result<ListPoliciesResponse, ListPoliciesError>

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.

fn list_policies_for_target(
    &self,
    input: &ListPoliciesForTargetRequest
) -> Result<ListPoliciesForTargetResponse, ListPoliciesForTargetError>

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.

fn list_roots(
    &self,
    input: &ListRootsRequest
) -> Result<ListRootsResponse, ListRootsError>

Lists the roots that are defined in the current organization.

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

fn list_targets_for_policy(
    &self,
    input: &ListTargetsForPolicyRequest
) -> Result<ListTargetsForPolicyResponse, ListTargetsForPolicyError>

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.

fn move_account(
    &self,
    input: &MoveAccountRequest
) -> Result<(), MoveAccountError>

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.

fn remove_account_from_organization(
    &self,
    input: &RemoveAccountFromOrganizationRequest
) -> Result<(), RemoveAccountFromOrganizationError>

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 only accounts that were created outside your organization and invited to join. If you created the account using the AWS Organizations console, the Organizations API, or the Organizations CLI commands, then you cannot remove the account.

• 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.

fn update_organizational_unit(
    &self,
    input: &UpdateOrganizationalUnitRequest
) -> Result<UpdateOrganizationalUnitResponse, UpdateOrganizationalUnitError>

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.

fn update_policy(
    &self,
    input: &UpdatePolicyRequest
) -> Result<UpdatePolicyResponse, UpdatePolicyError>

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.