Class: AWS.Organizations

Inherits:
AWS.Service show all
Identifier:
organizations
API Version:
2016-11-28
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

AWS Organizations is a web service that enables you to consolidate your multiple AWS accounts into an organization and centrally manage your accounts and their resources.

This guide provides descriptions of the Organizations API. For more information about using this service, see the AWS Organizations User Guide.

API Version

This version of the Organizations API Reference documents the Organizations API version 2016-11-28.

Note: As an alternative to using the API directly, you can use one of the AWS SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, and more). The SDKs provide a convenient way to create programmatic access to AWS Organizations. For example, the SDKs take care of cryptographically signing requests, managing errors, and retrying requests automatically. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.

We recommend that you use the AWS SDKs to make programmatic API calls to Organizations. However, you also can use the Organizations Query API to make direct calls to the Organizations web service. To learn more about the Organizations Query API, see Making Query Requests in the AWS Organizations User Guide. Organizations supports GET and POST requests for all actions. That is, the API does not require you to use GET for some actions and POST for others. However, GET requests are subject to the limitation size of a URL. Therefore, for operations that require larger sizes, use a POST request.

Signing Requests

When you send HTTP requests to AWS, you must sign the requests so that AWS can identify who sent them. You sign requests with your AWS access key, which consists of an access key ID and a secret access key. We strongly recommend that you do not create an access key for your root account. Anyone who has the access key for your root account has unrestricted access to all the resources in your account. Instead, create an access key for an IAM user account that has administrative privileges. As another option, use AWS Security Token Service to generate temporary security credentials, and use those credentials to sign requests.

To sign requests, we recommend that you use Signature Version 4. If you have an existing application that uses Signature Version 2, you do not have to update it to use Signature Version 4. However, some operations now require Signature Version 4. The documentation for operations that require version 4 indicate this requirement.

When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools.

In this release, each organization can have only one root. In a future release, a single organization will support multiple roots.

Support and Feedback for AWS Organizations

We welcome your feedback. Send your comments to feedback-awsorganizations@amazon.com or post your feedback and questions in the AWS Organizations support forum. For more information about the AWS support forums, see Forums Help.

Endpoint to Call When Using the CLI or the AWS API

For the current release of Organizations, you must specify the us-east-1 region for all AWS API and CLI calls. You can do this in the CLI by using these parameters and commands:

  • Use the following parameter with each command to specify both the endpoint and its region:

    --endpoint-url https://organizations.us-east-1.amazonaws.com

  • Use the default endpoint, but configure your default region with this command:

    aws configure set default.region us-east-1

  • Use the following parameter with each command to specify the endpoint:

    --region us-east-1

For the various SDKs used to call the APIs, see the documentation for the SDK of interest to learn how to direct the requests to a specific endpoint. For more information, see Regions and Endpoints in the AWS General Reference.

How examples are presented

The JSON returned by the AWS Organizations service as response to your requests is returned as a single long string without line breaks or formatting whitespace. Both line breaks and whitespace are included in the examples in this guide to improve readability. When example input parameters also would result in long strings that would extend beyond the screen, we insert line breaks to enhance readability. You should always submit the input as a single JSON text string.

Recording API Requests

AWS Organizations supports AWS CloudTrail, a service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information collected by AWS CloudTrail, you can determine which requests were successfully made to Organizations, who made the request, when it was made, and so on. For more about AWS Organizations and its support for AWS CloudTrail, see Logging AWS Organizations Events with AWS CloudTrail in the AWS Organizations User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.

Sending a Request Using Organizations

var organizations = new AWS.Organizations();
organizations.listPoliciesForTarget(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Organizations object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var organizations = new AWS.Organizations({apiVersion: '2016-11-28'});

You can also set the API version globally in AWS.config.apiVersions using the organizations service identifier:

AWS.config.apiVersions = {
  organizations: '2016-11-28',
  // other service API versions
};

var organizations = new AWS.Organizations();

Version:

  • 2016-11-28

Constructor Summary

Property Summary

Properties inherited from AWS.Service

apiVersions

Method Summary

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.Organizations(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a Organizations object

var organizations = new AWS.Organizations({apiVersion: '2016-11-28'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.Organizations.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.Organizations.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.Organizations.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean) —

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

acceptHandshake(params = {}, callback) ⇒ AWS.Request

Sends a response to the originator of a handshake agreeing to the action proposed by the handshake request.

This operation can be called only by the following principals when they also have the relevant IAM permissions:

  • Invitation to join or Approve all features request handshakes: only a principal from the member account.

    The user who calls the API for an invitation to join must have the organizations:AcceptHandshake permission. If you enabled all features in the organization, then the user must also have the iam:CreateServiceLinkedRole permission so that Organizations can create the required service-linked role named AWSServiceRoleForOrganizations. For more information, see AWS Organizations and Service-Linked Roles in the AWS Organizations User Guide.

  • Enable all features final confirmation handshake: only a principal from the master account.

    For more information about invitations, see Inviting an AWS Account to Join Your Organization in the AWS Organizations User Guide. For more information about requests to enable all features in the organization, see Enabling All Features in Your Organization in the AWS Organizations User Guide.

After you accept a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that it is deleted.

Service Reference:

Examples:

To accept a handshake from another account


/* 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. */

 var params = {
  HandshakeId: "h-examplehandshakeid111"
 };
 organizations.acceptHandshake(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Handshake: {
     Action: "INVITE", 
     Arn: "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", 
     ExpirationTimestamp: <Date Representation>, 
     Id: "h-examplehandshakeid111", 
     Parties: [
        {
       Id: "o-exampleorgid", 
       Type: "ORGANIZATION"
      }, 
        {
       Id: "juan@example.com", 
       Type: "EMAIL"
      }
     ], 
     RequestedTimestamp: <Date Representation>, 
     Resources: [
        {
       Resources: [
          {
         Type: "MASTER_EMAIL", 
         Value: "bill@amazon.com"
        }, 
          {
         Type: "MASTER_NAME", 
         Value: "Org Master Account"
        }, 
          {
         Type: "ORGANIZATION_FEATURE_SET", 
         Value: "ALL"
        }
       ], 
       Type: "ORGANIZATION", 
       Value: "o-exampleorgid"
      }, 
        {
       Type: "ACCOUNT", 
       Value: "222222222222"
      }
     ], 
     State: "ACCEPTED"
    }
   }
   */
 });

Calling the acceptHandshake operation

var params = {
  HandshakeId: 'STRING_VALUE' /* required */
};
organizations.acceptHandshake(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • HandshakeId — (String)

      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 lower-case letters or digits.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Handshake — (map)

        A structure that contains details about the accepted handshake.

        • Id — (String)

          The unique identifier (ID) of a handshake. The originating account creates the ID when it initiates the handshake.

          The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.

        • Arn — (String)

          The Amazon Resource Name (ARN) of a handshake.

          For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

        • Parties — (Array<map>)

          Information about the two accounts that are participating in the handshake.

          • Id — required — (String)

            The unique identifier (ID) for the party.

            The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.

          • Type — required — (String)

            The type of party.

            Possible values include:
            • "ACCOUNT"
            • "ORGANIZATION"
            • "EMAIL"
        • State — (String)

          The current state of the handshake. Use the state to trace the flow of the handshake through the process from its creation to its acceptance. The meaning of each of the valid values is as follows:

          • REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond.

          • OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action.

          • CANCELED: This handshake is no longer active because it was canceled by the originating account.

          • ACCEPTED: This handshake is complete because it has been accepted by the recipient.

          • DECLINED: This handshake is no longer active because it was declined by the recipient account.

          • EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days).

          Possible values include:
          • "REQUESTED"
          • "OPEN"
          • "CANCELED"
          • "ACCEPTED"
          • "DECLINED"
          • "EXPIRED"
        • RequestedTimestamp — (Date)

          The date and time that the handshake request was made.

        • ExpirationTimestamp — (Date)

          The date and time that the handshake expires. If the recipient of the handshake request fails to respond before the specified date and time, the handshake becomes inactive and is no longer valid.

        • Action — (String)

          The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:

          • INVITE: This type of handshake represents a request to join an organization. It is always sent from the master account to only non-member accounts.

          • ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all features in an organization. It is always sent from the master account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's master account and approval is inferred.

          • APPROVE_ALL_FEATURES: This type of handshake is sent from the Organizations service when all member accounts have approved the ENABLE_ALL_FEATURES invitation. It is sent only to the master account and signals the master that it can finalize the process to enable all features.

          Possible values include:
          • "INVITE"
          • "ENABLE_ALL_FEATURES"
          • "APPROVE_ALL_FEATURES"
          • "ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE"
        • Resources — (Array<map>)

          Additional information that is needed to process the handshake.

          • Value — (String)

            The information that is passed to the other party in the handshake. The format of the value string must match the requirements of the specified type.

          • Type — (String)

            The type of information being passed, specifying how the value is to be interpreted by the other party:

            • ACCOUNT - Specifies an AWS account ID number.

            • ORGANIZATION - Specifies an organization ID number.

            • EMAIL - Specifies the email address that is associated with the account that receives the handshake.

            • OWNER_EMAIL - Specifies the email address associated with the master account. Included as information about an organization.

            • OWNER_NAME - Specifies the name associated with the master account. Included as information about an organization.

            • NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.

            Possible values include:
            • "ACCOUNT"
            • "ORGANIZATION"
            • "ORGANIZATION_FEATURE_SET"
            • "EMAIL"
            • "MASTER_EMAIL"
            • "MASTER_NAME"
            • "NOTES"
            • "PARENT_HANDSHAKE"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

attachPolicy(params = {}, callback) ⇒ AWS.Request

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:

  • Service control policy (SCP) - An SCP specifies what permissions can be delegated to users in affected member accounts. The scope of influence for a policy depends on what you attach the policy to:

    • If you attach an SCP to a root, it affects all accounts in the organization.

    • If you attach an SCP to an OU, it affects all accounts in that OU and in any child OUs.

    • If you attach the policy directly to an account, then it affects only that account.

    SCPs are JSON policies that specify the maximum permissions for an organization or organizational unit (OU). When you attach one SCP to a higher level root or OU, and you also attach a different SCP to a child OU or to an account, the child policy can further restrict only the permissions that pass through the parent filter and are available to the child. An SCP that is attached to a child cannot grant a permission that is not already granted by the parent. For example, imagine that the parent SCP allows permissions A, B, C, D, and E. The child SCP allows C, D, E, F, and G. The result is that the accounts affected by the child SCP are allowed to use only C, D, and E. They cannot use A or B because they were filtered out by the child OU. They also cannot use F and G because they were filtered out by the parent OU. They cannot be granted back by the child SCP; child SCPs can only filter the permissions they receive from the parent SCP.

    AWS Organizations attaches a default SCP named "FullAWSAccess to every root, OU, and account. This default SCP allows all services and actions, enabling any new child OU or account to inherit the permissions of the parent root or OU. If you detach the default policy, you must replace it with a policy that specifies the permissions that you want to allow in that OU or account.

    For more information about how Organizations policies permissions work, see Using Service Control Policies in the AWS Organizations User Guide.

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

Service Reference:

Examples:

To attach a policy to an OU


/* The following example shows how to attach a service control policy (SCP) to an OU:
*/

 var params = {
  PolicyId: "p-examplepolicyid111", 
  TargetId: "ou-examplerootid111-exampleouid111"
 };
 organizations.attachPolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

To attach a policy to an account


/* The following example shows how to attach a service control policy (SCP) to an account:
*/

 var params = {
  PolicyId: "p-examplepolicyid111", 
  TargetId: "333333333333"
 };
 organizations.attachPolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the attachPolicy operation

var params = {
  PolicyId: 'STRING_VALUE', /* required */
  TargetId: 'STRING_VALUE' /* required */
};
organizations.attachPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • PolicyId — (String)

      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 lower-case letters or digits.

    • TargetId — (String)

      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 lower-case 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 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

cancelHandshake(params = {}, callback) ⇒ AWS.Request

Cancels a handshake. Canceling a handshake sets the handshake state to CANCELED.

This operation can be called only from the account that originated the handshake. The recipient of the handshake can't cancel it, but can use DeclineHandshake instead. After a handshake is canceled, the recipient can no longer respond to that handshake.

After you cancel a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that it is deleted.

Service Reference:

Examples:

To cancel a handshake sent to a member account


/* Bill previously sent an invitation to Susan's account to join his organization. He changes his mind and decides to cancel the invitation before Susan accepts it. The following example shows Bill's cancellation:
*/

 var params = {
  HandshakeId: "h-examplehandshakeid111"
 };
 organizations.cancelHandshake(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Handshake: {
     Action: "INVITE", 
     Arn: "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", 
     ExpirationTimestamp: <Date Representation>, 
     Id: "h-examplehandshakeid111", 
     Parties: [
        {
       Id: "o-exampleorgid", 
       Type: "ORGANIZATION"
      }, 
        {
       Id: "susan@example.com", 
       Type: "EMAIL"
      }
     ], 
     RequestedTimestamp: <Date Representation>, 
     Resources: [
        {
       Resources: [
          {
         Type: "MASTER_EMAIL", 
         Value: "bill@example.com"
        }, 
          {
         Type: "MASTER_NAME", 
         Value: "Master Account"
        }, 
          {
         Type: "ORGANIZATION_FEATURE_SET", 
         Value: "CONSOLIDATED_BILLING"
        }
       ], 
       Type: "ORGANIZATION", 
       Value: "o-exampleorgid"
      }, 
        {
       Type: "ACCOUNT", 
       Value: "222222222222"
      }, 
        {
       Type: "NOTES", 
       Value: "This is a request for Susan's account to join Bob's organization."
      }
     ], 
     State: "CANCELED"
    }
   }
   */
 });

Calling the cancelHandshake operation

