Struct aws_sdk_organizations::client::Client

pub struct Client { /* private fields */ }

Client for AWS Organizations

Client for invoking operations on AWS Organizations. Each operation on AWS Organizations is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_organizations::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_organizations::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the AcceptHandshake operation has a Client::accept_handshake, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.accept_handshake()
    .handshake_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn accept_handshake(&self) -> AcceptHandshakeFluentBuilder

Constructs a fluent builder for the AcceptHandshake operation.

• The fluent builder is configurable:
  • handshake_id(impl Into<String>) / set_handshake_id(Option<String>):
    required: true
    

    The unique identifier (ID) of the handshake that you want to accept.

    The regex pattern for handshake ID string requires “h-” followed by from 8 to 32 lowercase letters or digits.

    
    
• On success, responds with AcceptHandshakeOutput with field(s):
  • handshake(Option<Handshake>):

    A structure that contains details about the accepted handshake.

• On failure, responds with SdkError<AcceptHandshakeError>

impl Client

pub fn attach_policy(&self) -> AttachPolicyFluentBuilder

Constructs a fluent builder for the AttachPolicy operation.

• The fluent builder is configurable:
  • policy_id(impl Into<String>) / set_policy_id(Option<String>):
    required: true
    

    The unique identifier (ID) of the policy that you want to attach to the target. You can get the ID for the policy by calling the ListPolicies operation.

    The regex pattern for a policy ID string requires “p-” followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).

    
    
  • target_id(impl Into<String>) / set_target_id(Option<String>):
    required: true
    

    The unique identifier (ID) of the root, OU, or account that you want to attach the policy to. You can get the ID by calling the ListRoots, ListOrganizationalUnitsForParent, or ListAccounts operations.

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

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

    • Account - A string that consists of exactly 12 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.

    
    
• On success, responds with AttachPolicyOutput
• On failure, responds with SdkError<AttachPolicyError>

impl Client

pub fn cancel_handshake(&self) -> CancelHandshakeFluentBuilder

Constructs a fluent builder for the CancelHandshake operation.

• The fluent builder is configurable:
  • handshake_id(impl Into<String>) / set_handshake_id(Option<String>):
    required: true
    

    The unique identifier (ID) of the handshake that you want to cancel. You can get the ID from the ListHandshakesForOrganization operation.

    The regex pattern for handshake ID string requires “h-” followed by from 8 to 32 lowercase letters or digits.

    
    
• On success, responds with CancelHandshakeOutput with field(s):
  • handshake(Option<Handshake>):

    A structure that contains details about the handshake that you canceled.

• On failure, responds with SdkError<CancelHandshakeError>

impl Client

pub fn close_account(&self) -> CloseAccountFluentBuilder

Constructs a fluent builder for the CloseAccount operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    Retrieves the Amazon Web Services account Id for the current CloseAccount API request.

    
    
• On success, responds with CloseAccountOutput
• On failure, responds with SdkError<CloseAccountError>

impl Client

pub fn create_account(&self) -> CreateAccountFluentBuilder

Constructs a fluent builder for the CreateAccount operation.

• The fluent builder is configurable:
  • email(impl Into<String>) / set_email(Option<String>):
    required: true
    

    The email address of the owner to assign to the new member account. This email address must not already be associated with another Amazon Web Services account. You must use a valid email address to complete account creation.

    The rules for a valid email address:

    • The address must be a minimum of 6 and a maximum of 64 characters long.

    • All characters must be 7-bit ASCII characters.

    • There must be one and only one @ symbol, which separates the local name from the domain name.

    • The local name can’t contain any of the following characters:

      whitespace, “ ’ ( ) < > [ ] : ; , \ | % &

    • The local name can’t begin with a dot (.)

    • The domain name can consist of only the characters [a-z],[A-Z],[0-9], hyphen (-), or dot (.)

    • The domain name can’t begin or end with a hyphen (-) or dot (.)

    • The domain name must contain at least one dot

    You can’t access the root user of the account or remove an account that was created with an invalid email address.

    
    
  • account_name(impl Into<String>) / set_account_name(Option<String>):
    required: true
    

    The friendly name of the member account.

    
    
  • role_name(impl Into<String>) / set_role_name(Option<String>):
    required: false
    

    The name of an IAM role that Organizations automatically preconfigures in the new member account. This role trusts the management account, allowing users in the management account to assume the role, as permitted by the management account administrator. The role has administrator permissions in the new member account.

    If you don’t specify this parameter, the role name defaults to OrganizationAccountAccessRole.

    For more information about how to use this role to access the member account, see the following links:

    • Creating the OrganizationAccountAccessRole in an invited member account in the Organizations User Guide

    • Steps 2 and 3 in IAM Tutorial: Delegate access across Amazon Web Services accounts using IAM roles in the IAM User Guide

    The regex pattern that is used to validate this parameter. The pattern can include uppercase letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@-

    
    
  • iam_user_access_to_billing(IamUserAccessToBilling) / set_iam_user_access_to_billing(Option<IamUserAccessToBilling>):
    required: false
    

    If set to ALLOW, the new account enables IAM users to access account billing information if they have the required permissions. If set to DENY, only the root user of the new account can access account billing information. For more information, see About IAM access to the Billing and Cost Management console in the Amazon Web Services Billing and Cost Management User Guide.

    If you don’t specify this parameter, the value defaults to ALLOW, and IAM users and roles with the required permissions can access billing information for the new account.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of tags that you want to attach to the newly created account. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can’t set it to null. For more information about tagging, see Tagging Organizations resources in the Organizations User Guide.

    If any one of the tags is not valid or if you exceed the maximum allowed number of tags for an account, then the entire request fails and the account is not created.

    
    
