❤
npm
Sign UpSign In

@datafire/amazonaws_organizations

5.0.0 • Public • Published

@datafire/amazonaws_organizations

Client library for AWS Organizations

Installation and Usage

npm install --save @datafire/amazonaws_organizations
let amazonaws_organizations = require('@datafire/amazonaws_organizations').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_organizations.AcceptHandshake({
  "HandshakeId": ""
}).then(data => {
  console.log(data);
});

Description

AWS Organizations API Reference

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.

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.

Actions

AcceptHandshake

amazonaws_organizations.AcceptHandshake({
  "HandshakeId": ""
}, context)

Input

Output

AttachPolicy

amazonaws_organizations.AttachPolicy({
  "PolicyId": "",
  "TargetId": ""
}, context)

Input

Output

Output schema unknown

CancelHandshake

amazonaws_organizations.CancelHandshake({
  "HandshakeId": ""
}, context)

Input

Output

CreateAccount

amazonaws_organizations.CreateAccount({
  "Email": "",
  "AccountName": ""
}, context)

Input

Output

CreateOrganization

amazonaws_organizations.CreateOrganization({}, context)

Input

Output

CreateOrganizationalUnit

amazonaws_organizations.CreateOrganizationalUnit({
  "ParentId": "",
  "Name": ""
}, context)

Input

Output

CreatePolicy

amazonaws_organizations.CreatePolicy({
  "Content": "",
  "Description": "",
  "Name": "",
  "Type": ""
}, context)

Input

Output

DeclineHandshake

amazonaws_organizations.DeclineHandshake({
  "HandshakeId": ""
}, context)

Input

Output

DeleteOrganization

amazonaws_organizations.DeleteOrganization({}, context)

Input

  • input object

Output

Output schema unknown

DeleteOrganizationalUnit

amazonaws_organizations.DeleteOrganizationalUnit({
  "OrganizationalUnitId": ""
}, context)

Input

Output

Output schema unknown

DeletePolicy

amazonaws_organizations.DeletePolicy({
  "PolicyId": ""
}, context)

Input

  • input object

Output

Output schema unknown

DescribeAccount

amazonaws_organizations.DescribeAccount({
  "AccountId": ""
}, context)

Input

Output

DescribeCreateAccountStatus

amazonaws_organizations.DescribeCreateAccountStatus({
  "CreateAccountRequestId": ""
}, context)

Input

Output

DescribeHandshake

amazonaws_organizations.DescribeHandshake({
  "HandshakeId": ""
}, context)

Input

Output

DescribeOrganization

amazonaws_organizations.DescribeOrganization({}, context)

Input

  • input object

Output

DescribeOrganizationalUnit

amazonaws_organizations.DescribeOrganizationalUnit({
  "OrganizationalUnitId": ""
}, context)

Input

Output

DescribePolicy

amazonaws_organizations.DescribePolicy({
  "PolicyId": ""
}, context)

Input

  • input object

Output

DetachPolicy

amazonaws_organizations.DetachPolicy({
  "PolicyId": "",
  "TargetId": ""
}, context)

Input

Output

Output schema unknown

DisableAWSServiceAccess

amazonaws_organizations.DisableAWSServiceAccess({
  "ServicePrincipal": ""
}, context)

Input

Output

Output schema unknown

DisablePolicyType

amazonaws_organizations.DisablePolicyType({
  "RootId": "",
  "PolicyType": ""
}, context)

Input

Output

EnableAWSServiceAccess

amazonaws_organizations.EnableAWSServiceAccess({
  "ServicePrincipal": ""
}, context)

Input

Output

Output schema unknown

EnableAllFeatures

amazonaws_organizations.EnableAllFeatures({}, context)

Input

  • input object

Output

EnablePolicyType

amazonaws_organizations.EnablePolicyType({
  "RootId": "",
  "PolicyType": ""
}, context)

Input

Output

InviteAccountToOrganization

amazonaws_organizations.InviteAccountToOrganization({
  "Target": {
    "Id": "",
    "Type": ""
  }
}, context)

Input

Output

LeaveOrganization