var params = {
  HandshakeId: 'STRING_VALUE' /* required */
};
organizations.cancelHandshake(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • HandshakeId — (String)

      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 lower-case letters or digits.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Handshake — (map)

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

        • Id — (String)

          The unique identifier (ID) of a handshake. The originating account creates the ID when it initiates the handshake.

          The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.

        • Arn — (String)

          The Amazon Resource Name (ARN) of a handshake.

          For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

        • Parties — (Array<map>)

          Information about the two accounts that are participating in the handshake.

          • Id — required — (String)

            The unique identifier (ID) for the party.

            The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.

          • Type — required — (String)

            The type of party.

            Possible values include:
            • "ACCOUNT"
            • "ORGANIZATION"
            • "EMAIL"
        • State — (String)

          The current state of the handshake. Use the state to trace the flow of the handshake through the process from its creation to its acceptance. The meaning of each of the valid values is as follows:

          • REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond.

          • OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action.

          • CANCELED: This handshake is no longer active because it was canceled by the originating account.

          • ACCEPTED: This handshake is complete because it has been accepted by the recipient.

          • DECLINED: This handshake is no longer active because it was declined by the recipient account.

          • EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days).

          Possible values include:
          • "REQUESTED"
          • "OPEN"
          • "CANCELED"
          • "ACCEPTED"
          • "DECLINED"
          • "EXPIRED"
        • RequestedTimestamp — (Date)

          The date and time that the handshake request was made.

        • ExpirationTimestamp — (Date)

          The date and time that the handshake expires. If the recipient of the handshake request fails to respond before the specified date and time, the handshake becomes inactive and is no longer valid.

        • Action — (String)

          The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:

          • INVITE: This type of handshake represents a request to join an organization. It is always sent from the master account to only non-member accounts.

          • ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all features in an organization. It is always sent from the master account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's master account and approval is inferred.

          • APPROVE_ALL_FEATURES: This type of handshake is sent from the Organizations service when all member accounts have approved the ENABLE_ALL_FEATURES invitation. It is sent only to the master account and signals the master that it can finalize the process to enable all features.

          Possible values include:
          • "INVITE"
          • "ENABLE_ALL_FEATURES"
          • "APPROVE_ALL_FEATURES"
          • "ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE"
        • Resources — (Array<map>)

          Additional information that is needed to process the handshake.

          • Value — (String)

            The information that is passed to the other party in the handshake. The format of the value string must match the requirements of the specified type.

          • Type — (String)

            The type of information being passed, specifying how the value is to be interpreted by the other party:

            • ACCOUNT - Specifies an AWS account ID number.

            • ORGANIZATION - Specifies an organization ID number.

            • EMAIL - Specifies the email address that is associated with the account that receives the handshake.

            • OWNER_EMAIL - Specifies the email address associated with the master account. Included as information about an organization.

            • OWNER_NAME - Specifies the name associated with the master account. Included as information about an organization.

            • NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.

            Possible values include:
            • "ACCOUNT"
            • "ORGANIZATION"
            • "ORGANIZATION_FEATURE_SET"
            • "EMAIL"
            • "MASTER_EMAIL"
            • "MASTER_NAME"
            • "NOTES"
            • "PARENT_HANDSHAKE"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createAccount(params = {}, callback) ⇒ AWS.Request

Creates an AWS account that is automatically a member of the organization whose credentials made the request. This is an asynchronous request that AWS performs in the background. 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:

The user who calls the API to create an account must have the organizations:CreateAccount permission. If you enabled all features in the organization, AWS Organizations will create the required service-linked role named AWSServiceRoleForOrganizations. For more information, see AWS Organizations and Service-Linked Roles in the AWS Organizations User Guide.

AWS Organizations preconfigures the new member account with a role (named OrganizationAccountAccessRole by default) that grants users in the master account administrator permissions in the new member account. Principals in the master account can assume the role. AWS Organizations clones the company name and address information for the new account from the organization's master account.

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

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

  • When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required for the account to operate as a standalone account, such as a payment method and signing the end user license agreement (EULA) is not automatically collected. If you must remove an account from your organization later, you can do so only after you provide the missing information. Follow the steps at To leave an organization as a member account in the AWS Organizations User Guide.

  • If you get an exception that indicates that you exceeded your account limits for the organization, contact AWS 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 AWS 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 an AWS Account in the AWS Organizations User Guide.
Note: When you create a member account with this operation, you can choose whether to create the account with the IAM User and Role Access to Billing Information switch enabled. If you enable it, IAM users and roles that have appropriate permissions can view billing information for the account. If you disable it, only the account root user can access billing information. For information about how to disable this switch for an account, see Granting Access to Your Billing Information and Tools.

Service Reference:

Examples:

To create a new account that is automatically part of the organization


/* The owner of an organization creates a member account in the organization. The following example shows that when the organization owner creates the member account, the account is preconfigured with the name "Production Account" and an owner email address of susan@example.com.  An IAM role is automatically created using the default name because the roleName parameter is not used. AWS Organizations sends Susan a "Welcome to AWS" email:

*/

 var params = {
  AccountName: "Production Account", 
  Email: "susan@example.com"
 };
 organizations.createAccount(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CreateAccountStatus: {
     Id: "car-examplecreateaccountrequestid111", 
     State: "IN_PROGRESS"
    }
   }
   */
 });

Calling the createAccount operation

var params = {
  AccountName: 'STRING_VALUE', /* required */
  Email: 'STRING_VALUE', /* required */
  IamUserAccessToBilling: ALLOW | DENY,
  RoleName: 'STRING_VALUE'
};
organizations.createAccount(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Email — (String)

      The email address of the owner to assign to the new member account. This email address must not already be associated with another AWS account. You must use a valid email address to complete account creation. You can't access the root user of the account or remove an account that was created with an invalid email address.

    • AccountName — (String)

      The friendly name of the member account.

    • RoleName — (String)

      (Optional)

      The name of an IAM role that AWS Organizations automatically preconfigures in the new member account. This role trusts the master account, allowing users in the master account to assume the role, as permitted by the master 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 Accessing and Administering the Member Accounts in Your Organization in the AWS Organizations User Guide, and steps 2 and 3 in Tutorial: Delegate Access Across AWS Accounts Using IAM Roles in the IAM User Guide.

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

    • IamUserAccessToBilling — (String)

      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 Activating Access to the Billing and Cost Management Console in the AWS 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.

      Possible values include:
      • "ALLOW"
      • "DENY"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CreateAccountStatus — (map)

        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 AWS CloudTrail log for the CreateAccountResult event. For more information, see Monitoring the Activity in Your Organization in the AWS Organizations User Guide.

        • Id — (String)

          The unique identifier (ID) that references this request. You get this value from the response of the initial CreateAccount request to create the account.

          The regex pattern for an create account request ID string requires "car-" followed by from 8 to 32 lower-case letters or digits.

        • AccountName — (String)

          The account name given to the account when it was created.

        • State — (String)

          The status of the request.

          Possible values include:
          • "IN_PROGRESS"
          • "SUCCEEDED"
          • "FAILED"
        • RequestedTimestamp — (Date)

          The date and time that the request was made for the account creation.

        • CompletedTimestamp — (Date)

          The date and time that the account was created and the request completed.

        • AccountId — (String)

          If the account was created successfully, the unique identifier (ID) of the new account.

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

        • GovCloudAccountId — (String)

        • FailureReason — (String)

          If the request failed, a description of the reason for the failure.

          • ACCOUNT_LIMIT_EXCEEDED: The account could not be created because you have reached the limit on the number of accounts in your organization.

          • EMAIL_ALREADY_EXISTS: The account could not be created because another AWS account with that email address already exists.

          • INVALID_ADDRESS: The account could not be created because the address you provided is not valid.

          • INVALID_EMAIL: The account could not be created because the email address you provided is not valid.

          • INTERNAL_FAILURE: The account could not be created because of an internal failure. Try again later. If the problem persists, contact Customer Support.

          Possible values include:
          • "ACCOUNT_LIMIT_EXCEEDED"
          • "EMAIL_ALREADY_EXISTS"
          • "INVALID_ADDRESS"
          • "INVALID_EMAIL"
          • "CONCURRENT_ACCOUNT_MODIFICATION"
          • "INTERNAL_FAILURE"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createGovCloudAccount(params = {}, callback) ⇒ AWS.Request

This action is available if all of the following are true:

  • You are authorized to create accounts in the AWS GovCloud (US) Region. For more information on the AWS GovCloud (US) Region, see the AWS GovCloud User Guide.

  • You already have an account in the AWS GovCloud (US) Region that is associated with your master account in the commercial Region.

  • You call this action from the master account of your organization in the commercial Region.

  • You have the organizations:CreateGovCloudAccount permission. AWS Organizations creates the required service-linked role named AWSServiceRoleForOrganizations. For more information, see AWS Organizations and Service-Linked Roles in the AWS Organizations User Guide.

AWS automatically enables AWS CloudTrail for AWS GovCloud (US) accounts, but you should also do the following:

  • Verify that AWS CloudTrail is enabled to store logs.

  • Create an S3 bucket for AWS CloudTrail log storage.

    For more information, see Verifying AWS CloudTrail Is Enabled in the AWS GovCloud User Guide.

You call this action from the master account of your organization in the commercial Region to create a standalone AWS account in the AWS GovCloud (US) Region. After the account is created, the master account of an organization in the AWS GovCloud (US) Region can invite it to that organization. For more information on inviting standalone accounts in the AWS GovCloud (US) to join an organization, see AWS Organizations in the AWS GovCloud User Guide.

Calling CreateGovCloudAccount is an asynchronous request that AWS 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:

When you call the CreateGovCloudAccount action, you create two accounts: a standalone account in the AWS 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 master account in the organization in the commercial Region to assume it. An AWS GovCloud (US) account is then created and associated with the commercial account that you just created. A role is created in the new AWS GovCloud (US) account that can be assumed by the AWS GovCloud (US) account that is associated with the master account of the commercial organization. For more information and to view a diagram that explains how account access works, see AWS Organizations in the AWS GovCloud User Guide.

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

  • When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required for the account to operate as a standalone account, such as a payment method and signing the end user license agreement (EULA) is not automatically collected. If you must remove an account from your organization later, you can do so only after you provide the missing information. Follow the steps at To leave an organization as a member account in the AWS Organizations User Guide.

  • If you get an exception that indicates that you exceeded your account limits for the organization, contact AWS 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 AWS Support.

  • Using CreateGovCloudAccount to create multiple temporary accounts isn't recommended. You can only close an account from the AWS 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 an AWS Account in the AWS Organizations User Guide.
Note: When you create a member account with this operation, you can choose whether to create the account with the IAM User and Role Access to Billing Information switch enabled. If you enable it, IAM users and roles that have appropriate permissions can view billing information for the account. If you disable it, only the account root user can access billing information. For information about how to disable this switch for an account, see Granting Access to Your Billing Information and Tools.

Service Reference:

Examples:

Calling the createGovCloudAccount operation

var params = {
  AccountName: 'STRING_VALUE', /* required */
  Email: 'STRING_VALUE', /* required */
  IamUserAccessToBilling: ALLOW | DENY,
  RoleName: 'STRING_VALUE'
};
organizations.createGovCloudAccount(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Email — (String)

      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 AWS account. You must use a valid email address to complete account creation. 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 AWS GovCloud (US) account originates from the commercial Region, not from the AWS GovCloud (US) Region.

    • AccountName — (String)

      The friendly name of the member account.

    • RoleName — (String)

      (Optional)

      The name of an IAM role that AWS Organizations automatically preconfigures in the new member accounts in both the AWS GovCloud (US) Region and in the commercial Region. This role trusts the master account, allowing users in the master account to assume the role, as permitted by the master 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 Accessing and Administering the Member Accounts in Your Organization in the AWS Organizations User Guide and steps 2 and 3 in Tutorial: Delegate Access Across AWS Accounts Using IAM Roles in the IAM User Guide.

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

    • IamUserAccessToBilling — (String)

      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 Activating Access to the Billing and Cost Management Console in the AWS 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.

      Possible values include:
      • "ALLOW"
      • "DENY"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CreateAccountStatus — (map)

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

        • Id — (String)

          The unique identifier (ID) that references this request. You get this value from the response of the initial CreateAccount request to create the account.

          The regex pattern for an create account request ID string requires "car-" followed by from 8 to 32 lower-case letters or digits.

        • AccountName — (String)

          The account name given to the account when it was created.

        • State — (String)

          The status of the request.

          Possible values include:
          • "IN_PROGRESS"
          • "SUCCEEDED"
          • "FAILED"
        • RequestedTimestamp — (Date)

          The date and time that the request was made for the account creation.

        • CompletedTimestamp — (Date)

          The date and time that the account was created and the request completed.

        • AccountId — (String)

          If the account was created successfully, the unique identifier (ID) of the new account.

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

        • GovCloudAccountId — (String)

        • FailureReason — (String)

          If the request failed, a description of the reason for the failure.

          • ACCOUNT_LIMIT_EXCEEDED: The account could not be created because you have reached the limit on the number of accounts in your organization.

          • EMAIL_ALREADY_EXISTS: The account could not be created because another AWS account with that email address already exists.

          • INVALID_ADDRESS: The account could not be created because the address you provided is not valid.

          • INVALID_EMAIL: The account could not be created because the email address you provided is not valid.

          • INTERNAL_FAILURE: The account could not be created because of an internal failure. Try again later. If the problem persists, contact Customer Support.

          Possible values include:
          • "ACCOUNT_LIMIT_EXCEEDED"
          • "EMAIL_ALREADY_EXISTS"
          • "INVALID_ADDRESS"
          • "INVALID_EMAIL"
          • "CONCURRENT_ACCOUNT_MODIFICATION"
          • "INTERNAL_FAILURE"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createOrganization(params = {}, callback) ⇒ AWS.Request

Creates an AWS organization. The account whose user is calling the CreateOrganization operation automatically becomes the master account of the new organization.

This operation must be called using credentials from the account that is to become the new organization's master account. The principal must also have the relevant IAM permissions.

By default (or if you set the FeatureSet parameter to ALL), the new organization is created with all features enabled and service control policies automatically enabled in the root. If you instead choose to create the organization supporting only the consolidated billing features by setting the FeatureSet parameter to CONSOLIDATED_BILLING", then no policy types are enabled by default and you cannot use organization policies.

Service Reference:

Examples:

To create a new organization with all features enabled


/* Bill wants to create an organization using credentials from account 111111111111. The following example shows that the account becomes the master account in the new organization. Because he does not specify a feature set, the new organization defaults to all features enabled and service control policies enabled on the root:

*/

 var params = {
 };
 organizations.createOrganization(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Organization: {
     Arn: "arn:aws:organizations::111111111111:organization/o-exampleorgid", 
     AvailablePolicyTypes: [
        {
       Status: "ENABLED", 
       Type: "SERVICE_CONTROL_POLICY"
      }
     ], 
     FeatureSet: "ALL", 
     Id: "o-exampleorgid", 
     MasterAccountArn: "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111", 
     MasterAccountEmail: "bill@example.com", 
     MasterAccountId: "111111111111"
    }
   }
   */
 });

To create a new organization with consolidated billing features only