• On success, responds with CreateAccountOutput with field(s):
  • create_account_status(Option<CreateAccountStatus>):

    A structure that contains details about the request to create an account. This response structure might not be fully populated when you first receive it because account creation is an asynchronous process. You can pass the returned CreateAccountStatus ID as a parameter to DescribeCreateAccountStatus to get status about the progress of the request at later times. You can also check the CloudTrail log for the CreateAccountResult event. For more information, see Logging and monitoring in Organizations in the Organizations User Guide.

• On failure, responds with SdkError<CreateAccountError>

impl Client

pub fn create_gov_cloud_account(&self) -> CreateGovCloudAccountFluentBuilder

Constructs a fluent builder for the CreateGovCloudAccount operation.

• The fluent builder is configurable:
  • email(impl Into<String>) / set_email(Option<String>):
    required: true
    

    Specifies the email address of the owner to assign to the new member account in the commercial Region. This email address must not already be associated with another Amazon Web Services account. You must use a valid email address to complete account creation.

    The rules for a valid email address:

    • The address must be a minimum of 6 and a maximum of 64 characters long.

    • All characters must be 7-bit ASCII characters.

    • There must be one and only one @ symbol, which separates the local name from the domain name.

    • The local name can’t contain any of the following characters:

      whitespace, “ ’ ( ) < > [ ] : ; , \ | % &

    • The local name can’t begin with a dot (.)

    • The domain name can consist of only the characters [a-z],[A-Z],[0-9], hyphen (-), or dot (.)

    • The domain name can’t begin or end with a hyphen (-) or dot (.)

    • The domain name must contain at least one dot

    You can’t access the root user of the account or remove an account that was created with an invalid email address. Like all request parameters for CreateGovCloudAccount, the request for the email address for the Amazon Web Services GovCloud (US) account originates from the commercial Region, not from the Amazon Web Services GovCloud (US) Region.

    
    
  • account_name(impl Into<String>) / set_account_name(Option<String>):
    required: true
    

    The friendly name of the member account.

    The account name can consist of only the characters [a-z],[A-Z],[0-9], hyphen (-), or dot (.) You can’t separate characters with a dash (–).

    
    
  • role_name(impl Into<String>) / set_role_name(Option<String>):
    required: false
    

    (Optional)

    The name of an IAM role that Organizations automatically preconfigures in the new member accounts in both the Amazon Web Services GovCloud (US) Region and in the commercial Region. This role trusts the management account, allowing users in the management account to assume the role, as permitted by the management account administrator. The role has administrator permissions in the new member account.

    If you don’t specify this parameter, the role name defaults to OrganizationAccountAccessRole.

    For more information about how to use this role to access the member account, see the following links:

    • Creating the OrganizationAccountAccessRole in an invited member account in the Organizations User Guide

    • Steps 2 and 3 in IAM Tutorial: Delegate access across Amazon Web Services accounts using IAM roles in the IAM User Guide

    The regex pattern that is used to validate this parameter. The pattern can include uppercase letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@-

    
    
  • iam_user_access_to_billing(IamUserAccessToBilling) / set_iam_user_access_to_billing(Option<IamUserAccessToBilling>):
    required: false
    

    If set to ALLOW, the new linked account in the commercial Region enables IAM users to access account billing information if they have the required permissions. If set to DENY, only the root user of the new account can access account billing information. For more information, see About IAM access to the Billing and Cost Management console in the Amazon Web Services Billing and Cost Management User Guide.

    If you don’t specify this parameter, the value defaults to ALLOW, and IAM users and roles with the required permissions can access billing information for the new account.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of tags that you want to attach to the newly created account. These tags are attached to the commercial account associated with the GovCloud account, and not to the GovCloud account itself. To add tags to the actual GovCloud account, call the TagResource operation in the GovCloud region after the new GovCloud account exists.

    For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can’t set it to null. For more information about tagging, see Tagging Organizations resources in the Organizations User Guide.

    If any one of the tags is not valid or if you exceed the maximum allowed number of tags for an account, then the entire request fails and the account is not created.

    
    
• On success, responds with CreateGovCloudAccountOutput with field(s):
  • create_account_status(Option<CreateAccountStatus>):

    Contains the status about a CreateAccount or CreateGovCloudAccount request to create an Amazon Web Services account or an Amazon Web Services GovCloud (US) account in an organization.

• On failure, responds with SdkError<CreateGovCloudAccountError>

impl Client

pub fn create_organization(&self) -> CreateOrganizationFluentBuilder

Constructs a fluent builder for the CreateOrganization operation.

• The fluent builder is configurable:
  • feature_set(OrganizationFeatureSet) / set_feature_set(Option<OrganizationFeatureSet>):
    required: false
    

    Specifies the feature set supported by the new organization. Each feature set supports different levels of functionality.

    • CONSOLIDATED_BILLING: All member accounts have their bills consolidated to and paid by the management account. For more information, see Consolidated billing in the Organizations User Guide.

      The consolidated billing feature subset isn’t available for organizations in the Amazon Web Services GovCloud (US) Region.

    • ALL: In addition to all the features supported by the consolidated billing feature set, the management account can also apply any policy type to any member account in the organization. For more information, see All features in the Organizations User Guide.

    
    
• On success, responds with CreateOrganizationOutput with field(s):
  • organization(Option<Organization>):

    A structure that contains details about the newly created organization.

• On failure, responds with SdkError<CreateOrganizationError>

impl Client

pub fn create_organizational_unit( &self ) -> CreateOrganizationalUnitFluentBuilder

Constructs a fluent builder for the CreateOrganizationalUnit operation.

• The fluent builder is configurable:
  • parent_id(impl Into<String>) / set_parent_id(Option<String>):
    required: true
    

    The unique identifier (ID) of the parent root or OU that you want to create the new OU in.

    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.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The friendly name to assign to the new OU.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of tags that you want to attach to the newly created OU. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can’t set it to null. For more information about tagging, see Tagging Organizations resources in the Organizations User Guide.

    If any one of the tags is not valid or if you exceed the allowed number of tags for an OU, then the entire request fails and the OU is not created.

    
    