amazonaws_organizations.LeaveOrganization({}, context)

Input

  • input object

Output

Output schema unknown

ListAWSServiceAccessForOrganization

amazonaws_organizations.ListAWSServiceAccessForOrganization({}, context)

Input

Output

ListAccounts

amazonaws_organizations.ListAccounts({}, context)

Input

Output

ListAccountsForParent

amazonaws_organizations.ListAccountsForParent({
  "ParentId": ""
}, context)

Input

Output

ListChildren

amazonaws_organizations.ListChildren({
  "ParentId": "",
  "ChildType": ""
}, context)

Input

Output

ListCreateAccountStatus

amazonaws_organizations.ListCreateAccountStatus({}, context)

Input

Output

ListHandshakesForAccount

amazonaws_organizations.ListHandshakesForAccount({}, context)

Input

Output

ListHandshakesForOrganization

amazonaws_organizations.ListHandshakesForOrganization({}, context)

Input

Output

ListOrganizationalUnitsForParent

amazonaws_organizations.ListOrganizationalUnitsForParent({
  "ParentId": ""
}, context)

Input

Output

ListParents

amazonaws_organizations.ListParents({
  "ChildId": ""
}, context)

Input

Output

ListPolicies

amazonaws_organizations.ListPolicies({
  "Filter": ""
}, context)

Input

Output

ListPoliciesForTarget

amazonaws_organizations.ListPoliciesForTarget({
  "TargetId": "",
  "Filter": ""
}, context)

Input

Output

ListRoots

amazonaws_organizations.ListRoots({}, context)

Input

Output

ListTargetsForPolicy

amazonaws_organizations.ListTargetsForPolicy({
  "PolicyId": ""
}, context)

Input

Output

MoveAccount

amazonaws_organizations.MoveAccount({
  "AccountId": "",
  "SourceParentId": "",
  "DestinationParentId": ""
}, context)

Input

Output

Output schema unknown

RemoveAccountFromOrganization

amazonaws_organizations.RemoveAccountFromOrganization({
  "AccountId": ""
}, context)

Input

Output

Output schema unknown

UpdateOrganizationalUnit

amazonaws_organizations.UpdateOrganizationalUnit({
  "OrganizationalUnitId": ""
}, context)

Input

Output

UpdatePolicy

amazonaws_organizations.UpdatePolicy({
  "PolicyId": ""
}, context)

Input

Output

Definitions

AWSOrganizationsNotInUseException

  • AWSOrganizationsNotInUseException object: Your account is not a member of an organization. To make this request, you must use the credentials of an account that belongs to an organization.

AcceptHandshakeRequest

  • AcceptHandshakeRequest object

AcceptHandshakeResponse

  • AcceptHandshakeResponse object

AccessDeniedException

  • AccessDeniedException object: You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

AccessDeniedForDependencyException

  • AccessDeniedForDependencyException object: The operation you attempted requires you to have the iam:CreateServiceLinkedRole so that Organizations can create the required service-linked role. You do not have that permission.

AccessDeniedForDependencyExceptionReason

  • AccessDeniedForDependencyExceptionReason string (values: ACCESS_DENIED_DURING_CREATE_SERVICE_LINKED_ROLE)

Account

AccountArn

  • AccountArn string

AccountId

  • AccountId string

AccountJoinedMethod

  • AccountJoinedMethod string (values: INVITED, CREATED)

AccountName

  • AccountName string

AccountNotFoundException

  • AccountNotFoundException object: We can't find an AWS account with the AccountId that you specified, or the account whose credentials you used to make this request is not a member of an organization.

AccountStatus

  • AccountStatus string (values: ACTIVE, SUSPENDED)

Accounts

ActionType

  • ActionType string (values: INVITE, ENABLE_ALL_FEATURES, APPROVE_ALL_FEATURES, ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE)

AlreadyInOrganizationException

  • AlreadyInOrganizationException object: This account is already a member of an organization. An account can belong to only one organization at a time.

AttachPolicyRequest

AwsManagedPolicy

  • AwsManagedPolicy boolean

CancelHandshakeRequest

  • CancelHandshakeRequest object