/* In the following example, Bill creates an organization using credentials from account 111111111111, and configures the organization to support only the consolidated billing feature set:

*/

 var params = {
  FeatureSet: "CONSOLIDATED_BILLING"
 };
 organizations.createOrganization(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Organization: {
     Arn: "arn:aws:organizations::111111111111:organization/o-exampleorgid", 
     AvailablePolicyTypes: [
     ], 
     FeatureSet: "CONSOLIDATED_BILLING", 
     Id: "o-exampleorgid", 
     MasterAccountArn: "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111", 
     MasterAccountEmail: "bill@example.com", 
     MasterAccountId: "111111111111"
    }
   }
   */
 });

Calling the createOrganization operation

var params = {
  FeatureSet: ALL | CONSOLIDATED_BILLING
};
organizations.createOrganization(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • FeatureSet — (String)

      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 master account. For more information, see Consolidated billing in the AWS Organizations User Guide.

        The consolidated billing feature subset isn't available for organizations in the AWS GovCloud (US) Region.

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

      Possible values include:
      • "ALL"
      • "CONSOLIDATED_BILLING"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Organization — (map)

        A structure that contains details about the newly created organization.

        • Id — (String)

          The unique identifier (ID) of an organization.

          The regex pattern for an organization ID string requires "o-" followed by from 10 to 32 lower-case letters or digits.

        • Arn — (String)

          The Amazon Resource Name (ARN) of an organization.

          For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

        • FeatureSet — (String)

          Specifies the functionality that currently is available to the organization. If set to "ALL", then all features are enabled and policies can be applied to accounts in the organization. If set to "CONSOLIDATED_BILLING", then only consolidated billing functionality is available. For more information, see Enabling All Features in Your Organization in the AWS Organizations User Guide.

          Possible values include:
          • "ALL"
          • "CONSOLIDATED_BILLING"
        • MasterAccountArn — (String)

          The Amazon Resource Name (ARN) of the account that is designated as the master account for the organization.

          For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

        • MasterAccountId — (String)

          The unique identifier (ID) of the master account of an organization.

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

        • MasterAccountEmail — (String)

          The email address that is associated with the AWS account that is designated as the master account for the organization.

        • AvailablePolicyTypes — (Array<map>)

          A list of policy types that are enabled for this organization. For example, if your organization has all features enabled, then service control policies (SCPs) are included in the list.

          Note: Even if a policy type is shown as available in the organization, you can separately enable and disable them at the root level by using EnablePolicyType and DisablePolicyType. Use ListRoots to see the status of a policy type in that root.
          • Type — (String)

            The name of the policy type.

            Possible values include:
            • "SERVICE_CONTROL_POLICY"
          • Status — (String)

            The status of the policy type as it relates to the associated root. To attach a policy of the specified type to a root or to an OU or account in that root, it must be available in the organization and enabled for that root.

            Possible values include:
            • "ENABLED"
            • "PENDING_ENABLE"
            • "PENDING_DISABLE"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createOrganizationalUnit(params = {}, callback) ⇒ AWS.Request

Creates an organizational unit (OU) within a root or parent OU. An OU is a container for accounts that enables you to organize your accounts to apply policies according to your business requirements. The number of levels deep that you can nest OUs is dependent upon the policy types enabled for that root. For service control policies, the limit is five.

For more information about OUs, see Managing Organizational Units in the AWS Organizations User Guide.

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

Service Reference:

Examples:

To create a new organization unit


/* The following example shows how to create an OU that is named AccountingOU. The new OU is directly under the root.:

*/

 var params = {
  Name: "AccountingOU", 
  ParentId: "r-examplerootid111"
 };
 organizations.createOrganizationalUnit(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    OrganizationalUnit: {
     Arn: "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111", 
     Id: "ou-examplerootid111-exampleouid111", 
     Name: "AccountingOU"
    }
   }
   */
 });

Calling the createOrganizationalUnit operation

var params = {
  Name: 'STRING_VALUE', /* required */
  ParentId: 'STRING_VALUE' /* required */
};
organizations.createOrganizationalUnit(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ParentId — (String)

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

      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 lower-case letters or digits.

      • Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.

    • Name — (String)

      The friendly name to assign to the new OU.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • OrganizationalUnit — (map)

        A structure that contains details about the newly created OU.

        • Id — (String)

          The unique identifier (ID) associated with this OU.

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

        • Arn — (String)

          The Amazon Resource Name (ARN) of this OU.

          For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

        • Name — (String)

          The friendly name of this OU.

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createPolicy(params = {}, callback) ⇒ AWS.Request

Creates a policy of a specified type that you can attach to a root, an organizational unit (OU), or an individual AWS account.

For more information about policies and their use, see Managing Organization Policies.

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

Service Reference:

Examples:

To create a service control policy


/* The following example shows how to create a service control policy (SCP) that is named AllowAllS3Actions. The JSON string in the content parameter specifies the content in the policy. The parameter string is escaped with backslashes to ensure that the embedded double quotes in the JSON policy are treated as literals in the parameter, which itself is surrounded by double quotes:

*/

 var params = {
  Content: "{\\\"Version\\\":\\\"2012-10-17\\\",\\\"Statement\\\":{\\\"Effect\\\":\\\"Allow\\\",\\\"Action\\\":\\\"s3:*\\\"}}", 
  Description: "Enables admins of attached accounts to delegate all S3 permissions", 
  Name: "AllowAllS3Actions", 
  Type: "SERVICE_CONTROL_POLICY"
 };
 organizations.createPolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Policy: {
     Content: "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"s3:*\"}}", 
     PolicySummary: {
      Arn: "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111", 
      Description: "Allows delegation of all S3 actions", 
      Name: "AllowAllS3Actions", 
      Type: "SERVICE_CONTROL_POLICY"
     }
    }
   }
   */
 });

Calling the createPolicy operation

var params = {
  Content: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Type: SERVICE_CONTROL_POLICY /* required */
};
organizations.createPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Content — (String)

      The policy content to add to the new policy. For example, if you create a service control policy (SCP), this string must be JSON text that specifies the permissions that admins in attached accounts can delegate to their users, groups, and roles. For more information about the SCP syntax, see Service Control Policy Syntax in the AWS Organizations User Guide.

    • Description — (String)

      An optional description to assign to the policy.

    • Name — (String)

      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.

    • Type — (String)

      The type of policy to create.

      Note: In the current release, the only type of policy that you can create is a service control policy (SCP).
      Possible values include:
      • "SERVICE_CONTROL_POLICY"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Policy — (map)

        A structure that contains details about the newly created policy.

        • PolicySummary — (map)

          A structure that contains additional details about the policy.

          • Id — (String)

            The unique identifier (ID) of the policy.

            The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits.

          • Arn — (String)

            The Amazon Resource Name (ARN) of the policy.

            For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

          • Name — (String)

            The friendly name of 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 — (String)

            The description of the policy.

          • Type — (String)

            The type of policy.

            Possible values include:
            • "SERVICE_CONTROL_POLICY"
          • AwsManaged — (Boolean)

            A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.

        • Content — (String)

          The text content of the policy.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

declineHandshake(params = {}, callback) ⇒ AWS.Request

Declines a handshake request. This sets the handshake state to DECLINED and effectively deactivates the request.

This operation can be called only from the account that received the handshake. The originator of the handshake can use CancelHandshake instead. The originator can't reactivate a declined request, but can re-initiate the process with a new handshake request.

After you decline a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that it is deleted.

Service Reference:

Examples:

To decline a handshake sent from the master account


/* The following example shows Susan declining an invitation to join Bill's organization. The DeclineHandshake operation returns a handshake object, showing that the state is now DECLINED: */

 var params = {
  HandshakeId: "h-examplehandshakeid111"
 };
 organizations.declineHandshake(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Handshake: {
     Action: "INVITE", 
     Arn: "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", 
     ExpirationTimestamp: <Date Representation>, 
     Id: "h-examplehandshakeid111", 
     Parties: [
        {
       Id: "222222222222", 
       Type: "ACCOUNT"
      }, 
        {
       Id: "o-exampleorgid", 
       Type: "ORGANIZATION"
      }
     ], 
     RequestedTimestamp: <Date Representation>, 
     Resources: [
        {
       Resources: [
          {
         Type: "MASTER_EMAIL", 
         Value: "bill@example.com"
        }, 
          {
         Type: "MASTER_NAME", 
         Value: "Master Account"
        }
       ], 
       Type: "ORGANIZATION", 
       Value: "o-exampleorgid"
      }, 
        {
       Type: "ACCOUNT", 
       Value: "222222222222"
      }, 
        {
       Type: "NOTES", 
       Value: "This is an invitation to Susan's account to join the Bill's organization."
      }
     ], 
     State: "DECLINED"
    }
   }
   */
 });

Calling the declineHandshake operation

var params = {
  HandshakeId: 'STRING_VALUE' /* required */
};
organizations.declineHandshake(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • HandshakeId — (String)

      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 lower-case letters or digits.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Handshake — (map)

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

        • Id — (String)

          The unique identifier (ID) of a handshake. The originating account creates the ID when it initiates the handshake.

          The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.

        • Arn — (String)

          The Amazon Resource Name (ARN) of a handshake.

          For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

        • Parties — (Array<map>)

          Information about the two accounts that are participating in the handshake.

          • Id — required — (String)

            The unique identifier (ID) for the party.

            The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.

          • Type — required — (String)

            The type of party.

            Possible values include:
            • "ACCOUNT"
            • "ORGANIZATION"
            • "EMAIL"
        • State — (String)

          The current state of the handshake. Use the state to trace the flow of the handshake through the process from its creation to its acceptance. The meaning of each of the valid values is as follows:

          • REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond.

          • OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action.

          • CANCELED: This handshake is no longer active because it was canceled by the originating account.

          • ACCEPTED: This handshake is complete because it has been accepted by the recipient.

          • DECLINED: This handshake is no longer active because it was declined by the recipient account.

          • EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days).

          Possible values include:
          • "REQUESTED"
          • "OPEN"
          • "CANCELED"
          • "ACCEPTED"
          • "DECLINED"
          • "EXPIRED"
        • RequestedTimestamp — (Date)

          The date and time that the handshake request was made.

        • ExpirationTimestamp — (Date)

          The date and time that the handshake expires. If the recipient of the handshake request fails to respond before the specified date and time, the handshake becomes inactive and is no longer valid.

        • Action — (String)

          The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:

          • INVITE: This type of handshake represents a request to join an organization. It is always sent from the master account to only non-member accounts.

          • ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all features in an organization. It is always sent from the master account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's master account and approval is inferred.

          • APPROVE_ALL_FEATURES: This type of handshake is sent from the Organizations service when all member accounts have approved the ENABLE_ALL_FEATURES invitation. It is sent only to the master account and signals the master that it can finalize the process to enable all features.

          Possible values include:
          • "INVITE"
          • "ENABLE_ALL_FEATURES"
          • "APPROVE_ALL_FEATURES"
          • "ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE"
        • Resources — (Array<map>)

          Additional information that is needed to process the handshake.

          • Value — (String)

            The information that is passed to the other party in the handshake. The format of the value string must match the requirements of the specified type.

          • Type — (String)

            The type of information being passed, specifying how the value is to be interpreted by the other party:

            • ACCOUNT - Specifies an AWS account ID number.

            • ORGANIZATION - Specifies an organization ID number.

            • EMAIL - Specifies the email address that is associated with the account that receives the handshake.

            • OWNER_EMAIL - Specifies the email address associated with the master account. Included as information about an organization.

            • OWNER_NAME - Specifies the name associated with the master account. Included as information about an organization.

            • NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.

            Possible values include:
            • "ACCOUNT"
            • "ORGANIZATION"
            • "ORGANIZATION_FEATURE_SET"
            • "EMAIL"
            • "MASTER_EMAIL"
            • "MASTER_NAME"
            • "NOTES"
            • "PARENT_HANDSHAKE"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteOrganization(params = {}, callback) ⇒ AWS.Request

Deletes the organization. You can delete an organization only by using credentials from the master account. The organization must be empty of member accounts.

Service Reference:

Examples:

Calling the deleteOrganization operation

organizations.deleteOrganization(function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteOrganizationalUnit(params = {}, callback) ⇒ AWS.Request

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 master account.

Service Reference:

Examples:

To delete an organization unit


/* The following example shows how to delete an OU. The example assumes that you previously removed all accounts and other OUs from the OU:

*/

 var params = {
  OrganizationalUnitId: "ou-examplerootid111-exampleouid111"
 };
 organizations.deleteOrganizationalUnit(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteOrganizationalUnit operation

var params = {
  OrganizationalUnitId: 'STRING_VALUE' /* required */
};
organizations.deleteOrganizationalUnit(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • OrganizationalUnitId — (String)

      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 lower-case letters or digits (the ID of the root that contains the OU) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deletePolicy(params = {}, callback) ⇒ AWS.Request

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 master account.

Service Reference:

Examples:

To delete a policy


/* The following example shows how to delete a policy from an organization. The example assumes that you previously detached the policy from all entities:

*/

 var params = {
  PolicyId: "p-examplepolicyid111"
 };
 organizations.deletePolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deletePolicy operation

var params = {
  PolicyId: 'STRING_VALUE' /* required */
};
organizations.deletePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • PolicyId — (String)

      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 lower-case letters or digits.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeAccount(params = {}, callback) ⇒ AWS.Request

Retrieves Organizations-related information about the specified account.

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

Service Reference:

Examples:

To get the details about an account


/* The following example shows a user in the master account (111111111111) asking for details about account 555555555555: */

 var params = {
  AccountId: "555555555555"
 };
 organizations.describeAccount(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Account: {
     Arn: "arn:aws:organizations::111111111111:account/o-exampleorgid/555555555555", 
     Email: "anika@example.com", 
     Id: "555555555555", 
     Name: "Beta Account"
    }
   }
   */
 });

Calling the describeAccount operation

var params = {
  AccountId: 'STRING_VALUE' /* required */
};
organizations.describeAccount(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AccountId — (String)

      The unique identifier (ID) of the AWS 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Account — (map)

        A structure that contains information about the requested account.

        • Id — (String)

          The unique identifier (ID) of the account.

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

        • Arn — (String)

          The Amazon Resource Name (ARN) of the account.

          For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

        • Email — (String)

          The email address associated with the AWS account.

          The regex pattern for this parameter is a string of characters that represents a standard Internet email address.

        • Name — (String)

          The friendly name of the account.

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

        • Status — (String)

          The status of the account in the organization.

          Possible values include:
          • "ACTIVE"
          • "SUSPENDED"
        • JoinedMethod — (String)

          The method by which the account joined the organization.

          Possible values include:
          • "INVITED"
          • "CREATED"
        • JoinedTimestamp — (Date)

          The date the account became a part of the organization.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeCreateAccountStatus(params = {}, callback) ⇒ AWS.Request

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

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

Service Reference:

Examples:

To get information about a request to create an account


/* The following example shows how to request the status about a previous request to create an account in an organization. This operation can be called only by a principal from the organization's master account. In the example, the specified "createAccountRequestId" comes from the response of the original call to "CreateAccount": */

 var params = {
  CreateAccountRequestId: "car-exampleaccountcreationrequestid"
 };
 organizations.describeCreateAccountStatus(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CreateAccountStatus: {
     AccountId: "333333333333", 
     Id: "car-exampleaccountcreationrequestid", 
     State: "SUCCEEDED"
    }
   }
   */
 });