• On success, responds with CreateOrganizationalUnitOutput with field(s):
  • organizational_unit(Option<OrganizationalUnit>):

    A structure that contains details about the newly created OU.

• On failure, responds with SdkError<CreateOrganizationalUnitError>

impl Client

pub fn create_policy(&self) -> CreatePolicyFluentBuilder

Constructs a fluent builder for the CreatePolicy operation.

• The fluent builder is configurable:
  • content(impl Into<String>) / set_content(Option<String>):
    required: true
    

    The policy text content to add to the new policy. The text that you supply must adhere to the rules of the policy type you specify in the Type parameter.

    The maximum size of a policy document depends on the policy’s type. For more information, see Maximum and minimum values in the Organizations User Guide.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: true
    

    An optional description to assign to the policy.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The friendly name to assign to the policy.

    The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.

    
    
  • r#type(PolicyType) / set_type(Option<PolicyType>):
    required: true
    

    The type of policy to create. You can specify one of the following values:

    • AISERVICES_OPT_OUT_POLICY

    • BACKUP_POLICY

    • SERVICE_CONTROL_POLICY

    • TAG_POLICY

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of tags that you want to attach to the newly created policy. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can’t set it to null. For more information about tagging, see Tagging Organizations resources in the Organizations User Guide.

    If any one of the tags is not valid or if you exceed the allowed number of tags for a policy, then the entire request fails and the policy is not created.

    
    
• On success, responds with CreatePolicyOutput with field(s):
  • policy(Option<Policy>):

    A structure that contains details about the newly created policy.

• On failure, responds with SdkError<CreatePolicyError>

impl Client

pub fn decline_handshake(&self) -> DeclineHandshakeFluentBuilder

Constructs a fluent builder for the DeclineHandshake operation.

• The fluent builder is configurable:
  • handshake_id(impl Into<String>) / set_handshake_id(Option<String>):
    required: true
    

    The unique identifier (ID) of the handshake that you want to decline. You can get the ID from the ListHandshakesForAccount operation.

    The regex pattern for handshake ID string requires “h-” followed by from 8 to 32 lowercase letters or digits.

    
    
• On success, responds with DeclineHandshakeOutput with field(s):
  • handshake(Option<Handshake>):

    A structure that contains details about the declined handshake. The state is updated to show the value DECLINED.

• On failure, responds with SdkError<DeclineHandshakeError>

impl Client

pub fn delete_organization(&self) -> DeleteOrganizationFluentBuilder

Constructs a fluent builder for the DeleteOrganization operation.

• The fluent builder takes no input, just send it.
• On success, responds with DeleteOrganizationOutput
• On failure, responds with SdkError<DeleteOrganizationError>

impl Client

pub fn delete_organizational_unit( &self ) -> DeleteOrganizationalUnitFluentBuilder

Constructs a fluent builder for the DeleteOrganizationalUnit operation.

• The fluent builder is configurable:
  • organizational_unit_id(impl Into<String>) / set_organizational_unit_id(Option<String>):
    required: true
    

    The unique identifier (ID) of the organizational unit that you want to delete. You can get the ID from the ListOrganizationalUnitsForParent operation.

    The regex pattern for an organizational unit ID string requires “ou-” followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second “-” dash and from 8 to 32 additional lowercase letters or digits.

    
    
• On success, responds with DeleteOrganizationalUnitOutput
• On failure, responds with SdkError<DeleteOrganizationalUnitError>

impl Client

pub fn delete_policy(&self) -> DeletePolicyFluentBuilder

Constructs a fluent builder for the DeletePolicy operation.

• The fluent builder is configurable:
  • policy_id(impl Into<String>) / set_policy_id(Option<String>):
    required: true
    

    The unique identifier (ID) of the policy that you want to delete. You can get the ID from the ListPolicies or ListPoliciesForTarget operations.

    The regex pattern for a policy ID string requires “p-” followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).

    
    
• On success, responds with DeletePolicyOutput
• On failure, responds with SdkError<DeletePolicyError>

impl Client

pub fn delete_resource_policy(&self) -> DeleteResourcePolicyFluentBuilder

Constructs a fluent builder for the DeleteResourcePolicy operation.

• The fluent builder takes no input, just send it.
• On success, responds with DeleteResourcePolicyOutput
• On failure, responds with SdkError<DeleteResourcePolicyError>

impl Client

pub fn deregister_delegated_administrator( &self ) -> DeregisterDelegatedAdministratorFluentBuilder

Constructs a fluent builder for the DeregisterDelegatedAdministrator operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The account ID number of the member account in the organization that you want to deregister as a delegated administrator.

    
    
  • service_principal(impl Into<String>) / set_service_principal(Option<String>):
    required: true
    

    The service principal name of an Amazon Web Services service for which the account is a delegated administrator.

    Delegated administrator privileges are revoked for only the specified Amazon Web Services service from the member account. If the specified service is the only service for which the member account is a delegated administrator, the operation also revokes Organizations read action permissions.

    
    
• On success, responds with DeregisterDelegatedAdministratorOutput
• On failure, responds with SdkError<DeregisterDelegatedAdministratorError>

impl Client

pub fn describe_account(&self) -> DescribeAccountFluentBuilder

Constructs a fluent builder for the DescribeAccount operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The unique identifier (ID) of the Amazon Web Services account that you want information about. You can get the ID from the ListAccounts or ListAccountsForParent operations.

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

    
    
• On success, responds with DescribeAccountOutput with field(s):
  • account(Option<Account>):

    A structure that contains information about the requested account.

• On failure, responds with SdkError<DescribeAccountError>

impl Client

pub fn describe_create_account_status( &self ) -> DescribeCreateAccountStatusFluentBuilder

Constructs a fluent builder for the DescribeCreateAccountStatus operation.

