Class: Aws::Organizations::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Organizations::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb
Overview
An API client for Organizations. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Organizations::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#accept_handshake(params = {}) ⇒ Types::AcceptHandshakeResponse
Sends a response to the originator of a handshake agreeing to the action proposed by the handshake request.
-
#attach_policy(params = {}) ⇒ Struct
Attaches a policy to a root, an organizational unit (OU), or an individual account.
-
#cancel_handshake(params = {}) ⇒ Types::CancelHandshakeResponse
Cancels a handshake.
-
#close_account(params = {}) ⇒ Struct
Closes an Amazon Web Services member account within an organization.
-
#create_account(params = {}) ⇒ Types::CreateAccountResponse
Creates an Amazon Web Services account that is automatically a member of the organization whose credentials made the request.
-
#create_gov_cloud_account(params = {}) ⇒ Types::CreateGovCloudAccountResponse
This action is available if all of the following are true:.
-
#create_organization(params = {}) ⇒ Types::CreateOrganizationResponse
Creates an Amazon Web Services organization.
-
#create_organizational_unit(params = {}) ⇒ Types::CreateOrganizationalUnitResponse
Creates an organizational unit (OU) within a root or parent OU.
-
#create_policy(params = {}) ⇒ Types::CreatePolicyResponse
Creates a policy of a specified type that you can attach to a root, an organizational unit (OU), or an individual Amazon Web Services account.
-
#decline_handshake(params = {}) ⇒ Types::DeclineHandshakeResponse
Declines a handshake request.
-
#delete_organization(params = {}) ⇒ Struct
Deletes the organization.
-
#delete_organizational_unit(params = {}) ⇒ Struct
Deletes an organizational unit (OU) from a root or another OU.
-
#delete_policy(params = {}) ⇒ Struct
Deletes the specified policy from your organization.
-
#delete_resource_policy(params = {}) ⇒ Struct
Deletes the resource policy from your organization.
-
#deregister_delegated_administrator(params = {}) ⇒ Struct
Removes the specified member Amazon Web Services account as a delegated administrator for the specified Amazon Web Services service.
-
#describe_account(params = {}) ⇒ Types::DescribeAccountResponse
Retrieves Organizations-related information about the specified account.
-
#describe_create_account_status(params = {}) ⇒ Types::DescribeCreateAccountStatusResponse
Retrieves the current status of an asynchronous request to create an account.
-
#describe_effective_policy(params = {}) ⇒ Types::DescribeEffectivePolicyResponse
Returns the contents of the effective policy for specified policy type and account.
-
#describe_handshake(params = {}) ⇒ Types::DescribeHandshakeResponse
Retrieves information about a previously requested handshake.
-
#describe_organization(params = {}) ⇒ Types::DescribeOrganizationResponse
Retrieves information about the organization that the user's account belongs to.
-
#describe_organizational_unit(params = {}) ⇒ Types::DescribeOrganizationalUnitResponse
Retrieves information about an organizational unit (OU).
-
#describe_policy(params = {}) ⇒ Types::DescribePolicyResponse
Retrieves information about a policy.
-
#describe_resource_policy(params = {}) ⇒ Types::DescribeResourcePolicyResponse
Retrieves information about a resource policy.
-
#detach_policy(params = {}) ⇒ Struct
Detaches a policy from a target root, organizational unit (OU), or account.
-
#disable_aws_service_access(params = {}) ⇒ Struct
Disables the integration of an Amazon Web Services service (the service that is specified by
ServicePrincipal
) with Organizations. -
#disable_policy_type(params = {}) ⇒ Types::DisablePolicyTypeResponse
Disables an organizational policy type in a root.
-
#enable_all_features(params = {}) ⇒ Types::EnableAllFeaturesResponse
Enables all features in an organization.
-
#enable_aws_service_access(params = {}) ⇒ Struct
Enables the integration of an Amazon Web Services service (the service that is specified by
ServicePrincipal
) with Organizations. -
#enable_policy_type(params = {}) ⇒ Types::EnablePolicyTypeResponse
Enables a policy type in a root.
-
#invite_account_to_organization(params = {}) ⇒ Types::InviteAccountToOrganizationResponse
Sends an invitation to another account to join your organization as a member account.
-
#leave_organization(params = {}) ⇒ Struct
Removes a member account from its parent organization.
-
#list_accounts(params = {}) ⇒ Types::ListAccountsResponse
Lists all the accounts in the organization.
-
#list_accounts_for_parent(params = {}) ⇒ Types::ListAccountsForParentResponse
Lists the accounts in an organization that are contained by the specified target root or organizational unit (OU).
-
#list_aws_service_access_for_organization(params = {}) ⇒ Types::ListAWSServiceAccessForOrganizationResponse
Returns a list of the Amazon Web Services services that you enabled to integrate with your organization.
-
#list_children(params = {}) ⇒ Types::ListChildrenResponse
Lists all of the organizational units (OUs) or accounts that are contained in the specified parent OU or root.
-
#list_create_account_status(params = {}) ⇒ Types::ListCreateAccountStatusResponse
Lists the account creation requests that match the specified status that is currently being tracked for the organization.
-
#list_delegated_administrators(params = {}) ⇒ Types::ListDelegatedAdministratorsResponse
Lists the Amazon Web Services accounts that are designated as delegated administrators in this organization.
-
#list_delegated_services_for_account(params = {}) ⇒ Types::ListDelegatedServicesForAccountResponse
List the Amazon Web Services services for which the specified account is a delegated administrator.
-
#list_handshakes_for_account(params = {}) ⇒ Types::ListHandshakesForAccountResponse
Lists the current handshakes that are associated with the account of the requesting user.
-
#list_handshakes_for_organization(params = {}) ⇒ Types::ListHandshakesForOrganizationResponse
Lists the handshakes that are associated with the organization that the requesting user is part of.
-
#list_organizational_units_for_parent(params = {}) ⇒ Types::ListOrganizationalUnitsForParentResponse
Lists the organizational units (OUs) in a parent organizational unit or root.
-
#list_parents(params = {}) ⇒ Types::ListParentsResponse
Lists the root or organizational units (OUs) that serve as the immediate parent of the specified child OU or account.
-
#list_policies(params = {}) ⇒ Types::ListPoliciesResponse
Retrieves the list of all policies in an organization of a specified type.
-
#list_policies_for_target(params = {}) ⇒ Types::ListPoliciesForTargetResponse
Lists the policies that are directly attached to the specified target root, organizational unit (OU), or account.
-
#list_roots(params = {}) ⇒ Types::ListRootsResponse
Lists the roots that are defined in the current organization.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists tags that are attached to the specified resource.
-
#list_targets_for_policy(params = {}) ⇒ Types::ListTargetsForPolicyResponse
Lists all the roots, organizational units (OUs), and accounts that the specified policy is attached to.
-
#move_account(params = {}) ⇒ Struct
Moves an account from its current source parent root or organizational unit (OU) to the specified destination parent root or OU.
-
#put_resource_policy(params = {}) ⇒ Types::PutResourcePolicyResponse
Creates or updates a resource policy.
-
#register_delegated_administrator(params = {}) ⇒ Struct
Enables the specified member account to administer the Organizations features of the specified Amazon Web Services service.
-
#remove_account_from_organization(params = {}) ⇒ Struct
Removes the specified account from the organization.
-
#tag_resource(params = {}) ⇒ Struct
Adds one or more tags to the specified resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes any tags with the specified keys from the specified resource.
-
#update_organizational_unit(params = {}) ⇒ Types::UpdateOrganizationalUnitResponse
Renames the specified organizational unit (OU).
-
#update_policy(params = {}) ⇒ Types::UpdatePolicyResponse
Updates an existing policy with a new name, description, or content.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
429 430 431 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 429 def initialize(*args) super end |
Instance Method Details
#accept_handshake(params = {}) ⇒ Types::AcceptHandshakeResponse
Sends a response to the originator of a handshake agreeing to the action proposed by the handshake request.
You can only call this operation by the following principals when they also have the relevant IAM permissions:
Invitation to join or Approve all features request handshakes: only a principal from the member account.
The user who calls the API for an invitation to join must have the
organizations:AcceptHandshake
permission. If you enabled all features in the organization, the user must also have theiam:CreateServiceLinkedRole
permission so that Organizations can create the required service-linked role namedAWSServiceRoleForOrganizations
. For more information, see Organizations and service-linked roles in the Organizations User Guide.Enable all features final confirmation handshake: only a principal from the management account.
For more information about invitations, see Inviting an Amazon Web Services account to join your organization in the Organizations User Guide. For more information about requests to enable all features in the organization, see Enabling all features in your organization in the 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's deleted.
567 568 569 570 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 567 def accept_handshake(params = {}, = {}) req = build_request(:accept_handshake, params) req.send_request() end |
#attach_policy(params = {}) ⇒ Struct
Attaches a policy to a root, an organizational unit (OU), or an individual account. How the policy affects accounts depends on the type of policy. Refer to the Organizations User Guide for information about each policy type:
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
663 664 665 666 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 663 def attach_policy(params = {}, = {}) req = build_request(:attach_policy, params) req.send_request() end |
#cancel_handshake(params = {}) ⇒ Types::CancelHandshakeResponse
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's deleted.
780 781 782 783 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 780 def cancel_handshake(params = {}, = {}) req = build_request(:cancel_handshake, params) req.send_request() end |
#close_account(params = {}) ⇒ Struct
Closes an Amazon Web Services member account within an organization.
You can close an account when all features are enabled . You
can't close the management account with this API. This is an
asynchronous request that Amazon Web Services performs in the
background. Because CloseAccount
operates asynchronously, it can
return a successful completion message even though account closure
might still be in progress. You need to wait a few minutes before the
account is fully closed. To check the status of the request, do one of
the following:
Use the
AccountId
that you sent in theCloseAccount
request to provide as a parameter to the DescribeAccount operation.While the close account request is in progress, Account status will indicate PENDING_CLOSURE. When the close account request completes, the status will change to SUSPENDED.
Check the CloudTrail log for the
CloseAccountResult
event that gets published after the account closes successfully. For information on using CloudTrail with Organizations, see Logging and monitoring in Organizations in the Organizations User Guide.
To reinstate a closed account, contact Amazon Web Services Support within the 90-day grace period while the account is in SUSPENDED status.
If the Amazon Web Services account you attempt to close is linked to an Amazon Web Services GovCloud (US) account, the
CloseAccount
request will close both accounts. To learn important pre-closure details, see Closing an Amazon Web Services GovCloud (US) account in the Amazon Web Services GovCloud User Guide.
850 851 852 853 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 850 def close_account(params = {}, = {}) req = build_request(:close_account, params) req.send_request() end |
#create_account(params = {}) ⇒ Types::CreateAccountResponse
Creates an Amazon Web Services account that is automatically a member
of the organization whose credentials made the request. This is an
asynchronous request that Amazon Web Services performs in the
background. Because CreateAccount
operates asynchronously, it can
return a successful completion message even though account
initialization might still be in progress. You might need to wait a
few minutes before you can successfully access the account. To check
the status of the request, do one of the following:
Use the
Id
value of theCreateAccountStatus
response element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation.Check the CloudTrail log for the
CreateAccountResult
event. For information on using CloudTrail with Organizations, see Logging and monitoring in Organizations in the Organizations User Guide.
The user who calls the API to create an account must have the
organizations:CreateAccount
permission. If you enabled all features
in the organization, Organizations creates the required service-linked
role named AWSServiceRoleForOrganizations
. For more information, see
Organizations and service-linked roles in the Organizations User
Guide.
If the request includes tags, then the requester must have the
organizations:TagResource
permission.
Organizations preconfigures the new member account with a role (named
OrganizationAccountAccessRole
by default) that grants users in the
management account administrator permissions in the new member
account. Principals in the management account can assume the role.
Organizations clones the company name and address information for the
new account from the organization's management account.
This operation can be called only from the organization's management account.
For more information about creating accounts, see Creating a member account in your organization in the Organizations User Guide.
When you create an account in an organization using the Organizations console, API, or CLI commands, the information required for the account to operate as a standalone account, such as a payment method is not automatically collected. If you must remove an account from your organization later, you can do so only after you provide the missing information. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.
If you get an exception that indicates that you exceeded your account limits for the organization, contact Amazon Web Services Support.
If you get an exception that indicates that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists, contact Amazon Web Services Support.
Using
CreateAccount
to create multiple temporary accounts isn't recommended. You can only close an account from the Billing and Cost Management console, and you must be signed in as the root user. For information on the requirements and process for closing an account, see Closing a member account in your organization in the Organizations User Guide.
1093 1094 1095 1096 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 1093 def create_account(params = {}, = {}) req = build_request(:create_account, params) req.send_request() end |
#create_gov_cloud_account(params = {}) ⇒ Types::CreateGovCloudAccountResponse
This action is available if all of the following are true:
You're authorized to create accounts in the Amazon Web Services GovCloud (US) Region. For more information on the Amazon Web Services GovCloud (US) Region, see the Amazon Web Services GovCloud User Guide.
You already have an account in the Amazon Web Services GovCloud (US) Region that is paired with a management account of an organization in the commercial Region.
You call this action from the management account of your organization in the commercial Region.
You have the
organizations:CreateGovCloudAccount
permission.
Organizations automatically creates the required service-linked role
named AWSServiceRoleForOrganizations
. For more information, see
Organizations and service-linked roles in the Organizations User
Guide.
Amazon Web Services automatically enables CloudTrail for Amazon Web Services GovCloud (US) accounts, but you should also do the following:
Verify that CloudTrail is enabled to store logs.
Create an Amazon S3 bucket for CloudTrail log storage.
For more information, see Verifying CloudTrail Is Enabled in the Amazon Web Services GovCloud User Guide.
If the request includes tags, then the requester must have the
organizations:TagResource
permission. The tags are attached to the
commercial account associated with the GovCloud account, rather than
the GovCloud account itself. To add tags to the GovCloud account, call
the TagResource operation in the GovCloud Region after the new
GovCloud account exists.
You call this action from the management account of your organization in the commercial Region to create a standalone Amazon Web Services account in the Amazon Web Services GovCloud (US) Region. After the account is created, the management account of an organization in the Amazon Web Services GovCloud (US) Region can invite it to that organization. For more information on inviting standalone accounts in the Amazon Web Services GovCloud (US) to join an organization, see Organizations in the Amazon Web Services GovCloud User Guide.
Calling CreateGovCloudAccount
is an asynchronous request that Amazon
Web Services performs in the background. Because
CreateGovCloudAccount
operates asynchronously, it can return a
successful completion message even though account initialization might
still be in progress. You might need to wait a few minutes before you
can successfully access the account. To check the status of the
request, do one of the following:
Use the
OperationId
response element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation.Check the CloudTrail log for the
CreateAccountResult
event. For information on using CloudTrail with Organizations, see Logging and monitoring in Organizations in the Organizations User Guide.
When you call the CreateGovCloudAccount
action, you create two
accounts: a standalone account in the Amazon Web Services GovCloud
(US) Region and an associated account in the commercial Region for
billing and support purposes. The account in the commercial Region is
automatically a member of the organization whose credentials made the
request. Both accounts are associated with the same email address.
A role is created in the new account in the commercial Region that allows the management account in the organization in the commercial Region to assume it. An Amazon Web Services GovCloud (US) account is then created and associated with the commercial account that you just created. A role is also created in the new Amazon Web Services GovCloud (US) account that can be assumed by the Amazon Web Services GovCloud (US) account that is associated with the management account of the commercial organization. For more information and to view a diagram that explains how account access works, see Organizations in the Amazon Web Services GovCloud User Guide.
For more information about creating accounts, see Creating a member account in your organization in the Organizations User Guide.
When you create an account in an organization using the Organizations console, API, or CLI commands, the information required for the account to operate as a standalone account is not automatically collected. This includes a payment method and signing the end user license agreement (EULA). If you must remove an account from your organization later, you can do so only after you provide the missing information. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.
If you get an exception that indicates that you exceeded your account limits for the organization, contact Amazon Web Services Support.
If you get an exception that indicates that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists, contact Amazon Web Services Support.
Using
CreateGovCloudAccount
to create multiple temporary accounts isn't recommended. You can only close an account from the Amazon Web Services Billing and Cost Management console, and you must be signed in as the root user. For information on the requirements and process for closing an account, see Closing a member account in your organization in the Organizations User Guide.
1381 1382 1383 1384 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 1381 def create_gov_cloud_account(params = {}, = {}) req = build_request(:create_gov_cloud_account, params) req.send_request() end |
#create_organization(params = {}) ⇒ Types::CreateOrganizationResponse
Creates an Amazon Web Services organization. The account whose user is
calling the CreateOrganization
operation automatically becomes the
management account of the new organization.
This operation must be called using credentials from the account that is to become the new organization's management 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
, no policy types are enabled by default and you
can't use organization policies.
1506 1507 1508 1509 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 1506 def create_organization(params = {}, = {}) req = build_request(:create_organization, params) req.send_request() end |
#create_organizational_unit(params = {}) ⇒ Types::CreateOrganizationalUnitResponse
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 (OUs) in the Organizations User Guide.
If the request includes tags, then the requester must have the
organizations:TagResource
permission.
This operation can be called only from the organization's management account.
1616 1617 1618 1619 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 1616 def create_organizational_unit(params = {}, = {}) req = build_request(:create_organizational_unit, params) req.send_request() end |
#create_policy(params = {}) ⇒ Types::CreatePolicyResponse
Creates a policy of a specified type that you can attach to a root, an organizational unit (OU), or an individual Amazon Web Services account.
For more information about policies and their use, see Managing Organizations policies.
If the request includes tags, then the requester must have the
organizations:TagResource
permission.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
1762 1763 1764 1765 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 1762 def create_policy(params = {}, = {}) req = build_request(:create_policy, params) req.send_request() end |
#decline_handshake(params = {}) ⇒ Types::DeclineHandshakeResponse
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 reinitiate 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's deleted.
1875 1876 1877 1878 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 1875 def decline_handshake(params = {}, = {}) req = build_request(:decline_handshake, params) req.send_request() end |
#delete_organization(params = {}) ⇒ Struct
Deletes the organization. You can delete an organization only by using credentials from the management account. The organization must be empty of member accounts.
1890 1891 1892 1893 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 1890 def delete_organization(params = {}, = {}) req = build_request(:delete_organization, params) req.send_request() end |
#delete_organizational_unit(params = {}) ⇒ Struct
Deletes an organizational unit (OU) 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 management account.
1938 1939 1940 1941 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 1938 def delete_organizational_unit(params = {}, = {}) req = build_request(:delete_organizational_unit, params) req.send_request() end |
#delete_policy(params = {}) ⇒ Struct
Deletes the specified policy from your organization. Before you perform this operation, you must first detach the policy from all organizational units (OUs), roots, and accounts.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
1986 1987 1988 1989 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 1986 def delete_policy(params = {}, = {}) req = build_request(:delete_policy, params) req.send_request() end |
#delete_resource_policy(params = {}) ⇒ Struct
Deletes the resource policy from your organization.
You can only call this operation from the organization's management account.
2002 2003 2004 2005 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 2002 def delete_resource_policy(params = {}, = {}) req = build_request(:delete_resource_policy, params) req.send_request() end |
#deregister_delegated_administrator(params = {}) ⇒ Struct
Removes the specified member Amazon Web Services account as a delegated administrator for the specified Amazon Web Services service.
Deregistering a delegated administrator can have unintended impacts on the functionality of the enabled Amazon Web Services service. See the documentation for the enabled service before you deregister a delegated administrator so that you understand any potential impacts.
You can run this action only for Amazon Web Services services that support this feature. For a current list of services that support it, see the column Supports Delegated Administrator in the table at Amazon Web Services Services that you can use with Organizations in the Organizations User Guide.
This operation can be called only from the organization's management account.
2055 2056 2057 2058 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 2055 def deregister_delegated_administrator(params = {}, = {}) req = build_request(:deregister_delegated_administrator, params) req.send_request() end |
#describe_account(params = {}) ⇒ Types::DescribeAccountResponse
Retrieves Organizations-related information about the specified account.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
2122 2123 2124 2125 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 2122 def describe_account(params = {}, = {}) req = build_request(:describe_account, params) req.send_request() end |
#describe_create_account_status(params = {}) ⇒ Types::DescribeCreateAccountStatusResponse
Retrieves the current status of an asynchronous request to create an account.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
2192 2193 2194 2195 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 2192 def describe_create_account_status(params = {}, = {}) req = build_request(:describe_create_account_status, params) req.send_request() end |
#describe_effective_policy(params = {}) ⇒ Types::DescribeEffectivePolicyResponse
Returns the contents of the effective policy for specified policy type and account. The effective policy is the aggregation of any policies of the specified type that the account inherits, plus any policy of that type that is directly attached to the account.
This operation applies only to policy types other than service control policies (SCPs).
For more information about policy inheritance, see Understanding management policy inheritance in the Organizations User Guide.
This operation can be called from any account in the organization.
2257 2258 2259 2260 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 2257 def describe_effective_policy(params = {}, = {}) req = build_request(:describe_effective_policy, params) req.send_request() end |
#describe_handshake(params = {}) ⇒ Types::DescribeHandshakeResponse
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're
then deleted and no longer accessible.
This operation can be called from any account in the organization.
2368 2369 2370 2371 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 2368 def describe_handshake(params = {}, = {}) req = build_request(:describe_handshake, params) req.send_request() end |
#describe_organization(params = {}) ⇒ Types::DescribeOrganizationResponse
Retrieves information about the organization that the user's account belongs to.
This operation can be called from any account in the organization.
2429 2430 2431 2432 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 2429 def describe_organization(params = {}, = {}) req = build_request(:describe_organization, params) req.send_request() end |
#describe_organizational_unit(params = {}) ⇒ Types::DescribeOrganizationalUnitResponse
Retrieves information about an organizational unit (OU).
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
2492 2493 2494 2495 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 2492 def describe_organizational_unit(params = {}, = {}) req = build_request(:describe_organizational_unit, params) req.send_request() end |
#describe_policy(params = {}) ⇒ Types::DescribePolicyResponse
Retrieves information about a policy.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
2564 2565 2566 2567 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 2564 def describe_policy(params = {}, = {}) req = build_request(:describe_policy, params) req.send_request() end |
#describe_resource_policy(params = {}) ⇒ Types::DescribeResourcePolicyResponse
Retrieves information about a resource policy.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
2589 2590 2591 2592 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 2589 def describe_resource_policy(params = {}, = {}) req = build_request(:describe_resource_policy, params) req.send_request() end |
#detach_policy(params = {}) ⇒ Struct
Detaches a policy from a target root, organizational unit (OU), or account.
If the policy being detached is a service control policy (SCP), the changes to permissions for Identity and Access Management (IAM) users and roles in affected accounts are immediate.
Every root, OU, and account must have at least one SCP attached. If
you want to replace the default FullAWSAccess
policy with an SCP
that limits the permissions that can be delegated, you must attach the
replacement SCP before you can remove the default SCP. This is the
authorization strategy of an "allow list". 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), you're using the authorization strategy of a "deny
list".
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
2678 2679 2680 2681 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 2678 def detach_policy(params = {}, = {}) req = build_request(:detach_policy, params) req.send_request() end |
#disable_aws_service_access(params = {}) ⇒ Struct
Disables the integration of an Amazon Web Services service (the
service that is specified by ServicePrincipal
) with Organizations.
When you disable integration, the specified service no longer can
create a service-linked role in new accounts in your
organization. This means the service can't perform operations on your
behalf on any new accounts in your organization. The service can still
perform operations in older accounts until the service completes its
clean-up from Organizations.
We strongly recommend that you don't use this command to disable integration between Organizations and the specified Amazon Web Services service. Instead, use the console or commands that are provided by the specified service. This lets the trusted service perform any required initialization when enabling trusted access, such as creating any required resources and any required clean up of resources when disabling trusted access.
For information about how to disable trusted service access to your organization using the trusted service, see the Learn more link under the Supports Trusted Access column at Amazon Web Services services that you can use with Organizations. on this page.
If you disable access by using this command, it causes the following actions to occur:
The service can no longer create a service-linked role in the accounts in your organization. This means that the service can't perform operations on your behalf on any new accounts in your organization. The service can still perform operations in older accounts until the service completes its clean-up from Organizations.
The service can no longer perform tasks in the member accounts in the organization, unless those operations are explicitly permitted by the IAM policies that are attached to your roles. This includes any data aggregation from the member accounts to the management account, or to a delegated administrator account, where relevant.
Some services detect this and clean up any remaining data or resources related to the integration, while other services stop accessing the organization but leave any historical data and configuration in place to support a possible re-enabling of the integration.
Using the other service's console or commands to disable the integration ensures that the other service is aware that it can clean up any resources that are required only for the integration. How the service cleans up its resources in the organization's accounts depends on that service. For more information, see the documentation for the other Amazon Web Services service.
After you perform the DisableAWSServiceAccess
operation, the
specified service can no longer perform operations in your
organization's accounts
For more information about integrating other services with Organizations, including the list of services that work with Organizations, see Using Organizations with other Amazon Web Services services in the Organizations User Guide.
This operation can be called only from the organization's management account.
2770 2771 2772 2773 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 2770 def disable_aws_service_access(params = {}, = {}) req = build_request(:disable_aws_service_access, params) req.send_request() end |
#disable_policy_type(params = {}) ⇒ Types::DisablePolicyTypeResponse
Disables an organizational policy type in a root. A policy of a certain type can be attached to entities in a root only if that type is enabled in the root. After you perform this operation, you no longer can attach policies of the specified type to that root or to any organizational unit (OU) or account in that root. You can undo this by using the EnablePolicyType operation.
This is an asynchronous request that Amazon Web Services performs in the background. If you disable a policy type for a root, it still appears enabled for the organization if all features are enabled for the organization. Amazon Web Services recommends that you first use ListRoots to see the status of policy types for a specified root, and then use this operation.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
To view the status of available policy types in the organization, use DescribeOrganization.
2876 2877 2878 2879 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 2876 def disable_policy_type(params = {}, = {}) req = build_request(:disable_policy_type, params) req.send_request() end |
#enable_all_features(params = {}) ⇒ Types::EnableAllFeaturesResponse
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 Organizations supports. For more information, see Enabling all features in your organization in the Organizations User Guide.
This operation is required only for organizations that were created explicitly with only the consolidated billing features enabled. 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 you enable all features, you can separately enable or disable individual policy types in a root using EnablePolicyType and DisablePolicyType. To see the status of policy types in a root, use ListRoots.
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 management 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 management 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 management account.
3031 3032 3033 3034 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 3031 def enable_all_features(params = {}, = {}) req = build_request(:enable_all_features, params) req.send_request() end |
#enable_aws_service_access(params = {}) ⇒ Struct
Enables the integration of an Amazon Web Services service (the service
that is specified by ServicePrincipal
) with Organizations. When you
enable integration, you allow the specified service to create a
service-linked role in all the accounts in your organization.
This allows the service to perform operations on your behalf in your
organization and its accounts.
We recommend that you enable integration between Organizations and the specified Amazon Web Services service by using the console or commands that are provided by the specified service. Doing so ensures that the service is aware that it can create the resources that are required for the integration. How the service creates those resources in the organization's accounts depends on that service. For more information, see the documentation for the other Amazon Web Services service.
For more information about enabling services to integrate with Organizations, see Using Organizations with other Amazon Web Services services in the Organizations User Guide.
You can only call this operation from the organization's management account and only if the organization has enabled all features.
2928 2929 2930 2931 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 2928 def enable_aws_service_access(params = {}, = {}) req = build_request(:enable_aws_service_access, params) req.send_request() end |
#enable_policy_type(params = {}) ⇒ Types::EnablePolicyTypeResponse
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 organizational unit (OU), or account in that root. You can undo this by using the DisablePolicyType operation.
This is an asynchronous request that Amazon Web Services performs in the background. Amazon Web Services recommends that you first use ListRoots to see the status of policy types for a specified root, and then use this operation.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
You can enable a policy type in a root only if that policy type is available in the organization. To view the status of available policy types in the organization, use DescribeOrganization.
3134 3135 3136 3137 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 3134 def enable_policy_type(params = {}, = {}) req = build_request(:enable_policy_type, params) req.send_request() end |
#invite_account_to_organization(params = {}) ⇒ Types::InviteAccountToOrganizationResponse
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 Amazon Web Services accounts only from the same seller as the management account. For example, if your organization's management account was created by Amazon Internet Services Pvt. Ltd (AISPL), an Amazon Web Services seller in India, you can invite only other AISPL accounts to your organization. You can't combine accounts from AISPL and Amazon Web Services or from any other Amazon Web Services seller. For more information, see Consolidated billing in India.
If you receive an exception that indicates that you exceeded your account limits for the organization or that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists after an hour, contact Amazon Web Services Support.
If the request includes tags, then the requester must have the
organizations:TagResource
permission.
This operation can be called only from the organization's management account.
3321 3322 3323 3324 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 3321 def invite_account_to_organization(params = {}, = {}) req = build_request(:invite_account_to_organization, params) req.send_request() end |
#leave_organization(params = {}) ⇒ Struct
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 management account, use RemoveAccountFromOrganization instead.
This operation can be called only from a member account in the organization.
The management account in an organization with all features enabled can set service control policies (SCPs) that can restrict what administrators of member accounts can do. This includes preventing them from successfully calling
LeaveOrganization
and leaving the organization.You can leave an organization as a member account only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the Organizations console, API, or CLI commands, the information required of standalone accounts is not automatically collected. For each account that you want to make standalone, you must perform the following steps. If any of the steps are already completed for this account, that step doesn't appear.
Choose a support plan
Provide and verify the required contact information
Provide a current payment method
Amazon Web Services uses the payment method to charge for any billable (not free tier) Amazon Web Services activity that occurs while the account isn't attached to an organization. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.
The account that you want to leave must not be a delegated administrator account for any Amazon Web Services service enabled for your organization. If the account is a delegated administrator, you must first change the delegated administrator account to another account that is remaining in the organization.
You can leave an organization only after you enable IAM user access to billing in your account. 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.
After the account leaves the organization, all tags that were attached to the account object in the organization are deleted. Amazon Web Services accounts outside of an organization do not support tags.
A newly created account has a waiting period before it can be removed from its organization. If you get an error that indicates that a wait period is required, then try again in a few days.
If you are using an organization principal to call
LeaveOrganization
across multiple accounts, you can only do this up to 5 accounts per second in a single organization.
3404 3405 3406 3407 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 3404 def leave_organization(params = {}, = {}) req = build_request(:leave_organization, params) req.send_request() end |
#list_accounts(params = {}) ⇒ Types::ListAccountsResponse
Lists all the accounts in the organization. To request only the accounts in a specified root or organizational unit (OU), use the ListAccountsForParent operation instead.
NextToken
response parameter for a null
value
when calling a List*
operation. These operations can occasionally
return an empty set of results even when there are more results
available. The NextToken
response parameter value is null
only
when there are no more results to display.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3591 3592 3593 3594 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 3591 def list_accounts(params = {}, = {}) req = build_request(:list_accounts, params) req.send_request() end |
#list_accounts_for_parent(params = {}) ⇒ Types::ListAccountsForParentResponse
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 aren't 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.
NextToken
response parameter for a null
value
when calling a List*
operation. These operations can occasionally
return an empty set of results even when there are more results
available. The NextToken
response parameter value is null
only
when there are no more results to display.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3702 3703 3704 3705 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 3702 def list_accounts_for_parent(params = {}, = {}) req = build_request(:list_accounts_for_parent, params) req.send_request() end |
#list_aws_service_access_for_organization(params = {}) ⇒ Types::ListAWSServiceAccessForOrganizationResponse
Returns a list of the Amazon Web Services services that you enabled to integrate with your organization. After a service on this list creates the resources that it requires for the integration, it can perform operations on your organization and its accounts.
For more information about integrating other services with Organizations, including the list of services that currently work with Organizations, see Using Organizations with other Amazon Web Services services in the Organizations User Guide.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3471 3472 3473 3474 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 3471 def list_aws_service_access_for_organization(params = {}, = {}) req = build_request(:list_aws_service_access_for_organization, params) req.send_request() end |
#list_children(params = {}) ⇒ Types::ListChildrenResponse
Lists all of the organizational units (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.
NextToken
response parameter for a null
value
when calling a List*
operation. These operations can occasionally
return an empty set of results even when there are more results
available. The NextToken
response parameter value is null
only
when there are no more results to display.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3816 3817 3818 3819 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 3816 def list_children(params = {}, = {}) req = build_request(:list_children, params) req.send_request() end |
#list_create_account_status(params = {}) ⇒ Types::ListCreateAccountStatusResponse
Lists the account creation requests that match the specified status that is currently being tracked for the organization.
NextToken
response parameter for a null
value
when calling a List*
operation. These operations can occasionally
return an empty set of results even when there are more results
available. The NextToken
response parameter value is null
only
when there are no more results to display.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3941 3942 3943 3944 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 3941 def list_create_account_status(params = {}, = {}) req = build_request(:list_create_account_status, params) req.send_request() end |
#list_delegated_administrators(params = {}) ⇒ Types::ListDelegatedAdministratorsResponse
Lists the Amazon Web Services accounts that are designated as delegated administrators in this organization.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4011 4012 4013 4014 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 4011 def list_delegated_administrators(params = {}, = {}) req = build_request(:list_delegated_administrators, params) req.send_request() end |
#list_delegated_services_for_account(params = {}) ⇒ Types::ListDelegatedServicesForAccountResponse
List the Amazon Web Services services for which the specified account is a delegated administrator.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4072 4073 4074 4075 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 4072 def list_delegated_services_for_account(params = {}, = {}) req = build_request(:list_delegated_services_for_account, params) req.send_request() end |
#list_handshakes_for_account(params = {}) ⇒ Types::ListHandshakesForAccountResponse
Lists the current handshakes that are associated with the account of the requesting user.
Handshakes that are ACCEPTED
, DECLINED
, CANCELED
, or EXPIRED
appear in the results of this API for only 30 days after changing to
that state. After that, they're deleted and no longer accessible.
NextToken
response parameter for a null
value
when calling a List*
operation. These operations can occasionally
return an empty set of results even when there are more results
available. The NextToken
response parameter value is null
only
when there are no more results to display.
This operation can be called from any account in the organization.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4219 4220 4221 4222 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 4219 def list_handshakes_for_account(params = {}, = {}) req = build_request(:list_handshakes_for_account, params) req.send_request() end |
#list_handshakes_for_organization(params = {}) ⇒ Types::ListHandshakesForOrganizationResponse
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
, CANCELED
, or EXPIRED
appear in the results of this API for only 30 days after changing to
that state. After that, they're deleted and no longer accessible.
NextToken
response parameter for a null
value
when calling a List*
operation. These operations can occasionally
return an empty set of results even when there are more results
available. The NextToken
response parameter value is null
only
when there are no more results to display.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4411 4412 4413 4414 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 4411 def list_handshakes_for_organization(params = {}, = {}) req = build_request(:list_handshakes_for_organization, params) req.send_request() end |
#list_organizational_units_for_parent(params = {}) ⇒ Types::ListOrganizationalUnitsForParentResponse
Lists the organizational units (OUs) in a parent organizational unit or root.
NextToken
response parameter for a null
value
when calling a List*
operation. These operations can occasionally
return an empty set of results even when there are more results
available. The NextToken
response parameter value is null
only
when there are no more results to display.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4521 4522 4523 4524 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 4521 def list_organizational_units_for_parent(params = {}, = {}) req = build_request(:list_organizational_units_for_parent, params) req.send_request() end |
#list_parents(params = {}) ⇒ Types::ListParentsResponse
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.
NextToken
response parameter for a null
value
when calling a List*
operation. These operations can occasionally
return an empty set of results even when there are more results
available. The NextToken
response parameter value is null
only
when there are no more results to display.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4629 4630 4631 4632 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 4629 def list_parents(params = {}, = {}) req = build_request(:list_parents, params) req.send_request() end |
#list_policies(params = {}) ⇒ Types::ListPoliciesResponse
Retrieves the list of all policies in an organization of a specified type.
NextToken
response parameter for a null
value
when calling a List*
operation. These operations can occasionally
return an empty set of results even when there are more results
available. The NextToken
response parameter value is null
only
when there are no more results to display.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4756 4757 4758 4759 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 4756 def list_policies(params = {}, = {}) req = build_request(:list_policies, params) req.send_request() end |
#list_policies_for_target(params = {}) ⇒ Types::ListPoliciesForTargetResponse
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.
NextToken
response parameter for a null
value
when calling a List*
operation. These operations can occasionally
return an empty set of results even when there are more results
available. The NextToken
response parameter value is null
only
when there are no more results to display.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4893 4894 4895 4896 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 4893 def list_policies_for_target(params = {}, = {}) req = build_request(:list_policies_for_target, params) req.send_request() end |
#list_roots(params = {}) ⇒ Types::ListRootsResponse
Lists the roots that are defined in the current organization.
NextToken
response parameter for a null
value
when calling a List*
operation. These operations can occasionally
return an empty set of results even when there are more results
available. The NextToken
response parameter value is null
only
when there are no more results to display.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4994 4995 4996 4997 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 4994 def list_roots(params = {}, = {}) req = build_request(:list_roots, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists tags that are attached to the specified resource.
You can attach tags to the following resources in Organizations.
Amazon Web Services account
Organization root
Organizational unit (OU)
Policy (any type)
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5063 5064 5065 5066 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 5063 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_targets_for_policy(params = {}) ⇒ Types::ListTargetsForPolicyResponse
Lists all the roots, organizational units (OUs), and accounts that the specified policy is attached to.
NextToken
response parameter for a null
value
when calling a List*
operation. These operations can occasionally
return an empty set of results even when there are more results
available. The NextToken
response parameter value is null
only
when there are no more results to display.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5176 5177 5178 5179 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 5176 def list_targets_for_policy(params = {}, = {}) req = build_request(:list_targets_for_policy, params) req.send_request() end |
#move_account(params = {}) ⇒ Struct
Moves an account from its current source parent root or organizational unit (OU) to the specified destination parent root or OU.
This operation can be called only from the organization's management account.
5260 5261 5262 5263 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 5260 def move_account(params = {}, = {}) req = build_request(:move_account, params) req.send_request() end |
#put_resource_policy(params = {}) ⇒ Types::PutResourcePolicyResponse
Creates or updates a resource policy.
You can only call this operation from the organization's management account.
5324 5325 5326 5327 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 5324 def put_resource_policy(params = {}, = {}) req = build_request(:put_resource_policy, params) req.send_request() end |
#register_delegated_administrator(params = {}) ⇒ Struct
Enables the specified member account to administer the Organizations features of the specified Amazon Web Services service. It grants read-only access to Organizations service data. The account still requires IAM permissions to access and administer the Amazon Web Services service.
You can run this action only for Amazon Web Services services that support this feature. For a current list of services that support it, see the column Supports Delegated Administrator in the table at Amazon Web Services Services that you can use with Organizations in the Organizations User Guide.
This operation can be called only from the organization's management account.
5369 5370 5371 5372 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 5369 def register_delegated_administrator(params = {}, = {}) req = build_request(:register_delegated_administrator, params) req.send_request() end |
#remove_account_from_organization(params = {}) ⇒ Struct
Removes the specified account from the organization.
The removed account becomes a standalone account that isn't a member of any organization. It's no longer subject to any policies and is responsible for its own bill payments. The organization's management account is no longer charged for any expenses accrued by the member account after it's removed from the organization.
This operation can be called only from the organization's management account. Member accounts can remove themselves with LeaveOrganization instead.
You can remove an account from your organization only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the Organizations console, API, or CLI commands, the information required of standalone accounts is not automatically collected. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.
The account that you want to leave must not be a delegated administrator account for any Amazon Web Services service enabled for your organization. If the account is a delegated administrator, you must first change the delegated administrator account to another account that is remaining in the organization.
After the account leaves the organization, all tags that were attached to the account object in the organization are deleted. Amazon Web Services accounts outside of an organization do not support tags.
5442 5443 5444 5445 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 5442 def remove_account_from_organization(params = {}, = {}) req = build_request(:remove_account_from_organization, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds one or more tags to the specified resource.
Currently, you can attach tags to the following resources in Organizations.
Amazon Web Services account
Organization root
Organizational unit (OU)
Policy (any type)
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
5509 5510 5511 5512 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 5509 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes any tags with the specified keys from the specified resource.
You can attach tags to the following resources in Organizations.
Amazon Web Services account
Organization root
Organizational unit (OU)
Policy (any type)
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
5562 5563 5564 5565 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 5562 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_organizational_unit(params = {}) ⇒ Types::UpdateOrganizationalUnitResponse
Renames the specified organizational unit (OU). The ID and ARN don't 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 management account.
5637 5638 5639 5640 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 5637 def update_organizational_unit(params = {}, = {}) req = build_request(:update_organizational_unit, params) req.send_request() end |
#update_policy(params = {}) ⇒ Types::UpdatePolicyResponse
Updates an existing policy with a new name, description, or content. If you don't supply any parameter, that value remains unchanged. You can't change a policy's type.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
5768 5769 5770 5771 |
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/client.rb', line 5768 def update_policy(params = {}, = {}) req = build_request(:update_policy, params) req.send_request() end |