Calling the describeCreateAccountStatus operation

var params = {
  CreateAccountRequestId: 'STRING_VALUE' /* required */
};
organizations.describeCreateAccountStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CreateAccountRequestId — (String)

      Specifies the operationId that uniquely identifies the request. You can get the ID from the response to an earlier CreateAccount request, or from the ListCreateAccountStatus operation.

      The regex pattern for an create account request ID string requires "car-" followed by from 8 to 32 lower-case letters or digits.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CreateAccountStatus — (map)

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

        • Id — (String)

          The unique identifier (ID) that references this request. You get this value from the response of the initial CreateAccount request to create the account.

          The regex pattern for an create account request ID string requires "car-" followed by from 8 to 32 lower-case letters or digits.

        • AccountName — (String)

          The account name given to the account when it was created.

        • State — (String)

          The status of the request.

          Possible values include:
          • "IN_PROGRESS"
          • "SUCCEEDED"
          • "FAILED"
        • RequestedTimestamp — (Date)

          The date and time that the request was made for the account creation.

        • CompletedTimestamp — (Date)

          The date and time that the account was created and the request completed.

        • AccountId — (String)

          If the account was created successfully, the unique identifier (ID) of the new account.

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

        • GovCloudAccountId — (String)

        • FailureReason — (String)

          If the request failed, a description of the reason for the failure.

          • ACCOUNT_LIMIT_EXCEEDED: The account could not be created because you have reached the limit on the number of accounts in your organization.

          • EMAIL_ALREADY_EXISTS: The account could not be created because another AWS account with that email address already exists.

          • INVALID_ADDRESS: The account could not be created because the address you provided is not valid.

          • INVALID_EMAIL: The account could not be created because the email address you provided is not valid.

          • INTERNAL_FAILURE: The account could not be created because of an internal failure. Try again later. If the problem persists, contact Customer Support.

          Possible values include:
          • "ACCOUNT_LIMIT_EXCEEDED"
          • "EMAIL_ALREADY_EXISTS"
          • "INVALID_ADDRESS"
          • "INVALID_EMAIL"
          • "CONCURRENT_ACCOUNT_MODIFICATION"
          • "INTERNAL_FAILURE"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeHandshake(params = {}, callback) ⇒ AWS.Request

Retrieves information about a previously requested handshake. The handshake ID comes from the response to the original InviteAccountToOrganization operation that generated the handshake.

You can access handshakes that are ACCEPTED, DECLINED, or CANCELED for only 30 days after they change to that state. They are then deleted and no longer accessible.

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

Service Reference:

Examples:

To get information about a handshake


/* The following example shows you how to request details about a handshake. The handshake ID comes either from the original call to "InviteAccountToOrganization", or from a call to "ListHandshakesForAccount" or "ListHandshakesForOrganization": */

 var params = {
  HandshakeId: "h-examplehandshakeid111"
 };
 organizations.describeHandshake(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Handshake: {
     Action: "INVITE", 
     Arn: "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", 
     ExpirationTimestamp: <Date Representation>, 
     Id: "h-examplehandshakeid111", 
     Parties: [
        {
       Id: "o-exampleorgid", 
       Type: "ORGANIZATION"
      }, 
        {
       Id: "333333333333", 
       Type: "ACCOUNT"
      }
     ], 
     RequestedTimestamp: <Date Representation>, 
     Resources: [
        {
       Resources: [
          {
         Type: "MASTER_EMAIL", 
         Value: "bill@example.com"
        }, 
          {
         Type: "MASTER_NAME", 
         Value: "Master Account"
        }
       ], 
       Type: "ORGANIZATION", 
       Value: "o-exampleorgid"
      }, 
        {
       Type: "ACCOUNT", 
       Value: "333333333333"
      }
     ], 
     State: "OPEN"
    }
   }
   */
 });

Calling the describeHandshake operation

var params = {
  HandshakeId: 'STRING_VALUE' /* required */
};
organizations.describeHandshake(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Handshake — (map)

        A structure that contains information about the specified handshake.

        • Id — (String)

          The unique identifier (ID) of a handshake. The originating account creates the ID when it initiates the handshake.

          The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.

        • Arn — (String)

          The Amazon Resource Name (ARN) of a handshake.

          For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

        • Parties — (Array<map>)

          Information about the two accounts that are participating in the handshake.

          • Id — required — (String)

            The unique identifier (ID) for the party.

            The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.

          • Type — required — (String)

            The type of party.

            Possible values include:
            • "ACCOUNT"
            • "ORGANIZATION"
            • "EMAIL"
        • State — (String)

          The current state of the handshake. Use the state to trace the flow of the handshake through the process from its creation to its acceptance. The meaning of each of the valid values is as follows:

          • REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond.

          • OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action.

          • CANCELED: This handshake is no longer active because it was canceled by the originating account.

          • ACCEPTED: This handshake is complete because it has been accepted by the recipient.

          • DECLINED: This handshake is no longer active because it was declined by the recipient account.

          • EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days).

          Possible values include:
          • "REQUESTED"
          • "OPEN"
          • "CANCELED"
          • "ACCEPTED"
          • "DECLINED"
          • "EXPIRED"
        • RequestedTimestamp — (Date)

          The date and time that the handshake request was made.

        • ExpirationTimestamp — (Date)

          The date and time that the handshake expires. If the recipient of the handshake request fails to respond before the specified date and time, the handshake becomes inactive and is no longer valid.

        • Action — (String)

          The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:

          • INVITE: This type of handshake represents a request to join an organization. It is always sent from the master account to only non-member accounts.

          • ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all features in an organization. It is always sent from the master account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's master account and approval is inferred.

          • APPROVE_ALL_FEATURES: This type of handshake is sent from the Organizations service when all member accounts have approved the ENABLE_ALL_FEATURES invitation. It is sent only to the master account and signals the master that it can finalize the process to enable all features.

          Possible values include:
          • "INVITE"
          • "ENABLE_ALL_FEATURES"
          • "APPROVE_ALL_FEATURES"
          • "ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE"
        • Resources — (Array<map>)

          Additional information that is needed to process the handshake.

          • Value — (String)

            The information that is passed to the other party in the handshake. The format of the value string must match the requirements of the specified type.

          • Type — (String)

            The type of information being passed, specifying how the value is to be interpreted by the other party:

            • ACCOUNT - Specifies an AWS account ID number.

            • ORGANIZATION - Specifies an organization ID number.

            • EMAIL - Specifies the email address that is associated with the account that receives the handshake.

            • OWNER_EMAIL - Specifies the email address associated with the master account. Included as information about an organization.

            • OWNER_NAME - Specifies the name associated with the master account. Included as information about an organization.

            • NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.

            Possible values include:
            • "ACCOUNT"
            • "ORGANIZATION"
            • "ORGANIZATION_FEATURE_SET"
            • "EMAIL"
            • "MASTER_EMAIL"
            • "MASTER_NAME"
            • "NOTES"
            • "PARENT_HANDSHAKE"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeOrganization(params = {}, callback) ⇒ AWS.Request

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

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

Note: Even if a policy type is shown as available in the organization, it can be disabled separately at the root level with DisablePolicyType. Use ListRoots to see the status of policy types for a specified root.

Service Reference:

Examples:

To get information about an organization


/* The following example shows how to request information about the current user's organization:/n/n */

 var params = {};
 organizations.describeOrganization(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Organization: {
     Arn: "arn:aws:organizations::111111111111:organization/o-exampleorgid", 
     AvailablePolicyTypes: [
        {
       Status: "ENABLED", 
       Type: "SERVICE_CONTROL_POLICY"
      }
     ], 
     FeatureSet: "ALL", 
     Id: "o-exampleorgid", 
     MasterAccountArn: "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111", 
     MasterAccountEmail: "bill@example.com"
    }
   }
   */
 });

Calling the describeOrganization operation

organizations.describeOrganization(function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Organization — (map)

        A structure that contains information about the organization.

        • Id — (String)

          The unique identifier (ID) of an organization.

          The regex pattern for an organization ID string requires "o-" followed by from 10 to 32 lower-case letters or digits.

        • Arn — (String)

          The Amazon Resource Name (ARN) of an organization.

          For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

        • FeatureSet — (String)

          Specifies the functionality that currently is available to the organization. If set to "ALL", then all features are enabled and policies can be applied to accounts in the organization. If set to "CONSOLIDATED_BILLING", then only consolidated billing functionality is available. For more information, see Enabling All Features in Your Organization in the AWS Organizations User Guide.

          Possible values include:
          • "ALL"
          • "CONSOLIDATED_BILLING"
        • MasterAccountArn — (String)

          The Amazon Resource Name (ARN) of the account that is designated as the master account for the organization.

          For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

        • MasterAccountId — (String)

          The unique identifier (ID) of the master account of an organization.

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

        • MasterAccountEmail — (String)

          The email address that is associated with the AWS account that is designated as the master account for the organization.

        • AvailablePolicyTypes — (Array<map>)

          A list of policy types that are enabled for this organization. For example, if your organization has all features enabled, then service control policies (SCPs) are included in the list.

          Note: Even if a policy type is shown as available in the organization, you can separately enable and disable them at the root level by using EnablePolicyType and DisablePolicyType. Use ListRoots to see the status of a policy type in that root.
          • Type — (String)

            The name of the policy type.

            Possible values include:
            • "SERVICE_CONTROL_POLICY"
          • Status — (String)

            The status of the policy type as it relates to the associated root. To attach a policy of the specified type to a root or to an OU or account in that root, it must be available in the organization and enabled for that root.

            Possible values include:
            • "ENABLED"
            • "PENDING_ENABLE"
            • "PENDING_DISABLE"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeOrganizationalUnit(params = {}, callback) ⇒ AWS.Request

Retrieves information about an organizational unit (OU).

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

Service Reference:

Examples:

To get information about an organizational unit


/* The following example shows how to request details about an OU:/n/n */

 var params = {
  OrganizationalUnitId: "ou-examplerootid111-exampleouid111"
 };
 organizations.describeOrganizationalUnit(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    OrganizationalUnit: {
     Arn: "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111", 
     Id: "ou-examplerootid111-exampleouid111", 
     Name: "Accounting Group"
    }
   }
   */
 });

Calling the describeOrganizationalUnit operation

var params = {
  OrganizationalUnitId: 'STRING_VALUE' /* required */
};
organizations.describeOrganizationalUnit(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • OrganizationalUnitId — (String)

      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 lower-case letters or digits (the ID of the root that contains the OU) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • OrganizationalUnit — (map)

        A structure that contains details about the specified OU.

        • Id — (String)

          The unique identifier (ID) associated with this OU.

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

        • Arn — (String)

          The Amazon Resource Name (ARN) of this OU.

          For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

        • Name — (String)

          The friendly name of this OU.

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describePolicy(params = {}, callback) ⇒ AWS.Request

Retrieves information about a policy.

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

Service Reference:

Examples:

To get information about a policy


/* The following example shows how to request information about a policy:/n/n */

 var params = {
  PolicyId: "p-examplepolicyid111"
 };
 organizations.describePolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Policy: {
     Content: "{\\n  \\\"Version\\\": \\\"2012-10-17\\\",\\n  \\\"Statement\\\": [\\n    {\\n      \\\"Effect\\\": \\\"Allow\\\",\\n      \\\"Action\\\": \\\"*\\\",\\n      \\\"Resource\\\": \\\"*\\\"\\n    }\\n  ]\\n}", 
     PolicySummary: {
      Arn: "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111", 
      AwsManaged: false, 
      Description: "Enables admins to delegate S3 permissions", 
      Id: "p-examplepolicyid111", 
      Name: "AllowAllS3Actions", 
      Type: "SERVICE_CONTROL_POLICY"
     }
    }
   }
   */
 });

Calling the describePolicy operation

var params = {
  PolicyId: 'STRING_VALUE' /* required */
};
organizations.describePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • PolicyId — (String)

      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 lower-case letters or digits.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Policy — (map)

        A structure that contains details about the specified policy.

        • PolicySummary — (map)

          A structure that contains additional details about the policy.

          • Id — (String)

            The unique identifier (ID) of the policy.

            The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits.

          • Arn — (String)

            The Amazon Resource Name (ARN) of the policy.

            For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

          • Name — (String)

            The friendly name of 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 — (String)

            The description of the policy.

          • Type — (String)

            The type of policy.

            Possible values include:
            • "SERVICE_CONTROL_POLICY"
          • AwsManaged — (Boolean)

            A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.

        • Content — (String)

          The text content of the policy.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

detachPolicy(params = {}, callback) ⇒ AWS.Request

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 IAM users and roles in affected accounts are immediate.

Note: Every root, OU, and account must have at least one SCP attached. If you want to replace the default FullAWSAccess policy with one that limits the permissions that can be delegated, then you must attach the replacement policy before you can remove the default one. This is the authorization strategy of whitelisting. If you instead attach a second SCP and leave the FullAWSAccess SCP still attached, and specify "Effect": "Deny" in the second SCP to override the "Effect": "Allow" in the FullAWSAccess policy (or any other attached SCP), then you are using the authorization strategy of blacklisting.

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

Service Reference:

Examples:

To detach a policy from a root, OU, or account


/* The following example shows how to detach a policy from an OU:/n/n */

 var params = {
  PolicyId: "p-examplepolicyid111", 
  TargetId: "ou-examplerootid111-exampleouid111"
 };
 organizations.detachPolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the detachPolicy operation

var params = {
  PolicyId: 'STRING_VALUE', /* required */
  TargetId: 'STRING_VALUE' /* required */
};
organizations.detachPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • PolicyId — (String)

      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 lower-case letters or digits.

    • TargetId — (String)

      The unique identifier (ID) of the root, OU, or account from which you want to detach the policy. 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 lower-case 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 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

disableAWSServiceAccess(params = {}, callback) ⇒ AWS.Request

Disables the integration of an AWS service (the service that is specified by ServicePrincipal) with AWS 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 AWS Organizations.

We recommend that you disable integration between AWS Organizations and the specified AWS service by using the console or commands that are provided by the specified service. Doing so 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 AWS service.