CancelHandshakeResponse

  • CancelHandshakeResponse object

Child

  • Child object: Contains a list of child entities, either OUs or accounts.

ChildId

  • ChildId string

ChildNotFoundException

  • ChildNotFoundException object: We can't find an organizational unit (OU) or AWS account with the ChildId that you specified.

ChildType

  • ChildType string (values: ACCOUNT, ORGANIZATIONAL_UNIT)

Children

  • Children array

ConcurrentModificationException

  • ConcurrentModificationException object: The target of the operation is currently being modified by a different request. Try again later.

ConstraintViolationException

  • ConstraintViolationException object:

    Performing this operation violates a minimum or maximum value limit. For example, attempting to removing the last SCP from an OU or root, inviting or creating too many accounts to the organization, or attaching too many policies to an account, OU, or root. This exception includes a reason that contains additional information about the violated limit:

    Some of the reasons in the following list might not be applicable to this specific API or operation:

    • ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact AWS Support to request an increase in your limit.

      Or, The number of invitations that you tried to send would cause you to exceed the limit of accounts in your organization. Send fewer invitations, or contact AWS Support to request an increase in the number of accounts.

      Note: deleted and closed accounts still count toward your limit.

      If you get an exception that indicates that you exceeded your account limits for the organization or that you can"t add an account because your organization is still initializing, please contact AWS Customer Support.

    • HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes you can send in one day.

    • OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of organizational units you can have in an organization.

    • OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an organizational unit tree that is too many levels deep.

    • POLICY_NUMBER_LIMIT_EXCEEDED. You attempted to exceed the number of policies that you can have in an organization.

    • MAX_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to exceed the number of policies of a certain type that can be attached to an entity at one time.

    • MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity that would cause the entity to have fewer than the minimum number of policies of a certain type required.

    • ACCOUNT_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that does not yet have enough information to exist as a stand-alone account. This account requires you to first agree to the AWS Customer Agreement. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.

    • ACCOUNT_CANNOT_LEAVE_WITHOUT_PHONE_VERIFICATION: You attempted to remove an account from the organization that does not yet have enough information to exist as a stand-alone account. This account requires you to first complete phone verification. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.

    • MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this account, you first must associate a payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.

    • MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.

    • ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.

    • MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's master account to the marketplace that corresponds to the master account's address. For example, accounts with India addresses must be associated with the AISPL marketplace. All accounts in an organization must be associated with the same marketplace.

    • MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide contact a valid address and phone number for the master account. Then try the operation again.

ConstraintViolationExceptionReason

  • ConstraintViolationExceptionReason string (values: ACCOUNT_NUMBER_LIMIT_EXCEEDED, HANDSHAKE_RATE_LIMIT_EXCEEDED, OU_NUMBER_LIMIT_EXCEEDED, OU_DEPTH_LIMIT_EXCEEDED, POLICY_NUMBER_LIMIT_EXCEEDED, MAX_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED, MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED, ACCOUNT_CANNOT_LEAVE_ORGANIZATION, ACCOUNT_CANNOT_LEAVE_WITHOUT_EULA, ACCOUNT_CANNOT_LEAVE_WITHOUT_PHONE_VERIFICATION, MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED, MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED, ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED, MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE, MASTER_ACCOUNT_MISSING_CONTACT_INFO, ORGANIZATION_NOT_IN_ALL_FEATURES_MODE)

CreateAccountFailureReason

  • CreateAccountFailureReason string (values: ACCOUNT_LIMIT_EXCEEDED, EMAIL_ALREADY_EXISTS, INVALID_ADDRESS, INVALID_EMAIL, CONCURRENT_ACCOUNT_MODIFICATION, INTERNAL_FAILURE)

CreateAccountRequest

CreateAccountRequestId

  • CreateAccountRequestId string

CreateAccountResponse

CreateAccountState

  • CreateAccountState string (values: IN_PROGRESS, SUCCEEDED, FAILED)

CreateAccountStates

CreateAccountStatus

CreateAccountStatusNotFoundException

  • CreateAccountStatusNotFoundException object: We can't find an create account request with the CreateAccountRequestId that you specified.