• The fluent builder is configurable:
  • create_account_request_id(impl Into<String>) / set_create_account_request_id(Option<String>):
    required: true
    

    Specifies the Id value that uniquely identifies the CreateAccount request. You can get the value from the CreateAccountStatus.Id response in an earlier CreateAccount request, or from the ListCreateAccountStatus operation.

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

    
    
• On success, responds with DescribeCreateAccountStatusOutput with field(s):
  • create_account_status(Option<CreateAccountStatus>):

    A structure that contains the current status of an account creation request.

• On failure, responds with SdkError<DescribeCreateAccountStatusError>

impl Client

pub fn describe_effective_policy(&self) -> DescribeEffectivePolicyFluentBuilder

Constructs a fluent builder for the DescribeEffectivePolicy operation.

• The fluent builder is configurable:
  • policy_type(EffectivePolicyType) / set_policy_type(Option<EffectivePolicyType>):
    required: true
    

    The type of policy that you want information about. You can specify one of the following values:

    • AISERVICES_OPT_OUT_POLICY

    • BACKUP_POLICY

    • TAG_POLICY

    
    
  • target_id(impl Into<String>) / set_target_id(Option<String>):
    required: false
    

    When you’re signed in as the management account, specify the ID of the account that you want details about. Specifying an organization root or organizational unit (OU) as the target is not supported.

    
    
• On success, responds with DescribeEffectivePolicyOutput with field(s):
  • effective_policy(Option<EffectivePolicy>):

    The contents of the effective policy.

• On failure, responds with SdkError<DescribeEffectivePolicyError>

impl Client

pub fn describe_handshake(&self) -> DescribeHandshakeFluentBuilder

Constructs a fluent builder for the DescribeHandshake operation.

• The fluent builder is configurable:
  • handshake_id(impl Into<String>) / set_handshake_id(Option<String>):
    required: true
    

    The unique identifier (ID) of the handshake that you want information about. You can get the ID from the original call to InviteAccountToOrganization, or from a call to ListHandshakesForAccount or ListHandshakesForOrganization.

    The regex pattern for handshake ID string requires “h-” followed by from 8 to 32 lowercase letters or digits.

    
    
• On success, responds with DescribeHandshakeOutput with field(s):
  • handshake(Option<Handshake>):

    A structure that contains information about the specified handshake.

• On failure, responds with SdkError<DescribeHandshakeError>

impl Client

pub fn describe_organization(&self) -> DescribeOrganizationFluentBuilder

Constructs a fluent builder for the DescribeOrganization operation.

• The fluent builder takes no input, just send it.
• On success, responds with DescribeOrganizationOutput with field(s):
  • organization(Option<Organization>):

    A structure that contains information about the organization.

    The AvailablePolicyTypes part of the response is deprecated, and you shouldn’t use it in your apps. It doesn’t include any policy type supported by Organizations other than SCPs. To determine which policy types are enabled in your organization, use the ListRoots operation.

• On failure, responds with SdkError<DescribeOrganizationError>

impl Client

pub fn describe_organizational_unit( &self ) -> DescribeOrganizationalUnitFluentBuilder

Constructs a fluent builder for the DescribeOrganizationalUnit operation.

• The fluent builder is configurable:
  • organizational_unit_id(impl Into<String>) / set_organizational_unit_id(Option<String>):
    required: true
    

    The unique identifier (ID) of the organizational unit that you want details about. You can get the ID from the ListOrganizationalUnitsForParent operation.

    The regex pattern for an organizational unit ID string requires “ou-” followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second “-” dash and from 8 to 32 additional lowercase letters or digits.

    
    
• On success, responds with DescribeOrganizationalUnitOutput with field(s):
  • organizational_unit(Option<OrganizationalUnit>):

    A structure that contains details about the specified OU.

• On failure, responds with SdkError<DescribeOrganizationalUnitError>

impl Client

pub fn describe_policy(&self) -> DescribePolicyFluentBuilder

Constructs a fluent builder for the DescribePolicy operation.

• The fluent builder is configurable:
  • policy_id(impl Into<String>) / set_policy_id(Option<String>):
    required: true
    

    The unique identifier (ID) of the policy that you want details about. You can get the ID from the ListPolicies or ListPoliciesForTarget operations.

    The regex pattern for a policy ID string requires “p-” followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).

    
    
• On success, responds with DescribePolicyOutput with field(s):
  • policy(Option<Policy>):

    A structure that contains details about the specified policy.

• On failure, responds with SdkError<DescribePolicyError>

impl Client

pub fn describe_resource_policy(&self) -> DescribeResourcePolicyFluentBuilder

Constructs a fluent builder for the DescribeResourcePolicy operation.

• The fluent builder takes no input, just send it.
• On success, responds with DescribeResourcePolicyOutput with field(s):
  • resource_policy(Option<ResourcePolicy>):

    A structure that contains details about the resource policy.

• On failure, responds with SdkError<DescribeResourcePolicyError>

impl Client

pub fn detach_policy(&self) -> DetachPolicyFluentBuilder

Constructs a fluent builder for the DetachPolicy operation.

• The fluent builder is configurable:
  • policy_id(impl Into<String>) / set_policy_id(Option<String>):
    required: true
    

    The unique identifier (ID) of the policy you want to detach. You can get the ID from the ListPolicies or ListPoliciesForTarget operations.

    The regex pattern for a policy ID string requires “p-” followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).

    
    
  • target_id(impl Into<String>) / set_target_id(Option<String>):
    required: true
    

    The unique identifier (ID) of the root, OU, or account that you want to detach the policy from. You can get the ID from the ListRoots, ListOrganizationalUnitsForParent, or ListAccounts operations.

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

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

    • Account - A string that consists of exactly 12 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.

    
    
• On success, responds with DetachPolicyOutput
• On failure, responds with SdkError<DetachPolicyError>

impl Client

pub fn disable_aws_service_access(&self) -> DisableAWSServiceAccessFluentBuilder