After you perform the DisableAWSServiceAccess operation, the specified service can no longer perform operations in your organization's accounts unless the operations are explicitly permitted by the IAM policies that are attached to your roles.

For more information about integrating other services with AWS Organizations, including the list of services that work with Organizations, see Integrating AWS Organizations with Other AWS Services in the AWS Organizations User Guide.

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

Service Reference:

Examples:

Calling the disableAWSServiceAccess operation

var params = {
  ServicePrincipal: 'STRING_VALUE' /* required */
};
organizations.disableAWSServiceAccess(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ServicePrincipal — (String)

      The service principal name of the AWS 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

disablePolicyType(params = {}, callback) ⇒ AWS.Request

Disables an organizational control policy type in a root. A policy of a certain type can be attached to entities in a root only if that type is enabled in the root. After you perform this operation, you no longer can attach policies of the specified type to that root or to any organizational unit (OU) or account in that root. You can undo this by using the EnablePolicyType operation.

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

Note: If you disable a policy type for a root, it still shows as enabled for the organization if all features are enabled in that organization. Use ListRoots to see the status of policy types for a specified root. Use DescribeOrganization to see the status of policy types in the organization.

Service Reference:

Examples:

To disable a policy type in a root


/* The following example shows how to disable the service control policy (SCP) policy type in a root. The response shows that the PolicyTypes response element no longer includes SERVICE_CONTROL_POLICY:/n/n */

 var params = {
  PolicyType: "SERVICE_CONTROL_POLICY", 
  RootId: "r-examplerootid111"
 };
 organizations.disablePolicyType(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Root: {
     Arn: "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111", 
     Id: "r-examplerootid111", 
     Name: "Root", 
     PolicyTypes: [
     ]
    }
   }
   */
 });

Calling the disablePolicyType operation

var params = {
  PolicyType: SERVICE_CONTROL_POLICY, /* required */
  RootId: 'STRING_VALUE' /* required */
};
organizations.disablePolicyType(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • RootId — (String)

      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 lower-case letters or digits.

    • PolicyType — (String)

      The policy type that you want to disable in this root.

      Possible values include:
      • "SERVICE_CONTROL_POLICY"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Root — (map)

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

        • Id — (String)

          The unique identifier (ID) for the root.

          The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lower-case letters or digits.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the root.

          For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

        • Name — (String)

          The friendly name of the root.

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

        • PolicyTypes — (Array<map>)

          The types of policies that are currently enabled for the root and therefore can be attached to the root or to its OUs or accounts.

          Note: Even if a policy type is shown as available in the organization, you can separately enable and disable them at the root level by using EnablePolicyType and DisablePolicyType. Use DescribeOrganization to see the availability of the policy types in that organization.
          • Type — (String)

            The name of the policy type.

            Possible values include:
            • "SERVICE_CONTROL_POLICY"
          • Status — (String)

            The status of the policy type as it relates to the associated root. To attach a policy of the specified type to a root or to an OU or account in that root, it must be available in the organization and enabled for that root.

            Possible values include:
            • "ENABLED"
            • "PENDING_ENABLE"
            • "PENDING_DISABLE"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

enableAllFeatures(params = {}, callback) ⇒ AWS.Request

Enables all features in an organization. This enables the use of organization policies that can restrict the services and actions that can be called in each account. Until you enable all features, you have access only to consolidated billing, and you can't use any of the advanced account administration features that AWS Organizations supports. For more information, see Enabling All Features in Your Organization in the AWS Organizations User Guide.

This operation is required only for organizations that were created explicitly with only the consolidated billing features enabled. 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 master account in the organization can apply policies on all member accounts. These policies can restrict what users and even administrators in those accounts can do. The master account can apply policies that prevent accounts from leaving the organization. Ensure that your account administrators are aware of this.

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

Service Reference:

Examples:

To enable all features in an organization


/* This example shows the administrator asking all the invited accounts in the organization to approve enabling all features in the organization. AWS Organizations sends an email to the address that is registered with every invited member account asking the owner to approve the change by accepting the handshake that is sent. After all invited member accounts accept the handshake, the organization administrator can finalize the change to enable all features, and those with appropriate permissions can create policies and apply them to roots, OUs, and accounts:/n/n */

 var params = {
 };
 organizations.enableAllFeatures(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Handshake: {
     Action: "ENABLE_ALL_FEATURES", 
     Arn: "arn:aws:organizations::111111111111:handshake/o-exampleorgid/enable_all_features/h-examplehandshakeid111", 
     ExpirationTimestamp: <Date Representation>, 
     Id: "h-examplehandshakeid111", 
     Parties: [
        {
       Id: "o-exampleorgid", 
       Type: "ORGANIZATION"
      }
     ], 
     RequestedTimestamp: <Date Representation>, 
     Resources: [
        {
       Type: "ORGANIZATION", 
       Value: "o-exampleorgid"
      }
     ], 
     State: "REQUESTED"
    }
   }
   */
 });

Calling the enableAllFeatures operation

var params = {
};
organizations.enableAllFeatures(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Handshake — (map)

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

        • Id — (String)

          The unique identifier (ID) of a handshake. The originating account creates the ID when it initiates the handshake.

          The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.

        • Arn — (String)

          The Amazon Resource Name (ARN) of a handshake.

          For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

        • Parties — (Array<map>)

          Information about the two accounts that are participating in the handshake.

          • Id — required — (String)

            The unique identifier (ID) for the party.

            The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.

          • Type — required — (String)

            The type of party.

            Possible values include:
            • "ACCOUNT"
            • "ORGANIZATION"
            • "EMAIL"
        • State — (String)

          The current state of the handshake. Use the state to trace the flow of the handshake through the process from its creation to its acceptance. The meaning of each of the valid values is as follows:

          • REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond.

          • OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action.

          • CANCELED: This handshake is no longer active because it was canceled by the originating account.

          • ACCEPTED: This handshake is complete because it has been accepted by the recipient.

          • DECLINED: This handshake is no longer active because it was declined by the recipient account.

          • EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days).

          Possible values include:
          • "REQUESTED"
          • "OPEN"
          • "CANCELED"
          • "ACCEPTED"
          • "DECLINED"
          • "EXPIRED"
        • RequestedTimestamp — (Date)

          The date and time that the handshake request was made.

        • ExpirationTimestamp — (Date)

          The date and time that the handshake expires. If the recipient of the handshake request fails to respond before the specified date and time, the handshake becomes inactive and is no longer valid.

        • Action — (String)

          The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:

          • INVITE: This type of handshake represents a request to join an organization. It is always sent from the master account to only non-member accounts.

          • ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all features in an organization. It is always sent from the master account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's master account and approval is inferred.

          • APPROVE_ALL_FEATURES: This type of handshake is sent from the Organizations service when all member accounts have approved the ENABLE_ALL_FEATURES invitation. It is sent only to the master account and signals the master that it can finalize the process to enable all features.

          Possible values include:
          • "INVITE"
          • "ENABLE_ALL_FEATURES"
          • "APPROVE_ALL_FEATURES"
          • "ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE"
        • Resources — (Array<map>)

          Additional information that is needed to process the handshake.

          • Value — (String)

            The information that is passed to the other party in the handshake. The format of the value string must match the requirements of the specified type.

          • Type — (String)

            The type of information being passed, specifying how the value is to be interpreted by the other party:

            • ACCOUNT - Specifies an AWS account ID number.

            • ORGANIZATION - Specifies an organization ID number.

            • EMAIL - Specifies the email address that is associated with the account that receives the handshake.

            • OWNER_EMAIL - Specifies the email address associated with the master account. Included as information about an organization.

            • OWNER_NAME - Specifies the name associated with the master account. Included as information about an organization.

            • NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.

            Possible values include:
            • "ACCOUNT"
            • "ORGANIZATION"
            • "ORGANIZATION_FEATURE_SET"
            • "EMAIL"
            • "MASTER_EMAIL"
            • "MASTER_NAME"
            • "NOTES"
            • "PARENT_HANDSHAKE"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

enableAWSServiceAccess(params = {}, callback) ⇒ AWS.Request

Enables the integration of an AWS service (the service that is specified by ServicePrincipal) with AWS 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 AWS Organizations and the specified AWS 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 AWS service.

For more information about enabling services to integrate with AWS Organizations, see Integrating AWS Organizations with Other AWS Services in the AWS Organizations User Guide.

This operation can be called only from the organization's master account and only if the organization has enabled all features.

Service Reference:

Examples:

Calling the enableAWSServiceAccess operation

var params = {
  ServicePrincipal: 'STRING_VALUE' /* required */
};
organizations.enableAWSServiceAccess(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ServicePrincipal — (String)

      The service principal name of the AWS 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

enablePolicyType(params = {}, callback) ⇒ AWS.Request

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 operation can be called only from the organization's master account.

You can enable a policy type in a root only if that policy type is available in the organization. Use DescribeOrganization to view the status of available policy types in the organization.

To view the status of policy type in a root, use ListRoots.

Service Reference:

Examples:

To enable a policy type in a root


/* The following example shows how to enable the service control policy (SCP) policy type in a root. The output shows a root object with a PolicyTypes response element showing that SCPs are now enabled:/n/n */

 var params = {
  PolicyType: "SERVICE_CONTROL_POLICY", 
  RootId: "r-examplerootid111"
 };
 organizations.enablePolicyType(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Root: {
     Arn: "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111", 
     Id: "r-examplerootid111", 
     Name: "Root", 
     PolicyTypes: [
        {
       Status: "ENABLED", 
       Type: "SERVICE_CONTROL_POLICY"
      }
     ]
    }
   }
   */
 });

Calling the enablePolicyType operation

var params = {
  PolicyType: SERVICE_CONTROL_POLICY, /* required */
  RootId: 'STRING_VALUE' /* required */
};
organizations.enablePolicyType(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • RootId — (String)

      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 lower-case letters or digits.

    • PolicyType — (String)

      The policy type that you want to enable.

      Possible values include:
      • "SERVICE_CONTROL_POLICY"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Root — (map)

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

        • Id — (String)

          The unique identifier (ID) for the root.

          The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lower-case letters or digits.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the root.

          For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

        • Name — (String)

          The friendly name of the root.

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

        • PolicyTypes — (Array<map>)

          The types of policies that are currently enabled for the root and therefore can be attached to the root or to its OUs or accounts.

          Note: Even if a policy type is shown as available in the organization, you can separately enable and disable them at the root level by using EnablePolicyType and DisablePolicyType. Use DescribeOrganization to see the availability of the policy types in that organization.
          • Type — (String)

            The name of the policy type.

            Possible values include:
            • "SERVICE_CONTROL_POLICY"
          • Status — (String)

            The status of the policy type as it relates to the associated root. To attach a policy of the specified type to a root or to an OU or account in that root, it must be available in the organization and enabled for that root.

            Possible values include:
            • "ENABLED"
            • "PENDING_ENABLE"
            • "PENDING_DISABLE"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

inviteAccountToOrganization(params = {}, callback) ⇒ AWS.Request

Sends an invitation to another account to join your organization as a member account. Organizations sends email on your behalf to the email address that is associated with the other account's owner. The invitation is implemented as a Handshake whose details are in the response.

  • You can invite AWS accounts only from the same seller as the master account. For example, if your organization's master account was created by Amazon Internet Services Pvt. Ltd (AISPL), an AWS seller in India, then you can only invite other AISPL accounts to your organization. You can't combine accounts from AISPL and AWS, or any other AWS seller. For more information, see Consolidated Billing in India.

  • 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, then contact AWS Customer Support.

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

Service Reference:

Examples:

To invite an account to join an organization


/* The following example shows the admin of the master account owned by bill@example.com inviting the account owned by juan@example.com to join an organization. */

 var params = {
  Notes: "This is a request for Juan's account to join Bill's organization", 
  Target: {
   Id: "juan@example.com", 
   Type: "EMAIL"
  }
 };
 organizations.inviteAccountToOrganization(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Handshake: {
     Action: "INVITE", 
     Arn: "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", 
     ExpirationTimestamp: <Date Representation>, 
     Id: "h-examplehandshakeid111", 
     Parties: [
        {
       Id: "o-exampleorgid", 
       Type: "ORGANIZATION"
      }, 
        {
       Id: "juan@example.com", 
       Type: "EMAIL"
      }
     ], 
     RequestedTimestamp: <Date Representation>, 
     Resources: [
        {
       Resources: [
          {
         Type: "MASTER_EMAIL", 
         Value: "bill@amazon.com"
        }, 
          {
         Type: "MASTER_NAME", 
         Value: "Org Master Account"
        }, 
          {
         Type: "ORGANIZATION_FEATURE_SET", 
         Value: "FULL"
        }
       ], 
       Type: "ORGANIZATION", 
       Value: "o-exampleorgid"
      }, 
        {
       Type: "EMAIL", 
       Value: "juan@example.com"
      }
     ], 
     State: "OPEN"
    }
   }
   */
 });

Calling the inviteAccountToOrganization operation