CreateAccountStatuses

CreateOrganizationRequest

CreateOrganizationResponse

  • CreateOrganizationResponse object

CreateOrganizationalUnitRequest

CreateOrganizationalUnitResponse

CreatePolicyRequest

CreatePolicyResponse

  • CreatePolicyResponse object

DeclineHandshakeRequest

  • DeclineHandshakeRequest object

DeclineHandshakeResponse

  • DeclineHandshakeResponse object

DeleteOrganizationalUnitRequest

DeletePolicyRequest

  • DeletePolicyRequest object

DescribeAccountRequest

  • DescribeAccountRequest object

DescribeAccountResponse

  • DescribeAccountResponse object

DescribeCreateAccountStatusRequest

DescribeCreateAccountStatusResponse

DescribeHandshakeRequest

  • DescribeHandshakeRequest object

DescribeHandshakeResponse

  • DescribeHandshakeResponse object

DescribeOrganizationResponse

  • DescribeOrganizationResponse object

DescribeOrganizationalUnitRequest

DescribeOrganizationalUnitResponse

DescribePolicyRequest

  • DescribePolicyRequest object

DescribePolicyResponse

  • DescribePolicyResponse object

DestinationParentNotFoundException

  • DestinationParentNotFoundException object: We can't find the destination container (a root or OU) with the ParentId that you specified.

DetachPolicyRequest

DisableAWSServiceAccessRequest

  • DisableAWSServiceAccessRequest object

DisablePolicyTypeRequest

  • DisablePolicyTypeRequest object

DisablePolicyTypeResponse

  • DisablePolicyTypeResponse object

DuplicateAccountException

  • DuplicateAccountException object: That account is already present in the specified destination.

DuplicateHandshakeException

  • DuplicateHandshakeException object: A handshake with the same action and target already exists. For example, if you invited an account to join your organization, the invited account might already have a pending invitation from this organization. If you intend to resend an invitation to an account, ensure that existing handshakes that might be considered duplicates are canceled or declined.

DuplicateOrganizationalUnitException

  • DuplicateOrganizationalUnitException object: An organizational unit (OU) with the same name already exists.

DuplicatePolicyAttachmentException

  • DuplicatePolicyAttachmentException object: The selected policy is already attached to the specified target.

DuplicatePolicyException

  • DuplicatePolicyException object: A policy with the same name already exists.

Email

  • Email string

EnableAWSServiceAccessRequest

  • EnableAWSServiceAccessRequest object

EnableAllFeaturesRequest

  • EnableAllFeaturesRequest object

EnableAllFeaturesResponse

  • EnableAllFeaturesResponse object

EnablePolicyTypeRequest

  • EnablePolicyTypeRequest object

EnablePolicyTypeResponse

  • EnablePolicyTypeResponse object

EnabledServicePrincipal

  • EnabledServicePrincipal object: A structure that contains details of a service principal that is enabled to integrate with AWS Organizations.

EnabledServicePrincipals

ExceptionMessage

  • ExceptionMessage string

ExceptionType

  • ExceptionType string

FinalizingOrganizationException

  • FinalizingOrganizationException object: AWS Organizations could not finalize the creation of your organization. Try again later. If this persists, contact AWS customer support.

GenericArn

  • GenericArn string

Handshake

  • Handshake object:

    Contains information that must be exchanged to securely establish a relationship between two accounts (an originator and a recipient). For example, when a master account (the originator) invites another account (the recipient) to join its organization, the two accounts exchange information as a series of handshake requests and responses.

    Note: Handshakes that are CANCELED, ACCEPTED, or DECLINED show up in lists for only 30 days after entering that state After that they are deleted.

HandshakeAlreadyInStateException

  • HandshakeAlreadyInStateException object: The specified handshake is already in the requested state. For example, you can't accept a handshake that was already accepted.

HandshakeArn

  • HandshakeArn string