Constructs a fluent builder for the DisableAWSServiceAccess operation.

• The fluent builder is configurable:
  • service_principal(impl Into<String>) / set_service_principal(Option<String>):
    required: true
    

    The service principal name of the Amazon Web Services service for which you want to disable integration with your organization. This is typically in the form of a URL, such as service-abbreviation.amazonaws.com.

    
    
• On success, responds with DisableAwsServiceAccessOutput
• On failure, responds with SdkError<DisableAWSServiceAccessError>

impl Client

pub fn disable_policy_type(&self) -> DisablePolicyTypeFluentBuilder

Constructs a fluent builder for the DisablePolicyType operation.

• The fluent builder is configurable:
  • root_id(impl Into<String>) / set_root_id(Option<String>):
    required: true
    

    The unique identifier (ID) of the root in which you want to disable a policy type. You can get the ID from the ListRoots operation.

    The regex pattern for a root ID string requires “r-” followed by from 4 to 32 lowercase letters or digits.

    
    
  • policy_type(PolicyType) / set_policy_type(Option<PolicyType>):
    required: true
    

    The policy type that you want to disable in this root. You can specify one of the following values:

    • AISERVICES_OPT_OUT_POLICY

    • BACKUP_POLICY

    • SERVICE_CONTROL_POLICY

    • TAG_POLICY

    
    
• On success, responds with DisablePolicyTypeOutput with field(s):
  • root(Option<Root>):

    A structure that shows the root with the updated list of enabled policy types.

• On failure, responds with SdkError<DisablePolicyTypeError>

impl Client

pub fn enable_all_features(&self) -> EnableAllFeaturesFluentBuilder

Constructs a fluent builder for the EnableAllFeatures operation.

• The fluent builder takes no input, just send it.
• On success, responds with EnableAllFeaturesOutput with field(s):
  • handshake(Option<Handshake>):

    A structure that contains details about the handshake created to support this request to enable all features in the organization.

• On failure, responds with SdkError<EnableAllFeaturesError>

impl Client

pub fn enable_aws_service_access(&self) -> EnableAWSServiceAccessFluentBuilder

Constructs a fluent builder for the EnableAWSServiceAccess operation.

• The fluent builder is configurable:
  • service_principal(impl Into<String>) / set_service_principal(Option<String>):
    required: true
    

    The service principal name of the Amazon Web Services service for which you want to enable integration with your organization. This is typically in the form of a URL, such as service-abbreviation.amazonaws.com.

    
    
• On success, responds with EnableAwsServiceAccessOutput
• On failure, responds with SdkError<EnableAWSServiceAccessError>

impl Client

pub fn enable_policy_type(&self) -> EnablePolicyTypeFluentBuilder

Constructs a fluent builder for the EnablePolicyType operation.

• The fluent builder is configurable:
  • root_id(impl Into<String>) / set_root_id(Option<String>):
    required: true
    

    The unique identifier (ID) of the root in which you want to enable a policy type. You can get the ID from the ListRoots operation.

    The regex pattern for a root ID string requires “r-” followed by from 4 to 32 lowercase letters or digits.

    
    
  • policy_type(PolicyType) / set_policy_type(Option<PolicyType>):
    required: true
    

    The policy type that you want to enable. You can specify one of the following values:

    • AISERVICES_OPT_OUT_POLICY

    • BACKUP_POLICY

    • SERVICE_CONTROL_POLICY

    • TAG_POLICY

    
    
• On success, responds with EnablePolicyTypeOutput with field(s):
  • root(Option<Root>):

    A structure that shows the root with the updated list of enabled policy types.

• On failure, responds with SdkError<EnablePolicyTypeError>

impl Client

pub fn invite_account_to_organization( &self ) -> InviteAccountToOrganizationFluentBuilder

Constructs a fluent builder for the InviteAccountToOrganization operation.

• The fluent builder is configurable:
  • target(HandshakeParty) / set_target(Option<HandshakeParty>):
    required: true
    

    The identifier (ID) of the Amazon Web Services account that you want to invite to join your organization. This is a JSON object that contains the following elements:

    { “Type”: “ACCOUNT”, “Id”: “< account id number >” }

    If you use the CLI, you can submit this as a single string, similar to the following example:

    –target Id=123456789012,Type=ACCOUNT

    If you specify “Type”: “ACCOUNT”, you must provide the Amazon Web Services account ID number as the Id. If you specify “Type”: “EMAIL”, you must specify the email address that is associated with the account.

    –target Id=diego@example.com,Type=EMAIL

    
    
  • notes(impl Into<String>) / set_notes(Option<String>):
    required: false
    

    Additional information that you want to include in the generated email to the recipient account owner.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of tags that you want to attach to the account when it becomes a member of the organization. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can’t set it to null. For more information about tagging, see Tagging Organizations resources in the Organizations User Guide.

    Any tags in the request are checked for compliance with any applicable tag policies when the request is made. The request is rejected if the tags in the request don’t match the requirements of the policy at that time. Tag policy compliance is not checked again when the invitation is accepted and the tags are actually attached to the account. That means that if the tag policy changes between the invitation and the acceptance, then that tags could potentially be non-compliant.

    If any one of the tags is not valid or if you exceed the allowed number of tags for an account, then the entire request fails and invitations are not sent.

    
    
• On success, responds with InviteAccountToOrganizationOutput with field(s):
  • handshake(Option<Handshake>):

    A structure that contains details about the handshake that is created to support this invitation request.

• On failure, responds with SdkError<InviteAccountToOrganizationError>

impl Client

pub fn leave_organization(&self) -> LeaveOrganizationFluentBuilder

Constructs a fluent builder for the LeaveOrganization operation.

• The fluent builder takes no input, just send it.
• On success, responds with LeaveOrganizationOutput
• On failure, responds with SdkError<LeaveOrganizationError>

impl Client

pub fn list_accounts(&self) -> ListAccountsFluentBuilder