var params = {
  Target: { /* required */
    Id: 'STRING_VALUE', /* required */
    Type: ACCOUNT | ORGANIZATION | EMAIL /* required */
  },
  Notes: 'STRING_VALUE'
};
organizations.inviteAccountToOrganization(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Target — (map)

      The identifier (ID) of the AWS 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 AWS CLI, you can submit this as a single string, similar to the following example:

      --target Id=123456789012,Type=ACCOUNT

      If you specify "Type": "ACCOUNT", then you must provide the AWS account ID number as the Id. If you specify "Type": "EMAIL", then you must specify the email address that is associated with the account.

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

      • Id — required — (String)

        The unique identifier (ID) for the party.

        The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.

      • Type — required — (String)

        The type of party.

        Possible values include:
        • "ACCOUNT"
        • "ORGANIZATION"
        • "EMAIL"
    • Notes — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Handshake — (map)

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

        • Id — (String)

          The unique identifier (ID) of a handshake. The originating account creates the ID when it initiates the handshake.

          The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.

        • Arn — (String)

          The Amazon Resource Name (ARN) of a handshake.

          For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

        • Parties — (Array<map>)

          Information about the two accounts that are participating in the handshake.

          • Id — required — (String)

            The unique identifier (ID) for the party.

            The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.

          • Type — required — (String)

            The type of party.

            Possible values include:
            • "ACCOUNT"
            • "ORGANIZATION"
            • "EMAIL"
        • State — (String)

          The current state of the handshake. Use the state to trace the flow of the handshake through the process from its creation to its acceptance. The meaning of each of the valid values is as follows:

          • REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond.

          • OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action.

          • CANCELED: This handshake is no longer active because it was canceled by the originating account.

          • ACCEPTED: This handshake is complete because it has been accepted by the recipient.

          • DECLINED: This handshake is no longer active because it was declined by the recipient account.

          • EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days).

          Possible values include:
          • "REQUESTED"
          • "OPEN"
          • "CANCELED"
          • "ACCEPTED"
          • "DECLINED"
          • "EXPIRED"
        • RequestedTimestamp — (Date)

          The date and time that the handshake request was made.

        • ExpirationTimestamp — (Date)

          The date and time that the handshake expires. If the recipient of the handshake request fails to respond before the specified date and time, the handshake becomes inactive and is no longer valid.

        • Action — (String)

          The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:

          • INVITE: This type of handshake represents a request to join an organization. It is always sent from the master account to only non-member accounts.

          • ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all features in an organization. It is always sent from the master account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's master account and approval is inferred.

          • APPROVE_ALL_FEATURES: This type of handshake is sent from the Organizations service when all member accounts have approved the ENABLE_ALL_FEATURES invitation. It is sent only to the master account and signals the master that it can finalize the process to enable all features.

          Possible values include:
          • "INVITE"
          • "ENABLE_ALL_FEATURES"
          • "APPROVE_ALL_FEATURES"
          • "ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE"
        • Resources — (Array<map>)

          Additional information that is needed to process the handshake.

          • Value — (String)

            The information that is passed to the other party in the handshake. The format of the value string must match the requirements of the specified type.

          • Type — (String)

            The type of information being passed, specifying how the value is to be interpreted by the other party:

            • ACCOUNT - Specifies an AWS account ID number.

            • ORGANIZATION - Specifies an organization ID number.

            • EMAIL - Specifies the email address that is associated with the account that receives the handshake.

            • OWNER_EMAIL - Specifies the email address associated with the master account. Included as information about an organization.

            • OWNER_NAME - Specifies the name associated with the master account. Included as information about an organization.

            • NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.

            Possible values include:
            • "ACCOUNT"
            • "ORGANIZATION"
            • "ORGANIZATION_FEATURE_SET"
            • "EMAIL"
            • "MASTER_EMAIL"
            • "MASTER_NAME"
            • "NOTES"
            • "PARENT_HANDSHAKE"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

leaveOrganization(params = {}, callback) ⇒ AWS.Request

Removes a member account from its parent organization. This version of the operation is performed by the account that wants to leave. To remove a member account as a user in the master account, use RemoveAccountFromOrganization instead.

This operation can be called only from a member account in the organization.

  • The master account in an organization with all features enabled can set service control policies (SCPs) that can restrict what administrators of member accounts can do, including preventing them from successfully calling LeaveOrganization and leaving the organization.

  • You can leave an organization as a member account only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required of standalone accounts is not automatically collected. For each account that you want to make standalone, you must accept the End User License Agreement (EULA), choose a support plan, provide and verify the required contact information, and provide a current payment method. AWS uses the payment method to charge for any billable (not free tier) AWS activity that occurs while the account is not attached to an organization. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.

  • You can leave an organization only after you enable IAM user access to billing in your account. For more information, see Activating Access to the Billing and Cost Management Console in the AWS Billing and Cost Management User Guide.

Service Reference:

Examples:

To leave an organization as a member account


/* TThe following example shows how to remove your member account from an organization: */

 var params = {};
 organizations.leaveOrganization(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the leaveOrganization operation

organizations.leaveOrganization(function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listAccounts(params = {}, callback) ⇒ AWS.Request

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.

Note: Always check the 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 master account.

Service Reference:

Examples:

To retrieve a list of all of the accounts in an organization


/* The following example shows you how to request a list of the accounts in an organization: */

 var params = {
 };
 organizations.listAccounts(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Accounts: [
       {
      Arn: "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111", 
      Email: "bill@example.com", 
      Id: "111111111111", 
      JoinedMethod: "INVITED", 
      JoinedTimestamp: <Date Representation>, 
      Name: "Master Account", 
      Status: "ACTIVE"
     }, 
       {
      Arn: "arn:aws:organizations::111111111111:account/o-exampleorgid/222222222222", 
      Email: "alice@example.com", 
      Id: "222222222222", 
      JoinedMethod: "INVITED", 
      JoinedTimestamp: <Date Representation>, 
      Name: "Developer Account", 
      Status: "ACTIVE"
     }, 
       {
      Arn: "arn:aws:organizations::111111111111:account/o-exampleorgid/333333333333", 
      Email: "juan@example.com", 
      Id: "333333333333", 
      JoinedMethod: "INVITED", 
      JoinedTimestamp: <Date Representation>, 
      Name: "Test Account", 
      Status: "ACTIVE"
     }, 
       {
      Arn: "arn:aws:organizations::111111111111:account/o-exampleorgid/444444444444", 
      Email: "anika@example.com", 
      Id: "444444444444", 
      JoinedMethod: "INVITED", 
      JoinedTimestamp: <Date Representation>, 
      Name: "Production Account", 
      Status: "ACTIVE"
     }
    ]
   }
   */
 });

Calling the listAccounts operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
organizations.listAccounts(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

      Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

    • MaxResults — (Integer)

      (Optional) Use this to limit the number of results you want included per page in 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Accounts — (Array<map>)

        A list of objects in the organization.

        • Id — (String)

          The unique identifier (ID) of the account.

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

        • Arn — (String)

          The Amazon Resource Name (ARN) of the account.

          For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

        • Email — (String)

          The email address associated with the AWS account.

          The regex pattern for this parameter is a string of characters that represents a standard Internet email address.

        • Name — (String)

          The friendly name of the account.

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

        • Status — (String)

          The status of the account in the organization.

          Possible values include:
          • "ACTIVE"
          • "SUSPENDED"
        • JoinedMethod — (String)

          The method by which the account joined the organization.

          Possible values include:
          • "INVITED"
          • "CREATED"
        • JoinedTimestamp — (Date)

          The date the account became a part of the organization.

      • NextToken — (String)

        If present, this value indicates that there is more output 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listAccountsForParent(params = {}, callback) ⇒ AWS.Request

Lists the accounts in an organization that are contained by the specified target root or organizational unit (OU). If you specify the root, you get a list of all the accounts that are not in any OU. If you specify an OU, you get a list of all the accounts in only that OU, and not in any child OUs. To get a list of all accounts in the organization, use the ListAccounts operation.

Note: Always check the 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 master account.

Service Reference:

Examples:

To retrieve a list of all of the accounts in a root or OU


/* The following example shows how to request a list of the accounts in an OU:/n/n */

 var params = {
  ParentId: "ou-examplerootid111-exampleouid111"
 };
 organizations.listAccountsForParent(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Accounts: [
       {
      Arn: "arn:aws:organizations::111111111111:account/o-exampleorgid/333333333333", 
      Email: "juan@example.com", 
      Id: "333333333333", 
      JoinedMethod: "INVITED", 
      JoinedTimestamp: <Date Representation>, 
      Name: "Development Account", 
      Status: "ACTIVE"
     }, 
       {
      Arn: "arn:aws:organizations::111111111111:account/o-exampleorgid/444444444444", 
      Email: "anika@example.com", 
      Id: "444444444444", 
      JoinedMethod: "INVITED", 
      JoinedTimestamp: <Date Representation>, 
      Name: "Test Account", 
      Status: "ACTIVE"
     }
    ]
   }
   */
 });

Calling the listAccountsForParent operation

var params = {
  ParentId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
organizations.listAccountsForParent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ParentId — (String)

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

    • NextToken — (String)

      Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

    • MaxResults — (Integer)

      (Optional) Use this to limit the number of results you want included per page in 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Accounts — (Array<map>)

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

        • Id — (String)

          The unique identifier (ID) of the account.

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

        • Arn — (String)

          The Amazon Resource Name (ARN) of the account.

          For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

        • Email — (String)

          The email address associated with the AWS account.

          The regex pattern for this parameter is a string of characters that represents a standard Internet email address.

        • Name — (String)

          The friendly name of the account.

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

        • Status — (String)

          The status of the account in the organization.

          Possible values include:
          • "ACTIVE"
          • "SUSPENDED"
        • JoinedMethod — (String)

          The method by which the account joined the organization.

          Possible values include:
          • "INVITED"
          • "CREATED"
        • JoinedTimestamp — (Date)

          The date the account became a part of the organization.

      • NextToken — (String)

        If present, this value indicates that there is more output 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listAWSServiceAccessForOrganization(params = {}, callback) ⇒ AWS.Request

Returns a list of the AWS 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 AWS Organizations, including the list of services that currently work with Organizations, see Integrating AWS Organizations with Other AWS Services in the AWS Organizations User Guide.

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

Service Reference:

Examples:

Calling the listAWSServiceAccessForOrganization operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
organizations.listAWSServiceAccessForOrganization(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

      Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

    • MaxResults — (Integer)

      (Optional) Use this to limit the number of results you want included per page in 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EnabledServicePrincipals — (Array<map>)

        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 AWS Organizations.

        • ServicePrincipal — (String)

          The name of the service principal. This is typically in the form of a URL, such as: servicename.amazonaws.com.

        • DateEnabled — (Date)

          The date that the service principal was enabled for integration with AWS Organizations.

      • NextToken — (String)

        If present, this value indicates that there is more output 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listChildren(params = {}, callback) ⇒ AWS.Request

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.

Note: Always check the 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 master account.

Service Reference:

Examples:

To retrieve a list of all of the child accounts and OUs in a parent root or OU


/* The following example shows how to request a list of the child OUs in a parent root or OU:/n/n */

 var params = {
  ChildType: "ORGANIZATIONAL_UNIT", 
  ParentId: "ou-examplerootid111-exampleouid111"
 };
 organizations.listChildren(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Children: [
       {
      Id: "ou-examplerootid111-exampleouid111", 
      Type: "ORGANIZATIONAL_UNIT"
     }, 
       {
      Id: "ou-examplerootid111-exampleouid222", 
      Type: "ORGANIZATIONAL_UNIT"
     }
    ]
   }
   */
 });

Calling the listChildren operation

var params = {
  ChildType: ACCOUNT | ORGANIZATIONAL_UNIT, /* required */
  ParentId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
organizations.listChildren(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ParentId — (String)

      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 lower-case letters or digits.

      • Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.

    • ChildType — (String)

      Filters the output to include only the specified child type.

      Possible values include:
      • "ACCOUNT"
      • "ORGANIZATIONAL_UNIT"
    • NextToken — (String)

      Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

    • MaxResults — (Integer)

      (Optional) Use this to limit the number of results you want included per page in 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Children — (Array<map>)

        The list of children of the specified parent container.

        • Id — (String)

          The unique identifier (ID) of this child entity.

          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 lower-case letters or digits (the ID of the root that contains the OU) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.

        • Type — (String)

          The type of this child entity.

          Possible values include:
          • "ACCOUNT"
          • "ORGANIZATIONAL_UNIT"
      • NextToken — (String)

        If present, this value indicates that there is more output 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listCreateAccountStatus(params = {}, callback) ⇒ AWS.Request

Lists the account creation requests that match the specified status that is currently being tracked for the organization.

Note: Always check the 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 master account.

Service Reference:

Examples:

To get a list of completed account creation requests made in the organization


/* The following example shows a user requesting a list of only the completed account creation requests made for the current organization: */

 var params = {
  States: [
     "SUCCEEDED"
  ]
 };
 organizations.listCreateAccountStatus(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CreateAccountStatuses: [
       {
      AccountId: "444444444444", 
      AccountName: "Developer Test Account", 
      CompletedTimestamp: <Date Representation>, 
      Id: "car-exampleaccountcreationrequestid1", 
      RequestedTimestamp: <Date Representation>, 
      State: "SUCCEEDED"
     }
    ]
   }
   */
 });

To get a list of all account creation requests made in the organization


/* The following example shows a user requesting a list of only the in-progress account creation requests made for the current organization: */

 var params = {
  States: [
     "IN_PROGRESS"
  ]
 };
 organizations.listCreateAccountStatus(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CreateAccountStatuses: [
       {
      AccountName: "Production Account", 
      Id: "car-exampleaccountcreationrequestid2", 
      RequestedTimestamp: <Date Representation>, 
      State: "IN_PROGRESS"
     }
    ]
   }
   */
 });

Calling the listCreateAccountStatus operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  States: [
    IN_PROGRESS | SUCCEEDED | FAILED,
    /* more items */
  ]
};
organizations.listCreateAccountStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • States — (Array<String>)

      A list of one or more states that you want included in the response. If this parameter is not present, then all requests are included in the response.

    • NextToken — (String)

      Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

    • MaxResults — (Integer)

      (Optional) Use this to limit the number of results you want included per page in 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CreateAccountStatuses — (Array<map>)

        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.

        • Id — (String)

          The unique identifier (ID) that references this request. You get this value from the response of the initial CreateAccount request to create the account.

          The regex pattern for an create account request ID string requires "car-" followed by from 8 to 32 lower-case letters or digits.

        • AccountName — (String)

          The account name given to the account when it was created.

        • State — (String)

          The status of the request.

          Possible values include:
          • "IN_PROGRESS"
          • "SUCCEEDED"
          • "FAILED"
        • RequestedTimestamp — (Date)

          The date and time that the request was made for the account creation.

        • CompletedTimestamp — (Date)

          The date and time that the account was created and the request completed.

        • AccountId — (String)

          If the account was created successfully, the unique identifier (ID) of the new account.

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

        • GovCloudAccountId — (String)

        • FailureReason — (String)

          If the request failed, a description of the reason for the failure.

          • ACCOUNT_LIMIT_EXCEEDED: The account could not be created because you have reached the limit on the number of accounts in your organization.

          • EMAIL_ALREADY_EXISTS: The account could not be created because another AWS account with that email address already exists.

          • INVALID_ADDRESS: The account could not be created because the address you provided is not valid.

          • INVALID_EMAIL: The account could not be created because the email address you provided is not valid.

          • INTERNAL_FAILURE: The account could not be created because of an internal failure. Try again later. If the problem persists, contact Customer Support.

          Possible values include:
          • "ACCOUNT_LIMIT_EXCEEDED"
          • "EMAIL_ALREADY_EXISTS"
          • "INVALID_ADDRESS"
          • "INVALID_EMAIL"
          • "CONCURRENT_ACCOUNT_MODIFICATION"
          • "INTERNAL_FAILURE"
      • NextToken — (String)

        If present, this value indicates that there is more output 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listHandshakesForAccount(params = {}, callback) ⇒ AWS.Request

Lists the current handshakes that are associated with the account of the requesting user.