HandshakeConstraintViolationException

  • HandshakeConstraintViolationException object:

    The requested operation would violate the constraint identified in the reason code.

    Some of the reasons in the following list might not be applicable to this specific API or operation:

    • ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. Note: deleted and closed accounts still count toward your limit.

      If you get an exception that indicates that you exceeded your account limits for the organization or that you can"t add an account because your organization is still initializing, please contact AWS Customer Support.

    • HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes you can send in one day.

    • ALREADY_IN_AN_ORGANIZATION: The handshake request is invalid because the invited account is already a member of an organization.

    • ORGANIZATION_ALREADY_HAS_ALL_FEATURES: The handshake request is invalid because the organization has already enabled all features.

    • INVITE_DISABLED_DURING_ENABLE_ALL_FEATURES: You cannot issue new invitations to join an organization while it is in the process of enabling all features. You can resume inviting accounts after you finalize the process when all accounts have agreed to the change.

    • PAYMENT_INSTRUMENT_REQUIRED: You cannot complete the operation with an account that does not have a payment instrument, such as a credit card, associated with it.

    • ORGANIZATION_FROM_DIFFERENT_SELLER_OF_RECORD: The request failed because the account is from a different marketplace than the accounts in the organization. For example, accounts with India addresses must be associated with the AISPL marketplace. All accounts in an organization must be from the same marketplace.

    • ORGANIZATION_MEMBERSHIP_CHANGE_RATE_LIMIT_EXCEEDED: You attempted to change the membership of an account too quickly after its previous change.

HandshakeConstraintViolationExceptionReason

  • HandshakeConstraintViolationExceptionReason string (values: ACCOUNT_NUMBER_LIMIT_EXCEEDED, HANDSHAKE_RATE_LIMIT_EXCEEDED, ALREADY_IN_AN_ORGANIZATION, ORGANIZATION_ALREADY_HAS_ALL_FEATURES, INVITE_DISABLED_DURING_ENABLE_ALL_FEATURES, PAYMENT_INSTRUMENT_REQUIRED, ORGANIZATION_FROM_DIFFERENT_SELLER_OF_RECORD, ORGANIZATION_MEMBERSHIP_CHANGE_RATE_LIMIT_EXCEEDED)

HandshakeFilter

  • HandshakeFilter object: Specifies the criteria that are used to select the handshakes for the operation.

HandshakeId

  • HandshakeId string

HandshakeNotFoundException

  • HandshakeNotFoundException object: We can't find a handshake with the HandshakeId that you specified.

HandshakeNotes

  • HandshakeNotes string

HandshakeParties

HandshakeParty

HandshakePartyId

  • HandshakePartyId string

HandshakePartyType

  • HandshakePartyType string (values: ACCOUNT, ORGANIZATION, EMAIL)

HandshakeResource

HandshakeResourceType

  • HandshakeResourceType string (values: ACCOUNT, ORGANIZATION, ORGANIZATION_FEATURE_SET, EMAIL, MASTER_EMAIL, MASTER_NAME, NOTES, PARENT_HANDSHAKE)

HandshakeResourceValue

  • HandshakeResourceValue string

HandshakeResources

HandshakeState

  • HandshakeState string (values: REQUESTED, OPEN, CANCELED, ACCEPTED, DECLINED, EXPIRED)

Handshakes

IAMUserAccessToBilling

  • IAMUserAccessToBilling string (values: ALLOW, DENY)

InvalidHandshakeTransitionException

  • InvalidHandshakeTransitionException object: You can't perform the operation on the handshake in its current state. For example, you can't cancel a handshake that was already accepted, or accept a handshake that was already declined.

InvalidInputException

  • InvalidInputException object:

    The requested operation failed because you provided invalid values for one or more of the request parameters. This exception includes a reason that contains additional information about the violated limit:

    Some of the reasons in the following list might not be applicable to this specific API or operation:

    • INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

    • INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.

    • INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

    • INVALID_ENUM: You specified a value that is not valid for that parameter.

    • INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.

    • INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.

    • MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.

    • MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.

    • MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.

    • MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.

    • IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.

    • INVALID_PATTERN: You provided a value that doesn't match the required pattern.

    • INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.

    • INPUT_REQUIRED: You must include a value for all required parameters.

    • INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

    • MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

    • MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.