Constructs a fluent builder for the ListAccounts operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call’s NextToken response to indicate where the output should continue from.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

    
    
• On success, responds with ListAccountsOutput with field(s):
  • accounts(Option<Vec::<Account>>):

    A list of objects in the organization.

  • next_token(Option<String>):

    If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

• On failure, responds with SdkError<ListAccountsError>

impl Client

pub fn list_accounts_for_parent(&self) -> ListAccountsForParentFluentBuilder

Constructs a fluent builder for the ListAccountsForParent operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • parent_id(impl Into<String>) / set_parent_id(Option<String>):
    required: true
    

    The unique identifier (ID) for the parent root or organization unit (OU) whose accounts you want to list.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call’s NextToken response to indicate where the output should continue from.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

    
    
• On success, responds with ListAccountsForParentOutput with field(s):
  • accounts(Option<Vec::<Account>>):

    A list of the accounts in the specified root or OU.

  • next_token(Option<String>):

    If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

• On failure, responds with SdkError<ListAccountsForParentError>

impl Client

pub fn list_aws_service_access_for_organization( &self ) -> ListAWSServiceAccessForOrganizationFluentBuilder

Constructs a fluent builder for the ListAWSServiceAccessForOrganization operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call’s NextToken response to indicate where the output should continue from.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

    
    
• On success, responds with ListAwsServiceAccessForOrganizationOutput with field(s):
  • enabled_service_principals(Option<Vec::<EnabledServicePrincipal>>):

    A list of the service principals for the services that are enabled to integrate with your organization. Each principal is a structure that includes the name and the date that it was enabled for integration with Organizations.

  • next_token(Option<String>):

    If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

• On failure, responds with SdkError<ListAWSServiceAccessForOrganizationError>

impl Client

pub fn list_children(&self) -> ListChildrenFluentBuilder

Constructs a fluent builder for the ListChildren operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • parent_id(impl Into<String>) / set_parent_id(Option<String>):
    required: true
    

    The unique identifier (ID) for the parent root or OU whose children you want to list.

    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.

    
    
  • child_type(ChildType) / set_child_type(Option<ChildType>):
    required: true
    

    Filters the output to include only the specified child type.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call’s NextToken response to indicate where the output should continue from.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

    
    
• On success, responds with ListChildrenOutput with field(s):
  • children(Option<Vec::<Child>>):

    The list of children of the specified parent container.

  • next_token(Option<String>):

    If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

• On failure, responds with SdkError<ListChildrenError>

impl Client

pub fn list_create_account_status(&self) -> ListCreateAccountStatusFluentBuilder

Constructs a fluent builder for the ListCreateAccountStatus operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • states(CreateAccountState) / set_states(Option<Vec::<CreateAccountState>>):
    required: false
    

    A list of one or more states that you want included in the response. If this parameter isn’t present, all requests are included in the response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call’s NextToken response to indicate where the output should continue from.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

    
    
• On success, responds with ListCreateAccountStatusOutput with field(s):
  • create_account_statuses(Option<Vec::<CreateAccountStatus>>):

    A list of objects with details about the requests. Certain elements, such as the accountId number, are present in the output only after the account has been successfully created.

  • next_token(Option<String>):

    If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

• On failure, responds with SdkError<ListCreateAccountStatusError>

impl Client

pub fn list_delegated_administrators( &self ) -> ListDelegatedAdministratorsFluentBuilder

Constructs a fluent builder for the ListDelegatedAdministrators operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • service_principal(impl Into<String>) / set_service_principal(Option<String>):
    required: false
    

    Specifies a service principal name. If specified, then the operation lists the delegated administrators only for the specified service.

    If you don’t specify a service principal, the operation lists all delegated administrators for all services in your organization.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call’s NextToken response to indicate where the output should continue from.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

    
    
• On success, responds with ListDelegatedAdministratorsOutput with field(s):
  • delegated_administrators(Option<Vec::<DelegatedAdministrator>>):

    The list of delegated administrators in your organization.

  • next_token(Option<String>):

    If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

• On failure, responds with SdkError<ListDelegatedAdministratorsError>

impl Client

pub fn list_delegated_services_for_account( &self ) -> ListDelegatedServicesForAccountFluentBuilder

Constructs a fluent builder for the ListDelegatedServicesForAccount operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The account ID number of a delegated administrator account in the organization.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call’s NextToken response to indicate where the output should continue from.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

    
    
• On success, responds with ListDelegatedServicesForAccountOutput with field(s):
  • delegated_services(Option<Vec::<DelegatedService>>):

    The services for which the account is a delegated administrator.

  • next_token(Option<String>):

    If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

• On failure, responds with SdkError<ListDelegatedServicesForAccountError>

impl Client

pub fn list_handshakes_for_account( &self ) -> ListHandshakesForAccountFluentBuilder

Constructs a fluent builder for the ListHandshakesForAccount operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filter(HandshakeFilter) / set_filter(Option<HandshakeFilter>):
    required: false
    

    Filters the handshakes that you want included in the response. The default is all types. Use the ActionType element to limit the output to only a specified type, such as INVITE, ENABLE_ALL_FEATURES, or APPROVE_ALL_FEATURES. Alternatively, for the ENABLE_ALL_FEATURES handshake that generates a separate child handshake for each member account, you can specify ParentHandshakeId to see only the handshakes that were generated by that parent request.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call’s NextToken response to indicate where the output should continue from.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

    
    
• On success, responds with ListHandshakesForAccountOutput with field(s):
  • handshakes(Option<Vec::<Handshake>>):

    A list of Handshake objects with details about each of the handshakes that is associated with the specified account.

  • next_token(Option<String>):

    If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

• On failure, responds with SdkError<ListHandshakesForAccountError>

impl Client

pub fn list_handshakes_for_organization( &self ) -> ListHandshakesForOrganizationFluentBuilder

