organizations: AWS Organizations

Description Usage Arguments Service syntax Operations Examples

View source: R/organizations_service.R

Description

AWS Organizations

Usage

1
organizations(config = list())

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Service syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
svc <- organizations(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

accept_handshake Sends a response to the originator of a handshake agreeing to the action proposed by the handshake request
attach_policy Attaches a policy to a root, an organizational unit (OU), or an individual account
cancel_handshake Cancels a handshake
create_account Creates an AWS account that is automatically a member of the organization whose credentials made the request
create_gov_cloud_account This action is available if all of the following are true:
create_organization Creates an AWS organization
create_organizational_unit Creates an organizational unit (OU) within a root or parent OU
create_policy Creates a policy of a specified type that you can attach to a root, an organizational unit (OU), or an individual AWS account
decline_handshake Declines a handshake request
delete_organization Deletes the organization
delete_organizational_unit Deletes an organizational unit (OU) from a root or another OU
delete_policy Deletes the specified policy from your organization
deregister_delegated_administrator Removes the specified member AWS account as a delegated administrator for the specified AWS service
describe_account Retrieves AWS Organizations-related information about the specified account
describe_create_account_status Retrieves the current status of an asynchronous request to create an account
describe_effective_policy Returns the contents of the effective policy for specified policy type and account
describe_handshake Retrieves information about a previously requested handshake
describe_organization Retrieves information about the organization that the user's account belongs to
describe_organizational_unit Retrieves information about an organizational unit (OU)
describe_policy Retrieves information about a policy
detach_policy Detaches a policy from a target root, organizational unit (OU), or account
disable_aws_service_access Disables the integration of an AWS service (the service that is specified by ServicePrincipal) with AWS Organizations
disable_policy_type Disables an organizational policy type in a root
enable_all_features Enables all features in an organization
enable_aws_service_access Enables the integration of an AWS service (the service that is specified by ServicePrincipal) with AWS Organizations
enable_policy_type Enables a policy type in a root
invite_account_to_organization Sends an invitation to another account to join your organization as a member account
leave_organization Removes a member account from its parent organization
list_accounts Lists all the accounts in the organization
list_accounts_for_parent Lists the accounts in an organization that are contained by the specified target root or organizational unit (OU)
list_aws_service_access_for_organization Returns a list of the AWS services that you enabled to integrate with your organization
list_children Lists all of the organizational units (OUs) or accounts that are contained in the specified parent OU or root
list_create_account_status Lists the account creation requests that match the specified status that is currently being tracked for the organization
list_delegated_administrators Lists the AWS accounts that are designated as delegated administrators in this organization
list_delegated_services_for_account List the AWS services for which the specified account is a delegated administrator
list_handshakes_for_account Lists the current handshakes that are associated with the account of the requesting user
list_handshakes_for_organization Lists the handshakes that are associated with the organization that the requesting user is part of
list_organizational_units_for_parent Lists the organizational units (OUs) in a parent organizational unit or root
list_parents Lists the root or organizational units (OUs) that serve as the immediate parent of the specified child OU or account
list_policies Retrieves the list of all policies in an organization of a specified type
list_policies_for_target Lists the policies that are directly attached to the specified target root, organizational unit (OU), or account
list_roots Lists the roots that are defined in the current organization
list_tags_for_resource Lists tags that are attached to the specified resource
list_targets_for_policy Lists all the roots, organizational units (OUs), and accounts that the specified policy is attached to
move_account Moves an account from its current source parent root or organizational unit (OU) to the specified destination parent root or OU
register_delegated_administrator Enables the specified member account to administer the Organizations features of the specified AWS service
remove_account_from_organization Removes the specified account from the organization
tag_resource Adds one or more tags to the specified resource
untag_resource Removes any tags with the specified keys from the specified resource
update_organizational_unit Renames the specified organizational unit (OU)
update_policy Updates an existing policy with a new name, description, or content

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
## Not run: 
svc <- organizations()
# Bill is the owner of an organization, and he invites Juan's account
# (222222222222) to join his organization. The following example shows
# Juan's account accepting the handshake and thus agreeing to the
# invitation.
svc$accept_handshake(
  HandshakeId = "h-examplehandshakeid111"
)

## End(Not run)

paws.management documentation built on March 8, 2021, 1:07 a.m.