InvalidInputExceptionReason

  • InvalidInputExceptionReason string (values: INVALID_PARTY_TYPE_TARGET, INVALID_SYNTAX_ORGANIZATION_ARN, INVALID_SYNTAX_POLICY_ID, INVALID_ENUM, INVALID_LIST_MEMBER, MAX_LENGTH_EXCEEDED, MAX_VALUE_EXCEEDED, MIN_LENGTH_EXCEEDED, MIN_VALUE_EXCEEDED, IMMUTABLE_POLICY, INVALID_PATTERN, INVALID_PATTERN_TARGET_ID, INPUT_REQUIRED, INVALID_NEXT_TOKEN, MAX_LIMIT_EXCEEDED_FILTER, MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS, INVALID_FULL_NAME_TARGET, UNRECOGNIZED_SERVICE_PRINCIPAL)

InviteAccountToOrganizationRequest

InviteAccountToOrganizationResponse

  • InviteAccountToOrganizationResponse object

ListAWSServiceAccessForOrganizationRequest

ListAWSServiceAccessForOrganizationResponse

ListAccountsForParentRequest

ListAccountsForParentResponse

ListAccountsRequest

ListAccountsResponse

ListChildrenRequest

ListChildrenResponse

ListCreateAccountStatusRequest

ListCreateAccountStatusResponse

ListHandshakesForAccountRequest

ListHandshakesForAccountResponse

ListHandshakesForOrganizationRequest

ListHandshakesForOrganizationResponse

ListOrganizationalUnitsForParentRequest

ListOrganizationalUnitsForParentResponse

ListParentsRequest

ListParentsResponse

ListPoliciesForTargetRequest

ListPoliciesForTargetResponse

ListPoliciesRequest

ListPoliciesResponse

ListRootsRequest

ListRootsResponse

ListTargetsForPolicyRequest

ListTargetsForPolicyResponse

MalformedPolicyDocumentException

  • MalformedPolicyDocumentException object: The provided policy document does not meet the requirements of the specified policy type. For example, the syntax might be incorrect. For details about service control policy syntax, see Service Control Policy Syntax in the AWS Organizations User Guide.

MasterCannotLeaveOrganizationException

  • MasterCannotLeaveOrganizationException object: You can't remove a master account from an organization. If you want the master account to become a member account in another organization, you must first delete the current organization of the master account.

MaxResults

  • MaxResults integer

MoveAccountRequest

  • MoveAccountRequest object

NextToken

  • NextToken string

Organization

  • Organization object: Contains details about an organization. An organization is a collection of accounts that are centrally managed together using consolidated billing, organized hierarchically with organizational units (OUs), and controlled with policies .

OrganizationArn

  • OrganizationArn string

OrganizationFeatureSet

  • OrganizationFeatureSet string (values: ALL, CONSOLIDATED_BILLING)

OrganizationId

  • OrganizationId string

OrganizationNotEmptyException

  • OrganizationNotEmptyException object: The organization isn't empty. To delete an organization, you must first remove all accounts except the master account, delete all organizational units (OUs), and delete all policies.

OrganizationalUnit

  • OrganizationalUnit object: Contains details about an organizational unit (OU). An OU is a container of AWS accounts within a root of an organization. Policies that are attached to an OU apply to all accounts contained in that OU and in any child OUs.

OrganizationalUnitArn

  • OrganizationalUnitArn string

OrganizationalUnitId

  • OrganizationalUnitId string

OrganizationalUnitName

  • OrganizationalUnitName string

OrganizationalUnitNotEmptyException

  • OrganizationalUnitNotEmptyException object: The specified organizational unit (OU) is not empty. Move all accounts to another root or to other OUs, remove all child OUs, and then try the operation again.

OrganizationalUnitNotFoundException

  • OrganizationalUnitNotFoundException object: We can't find an organizational unit (OU) with the OrganizationalUnitId that you specified.

OrganizationalUnits

Parent

  • Parent object: Contains information about either a root or an organizational unit (OU) that can contain OUs or accounts in an organization.

ParentId

  • ParentId string