Constructs a fluent builder for the ListHandshakesForOrganization operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filter(HandshakeFilter) / set_filter(Option<HandshakeFilter>):
    required: false
    

    A filter of the handshakes that you want included in the response. The default is all types. Use the ActionType element to limit the output to only a specified type, such as INVITE, ENABLE-ALL-FEATURES, or APPROVE-ALL-FEATURES. Alternatively, for the ENABLE-ALL-FEATURES handshake that generates a separate child handshake for each member account, you can specify the ParentHandshakeId to see only the handshakes that were generated by that parent request.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call’s NextToken response to indicate where the output should continue from.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

    
    
• On success, responds with ListHandshakesForOrganizationOutput with field(s):
  • handshakes(Option<Vec::<Handshake>>):

    A list of Handshake objects with details about each of the handshakes that are associated with an organization.

  • next_token(Option<String>):

    If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

• On failure, responds with SdkError<ListHandshakesForOrganizationError>

impl Client

pub fn list_organizational_units_for_parent( &self ) -> ListOrganizationalUnitsForParentFluentBuilder

Constructs a fluent builder for the ListOrganizationalUnitsForParent operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • parent_id(impl Into<String>) / set_parent_id(Option<String>):
    required: true
    

    The unique identifier (ID) of the root or OU whose child OUs you want to list.

    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.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call’s NextToken response to indicate where the output should continue from.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

    
    
• On success, responds with ListOrganizationalUnitsForParentOutput with field(s):
  • organizational_units(Option<Vec::<OrganizationalUnit>>):

    A list of the OUs in the specified root or parent OU.

  • next_token(Option<String>):

    If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

• On failure, responds with SdkError<ListOrganizationalUnitsForParentError>

impl Client

pub fn list_parents(&self) -> ListParentsFluentBuilder

Constructs a fluent builder for the ListParents operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • child_id(impl Into<String>) / set_child_id(Option<String>):
    required: true
    

    The unique identifier (ID) of the OU or account whose parent containers you want to list. Don’t specify a root.

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

    • Account - A string that consists of exactly 12 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 contains the OU). This string is followed by a second “-” dash and from 8 to 32 additional lowercase letters or digits.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call’s NextToken response to indicate where the output should continue from.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

    
    
• On success, responds with ListParentsOutput with field(s):
  • parents(Option<Vec::<Parent>>):

    A list of parents for the specified child account or OU.

  • next_token(Option<String>):

    If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

• On failure, responds with SdkError<ListParentsError>

impl Client

pub fn list_policies(&self) -> ListPoliciesFluentBuilder

Constructs a fluent builder for the ListPolicies operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filter(PolicyType) / set_filter(Option<PolicyType>):
    required: true
    

    Specifies the type of policy that you want to include in the response. You must specify one of the following values:

    • AISERVICES_OPT_OUT_POLICY

    • BACKUP_POLICY

    • SERVICE_CONTROL_POLICY

    • TAG_POLICY

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call’s NextToken response to indicate where the output should continue from.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

    
    
• On success, responds with ListPoliciesOutput with field(s):
  • policies(Option<Vec::<PolicySummary>>):

    A list of policies that match the filter criteria in the request. The output list doesn’t include the policy contents. To see the content for a policy, see DescribePolicy.

  • next_token(Option<String>):

    If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

• On failure, responds with SdkError<ListPoliciesError>

impl Client

pub fn list_policies_for_target(&self) -> ListPoliciesForTargetFluentBuilder

Constructs a fluent builder for the ListPoliciesForTarget operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • target_id(impl Into<String>) / set_target_id(Option<String>):
    required: true
    

    The unique identifier (ID) of the root, organizational unit, or account whose policies you want to list.

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

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

    • Account - A string that consists of exactly 12 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.

    
    
  • filter(PolicyType) / set_filter(Option<PolicyType>):
    required: true
    

    The type of policy that you want to include in the returned list. You must specify one of the following values:

    • AISERVICES_OPT_OUT_POLICY

    • BACKUP_POLICY

    • SERVICE_CONTROL_POLICY

    • TAG_POLICY

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call’s NextToken response to indicate where the output should continue from.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

    
    
• On success, responds with ListPoliciesForTargetOutput with field(s):
  • policies(Option<Vec::<PolicySummary>>):

    The list of policies that match the criteria in the request.

  • next_token(Option<String>):

    If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

• On failure, responds with SdkError<ListPoliciesForTargetError>

impl Client

pub fn list_roots(&self) -> ListRootsFluentBuilder

Constructs a fluent builder for the ListRoots operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call’s NextToken response to indicate where the output should continue from.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

    
    
• On success, responds with ListRootsOutput with field(s):
  • roots(Option<Vec::<Root>>):

    A list of roots that are defined in an organization.

  • next_token(Option<String>):

    If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

• On failure, responds with SdkError<ListRootsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):
    required: true
    

    The ID of the resource with the tags to list.

    You can specify any of the following taggable resources.

    • Amazon Web Services account – specify the account ID number.

    • Organizational unit – specify the OU ID that begins with ou- and looks similar to: ou-1a2b-34uvwxyz

    • Root – specify the root ID that begins with r- and looks similar to: r-1a2b

    • Policy – specify the policy ID that begins with p- andlooks similar to: p-12abcdefg3

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call’s NextToken response to indicate where the output should continue from.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<Vec::<Tag>>):

    The tags that are assigned to the resource.

  • next_token(Option<String>):

    If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_targets_for_policy(&self) -> ListTargetsForPolicyFluentBuilder

Constructs a fluent builder for the ListTargetsForPolicy operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • policy_id(impl Into<String>) / set_policy_id(Option<String>):
    required: true
    

    The unique identifier (ID) of the policy whose attachments you want to know.

    The regex pattern for a policy ID string requires “p-” followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call’s NextToken response to indicate where the output should continue from.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

    
    