Handshakes that are ACCEPTED, DECLINED, or CANCELED appear in the results of this API for only 30 days after changing to that state. After that they are deleted and no longer accessible.

Note: Always check the 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.

Service Reference:

Examples:

To retrieve a list of the handshakes sent to an account


/* The following example shows you how to get a list of handshakes that are associated with the account of the credentials used to call the operation: */

 var params = {
 };
 organizations.listHandshakesForAccount(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Handshakes: [
       {
      Action: "INVITE", 
      Arn: "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", 
      ExpirationTimestamp: <Date Representation>, 
      Id: "h-examplehandshakeid111", 
      Parties: [
         {
        Id: "o-exampleorgid", 
        Type: "ORGANIZATION"
       }, 
         {
        Id: "juan@example.com", 
        Type: "EMAIL"
       }
      ], 
      RequestedTimestamp: <Date Representation>, 
      Resources: [
         {
        Resources: [
           {
          Type: "MASTER_EMAIL", 
          Value: "bill@amazon.com"
         }, 
           {
          Type: "MASTER_NAME", 
          Value: "Org Master Account"
         }, 
           {
          Type: "ORGANIZATION_FEATURE_SET", 
          Value: "FULL"
         }
        ], 
        Type: "ORGANIZATION", 
        Value: "o-exampleorgid"
       }, 
         {
        Type: "EMAIL", 
        Value: "juan@example.com"
       }
      ], 
      State: "OPEN"
     }
    ]
   }
   */
 });

Calling the listHandshakesForAccount operation

var params = {
  Filter: {
    ActionType: INVITE | ENABLE_ALL_FEATURES | APPROVE_ALL_FEATURES | ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE,
    ParentHandshakeId: 'STRING_VALUE'
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
organizations.listHandshakesForAccount(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Filter — (map)

      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.

      • ActionType — (String)

        Specifies the type of handshake action.

        If you specify ActionType, you cannot also specify ParentHandshakeId.

        Possible values include:
        • "INVITE"
        • "ENABLE_ALL_FEATURES"
        • "APPROVE_ALL_FEATURES"
        • "ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE"
      • ParentHandshakeId — (String)

        Specifies the parent handshake. Only used for handshake types that are a child of another type.

        If you specify ParentHandshakeId, you cannot also specify ActionType.

        The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.

    • NextToken — (String)

      Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

    • MaxResults — (Integer)

      (Optional) Use this to limit the number of results you want included per page in 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Handshakes — (Array<map>)

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

        • Id — (String)

          The unique identifier (ID) of a handshake. The originating account creates the ID when it initiates the handshake.

          The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.

        • Arn — (String)

          The Amazon Resource Name (ARN) of a handshake.

          For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

        • Parties — (Array<map>)

          Information about the two accounts that are participating in the handshake.

          • Id — required — (String)

            The unique identifier (ID) for the party.

            The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.

          • Type — required — (String)

            The type of party.

            Possible values include:
            • "ACCOUNT"
            • "ORGANIZATION"
            • "EMAIL"
        • State — (String)

          The current state of the handshake. Use the state to trace the flow of the handshake through the process from its creation to its acceptance. The meaning of each of the valid values is as follows:

          • REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond.

          • OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action.

          • CANCELED: This handshake is no longer active because it was canceled by the originating account.

          • ACCEPTED: This handshake is complete because it has been accepted by the recipient.

          • DECLINED: This handshake is no longer active because it was declined by the recipient account.

          • EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days).

          Possible values include:
          • "REQUESTED"
          • "OPEN"
          • "CANCELED"
          • "ACCEPTED"
          • "DECLINED"
          • "EXPIRED"
        • RequestedTimestamp — (Date)

          The date and time that the handshake request was made.

        • ExpirationTimestamp — (Date)

          The date and time that the handshake expires. If the recipient of the handshake request fails to respond before the specified date and time, the handshake becomes inactive and is no longer valid.

        • Action — (String)

          The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:

          • INVITE: This type of handshake represents a request to join an organization. It is always sent from the master account to only non-member accounts.

          • ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all features in an organization. It is always sent from the master account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's master account and approval is inferred.

          • APPROVE_ALL_FEATURES: This type of handshake is sent from the Organizations service when all member accounts have approved the ENABLE_ALL_FEATURES invitation. It is sent only to the master account and signals the master that it can finalize the process to enable all features.

          Possible values include:
          • "INVITE"
          • "ENABLE_ALL_FEATURES"
          • "APPROVE_ALL_FEATURES"
          • "ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE"
        • Resources — (Array<map>)

          Additional information that is needed to process the handshake.

          • Value — (String)

            The information that is passed to the other party in the handshake. The format of the value string must match the requirements of the specified type.

          • Type — (String)

            The type of information being passed, specifying how the value is to be interpreted by the other party:

            • ACCOUNT - Specifies an AWS account ID number.

            • ORGANIZATION - Specifies an organization ID number.

            • EMAIL - Specifies the email address that is associated with the account that receives the handshake.

            • OWNER_EMAIL - Specifies the email address associated with the master account. Included as information about an organization.

            • OWNER_NAME - Specifies the name associated with the master account. Included as information about an organization.

            • NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.

            Possible values include:
            • "ACCOUNT"
            • "ORGANIZATION"
            • "ORGANIZATION_FEATURE_SET"
            • "EMAIL"
            • "MASTER_EMAIL"
            • "MASTER_NAME"
            • "NOTES"
            • "PARENT_HANDSHAKE"
      • NextToken — (String)

        If present, this value indicates that there is more output 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listHandshakesForOrganization(params = {}, callback) ⇒ AWS.Request

Lists the handshakes that are associated with the organization that the requesting user is part of. The ListHandshakesForOrganization operation returns a list of handshake structures. Each structure contains details and status about a handshake.

Handshakes that are ACCEPTED, DECLINED, or CANCELED appear in the results of this API for only 30 days after changing to that state. After that they are deleted and no longer accessible.

Note: Always check the 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 master account.

Service Reference:

Examples:

To retrieve a list of the handshakes associated with an organization


/* The following example shows you how to get a list of handshakes associated with the current organization: */

 var params = {
 };
 organizations.listHandshakesForOrganization(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Handshakes: [
       {
      Action: "INVITE", 
      Arn: "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", 
      ExpirationTimestamp: <Date Representation>, 
      Id: "h-examplehandshakeid111", 
      Parties: [
         {
        Id: "o-exampleorgid", 
        Type: "ORGANIZATION"
       }, 
         {
        Id: "juan@example.com", 
        Type: "EMAIL"
       }
      ], 
      RequestedTimestamp: <Date Representation>, 
      Resources: [
         {
        Resources: [
           {
          Type: "MASTER_EMAIL", 
          Value: "bill@amazon.com"
         }, 
           {
          Type: "MASTER_NAME", 
          Value: "Org Master Account"
         }, 
           {
          Type: "ORGANIZATION_FEATURE_SET", 
          Value: "FULL"
         }
        ], 
        Type: "ORGANIZATION", 
        Value: "o-exampleorgid"
       }, 
         {
        Type: "EMAIL", 
        Value: "juan@example.com"
       }
      ], 
      State: "OPEN"
     }, 
       {
      Action: "INVITE", 
      Arn: "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", 
      ExpirationTimestamp: <Date Representation>, 
      Id: "h-examplehandshakeid222", 
      Parties: [
         {
        Id: "o-exampleorgid", 
        Type: "ORGANIZATION"
       }, 
         {
        Id: "anika@example.com", 
        Type: "EMAIL"
       }
      ], 
      RequestedTimestamp: <Date Representation>, 
      Resources: [
         {
        Resources: [
           {
          Type: "MASTER_EMAIL", 
          Value: "bill@example.com"
         }, 
           {
          Type: "MASTER_NAME", 
          Value: "Master Account"
         }
        ], 
        Type: "ORGANIZATION", 
        Value: "o-exampleorgid"
       }, 
         {
        Type: "EMAIL", 
        Value: "anika@example.com"
       }, 
         {
        Type: "NOTES", 
        Value: "This is an invitation to Anika's account to join Bill's organization."
       }
      ], 
      State: "ACCEPTED"
     }
    ]
   }
   */
 });

Calling the listHandshakesForOrganization operation

var params = {
  Filter: {
    ActionType: INVITE | ENABLE_ALL_FEATURES | APPROVE_ALL_FEATURES | ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE,
    ParentHandshakeId: 'STRING_VALUE'
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
organizations.listHandshakesForOrganization(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Filter — (map)

      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.

      • ActionType — (String)

        Specifies the type of handshake action.

        If you specify ActionType, you cannot also specify ParentHandshakeId.

        Possible values include:
        • "INVITE"
        • "ENABLE_ALL_FEATURES"
        • "APPROVE_ALL_FEATURES"
        • "ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE"
      • ParentHandshakeId — (String)

        Specifies the parent handshake. Only used for handshake types that are a child of another type.

        If you specify ParentHandshakeId, you cannot also specify ActionType.

        The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.

    • NextToken — (String)

      Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

    • MaxResults — (Integer)

      (Optional) Use this to limit the number of results you want included per page in 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Handshakes — (Array<map>)

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

        • Id — (String)

          The unique identifier (ID) of a handshake. The originating account creates the ID when it initiates the handshake.

          The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.

        • Arn — (String)

          The Amazon Resource Name (ARN) of a handshake.

          For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

        • Parties — (Array<map>)

          Information about the two accounts that are participating in the handshake.

          • Id — required — (String)

            The unique identifier (ID) for the party.

            The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.

          • Type — required — (String)

            The type of party.

            Possible values include:
            • "ACCOUNT"
            • "ORGANIZATION"
            • "EMAIL"
        • State — (String)

          The current state of the handshake. Use the state to trace the flow of the handshake through the process from its creation to its acceptance. The meaning of each of the valid values is as follows:

          • REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond.

          • OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action.

          • CANCELED: This handshake is no longer active because it was canceled by the originating account.

          • ACCEPTED: This handshake is complete because it has been accepted by the recipient.

          • DECLINED: This handshake is no longer active because it was declined by the recipient account.

          • EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days).

          Possible values include:
          • "REQUESTED"
          • "OPEN"
          • "CANCELED"
          • "ACCEPTED"
          • "DECLINED"
          • "EXPIRED"
        • RequestedTimestamp — (Date)

          The date and time that the handshake request was made.

        • ExpirationTimestamp — (Date)

          The date and time that the handshake expires. If the recipient of the handshake request fails to respond before the specified date and time, the handshake becomes inactive and is no longer valid.

        • Action — (String)

          The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:

          • INVITE: This type of handshake represents a request to join an organization. It is always sent from the master account to only non-member accounts.

          • ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all features in an organization. It is always sent from the master account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's master account and approval is inferred.

          • APPROVE_ALL_FEATURES: This type of handshake is sent from the Organizations service when all member accounts have approved the ENABLE_ALL_FEATURES invitation. It is sent only to the master account and signals the master that it can finalize the process to enable all features.

          Possible values include:
          • "INVITE"
          • "ENABLE_ALL_FEATURES"
          • "APPROVE_ALL_FEATURES"
          • "ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE"
        • Resources — (Array<map>)

          Additional information that is needed to process the handshake.

          • Value — (String)

            The information that is passed to the other party in the handshake. The format of the value string must match the requirements of the specified type.

          • Type — (String)

            The type of information being passed, specifying how the value is to be interpreted by the other party:

            • ACCOUNT - Specifies an AWS account ID number.

            • ORGANIZATION - Specifies an organization ID number.

            • EMAIL - Specifies the email address that is associated with the account that receives the handshake.

            • OWNER_EMAIL - Specifies the email address associated with the master account. Included as information about an organization.

            • OWNER_NAME - Specifies the name associated with the master account. Included as information about an organization.

            • NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.

            Possible values include:
            • "ACCOUNT"
            • "ORGANIZATION"
            • "ORGANIZATION_FEATURE_SET"
            • "EMAIL"
            • "MASTER_EMAIL"
            • "MASTER_NAME"
            • "NOTES"
            • "PARENT_HANDSHAKE"
      • NextToken — (String)

        If present, this value indicates that there is more output 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listOrganizationalUnitsForParent(params = {}, callback) ⇒ AWS.Request

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

Note: Always check the 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 master account.

Service Reference:

Examples:

To retrieve a list of all of the child OUs in a parent root or OU


/* The following example shows how to get a list of OUs in a specified root:/n/n */

 var params = {
  ParentId: "r-examplerootid111"
 };
 organizations.listOrganizationalUnitsForParent(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    OrganizationalUnits: [
       {
      Arn: "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examlerootid111-exampleouid111", 
      Id: "ou-examplerootid111-exampleouid111", 
      Name: "Development"
     }, 
       {
      Arn: "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examlerootid111-exampleouid222", 
      Id: "ou-examplerootid111-exampleouid222", 
      Name: "Production"
     }
    ]
   }
   */
 });

Calling the listOrganizationalUnitsForParent operation

var params = {
  ParentId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
organizations.listOrganizationalUnitsForParent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ParentId — (String)

      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 lower-case letters or digits.

      • Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.

    • NextToken — (String)

      Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

    • MaxResults — (Integer)

      (Optional) Use this to limit the number of results you want included per page in 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • OrganizationalUnits — (Array<map>)

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

        • Id — (String)

          The unique identifier (ID) associated with this OU.

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

        • Arn — (String)

          The Amazon Resource Name (ARN) of this OU.

          For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

        • Name — (String)

          The friendly name of this OU.

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

      • NextToken — (String)

        If present, this value indicates that there is more output 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listParents(params = {}, callback) ⇒ AWS.Request

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.

Note: Always check the 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 master account.

Note: In the current release, a child can have only a single parent.

Service Reference:

Examples:

To retrieve a list of all of the parents of a child OU or account


/* The following example shows how to list the root or OUs that contain account 444444444444:/n/n */

 var params = {
  ChildId: "444444444444"
 };
 organizations.listParents(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Parents: [
       {
      Id: "ou-examplerootid111-exampleouid111", 
      Type: "ORGANIZATIONAL_UNIT"
     }
    ]
   }
   */
 });

Calling the listParents operation