ParentNotFoundException

  • ParentNotFoundException object: We can't find a root or organizational unit (OU) with the ParentId that you specified.

ParentType

  • ParentType string (values: ROOT, ORGANIZATIONAL_UNIT)

Parents

Policies

Policy

  • Policy object: Contains rules to be applied to the affected accounts. Policies can be attached directly to accounts, or to roots and OUs to affect all accounts in those hierarchies.

PolicyArn

  • PolicyArn string

PolicyContent

  • PolicyContent string

PolicyDescription

  • PolicyDescription string

PolicyId

  • PolicyId string

PolicyInUseException

  • PolicyInUseException object: The policy is attached to one or more entities. You must detach it from all roots, organizational units (OUs), and accounts before performing this operation.

PolicyName

  • PolicyName string

PolicyNotAttachedException

  • PolicyNotAttachedException object: The policy isn't attached to the specified target in the specified root.

PolicyNotFoundException

  • PolicyNotFoundException object: We can't find a policy with the PolicyId that you specified.

PolicySummary

PolicyTargetId

  • PolicyTargetId string

PolicyTargetSummary

PolicyTargets

PolicyType

  • PolicyType string (values: SERVICE_CONTROL_POLICY)

PolicyTypeAlreadyEnabledException

  • PolicyTypeAlreadyEnabledException object: The specified policy type is already enabled in the specified root.

PolicyTypeNotAvailableForOrganizationException

  • PolicyTypeNotAvailableForOrganizationException object: You can't use the specified policy type with the feature set currently enabled for this organization. For example, you can enable service control policies (SCPs) only after you enable all features in the organization. For more information, see Enabling and Disabling a Policy Type on a Root in the AWS Organizations User Guide.

PolicyTypeNotEnabledException

  • PolicyTypeNotEnabledException object: The specified policy type is not currently enabled in this root. You cannot attach policies of the specified type to entities in a root until you enable that type in the root. For more information, see Enabling All Features in Your Organization in the AWS Organizations User Guide.

PolicyTypeStatus

  • PolicyTypeStatus string (values: ENABLED, PENDING_ENABLE, PENDING_DISABLE)

PolicyTypeSummary

  • PolicyTypeSummary object: Contains information about a policy type and its status in the associated root.

PolicyTypes

RemoveAccountFromOrganizationRequest

  • RemoveAccountFromOrganizationRequest object

RoleName

  • RoleName string

Root

  • Root object: Contains details about a root. A root is a top-level parent node in the hierarchy of an organization that can contain organizational units (OUs) and accounts. Every root contains every AWS account in the organization. Each root enables the accounts to be organized in a different way and to have different policy types enabled for use in that root.

RootArn

  • RootArn string

RootId

  • RootId string

RootName

  • RootName string

RootNotFoundException

  • RootNotFoundException object: We can't find a root with the RootId that you specified.

Roots

  • Roots array

ServiceException

  • ServiceException object: AWS Organizations can't complete your request because of an internal service error. Try again later.

ServicePrincipal

  • ServicePrincipal string

SourceParentNotFoundException

  • SourceParentNotFoundException object: We can't find a source root or OU with the ParentId that you specified.

TargetName

  • TargetName string

TargetNotFoundException

  • TargetNotFoundException object: We can't find a root, OU, or account with the TargetId that you specified.

TargetType

  • TargetType string (values: ACCOUNT, ORGANIZATIONAL_UNIT, ROOT)

Timestamp

  • Timestamp string

TooManyRequestsException

  • TooManyRequestsException object: You've sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

UpdateOrganizationalUnitRequest

UpdateOrganizationalUnitResponse

UpdatePolicyRequest

UpdatePolicyResponse

  • UpdatePolicyResponse object

Readme

Keywords

none

Package Sidebar

Install

npm i @datafire/amazonaws_organizations

Repository

github.com/DataFire/integrations

Homepage

github.com/DataFire/integrations#readme

Weekly Downloads

1

Version

5.0.0

License

MIT

Unpacked Size

369 kB

Total Files

5

Last publish

Collaborators

  • datafire
Try on RunKit
Report malware