• On success, responds with ListTargetsForPolicyOutput with field(s):
  • targets(Option<Vec::<PolicyTargetSummary>>):

    A list of structures, each of which contains details about one of the entities to which the specified policy is attached.

  • next_token(Option<String>):

    If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

• On failure, responds with SdkError<ListTargetsForPolicyError>

impl Client

pub fn move_account(&self) -> MoveAccountFluentBuilder

Constructs a fluent builder for the MoveAccount operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

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

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

    
    
  • source_parent_id(impl Into<String>) / set_source_parent_id(Option<String>):
    required: true
    

    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.

    
    
  • destination_parent_id(impl Into<String>) / set_destination_parent_id(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with MoveAccountOutput
• On failure, responds with SdkError<MoveAccountError>

impl Client

pub fn put_resource_policy(&self) -> PutResourcePolicyFluentBuilder

Constructs a fluent builder for the PutResourcePolicy operation.

• The fluent builder is configurable:
  • content(impl Into<String>) / set_content(Option<String>):
    required: true
    

    If provided, the new content for the resource policy. The text must be correctly formatted JSON that complies with the syntax for the resource policy’s type. For more information, see SCP syntax in the Organizations User Guide.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of tags that you want to attach to the newly created resource policy. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can’t set it to null. For more information about tagging, see Tagging Organizations resources in the Organizations User Guide.

    Calls with tags apply to the initial creation of the resource policy, otherwise an exception is thrown. If any one of the tags is not valid or if you exceed the allowed number of tags for the resource policy, then the entire request fails and the resource policy is not created.

    
    
• On success, responds with PutResourcePolicyOutput with field(s):
  • resource_policy(Option<ResourcePolicy>):

    A structure that contains details about the resource policy.

• On failure, responds with SdkError<PutResourcePolicyError>

impl Client

pub fn register_delegated_administrator( &self ) -> RegisterDelegatedAdministratorFluentBuilder

Constructs a fluent builder for the RegisterDelegatedAdministrator operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The account ID number of the member account in the organization to register as a delegated administrator.

    
    
  • service_principal(impl Into<String>) / set_service_principal(Option<String>):
    required: true
    

    The service principal of the Amazon Web Services service for which you want to make the member account a delegated administrator.

    
    
• On success, responds with RegisterDelegatedAdministratorOutput
• On failure, responds with SdkError<RegisterDelegatedAdministratorError>

impl Client

pub fn remove_account_from_organization( &self ) -> RemoveAccountFromOrganizationFluentBuilder

Constructs a fluent builder for the RemoveAccountFromOrganization operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The unique identifier (ID) of the member account that you want to remove from the organization.

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

    
    
• On success, responds with RemoveAccountFromOrganizationOutput
• On failure, responds with SdkError<RemoveAccountFromOrganizationError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):
    required: true
    

    The ID of the resource to add a tag to.

    You can specify any of the following taggable resources.

    • Amazon Web Services account – specify the account ID number.

    • Organizational unit – specify the OU ID that begins with ou- and looks similar to: ou-1a2b-34uvwxyz

    • Root – specify the root ID that begins with r- and looks similar to: r-1a2b

    • Policy – specify the policy ID that begins with p- andlooks similar to: p-12abcdefg3

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    A list of tags to add to the specified resource.

    For each tag in the list, you must specify both a tag key and a value. The value can be an empty string, but you can’t set it to null.

    If any one of the tags is not valid or if you exceed the maximum allowed number of tags for a resource, then the entire request fails.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):
    required: true
    

    The ID of the resource to remove a tag from.

    You can specify any of the following taggable resources.

    • Amazon Web Services account – specify the account ID number.

    • Organizational unit – specify the OU ID that begins with ou- and looks similar to: ou-1a2b-34uvwxyz

    • Root – specify the root ID that begins with r- and looks similar to: r-1a2b

    • Policy – specify the policy ID that begins with p- andlooks similar to: p-12abcdefg3

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The list of keys for tags to remove from the specified resource.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_organizational_unit( &self ) -> UpdateOrganizationalUnitFluentBuilder

Constructs a fluent builder for the UpdateOrganizationalUnit operation.

• The fluent builder is configurable:
  • organizational_unit_id(impl Into<String>) / set_organizational_unit_id(Option<String>):
    required: true
    

    The unique identifier (ID) of the OU that you want to rename. You can get the ID from the ListOrganizationalUnitsForParent operation.

    The regex pattern for an organizational unit ID string requires “ou-” followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second “-” dash and from 8 to 32 additional lowercase letters or digits.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The new name that you want to assign to the OU.

    The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.

    
    
• On success, responds with UpdateOrganizationalUnitOutput with field(s):
  • organizational_unit(Option<OrganizationalUnit>):

    A structure that contains the details about the specified OU, including its new name.

• On failure, responds with SdkError<UpdateOrganizationalUnitError>

impl Client

pub fn update_policy(&self) -> UpdatePolicyFluentBuilder

Constructs a fluent builder for the UpdatePolicy operation.

• The fluent builder is configurable:
  • policy_id(impl Into<String>) / set_policy_id(Option<String>):
    required: true
    

    The unique identifier (ID) of the policy that you want to update.

    The regex pattern for a policy ID string requires “p-” followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    If provided, the new name for the policy.

    The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    If provided, the new description for the policy.

    
    
  • content(impl Into<String>) / set_content(Option<String>):
    required: false
    

    If provided, the new content for the policy. The text must be correctly formatted JSON that complies with the syntax for the policy’s type. For more information, see SCP syntax in the Organizations User Guide.

    The maximum size of a policy document depends on the policy’s type. For more information, see Maximum and minimum values in the Organizations User Guide.

    
    
• On success, responds with UpdatePolicyOutput with field(s):
  • policy(Option<Policy>):

    A structure that contains details about the updated policy, showing the requested changes.

• On failure, responds with SdkError<UpdatePolicyError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.