var params = {
  ChildId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
organizations.listParents(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ChildId — (String)

      The unique identifier (ID) of the OU or account whose parent containers you want to list. Do not 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 lower-case letters or digits (the ID of the root that contains the OU) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.

    • NextToken — (String)

      Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

    • MaxResults — (Integer)

      (Optional) Use this to limit the number of results you want included per page in 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Parents — (Array<map>)

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

        • Id — (String)

          The unique identifier (ID) of the parent entity.

          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 lower-case letters or digits.

          • Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.

        • Type — (String)

          The type of the parent entity.

          Possible values include:
          • "ROOT"
          • "ORGANIZATIONAL_UNIT"
      • NextToken — (String)

        If present, this value indicates that there is more output 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listPolicies(params = {}, callback) ⇒ AWS.Request

Retrieves the list of all policies in an organization of a specified type.

Note: Always check the 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 master account.

Service Reference:

Examples:

To retrieve a list policies in the organization


/* The following example shows how to get a list of service control policies (SCPs):/n/n */

 var params = {
  Filter: "SERVICE_CONTROL_POLICY"
 };
 organizations.listPolicies(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Policies: [
       {
      Arn: "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111", 
      AwsManaged: false, 
      Description: "Enables account admins to delegate permissions for any S3 actions to users and roles in their accounts.", 
      Id: "p-examplepolicyid111", 
      Name: "AllowAllS3Actions", 
      Type: "SERVICE_CONTROL_POLICY"
     }, 
       {
      Arn: "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid222", 
      AwsManaged: false, 
      Description: "Enables account admins to delegate permissions for any EC2 actions to users and roles in their accounts.", 
      Id: "p-examplepolicyid222", 
      Name: "AllowAllEC2Actions", 
      Type: "SERVICE_CONTROL_POLICY"
     }, 
       {
      Arn: "arn:aws:organizations::aws:policy/service_control_policy/p-FullAWSAccess", 
      AwsManaged: true, 
      Description: "Allows access to every operation", 
      Id: "p-FullAWSAccess", 
      Name: "FullAWSAccess", 
      Type: "SERVICE_CONTROL_POLICY"
     }
    ]
   }
   */
 });

Calling the listPolicies operation

var params = {
  Filter: SERVICE_CONTROL_POLICY, /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
organizations.listPolicies(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Filter — (String)

      Specifies the type of policy that you want to include in the response.

      Possible values include:
      • "SERVICE_CONTROL_POLICY"
    • NextToken — (String)

      Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

    • MaxResults — (Integer)

      (Optional) Use this to limit the number of results you want included per page in 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Policies — (Array<map>)

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

        • Id — (String)

          The unique identifier (ID) of the policy.

          The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the policy.

          For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

        • Name — (String)

          The friendly name of 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 — (String)

          The description of the policy.

        • Type — (String)

          The type of policy.

          Possible values include:
          • "SERVICE_CONTROL_POLICY"
        • AwsManaged — (Boolean)

          A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.

      • NextToken — (String)

        If present, this value indicates that there is more output 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listPoliciesForTarget(params = {}, callback) ⇒ AWS.Request

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.

Note: Always check the 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 master account.

Service Reference:

Examples:

To retrieve a list policies attached to a root, OU, or account


/* The following example shows how to get a list of all service control policies (SCPs) of the type specified by the Filter parameter, that are directly attached to an account. The returned list does not include policies that apply to the account because of inheritance from its location in an OU hierarchy:/n/n */

 var params = {
  Filter: "SERVICE_CONTROL_POLICY", 
  TargetId: "444444444444"
 };
 organizations.listPoliciesForTarget(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Policies: [
       {
      Arn: "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid222", 
      AwsManaged: false, 
      Description: "Enables account admins to delegate permissions for any EC2 actions to users and roles in their accounts.", 
      Id: "p-examplepolicyid222", 
      Name: "AllowAllEC2Actions", 
      Type: "SERVICE_CONTROL_POLICY"
     }
    ]
   }
   */
 });

Calling the listPoliciesForTarget operation

var params = {
  Filter: SERVICE_CONTROL_POLICY, /* required */
  TargetId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
organizations.listPoliciesForTarget(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TargetId — (String)

      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 lower-case 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 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.

    • Filter — (String)

      The type of policy that you want to include in the returned list.

      Possible values include:
      • "SERVICE_CONTROL_POLICY"
    • NextToken — (String)

      Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

    • MaxResults — (Integer)

      (Optional) Use this to limit the number of results you want included per page in 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Policies — (Array<map>)

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

        • Id — (String)

          The unique identifier (ID) of the policy.

          The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the policy.

          For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

        • Name — (String)

          The friendly name of 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 — (String)

          The description of the policy.

        • Type — (String)

          The type of policy.

          Possible values include:
          • "SERVICE_CONTROL_POLICY"
        • AwsManaged — (Boolean)

          A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.

      • NextToken — (String)

        If present, this value indicates that there is more output 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listRoots(params = {}, callback) ⇒ AWS.Request

Lists the roots that are defined in the current organization.

Note: Always check the 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 master account.

Note: Policy types can be enabled and disabled in roots. This is distinct from whether they are available in the organization. When you enable all features, you make policy types available for use in that organization. Individual policy types can then be enabled and disabled in a root. To see the availability of a policy type in an organization, use DescribeOrganization.

Service Reference:

Examples:

To retrieve a list of roots in the organization


/* The following example shows how to get the list of the roots in the current organization:/n/n */

 var params = {
 };
 organizations.listRoots(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Roots: [
       {
      Arn: "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111", 
      Id: "r-examplerootid111", 
      Name: "Root", 
      PolicyTypes: [
         {
        Status: "ENABLED", 
        Type: "SERVICE_CONTROL_POLICY"
       }
      ]
     }
    ]
   }
   */
 });

Calling the listRoots operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
organizations.listRoots(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

      Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

    • MaxResults — (Integer)

      (Optional) Use this to limit the number of results you want included per page in 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Roots — (Array<map>)

        A list of roots that are defined in an organization.

        • Id — (String)

          The unique identifier (ID) for the root.

          The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lower-case letters or digits.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the root.

          For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

        • Name — (String)

          The friendly name of the root.

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

        • PolicyTypes — (Array<map>)

          The types of policies that are currently enabled for the root and therefore can be attached to the root or to its OUs or accounts.

          Note: Even if a policy type is shown as available in the organization, you can separately enable and disable them at the root level by using EnablePolicyType and DisablePolicyType. Use DescribeOrganization to see the availability of the policy types in that organization.
          • Type — (String)

            The name of the policy type.

            Possible values include:
            • "SERVICE_CONTROL_POLICY"
          • Status — (String)

            The status of the policy type as it relates to the associated root. To attach a policy of the specified type to a root or to an OU or account in that root, it must be available in the organization and enabled for that root.

            Possible values include:
            • "ENABLED"
            • "PENDING_ENABLE"
            • "PENDING_DISABLE"
      • NextToken — (String)

        If present, this value indicates that there is more output 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listTargetsForPolicy(params = {}, callback) ⇒ AWS.Request

Lists all the roots, organizational units (OUs), and accounts to which the specified policy is attached.

Note: Always check the 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 master account.

Service Reference:

Examples:

To retrieve a list of roots, OUs, and accounts to which a policy is attached


/* The following example shows how to get the list of roots, OUs, and accounts to which the specified policy is attached:/n/n */

 var params = {
  PolicyId: "p-FullAWSAccess"
 };
 organizations.listTargetsForPolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Targets: [
       {
      Arn: "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111", 
      Name: "Root", 
      TargetId: "r-examplerootid111", 
      Type: "ROOT"
     }, 
       {
      Arn: "arn:aws:organizations::111111111111:account/o-exampleorgid/333333333333;", 
      Name: "Developer Test Account", 
      TargetId: "333333333333", 
      Type: "ACCOUNT"
     }, 
       {
      Arn: "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111", 
      Name: "Accounting", 
      TargetId: "ou-examplerootid111-exampleouid111", 
      Type: "ORGANIZATIONAL_UNIT"
     }
    ]
   }
   */
 });

Calling the listTargetsForPolicy operation

var params = {
  PolicyId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
organizations.listTargetsForPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • PolicyId — (String)

      The unique identifier (ID) of the policy for which you want to know its attachments.

      The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits.

    • NextToken — (String)

      Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

    • MaxResults — (Integer)

      (Optional) Use this to limit the number of results you want included per page in 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Targets — (Array<map>)

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

        • TargetId — (String)

          The unique identifier (ID) of the policy target.

          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 lower-case 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 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the policy target.

          For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

        • Name — (String)

          The friendly name of the policy target.

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

        • Type — (String)

          The type of the policy target.

          Possible values include:
          • "ACCOUNT"
          • "ORGANIZATIONAL_UNIT"
          • "ROOT"
      • NextToken — (String)

        If present, this value indicates that there is more output 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

moveAccount(params = {}, callback) ⇒ AWS.Request

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 master account.

Service Reference:

Examples:

To move an OU or account to another OU or the root


/* The following example shows how to move a member account from the root to an OU:/n/n */

 var params = {
  AccountId: "333333333333", 
  DestinationParentId: "ou-examplerootid111-exampleouid111", 
  SourceParentId: "r-examplerootid111"
 };
 organizations.moveAccount(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the moveAccount operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  DestinationParentId: 'STRING_VALUE', /* required */
  SourceParentId: 'STRING_VALUE' /* required */
};
organizations.moveAccount(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AccountId — (String)

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

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

    • SourceParentId — (String)

      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 lower-case letters or digits.

      • Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.

    • DestinationParentId — (String)

      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 lower-case letters or digits.

      • Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

removeAccountFromOrganization(params = {}, callback) ⇒ AWS.Request

Removes the specified account from the organization.

The removed account becomes a stand-alone account that is not a member of any organization. It is no longer subject to any policies and is responsible for its own bill payments. The organization's master account is no longer charged for any expenses accrued by the member account after it is removed from the organization.

This operation can be called only from the organization's master account. Member accounts can remove themselves with LeaveOrganization instead.

You can remove an account from your organization only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required of standalone accounts is not automatically collected. For an account that you want to make standalone, you must accept the End User License Agreement (EULA), choose a support plan, provide and verify the required contact information, and provide a current payment method. AWS uses the payment method to charge for any billable (not free tier) AWS activity that occurs while the account is not attached to an organization. To remove an account that does not yet have this information, you must sign in as the member account and follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.

Service Reference:

Examples:

To remove an account from an organization as the master account


/* The following example shows you how to remove an account from an organization: */

 var params = {
  AccountId: "333333333333"
 };
 organizations.removeAccountFromOrganization(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the removeAccountFromOrganization operation

var params = {
  AccountId: 'STRING_VALUE' /* required */
};
organizations.removeAccountFromOrganization(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AccountId — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateOrganizationalUnit(params = {}, callback) ⇒ AWS.Request

Renames the specified organizational unit (OU). The ID and ARN do not change. The child OUs and accounts remain in place, and any attached policies of the OU remain attached.

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

Service Reference:

Examples:

To rename an organizational unit


/* The following example shows how to rename an OU. The output confirms the new name:/n/n */

 var params = {
  Name: "AccountingOU", 
  OrganizationalUnitId: "ou-examplerootid111-exampleouid111"
 };
 organizations.updateOrganizationalUnit(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    OrganizationalUnit: {
     Arn: "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111", 
     Id: "ou-examplerootid111-exampleouid111", 
     Name: "AccountingOU"
    }
   }
   */
 });

Calling the updateOrganizationalUnit operation

var params = {
  OrganizationalUnitId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE'
};
organizations.updateOrganizationalUnit(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • OrganizationalUnitId — (String)

      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 lower-case letters or digits (the ID of the root that contains the OU) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.

    • Name — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • OrganizationalUnit — (map)

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

        • Id — (String)

          The unique identifier (ID) associated with this OU.

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

        • Arn — (String)

          The Amazon Resource Name (ARN) of this OU.

          For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

        • Name — (String)

          The friendly name of this OU.

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updatePolicy(params = {}, callback) ⇒ AWS.Request

Updates an existing policy with a new name, description, or content. If any parameter is not supplied, that value remains unchanged. Note that you cannot change a policy's type.

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

Service Reference:

Examples:

To update the details of a policy


/* The following example shows how to rename a policy and give it a new description and new content. The output confirms the new name and description text:/n/n */

 var params = {
  Description: "This description replaces the original.", 
  Name: "Renamed-Policy", 
  PolicyId: "p-examplepolicyid111"
 };
 organizations.updatePolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Policy: {
     Content: "{ \"Version\": \"2012-10-17\", \"Statement\": { \"Effect\": \"Allow\", \"Action\": \"ec2:*\", \"Resource\": \"*\" } }", 
     PolicySummary: {
      Arn: "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111", 
      AwsManaged: false, 
      Description: "This description replaces the original.", 
      Id: "p-examplepolicyid111", 
      Name: "Renamed-Policy", 
      Type: "SERVICE_CONTROL_POLICY"
     }
    }
   }
   */
 });

To update the content of a policy


/* The following example shows how to replace the JSON text of the SCP from the preceding example with a new JSON policy text string that allows S3 actions instead of EC2 actions:/n/n */

 var params = {
  Content: "{ \\\"Version\\\": \\\"2012-10-17\\\", \\\"Statement\\\": {\\\"Effect\\\": \\\"Allow\\\", \\\"Action\\\": \\\"s3:*\\\", \\\"Resource\\\": \\\"*\\\" } }", 
  PolicyId: "p-examplepolicyid111"
 };
 organizations.updatePolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Policy: {
     Content: "{ \\\"Version\\\": \\\"2012-10-17\\\", \\\"Statement\\\": { \\\"Effect\\\": \\\"Allow\\\", \\\"Action\\\": \\\"s3:*\\\", \\\"Resource\\\": \\\"*\\\" } }", 
     PolicySummary: {
      Arn: "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111", 
      AwsManaged: false, 
      Description: "This description replaces the original.", 
      Id: "p-examplepolicyid111", 
      Name: "Renamed-Policy", 
      Type: "SERVICE_CONTROL_POLICY"
     }
    }
   }
   */
 });

Calling the updatePolicy operation

var params = {
  PolicyId: 'STRING_VALUE', /* required */
  Content: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  Name: 'STRING_VALUE'
};
organizations.updatePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • PolicyId — (String)

      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 lower-case letters or digits.

    • Name — (String)

      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 — (String)

      If provided, the new description for the policy.

    • Content — (String)

      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 Service Control Policy Syntax in the AWS Organizations User Guide.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Policy — (map)

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

        • PolicySummary — (map)

          A structure that contains additional details about the policy.

          • Id — (String)

            The unique identifier (ID) of the policy.

            The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits.

          • Arn — (String)

            The Amazon Resource Name (ARN) of the policy.

            For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

          • Name — (String)

            The friendly name of 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 — (String)

            The description of the policy.

          • Type — (String)

            The type of policy.

            Possible values include:
            • "SERVICE_CONTROL_POLICY"
          • AwsManaged — (Boolean)

            A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.

        • Content — (String)

          The text content of the policy.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.