Class: Aws::Organizations::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-organizations/client.rb

Overview

An API client for Organizations. To construct a client, you need to configure a ‘:region` and `:credentials`.

client = Aws::Organizations::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements ‘Aws::CredentialProvider`, or instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

    • ‘ENV`, `ENV`, `ENV`, and `ENV`.

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting `ENV` to `true`.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: ‘sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV` or in shared config as `auth_scheme_preference`, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When ‘true`, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at ‘HOME/.aws/credentials`. When not specified, ’default’ is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • ‘when_supported` - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a `requestAlgorithmMember` is modeled.

    • ‘when_required` - When set, a checksum will only be calculated for request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` or where a `requestAlgorithmMember` is modeled and supplied.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • ‘when_supported` - (default) When set, checksum validation is performed on all response payloads of operations modeled with the `httpChecksum` trait where `responseAlgorithms` is modeled, except when no modeled checksum algorithms are supported.

    • ‘when_required` - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the `requestValidationModeMember` member is set to `ENABLED`.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements ‘Aws::TokenProvider`, or instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::Organizations::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::Organizations::EndpointParameters`.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.



480
481
482
 
# File 'lib/aws-sdk-organizations/client.rb', line 480

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



6167
6168
6169
 
# File 'lib/aws-sdk-organizations/client.rb', line 6167

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



6170
6171
6172
 
# File 'lib/aws-sdk-organizations/client.rb', line 6170

def errors_module
  Errors
end

Instance Method Details

#accept_handshake(params = {}) ⇒ Types::AcceptHandshakeResponse

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

You can only call this operation by the following principals when they also have the relevant IAM permissions:

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

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

    Organizations and service-linked roles][1

    in the *Organizations

    User Guide*.

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

    For more information about invitations, see [Inviting an Amazon Web Services account to join your organization] in the *Organizations User Guide*. For more information about requests to enable all features in the organization, see [Enabling all features in your organization] in the *Organizations User Guide*.

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

[1]: docs.aws.amazon.com/organizations/latest/userguide/orgs_integration_services.html#orgs_integrate_services-using_slrs [2]: docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_invites.html [3]: docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html

Examples:

Example: 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.

resp = client.accept_handshake({
  handshake_id: "h-examplehandshakeid111", 
})

resp.to_h outputs the following:
{
  handshake: {
    action: "INVITE", 
    arn: "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", 
    expiration_timestamp: Time.parse("20170228T1215Z"), 
    id: "h-examplehandshakeid111", 
    parties: [
      {
        id: "o-exampleorgid", 
        type: "ORGANIZATION", 
      }, 
      {
        id: "[email protected]", 
        type: "EMAIL", 
      }, 
    ], 
    requested_timestamp: Time.parse("20170214T1215Z"), 
    resources: [
      {
        resources: [
          {
            type: "MASTER_EMAIL", 
            value: "[email protected]", 
          }, 
          {
            type: "MASTER_NAME", 
            value: "Org Master Account", 
          }, 
          {
            type: "ORGANIZATION_FEATURE_SET", 
            value: "ALL", 
          }, 
        ], 
        type: "ORGANIZATION", 
        value: "o-exampleorgid", 
      }, 
      {
        type: "ACCOUNT", 
        value: "222222222222", 
      }, 
    ], 
    state: "ACCEPTED", 
  }, 
}

Request syntax with placeholder values


resp = client.accept_handshake({
  handshake_id: "HandshakeId", # required
})

Response structure


resp.handshake.id #=> String
resp.handshake.arn #=> String
resp.handshake.parties #=> Array
resp.handshake.parties[0].id #=> String
resp.handshake.parties[0].type #=> String, one of "ACCOUNT", "ORGANIZATION", "EMAIL"
resp.handshake.state #=> String, one of "REQUESTED", "OPEN", "CANCELED", "ACCEPTED", "DECLINED", "EXPIRED"
resp.handshake.requested_timestamp #=> Time
resp.handshake.expiration_timestamp #=> Time
resp.handshake.action #=> String, one of "INVITE", "ENABLE_ALL_FEATURES", "APPROVE_ALL_FEATURES", "ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE"
resp.handshake.resources #=> Array
resp.handshake.resources[0].value #=> String
resp.handshake.resources[0].type #=> String, one of "ACCOUNT", "ORGANIZATION", "ORGANIZATION_FEATURE_SET", "EMAIL", "MASTER_EMAIL", "MASTER_NAME", "NOTES", "PARENT_HANDSHAKE"
resp.handshake.resources[0].resources #=> Types::HandshakeResources

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :handshake_id (required, 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 lowercase letters or digits.

    [1]: wikipedia.org/wiki/regex

Returns:

See Also:



618
619
620
621
 
# File 'lib/aws-sdk-organizations/client.rb', line 618

def accept_handshake(params = {}, options = {})
  req = build_request(:accept_handshake, params)
  req.send_request(options)
end

#attach_policy(params = {}) ⇒ Struct

Attaches a policy to a root, an organizational unit (OU), or an individual account. How the policy affects accounts depends on the type of policy. Refer to the *Organizations User Guide* for information about each policy type:

  • SERVICE_CONTROL_POLICY][1
  • RESOURCE_CONTROL_POLICY][2
  • DECLARATIVE_POLICY_EC2][3
  • BACKUP_POLICY][4
  • TAG_POLICY][5
  • CHATBOT_POLICY][6
  • AISERVICES_OPT_OUT_POLICY][7
  • SECURITYHUB_POLICY][8

This operation can be called only from the organization’s management account or by a member account that is a delegated administrator.

[1]: docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scp.html [2]: docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_rcps.html [3]: docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_declarative.html [4]: docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_backup.html [5]: docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html [6]: docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_chatbot.html [7]: docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html [8]: docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_security_hub.html

Examples:

Example: To attach a policy to an OU


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

resp = client.attach_policy({
  policy_id: "p-examplepolicyid111", 
  target_id: "ou-examplerootid111-exampleouid111", 
})

Example: To attach a policy to an account


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

resp = client.attach_policy({
  policy_id: "p-examplepolicyid111", 
  target_id: "333333333333", 
})

Request syntax with placeholder values


resp = client.attach_policy({
  policy_id: "PolicyId", # required
  target_id: "PolicyTargetId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :policy_id (required, 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 lowercase or uppercase letters, digits, or the underscore character (_).

    [1]: wikipedia.org/wiki/regex

  • :target_id (required, 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 lowercase letters or digits.

    • Account - A string that consists of exactly 12 digits.

    • **Organizational unit (OU)** - A string that begins with “ou-” followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second “-” dash and from 8 to 32 additional lowercase letters or digits.

    [1]: wikipedia.org/wiki/regex

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



725
726
727
728
 
# File 'lib/aws-sdk-organizations/client.rb', line 725

def attach_policy(params = {}, options = {})
  req = build_request(:attach_policy, params)
  req.send_request(options)
end

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

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


6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
 
# File 'lib/aws-sdk-organizations/client.rb', line 6140

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::Organizations')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-organizations'
  context[:gem_version] = '1.124.0'
  Seahorse::Client::Request.new(handlers, context)
end

#cancel_handshake(params = {}) ⇒ Types::CancelHandshakeResponse

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

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

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

Examples:

Example: 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:

resp = client.cancel_handshake({
  handshake_id: "h-examplehandshakeid111", 
})

resp.to_h outputs the following:
{
  handshake: {
    action: "INVITE", 
    arn: "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", 
    expiration_timestamp: Time.parse("20170228T1215Z"), 
    id: "h-examplehandshakeid111", 
    parties: [
      {
        id: "o-exampleorgid", 
        type: "ORGANIZATION", 
      }, 
      {
        id: "[email protected]", 
        type: "EMAIL", 
      }, 
    ], 
    requested_timestamp: Time.parse("20170214T1215Z"), 
    resources: [
      {
        resources: [
          {
            type: "MASTER_EMAIL", 
            value: "[email protected]", 
          }, 
          {
            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", 
  }, 
}

Request syntax with placeholder values


resp = client.cancel_handshake({
  handshake_id: "HandshakeId", # required
})

Response structure


resp.handshake.id #=> String
resp.handshake.arn #=> String
resp.handshake.parties #=> Array
resp.handshake.parties[0].id #=> String
resp.handshake.parties[0].type #=> String, one of "ACCOUNT", "ORGANIZATION", "EMAIL"
resp.handshake.state #=> String, one of "REQUESTED", "OPEN", "CANCELED", "ACCEPTED", "DECLINED", "EXPIRED"
resp.handshake.requested_timestamp #=> Time
resp.handshake.expiration_timestamp #=> Time
resp.handshake.action #=> String, one of "INVITE", "ENABLE_ALL_FEATURES", "APPROVE_ALL_FEATURES", "ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE"
resp.handshake.resources #=> Array
resp.handshake.resources[0].value #=> String
resp.handshake.resources[0].type #=> String, one of "ACCOUNT", "ORGANIZATION", "ORGANIZATION_FEATURE_SET", "EMAIL", "MASTER_EMAIL", "MASTER_NAME", "NOTES", "PARENT_HANDSHAKE"
resp.handshake.resources[0].resources #=> Types::HandshakeResources

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :handshake_id (required, 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 lowercase letters or digits.

    [1]: wikipedia.org/wiki/regex

Returns:

See Also:



842
843
844
845
 
# File 'lib/aws-sdk-organizations/client.rb', line 842

def cancel_handshake(params = {}, options = {})
  req = build_request(:cancel_handshake, params)
  req.send_request(options)
end

#close_account(params = {}) ⇒ Struct

Closes an Amazon Web Services member account within an organization. You can close an account when [all features are enabled ][1]. You can’t close the management account with this API. This is an asynchronous request that Amazon Web Services performs in the background. Because ‘CloseAccount` operates asynchronously, it can return a successful completion message even though account closure might still be in progress. You need to wait a few minutes before the account is fully closed. To check the status of the request, do one of the following:

  • Use the ‘AccountId` that you sent in the `CloseAccount` request to provide as a parameter to the DescribeAccount operation.

    While the close account request is in progress, Account status will indicate PENDING_CLOSURE. When the close account request completes, the status will change to SUSPENDED.

  • Check the CloudTrail log for the ‘CloseAccountResult` event that gets published after the account closes successfully. For information on using CloudTrail with Organizations, see [Logging and monitoring in Organizations] in the *Organizations User Guide*.

<note markdown=“1”> * You can close only 10% of member accounts, between 10 and 1000,

within a rolling 30 day period. This quota is not bound by a
calendar month, but starts when you close an account. After you
reach this limit, you can't close additional accounts. For more
information, see [Closing a member account in your organization][3]
and [Quotas for Organizations][4] in the *Organizations User Guide*.

  • To reinstate a closed account, contact Amazon Web Services Support within the 90-day grace period while the account is in SUSPENDED status.

  • If the Amazon Web Services account you attempt to close is linked to an Amazon Web Services GovCloud (US) account, the ‘CloseAccount` request will close both accounts. To learn important pre-closure details, see [ Closing an Amazon Web Services GovCloud (US) account] in the Amazon Web Services GovCloud User Guide.

</note>

[1]: docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html [2]: docs.aws.amazon.com/organizations/latest/userguide/orgs_security_incident-response.html#orgs_cloudtrail-integration [3]: docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_close.html [4]: docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_limits.html [5]: docs.aws.amazon.com/govcloud-us/latest/UserGuide/Closing-govcloud-account.html

Examples:

Request syntax with placeholder values


resp = client.({
  account_id: "AccountId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_id (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



912
913
914
915
 
# File 'lib/aws-sdk-organizations/client.rb', line 912

def (params = {}, options = {})
  req = build_request(:close_account, params)
  req.send_request(options)
end

#create_account(params = {}) ⇒ Types::CreateAccountResponse

Creates an Amazon Web Services account that is automatically a member of the organization whose credentials made the request. This is an asynchronous request that Amazon Web Services performs in the background. Because ‘CreateAccount` operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following:

  • Use the ‘Id` value of the `CreateAccountStatus` response element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation.

  • Check the CloudTrail log for the ‘CreateAccountResult` event. For information on using CloudTrail with Organizations, see [Logging and monitoring in Organizations] in the *Organizations User Guide*.

The user who calls the API to create an account must have the ‘organizations:CreateAccount` permission. If you enabled all features in the organization, Organizations creates the required service-linked role named `AWSServiceRoleForOrganizations`. For more information, see

Organizations and service-linked roles][2

in the *Organizations User

Guide*.

If the request includes tags, then the requester must have the ‘organizations:TagResource` permission.

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

This operation can be called only from the organization’s management account.

For more information about creating accounts, see [Creating a member account in your organization] in the *Organizations User Guide*.

  • When you create an account in an organization using the Organizations console, API, or CLI commands, the information required for the account to operate as a standalone account, such as a payment method is not automatically collected. If you must remove an account from your organization later, you can do so only after you provide the missing information. For more information, see

    Considerations before removing an account from an organization][4

    in the *Organizations User Guide*.

  • If you get an exception that indicates that you exceeded your account limits for the organization, contact [Amazon Web Services Support].

  • If you get an exception that indicates that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists, contact [Amazon Web Services Support].

  • It isn’t recommended to use ‘CreateAccount` to create multiple temporary accounts, and using the `CreateAccount` API to close accounts is subject to a 30-day usage quota. For information on the requirements and process for closing an account, see [Closing a member account in your organization] in the *Organizations User Guide*.

<note markdown=“1”> 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].

</note>

[1]: docs.aws.amazon.com/organizations/latest/userguide/orgs_security_incident-response.html#orgs_cloudtrail-integration [2]: docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html#orgs_integrate_services-using_slrs [3]: docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_create.html [4]: docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_account-before-remove.html [5]: console.aws.amazon.com/support/home#/ [6]: docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_close.html [7]: docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/control-access-billing.html#grantaccess

Examples:

Example: 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 [email protected].  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:

resp = client.({
  account_name: "Production Account", 
  email: "[email protected]", 
})

resp.to_h outputs the following:
{
  create_account_status: {
    id: "car-examplecreateaccountrequestid111", 
    state: "IN_PROGRESS", 
  }, 
}

Request syntax with placeholder values


resp = client.({
  email: "Email", # required
  account_name: "CreateAccountName", # required
  role_name: "RoleName",
  iam_user_access_to_billing: "ALLOW", # accepts ALLOW, DENY
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp..id #=> String
resp.. #=> String
resp..state #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
resp..requested_timestamp #=> Time
resp..completed_timestamp #=> Time
resp.. #=> String
resp.. #=> String
resp..failure_reason #=> String, one of "ACCOUNT_LIMIT_EXCEEDED", "EMAIL_ALREADY_EXISTS", "INVALID_ADDRESS", "INVALID_EMAIL", "CONCURRENT_ACCOUNT_MODIFICATION", "INTERNAL_FAILURE", "GOVCLOUD_ACCOUNT_ALREADY_EXISTS", "MISSING_BUSINESS_VALIDATION", "FAILED_BUSINESS_VALIDATION", "PENDING_BUSINESS_VALIDATION", "INVALID_IDENTITY_FOR_BUSINESS_VALIDATION", "UNKNOWN_BUSINESS_VALIDATION", "MISSING_PAYMENT_INSTRUMENT", "INVALID_PAYMENT_INSTRUMENT", "UPDATE_EXISTING_RESOURCE_POLICY_WITH_TAGS_NOT_SUPPORTED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :email (required, String) —

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

    The rules for a valid email address:

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

    • All characters must be 7-bit ASCII characters.

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

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

      whitespace, “ ‘ ( ) &lt; &gt; [ ] : ; , \ | % &amp;

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

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

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

    • The domain name must contain at least one dot

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

  • :account_name (required, String) —

    The friendly name of the member account.

  • :role_name (String) —

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

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

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

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

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

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

    [1]: docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html#orgs_manage_accounts_create-cross-account-role [2]: docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_cross-account-with-roles.html [3]: wikipedia.org/wiki/regex

  • :iam_user_access_to_billing (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 [About IAM access to the Billing and Cost Management console] in the *Amazon Web Services Billing and Cost Management User Guide*.

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

    [1]: docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html#ControllingAccessWebsite-Activate

  • :tags (Array<Types::Tag>) —

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

    <note markdown=“1”> If any one of the tags is not valid or if you exceed the maximum allowed number of tags for an account, then the entire request fails and the account is not created.

    </note>

    [1]: docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html

Returns:

See Also:



1155
1156
1157
1158
 
# File 'lib/aws-sdk-organizations/client.rb', line 1155

def (params = {}, options = {})
  req = build_request(:create_account, params)
  req.send_request(options)
end

#create_gov_cloud_account(params = {}) ⇒ Types::CreateGovCloudAccountResponse

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

  • You’re authorized to create accounts in the Amazon Web Services GovCloud (US) Region. For more information on the Amazon Web Services GovCloud (US) Region, see the [ *Amazon Web Services GovCloud User Guide*.]

  • You already have an account in the Amazon Web Services GovCloud (US) Region that is paired with a management account of an organization in the commercial Region.

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

  • You have the ‘organizations:CreateGovCloudAccount` permission.

Organizations automatically creates the required service-linked role named ‘AWSServiceRoleForOrganizations`. For more information, see

Organizations and service-linked roles][2

in the *Organizations User

Guide*.

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

  • Verify that CloudTrail is enabled to store logs.

  • Create an Amazon S3 bucket for CloudTrail log storage.

    For more information, see [Verifying CloudTrail Is Enabled] in the *Amazon Web Services GovCloud User Guide*.

If the request includes tags, then the requester must have the ‘organizations:TagResource` permission. The tags are attached to the commercial account associated with the GovCloud account, rather than the GovCloud account itself. To add tags to the GovCloud account, call the TagResource operation in the GovCloud Region after the new GovCloud account exists.

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

Organizations][4

in the *Amazon Web Services GovCloud User Guide*.

Calling ‘CreateGovCloudAccount` is an asynchronous request that Amazon Web Services performs in the background. Because `CreateGovCloudAccount` operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following:

  • Use the ‘OperationId` response element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation.

  • Check the CloudTrail log for the ‘CreateAccountResult` event. For information on using CloudTrail with Organizations, see [Logging and monitoring in Organizations] in the *Organizations User Guide*.

When you call the ‘CreateGovCloudAccount` action, you create two accounts: a standalone account in the Amazon Web Services GovCloud (US) Region and an associated account in the commercial Region for billing and support purposes. The account in the commercial Region is automatically a member of the organization whose credentials made the request. Both accounts are associated with the same email address.

A role is created in the new account in the commercial Region that allows the management account in the organization in the commercial Region to assume it. An Amazon Web Services GovCloud (US) account is then created and associated with the commercial account that you just created. A role is also created in the new Amazon Web Services GovCloud (US) account that can be assumed by the Amazon Web Services GovCloud (US) account that is associated with the management account of the commercial organization. For more information and to view a diagram that explains how account access works, see [Organizations] in the *Amazon Web Services GovCloud User Guide*.

For more information about creating accounts, see [Creating a member account in your organization] in the *Organizations User Guide*.

  • When you create an account in an organization using the Organizations console, API, or CLI commands, the information required for the account to operate as a standalone account is not automatically collected. This includes a payment method and signing the end user license agreement (EULA). If you must remove an account from your organization later, you can do so only after you provide the missing information. For more information, see [Considerations before removing an account from an organization] in the *Organizations User Guide*.

  • If you get an exception that indicates that you exceeded your account limits for the organization, contact [Amazon Web Services Support].

  • If you get an exception that indicates that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists, contact [Amazon Web Services Support].

  • Using ‘CreateGovCloudAccount` to create multiple temporary accounts isn’t recommended. You can only close an account from the Amazon Web Services Billing and Cost Management console, and you must be signed in as the root user. For information on the requirements and process for closing an account, see [Closing a member account in your organization] in the *Organizations User Guide*.

<note markdown=“1”> 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].

</note>

[1]: docs.aws.amazon.com/govcloud-us/latest/UserGuide/welcome.html [2]: docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html#orgs_integrate_services-using_slrs [3]: docs.aws.amazon.com/govcloud-us/latest/UserGuide/verifying-cloudtrail.html [4]: docs.aws.amazon.com/govcloud-us/latest/UserGuide/govcloud-organizations.html [5]: docs.aws.amazon.com/organizations/latest/userguide/orgs_security_incident-response.html [6]: docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_create.html [7]: docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_account-before-remove.html [8]: console.aws.amazon.com/support/home#/ [9]: docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_close.html [10]: docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html

Examples:

Request syntax with placeholder values


resp = client.({
  email: "Email", # required
  account_name: "CreateAccountName", # required
  role_name: "RoleName",
  iam_user_access_to_billing: "ALLOW", # accepts ALLOW, DENY
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp..id #=> String
resp.. #=> String
resp..state #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
resp..requested_timestamp #=> Time
resp..completed_timestamp #=> Time
resp.. #=> String
resp.. #=> String
resp..failure_reason #=> String, one of "ACCOUNT_LIMIT_EXCEEDED", "EMAIL_ALREADY_EXISTS", "INVALID_ADDRESS", "INVALID_EMAIL", "CONCURRENT_ACCOUNT_MODIFICATION", "INTERNAL_FAILURE", "GOVCLOUD_ACCOUNT_ALREADY_EXISTS", "MISSING_BUSINESS_VALIDATION", "FAILED_BUSINESS_VALIDATION", "PENDING_BUSINESS_VALIDATION", "INVALID_IDENTITY_FOR_BUSINESS_VALIDATION", "UNKNOWN_BUSINESS_VALIDATION", "MISSING_PAYMENT_INSTRUMENT", "INVALID_PAYMENT_INSTRUMENT", "UPDATE_EXISTING_RESOURCE_POLICY_WITH_TAGS_NOT_SUPPORTED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :email (required, String) —

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

    The rules for a valid email address:

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

    • All characters must be 7-bit ASCII characters.

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

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

      whitespace, “ ‘ ( ) &lt; &gt; [ ] : ; , \ | % &amp;

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

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

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

    • The domain name must contain at least one dot

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

  • :account_name (required, String) —

    The friendly name of the member account.

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

  • :role_name (String) — default: Optional —

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

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

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

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

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

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

    [1]: docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html#orgs_manage_accounts_create-cross-account-role [2]: docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_cross-account-with-roles.html [3]: wikipedia.org/wiki/regex

  • :iam_user_access_to_billing (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 [About IAM access to the Billing and Cost Management console] in the *Amazon Web Services Billing and Cost Management User Guide*.

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

    [1]: docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html#ControllingAccessWebsite-Activate

  • :tags (Array<Types::Tag>) —

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

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

    <note markdown=“1”> If any one of the tags is not valid or if you exceed the maximum allowed number of tags for an account, then the entire request fails and the account is not created.

    </note>

    [1]: docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html

Returns:

See Also:



1443
1444
1445
1446
 
# File 'lib/aws-sdk-organizations/client.rb', line 1443

def (params = {}, options = {})
  req = build_request(:create_gov_cloud_account, params)
  req.send_request(options)
end

#create_organization(params = {}) ⇒ Types::CreateOrganizationResponse

Creates an Amazon Web Services organization. The account whose user is calling the ‘CreateOrganization` operation automatically becomes the

management account][1

of the new organization.

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

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

[1]: docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account

Examples:

Example: 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:

resp = client.create_organization({
})

resp.to_h outputs the following:
{
  organization: {
    arn: "arn:aws:organizations::111111111111:organization/o-exampleorgid", 
    available_policy_types: [
      {
        status: "ENABLED", 
        type: "SERVICE_CONTROL_POLICY", 
      }, 
    ], 
    feature_set: "ALL", 
    id: "o-exampleorgid", 
    master_account_arn: "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111", 
    master_account_email: "[email protected]", 
    master_account_id: "111111111111", 
  }, 
}

Example: 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:

resp = client.create_organization({
  feature_set: "CONSOLIDATED_BILLING", 
})

resp.to_h outputs the following:
{
  organization: {
    arn: "arn:aws:organizations::111111111111:organization/o-exampleorgid", 
    available_policy_types: [
    ], 
    feature_set: "CONSOLIDATED_BILLING", 
    id: "o-exampleorgid", 
    master_account_arn: "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111", 
    master_account_email: "[email protected]", 
    master_account_id: "111111111111", 
  }, 
}

Request syntax with placeholder values


resp = client.create_organization({
  feature_set: "ALL", # accepts ALL, CONSOLIDATED_BILLING
})

Response structure


resp.organization.id #=> String
resp.organization.arn #=> String
resp.organization.feature_set #=> String, one of "ALL", "CONSOLIDATED_BILLING"
resp.organization. #=> String
resp.organization. #=> String
resp.organization. #=> String
resp.organization.available_policy_types #=> Array
resp.organization.available_policy_types[0].type #=> String, one of "SERVICE_CONTROL_POLICY", "RESOURCE_CONTROL_POLICY", "TAG_POLICY", "BACKUP_POLICY", "AISERVICES_OPT_OUT_POLICY", "CHATBOT_POLICY", "DECLARATIVE_POLICY_EC2", "SECURITYHUB_POLICY"
resp.organization.available_policy_types[0].status #=> String, one of "ENABLED", "PENDING_ENABLE", "PENDING_DISABLE"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



1568
1569
1570
1571
 
# File 'lib/aws-sdk-organizations/client.rb', line 1568

def create_organization(params = {}, options = {})
  req = build_request(:create_organization, params)
  req.send_request(options)
end

#create_organizational_unit(params = {}) ⇒ Types::CreateOrganizationalUnitResponse

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

For more information about OUs, see [Managing organizational units (OUs)] in the *Organizations User Guide*.

If the request includes tags, then the requester must have the ‘organizations:TagResource` permission.

This operation can be called only from the organization’s management account.

[1]: docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_ous.html

Examples:

Example: 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.:

resp = client.create_organizational_unit({
  name: "AccountingOU", 
  parent_id: "r-examplerootid111", 
})

resp.to_h outputs the following:
{
  organizational_unit: {
    arn: "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111", 
    id: "ou-examplerootid111-exampleouid111", 
    name: "AccountingOU", 
  }, 
}

Request syntax with placeholder values


resp = client.create_organizational_unit({
  parent_id: "ParentId", # required
  name: "OrganizationalUnitName", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.organizational_unit.id #=> String
resp.organizational_unit.arn #=> String
resp.organizational_unit.name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :parent_id (required, String) —

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

    The [regex pattern] for a parent ID string requires one of the following:

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

    • **Organizational unit (OU)** - A string that begins with “ou-” followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second “-” dash and from 8 to 32 additional lowercase letters or digits.

    [1]: wikipedia.org/wiki/regex

  • :name (required, String) —

    The friendly name to assign to the new OU.

  • :tags (Array<Types::Tag>) —

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

    <note markdown=“1”> If any one of the tags is not valid or if you exceed the allowed number of tags for an OU, then the entire request fails and the OU is not created.

    </note>

    [1]: docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html

Returns:

See Also:



1678
1679
1680
1681
 
# File 'lib/aws-sdk-organizations/client.rb', line 1678

def create_organizational_unit(params = {}, options = {})
  req = build_request(:create_organizational_unit, params)
  req.send_request(options)
end

#create_policy(params = {}) ⇒ Types::CreatePolicyResponse

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

For more information about policies and their use, see [Managing Organizations policies].

If the request includes tags, then the requester must have the ‘organizations:TagResource` permission.

This operation can be called only from the organization’s management account or by a member account that is a delegated administrator.

[1]: docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies.html

Examples:

Example: 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:

resp = client.create_policy({
  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", 
})

resp.to_h outputs the following:
{
  policy: {
    content: "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"s3:*\"}}", 
    policy_summary: {
      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", 
    }, 
  }, 
}

Request syntax with placeholder values


resp = client.create_policy({
  content: "PolicyContent", # required
  description: "PolicyDescription", # required
  name: "PolicyName", # required
  type: "SERVICE_CONTROL_POLICY", # required, accepts SERVICE_CONTROL_POLICY, RESOURCE_CONTROL_POLICY, TAG_POLICY, BACKUP_POLICY, AISERVICES_OPT_OUT_POLICY, CHATBOT_POLICY, DECLARATIVE_POLICY_EC2, SECURITYHUB_POLICY
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.policy.policy_summary.id #=> String
resp.policy.policy_summary.arn #=> String
resp.policy.policy_summary.name #=> String
resp.policy.policy_summary.description #=> String
resp.policy.policy_summary.type #=> String, one of "SERVICE_CONTROL_POLICY", "RESOURCE_CONTROL_POLICY", "TAG_POLICY", "BACKUP_POLICY", "AISERVICES_OPT_OUT_POLICY", "CHATBOT_POLICY", "DECLARATIVE_POLICY_EC2", "SECURITYHUB_POLICY"
resp.policy.policy_summary.aws_managed #=> Boolean
resp.policy.content #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



1835
1836
1837
1838
 
# File 'lib/aws-sdk-organizations/client.rb', line 1835

def create_policy(params = {}, options = {})
  req = build_request(:create_policy, params)
  req.send_request(options)
end

#decline_handshake(params = {}) ⇒ Types::DeclineHandshakeResponse

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

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

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

Examples:

Example: 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:

resp = client.decline_handshake({
  handshake_id: "h-examplehandshakeid111", 
})

resp.to_h outputs the following:
{
  handshake: {
    action: "INVITE", 
    arn: "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", 
    expiration_timestamp: Time.parse("2016-12-15T19:27:58Z"), 
    id: "h-examplehandshakeid111", 
    parties: [
      {
        id: "222222222222", 
        type: "ACCOUNT", 
      }, 
      {
        id: "o-exampleorgid", 
        type: "ORGANIZATION", 
      }, 
    ], 
    requested_timestamp: Time.parse("2016-11-30T19:27:58Z"), 
    resources: [
      {
        resources: [
          {
            type: "MASTER_EMAIL", 
            value: "[email protected]", 
          }, 
          {
            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", 
  }, 
}

Request syntax with placeholder values


resp = client.decline_handshake({
  handshake_id: "HandshakeId", # required
})

Response structure


resp.handshake.id #=> String
resp.handshake.arn #=> String
resp.handshake.parties #=> Array
resp.handshake.parties[0].id #=> String
resp.handshake.parties[0].type #=> String, one of "ACCOUNT", "ORGANIZATION", "EMAIL"
resp.handshake.state #=> String, one of "REQUESTED", "OPEN", "CANCELED", "ACCEPTED", "DECLINED", "EXPIRED"
resp.handshake.requested_timestamp #=> Time
resp.handshake.expiration_timestamp #=> Time
resp.handshake.action #=> String, one of "INVITE", "ENABLE_ALL_FEATURES", "APPROVE_ALL_FEATURES", "ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE"
resp.handshake.resources #=> Array
resp.handshake.resources[0].value #=> String
resp.handshake.resources[0].type #=> String, one of "ACCOUNT", "ORGANIZATION", "ORGANIZATION_FEATURE_SET", "EMAIL", "MASTER_EMAIL", "MASTER_NAME", "NOTES", "PARENT_HANDSHAKE"
resp.handshake.resources[0].resources #=> Types::HandshakeResources

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :handshake_id (required, 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 lowercase letters or digits.

    [1]: wikipedia.org/wiki/regex

Returns:

See Also:



1948
1949
1950
1951
 
# File 'lib/aws-sdk-organizations/client.rb', line 1948

def decline_handshake(params = {}, options = {})
  req = build_request(:decline_handshake, params)
  req.send_request(options)
end

#delete_organization(params = {}) ⇒ Struct

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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1963
1964
1965
1966
 
# File 'lib/aws-sdk-organizations/client.rb', line 1963

def delete_organization(params = {}, options = {})
  req = build_request(:delete_organization, params)
  req.send_request(options)
end

#delete_organizational_unit(params = {}) ⇒ Struct

Deletes an organizational unit (OU) from a root or another OU. You must first remove all accounts and child OUs from the OU that you want to delete.

This operation can be called only from the organization’s management account.

Examples:

Example: 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:

resp = client.delete_organizational_unit({
  organizational_unit_id: "ou-examplerootid111-exampleouid111", 
})

Request syntax with placeholder values


resp = client.delete_organizational_unit({
  organizational_unit_id: "OrganizationalUnitId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :organizational_unit_id (required, 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 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second “-” dash and from 8 to 32 additional lowercase letters or digits.

    [1]: wikipedia.org/wiki/regex

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2011
2012
2013
2014
 
# File 'lib/aws-sdk-organizations/client.rb', line 2011

def delete_organizational_unit(params = {}, options = {})
  req = build_request(:delete_organizational_unit, params)
  req.send_request(options)
end

#delete_policy(params = {}) ⇒ Struct

Deletes the specified policy from your organization. Before you perform this operation, you must first detach the policy from all organizational units (OUs), roots, and accounts.

This operation can be called only from the organization’s management account or by a member account that is a delegated administrator.

Examples:

Example: 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:

resp = client.delete_policy({
  policy_id: "p-examplepolicyid111", 
})

Request syntax with placeholder values


resp = client.delete_policy({
  policy_id: "PolicyId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :policy_id (required, 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 lowercase or uppercase letters, digits, or the underscore character (_).

    [1]: wikipedia.org/wiki/regex

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2058
2059
2060
2061
 
# File 'lib/aws-sdk-organizations/client.rb', line 2058

def delete_policy(params = {}, options = {})
  req = build_request(:delete_policy, params)
  req.send_request(options)
end

#delete_resource_policy(params = {}) ⇒ Struct

Deletes the resource policy from your organization.

This operation can be called only from the organization’s management account.

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2074
2075
2076
2077
 
# File 'lib/aws-sdk-organizations/client.rb', line 2074

def delete_resource_policy(params = {}, options = {})
  req = build_request(:delete_resource_policy, params)
  req.send_request(options)
end

#deregister_delegated_administrator(params = {}) ⇒ Struct

Removes the specified member Amazon Web Services account as a delegated administrator for the specified Amazon Web Services service.

Deregistering a delegated administrator can have unintended impacts on the functionality of the enabled Amazon Web Services service. See the documentation for the enabled service before you deregister a delegated administrator so that you understand any potential impacts.

You can run this action only for Amazon Web Services services that support this feature. For a current list of services that support it, see the column *Supports Delegated Administrator* in the table at

Amazon Web Services Services that you can use with Organizations][1

in the *Organizations User Guide.*

This operation can be called only from the organization’s management account.

[1]: docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services_list.html

Examples:

Request syntax with placeholder values


resp = client.deregister_delegated_administrator({
  account_id: "AccountId", # required
  service_principal: "ServicePrincipal", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_id (required, String) —

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

  • :service_principal (required, String) —

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

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2127
2128
2129
2130
 
# File 'lib/aws-sdk-organizations/client.rb', line 2127

def deregister_delegated_administrator(params = {}, options = {})
  req = build_request(:deregister_delegated_administrator, params)
  req.send_request(options)
end

#describe_account(params = {}) ⇒ Types::DescribeAccountResponse

Retrieves Organizations-related information about the specified account.

This operation can be called only from the organization’s management account or by a member account that is a delegated administrator.

Examples:

Example: To get the details about an account


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

resp = client.({
  account_id: "555555555555", 
})

resp.to_h outputs the following:
{
  account: {
    arn: "arn:aws:organizations::111111111111:account/o-exampleorgid/555555555555", 
    email: "[email protected]", 
    id: "555555555555", 
    name: "Beta Account", 
  }, 
}

Request syntax with placeholder values


resp = client.({
  account_id: "AccountId", # required
})

Response structure


resp..id #=> String
resp..arn #=> String
resp..email #=> String
resp..name #=> String
resp..status #=> String, one of "ACTIVE", "SUSPENDED", "PENDING_CLOSURE"
resp..state #=> String, one of "PENDING_ACTIVATION", "ACTIVE", "SUSPENDED", "PENDING_CLOSURE", "CLOSED"
resp..joined_method #=> String, one of "INVITED", "CREATED"
resp..joined_timestamp #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_id (required, String) —

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

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

    [1]: wikipedia.org/wiki/regex

Returns:

See Also:



2194
2195
2196
2197
 
# File 'lib/aws-sdk-organizations/client.rb', line 2194

def (params = {}, options = {})
  req = build_request(:describe_account, params)
  req.send_request(options)
end

#describe_create_account_status(params = {}) ⇒ Types::DescribeCreateAccountStatusResponse

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

This operation can be called only from the organization’s management account or by a member account that is a delegated administrator.

Examples:

Example: 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":

resp = client.({
  create_account_request_id: "car-exampleaccountcreationrequestid", 
})

resp.to_h outputs the following:
{
  create_account_status: {
    account_id: "333333333333", 
    id: "car-exampleaccountcreationrequestid", 
    state: "SUCCEEDED", 
  }, 
}

Request syntax with placeholder values


resp = client.({
  create_account_request_id: "CreateAccountRequestId", # required
})

Response structure


resp..id #=> String
resp.. #=> String
resp..state #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
resp..requested_timestamp #=> Time
resp..completed_timestamp #=> Time
resp.. #=> String
resp.. #=> String
resp..failure_reason #=> String, one of "ACCOUNT_LIMIT_EXCEEDED", "EMAIL_ALREADY_EXISTS", "INVALID_ADDRESS", "INVALID_EMAIL", "CONCURRENT_ACCOUNT_MODIFICATION", "INTERNAL_FAILURE", "GOVCLOUD_ACCOUNT_ALREADY_EXISTS", "MISSING_BUSINESS_VALIDATION", "FAILED_BUSINESS_VALIDATION", "PENDING_BUSINESS_VALIDATION", "INVALID_IDENTITY_FOR_BUSINESS_VALIDATION", "UNKNOWN_BUSINESS_VALIDATION", "MISSING_PAYMENT_INSTRUMENT", "INVALID_PAYMENT_INSTRUMENT", "UPDATE_EXISTING_RESOURCE_POLICY_WITH_TAGS_NOT_SUPPORTED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :create_account_request_id (required, String) —

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

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

    [1]: wikipedia.org/wiki/regex

Returns:

See Also:



2263
2264
2265
2266
 
# File 'lib/aws-sdk-organizations/client.rb', line 2263

def (params = {}, options = {})
  req = build_request(:describe_create_account_status, params)
  req.send_request(options)
end

#describe_effective_policy(params = {}) ⇒ Types::DescribeEffectivePolicyResponse

Returns the contents of the effective policy for specified policy type and account. The effective policy is the aggregation of any policies of the specified type that the account inherits, plus any policy of that type that is directly attached to the account.

This operation applies only to management policies. It does not apply to authorization policies: service control policies (SCPs) and resource control policies (RCPs).

For more information about policy inheritance, see [Understanding management policy inheritance] in the *Organizations User Guide*.

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

[1]: docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_inheritance_mgmt.html

Examples:

Request syntax with placeholder values


resp = client.describe_effective_policy({
  policy_type: "TAG_POLICY", # required, accepts TAG_POLICY, BACKUP_POLICY, AISERVICES_OPT_OUT_POLICY, CHATBOT_POLICY, DECLARATIVE_POLICY_EC2, SECURITYHUB_POLICY
  target_id: "PolicyTargetId",
})

Response structure


resp.effective_policy.policy_content #=> String
resp.effective_policy.last_updated_timestamp #=> Time
resp.effective_policy.target_id #=> String
resp.effective_policy.policy_type #=> String, one of "TAG_POLICY", "BACKUP_POLICY", "AISERVICES_OPT_OUT_POLICY", "CHATBOT_POLICY", "DECLARATIVE_POLICY_EC2", "SECURITYHUB_POLICY"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



2338
2339
2340
2341
 
# File 'lib/aws-sdk-organizations/client.rb', line 2338

def describe_effective_policy(params = {}, options = {})
  req = build_request(:describe_effective_policy, params)
  req.send_request(options)
end

#describe_handshake(params = {}) ⇒ Types::DescribeHandshakeResponse

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

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

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

Examples:

Example: 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":

resp = client.describe_handshake({
  handshake_id: "h-examplehandshakeid111", 
})

resp.to_h outputs the following:
{
  handshake: {
    action: "INVITE", 
    arn: "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", 
    expiration_timestamp: Time.parse("2016-11-30T17:24:58.046Z"), 
    id: "h-examplehandshakeid111", 
    parties: [
      {
        id: "o-exampleorgid", 
        type: "ORGANIZATION", 
      }, 
      {
        id: "333333333333", 
        type: "ACCOUNT", 
      }, 
    ], 
    requested_timestamp: Time.parse("2016-11-30T17:24:58.046Z"), 
    resources: [
      {
        resources: [
          {
            type: "MASTER_EMAIL", 
            value: "[email protected]", 
          }, 
          {
            type: "MASTER_NAME", 
            value: "Master Account", 
          }, 
        ], 
        type: "ORGANIZATION", 
        value: "o-exampleorgid", 
      }, 
      {
        type: "ACCOUNT", 
        value: "333333333333", 
      }, 
    ], 
    state: "OPEN", 
  }, 
}

Request syntax with placeholder values


resp = client.describe_handshake({
  handshake_id: "HandshakeId", # required
})

Response structure


resp.handshake.id #=> String
resp.handshake.arn #=> String
resp.handshake.parties #=> Array
resp.handshake.parties[0].id #=> String
resp.handshake.parties[0].type #=> String, one of "ACCOUNT", "ORGANIZATION", "EMAIL"
resp.handshake.state #=> String, one of "REQUESTED", "OPEN", "CANCELED", "ACCEPTED", "DECLINED", "EXPIRED"
resp.handshake.requested_timestamp #=> Time
resp.handshake.expiration_timestamp #=> Time
resp.handshake.action #=> String, one of "INVITE", "ENABLE_ALL_FEATURES", "APPROVE_ALL_FEATURES", "ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE"
resp.handshake.resources #=> Array
resp.handshake.resources[0].value #=> String
resp.handshake.resources[0].type #=> String, one of "ACCOUNT", "ORGANIZATION", "ORGANIZATION_FEATURE_SET", "EMAIL", "MASTER_EMAIL", "MASTER_NAME", "NOTES", "PARENT_HANDSHAKE"
resp.handshake.resources[0].resources #=> Types::HandshakeResources

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :handshake_id (required, String) —

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

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

    [1]: wikipedia.org/wiki/regex

Returns:

See Also:



2449
2450
2451
2452
 
# File 'lib/aws-sdk-organizations/client.rb', line 2449

def describe_handshake(params = {}, options = {})
  req = build_request(:describe_handshake, params)
  req.send_request(options)
end

#describe_organization(params = {}) ⇒ Types::DescribeOrganizationResponse

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

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

<note markdown=“1”> Even if a policy type is shown as available in the organization, you can disable it separately at the root level with DisablePolicyType. Use ListRoots to see the status of policy types for a specified root.

</note>

Examples:

Example: To get information about an organization


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

resp = client.describe_organization({
})

resp.to_h outputs the following:
{
  organization: {
    arn: "arn:aws:organizations::111111111111:organization/o-exampleorgid", 
    available_policy_types: [
      {
        status: "ENABLED", 
        type: "SERVICE_CONTROL_POLICY", 
      }, 
    ], 
    feature_set: "ALL", 
    id: "o-exampleorgid", 
    master_account_arn: "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111", 
    master_account_email: "[email protected]", 
  }, 
}

Response structure


resp.organization.id #=> String
resp.organization.arn #=> String
resp.organization.feature_set #=> String, one of "ALL", "CONSOLIDATED_BILLING"
resp.organization. #=> String
resp.organization. #=> String
resp.organization. #=> String
resp.organization.available_policy_types #=> Array
resp.organization.available_policy_types[0].type #=> String, one of "SERVICE_CONTROL_POLICY", "RESOURCE_CONTROL_POLICY", "TAG_POLICY", "BACKUP_POLICY", "AISERVICES_OPT_OUT_POLICY", "CHATBOT_POLICY", "DECLARATIVE_POLICY_EC2", "SECURITYHUB_POLICY"
resp.organization.available_policy_types[0].status #=> String, one of "ENABLED", "PENDING_ENABLE", "PENDING_DISABLE"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



2510
2511
2512
2513
 
# File 'lib/aws-sdk-organizations/client.rb', line 2510

def describe_organization(params = {}, options = {})
  req = build_request(:describe_organization, params)
  req.send_request(options)
end

#describe_organizational_unit(params = {}) ⇒ Types::DescribeOrganizationalUnitResponse

Retrieves information about an organizational unit (OU).

This operation can be called only from the organization’s management account or by a member account that is a delegated administrator.

Examples:

Example: To get information about an organizational unit


# The following example shows how to request details about an OU:

resp = client.describe_organizational_unit({
  organizational_unit_id: "ou-examplerootid111-exampleouid111", 
})

resp.to_h outputs the following:
{
  organizational_unit: {
    arn: "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111", 
    id: "ou-examplerootid111-exampleouid111", 
    name: "Accounting Group", 
  }, 
}

Request syntax with placeholder values


resp = client.describe_organizational_unit({
  organizational_unit_id: "OrganizationalUnitId", # required
})

Response structure


resp.organizational_unit.id #=> String
resp.organizational_unit.arn #=> String
resp.organizational_unit.name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :organizational_unit_id (required, 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 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second “-” dash and from 8 to 32 additional lowercase letters or digits.

    [1]: wikipedia.org/wiki/regex

Returns:

See Also:



2572
2573
2574
2575
 
# File 'lib/aws-sdk-organizations/client.rb', line 2572

def describe_organizational_unit(params = {}, options = {})
  req = build_request(:describe_organizational_unit, params)
  req.send_request(options)
end

#describe_policy(params = {}) ⇒ Types::DescribePolicyResponse

Retrieves information about a policy.

This operation can be called only from the organization’s management account or by a member account that is a delegated administrator.

Examples:

Example: To get information about a policy


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

resp = client.describe_policy({
  policy_id: "p-examplepolicyid111", 
})

resp.to_h outputs the following:
{
  policy: {
    content: "{\\n  \\\"Version\\\": \\\"2012-10-17\\\",\\n  \\\"Statement\\\": [\\n    {\\n      \\\"Effect\\\": \\\"Allow\\\",\\n      \\\"Action\\\": \\\"*\\\",\\n      \\\"Resource\\\": \\\"*\\\"\\n    }\\n  ]\\n}", 
    policy_summary: {
      arn: "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111", 
      aws_managed: false, 
      description: "Enables admins to delegate S3 permissions", 
      id: "p-examplepolicyid111", 
      name: "AllowAllS3Actions", 
      type: "SERVICE_CONTROL_POLICY", 
    }, 
  }, 
}

Request syntax with placeholder values


resp = client.describe_policy({
  policy_id: "PolicyId", # required
})

Response structure


resp.policy.policy_summary.id #=> String
resp.policy.policy_summary.arn #=> String
resp.policy.policy_summary.name #=> String
resp.policy.policy_summary.description #=> String
resp.policy.policy_summary.type #=> String, one of "SERVICE_CONTROL_POLICY", "RESOURCE_CONTROL_POLICY", "TAG_POLICY", "BACKUP_POLICY", "AISERVICES_OPT_OUT_POLICY", "CHATBOT_POLICY", "DECLARATIVE_POLICY_EC2", "SECURITYHUB_POLICY"
resp.policy.policy_summary.aws_managed #=> Boolean
resp.policy.content #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :policy_id (required, 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 lowercase or uppercase letters, digits, or the underscore character (_).

    [1]: wikipedia.org/wiki/regex

Returns:

See Also:



2643
2644
2645
2646
 
# File 'lib/aws-sdk-organizations/client.rb', line 2643

def describe_policy(params = {}, options = {})
  req = build_request(:describe_policy, params)
  req.send_request(options)
end

#describe_resource_policy(params = {}) ⇒ Types::DescribeResourcePolicyResponse

Retrieves information about a resource policy.

This operation can be called only from the organization’s management account or by a member account that is a delegated administrator.

Examples:

Response structure


resp.resource_policy.resource_policy_summary.id #=> String
resp.resource_policy.resource_policy_summary.arn #=> String
resp.resource_policy.content #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



2667
2668
2669
2670
 
# File 'lib/aws-sdk-organizations/client.rb', line 2667

def describe_resource_policy(params = {}, options = {})
  req = build_request(:describe_resource_policy, params)
  req.send_request(options)
end

#detach_policy(params = {}) ⇒ Struct

Detaches a policy from a target root, organizational unit (OU), or account.

If the policy being detached is a service control policy (SCP), the changes to permissions for Identity and Access Management (IAM) users and roles in affected accounts are immediate.

Every root, OU, and account must have at least one SCP attached. If you want to replace the default ‘FullAWSAccess` policy with an SCP that limits the permissions that can be delegated, you must attach the replacement SCP before you can remove the default SCP. This is the authorization strategy of an “[allow list]”. If you instead attach a second SCP and leave the `FullAWSAccess` SCP still attached, and specify `“Effect”: “Deny”` in the second SCP to override the `“Effect”: “Allow”` in the `FullAWSAccess` policy (or any other attached SCP), you’re using the authorization strategy of a “[deny list]”.

This operation can be called only from the organization’s management account or by a member account that is a delegated administrator.

[1]: docs.aws.amazon.com/organizations/latest/userguide/SCP_strategies.html#orgs_policies_allowlist [2]: docs.aws.amazon.com/organizations/latest/userguide/SCP_strategies.html#orgs_policies_denylist

Examples:

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


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

resp = client.detach_policy({
  policy_id: "p-examplepolicyid111", 
  target_id: "ou-examplerootid111-exampleouid111", 
})

Request syntax with placeholder values


resp = client.detach_policy({
  policy_id: "PolicyId", # required
  target_id: "PolicyTargetId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :policy_id (required, 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 lowercase or uppercase letters, digits, or the underscore character (_).

    [1]: wikipedia.org/wiki/regex

  • :target_id (required, String) —

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

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

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

    • Account - A string that consists of exactly 12 digits.

    • **Organizational unit (OU)** - A string that begins with “ou-” followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second “-” dash and from 8 to 32 additional lowercase letters or digits.

    [1]: wikipedia.org/wiki/regex

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2755
2756
2757
2758
 
# File 'lib/aws-sdk-organizations/client.rb', line 2755

def detach_policy(params = {}, options = {})
  req = build_request(:detach_policy, params)
  req.send_request(options)
end

#disable_aws_service_access(params = {}) ⇒ Struct

Disables the integration of an Amazon Web Services service (the service that is specified by ‘ServicePrincipal`) with Organizations. When you disable integration, the specified service no longer can create a [service-linked role] in new accounts in your organization. This means the service can’t perform operations on your behalf on any new accounts in your organization. The service can still perform operations in older accounts until the service completes its clean-up from Organizations.

We strongly recommend that you don’t use this command to disable integration between Organizations and the specified Amazon Web Services service. Instead, use the console or commands that are provided by the specified service. This lets the trusted service perform any required initialization when enabling trusted access, such as creating any required resources and any required clean up of resources when disabling trusted access.

For information about how to disable trusted service access to your

organization using the trusted service, see the **Learn more** link under the **Supports Trusted Access** column at [Amazon Web Services services that you can use with Organizations]. on this page.

If you disable access by using this command, it causes the following

actions to occur:

* The service can no longer create a service-linked role in the
 accounts in your organization. This means that the service can't
 perform operations on your behalf on any new accounts in your
 organization. The service can still perform operations in older
 accounts until the service completes its clean-up from
 Organizations.

  • The service can no longer perform tasks in the member accounts in the organization, unless those operations are explicitly permitted by the IAM policies that are attached to your roles. This includes any data aggregation from the member accounts to the management account, or to a delegated administrator account, where relevant.

  • Some services detect this and clean up any remaining data or resources related to the integration, while other services stop accessing the organization but leave any historical data and configuration in place to support a possible re-enabling of the integration.

Using the other service's console or commands to disable the

integration ensures that the other service is aware that it can clean up any resources that are required only for the integration. How the service cleans up its resources in the organization’s accounts depends on that service. For more information, see the documentation for the other Amazon Web Services service.

After you perform the ‘DisableAWSServiceAccess` operation, the specified service can no longer perform operations in your organization’s accounts

For more information about integrating other services with Organizations, including the list of services that work with Organizations, see [Using Organizations with other Amazon Web Services services] in the *Organizations User Guide*.

This operation can be called only from the organization’s management account.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html [2]: docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services_list.html [3]: docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html

Examples:

Request syntax with placeholder values


resp = client.disable_aws_service_access({
  service_principal: "ServicePrincipal", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :service_principal (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2847
2848
2849
2850
 
# File 'lib/aws-sdk-organizations/client.rb', line 2847

def disable_aws_service_access(params = {}, options = {})
  req = build_request(:disable_aws_service_access, params)
  req.send_request(options)
end

#disable_policy_type(params = {}) ⇒ Types::DisablePolicyTypeResponse

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

This is an asynchronous request that Amazon Web Services performs in the background. If you disable a policy type for a root, it still appears enabled for the organization if [all features] are enabled for the organization. Amazon Web Services recommends that you first use ListRoots to see the status of policy types for a specified root, and then use this operation.

This operation can be called only from the organization’s management account or by a member account that is a delegated administrator.

To view the status of available policy types in the organization, use ListRoots.

[1]: docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html

Examples:

Example: 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

resp = client.disable_policy_type({
  policy_type: "SERVICE_CONTROL_POLICY", 
  root_id: "r-examplerootid111", 
})

resp.to_h outputs the following:
{
  root: {
    arn: "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111", 
    id: "r-examplerootid111", 
    name: "Root", 
    policy_types: [
    ], 
  }, 
}

Request syntax with placeholder values


resp = client.disable_policy_type({
  root_id: "RootId", # required
  policy_type: "SERVICE_CONTROL_POLICY", # required, accepts SERVICE_CONTROL_POLICY, RESOURCE_CONTROL_POLICY, TAG_POLICY, BACKUP_POLICY, AISERVICES_OPT_OUT_POLICY, CHATBOT_POLICY, DECLARATIVE_POLICY_EC2, SECURITYHUB_POLICY
})

Response structure


resp.root.id #=> String
resp.root.arn #=> String
resp.root.name #=> String
resp.root.policy_types #=> Array
resp.root.policy_types[0].type #=> String, one of "SERVICE_CONTROL_POLICY", "RESOURCE_CONTROL_POLICY", "TAG_POLICY", "BACKUP_POLICY", "AISERVICES_OPT_OUT_POLICY", "CHATBOT_POLICY", "DECLARATIVE_POLICY_EC2", "SECURITYHUB_POLICY"
resp.root.policy_types[0].status #=> String, one of "ENABLED", "PENDING_ENABLE", "PENDING_DISABLE"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



2964
2965
2966
2967
 
# File 'lib/aws-sdk-organizations/client.rb', line 2964

def disable_policy_type(params = {}, options = {})
  req = build_request(:disable_policy_type, params)
  req.send_request(options)
end

#enable_all_features(params = {}) ⇒ Types::EnableAllFeaturesResponse

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

This operation is required only for organizations that were created explicitly with only the consolidated billing features enabled. Calling this operation sends a handshake to every invited account in the organization. The feature set change can be finalized and the additional features enabled only after all administrators in the invited accounts approve the change by accepting the handshake.

After you enable all features, you can separately enable or disable individual policy types in a root using EnablePolicyType and DisablePolicyType. To see the status of policy types in a root, use ListRoots.

After all invited member accounts accept the handshake, you finalize the feature set change by accepting the handshake that contains ‘“Action”: “ENABLE_ALL_FEATURES”`. This completes the change.

After you enable all features in your organization, the management account in the organization can apply policies on all member accounts. These policies can restrict what users and even administrators in those accounts can do. The management account can apply policies that prevent accounts from leaving the organization. Ensure that your account administrators are aware of this.

This operation can be called only from the organization’s management account.

[1]: docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html

Examples:

Example: 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

resp = client.enable_all_features({
})

resp.to_h outputs the following:
{
  handshake: {
    action: "ENABLE_ALL_FEATURES", 
    arn: "arn:aws:organizations::111111111111:handshake/o-exampleorgid/enable_all_features/h-examplehandshakeid111", 
    expiration_timestamp: Time.parse("2017-02-28T09:35:40.05Z"), 
    id: "h-examplehandshakeid111", 
    parties: [
      {
        id: "o-exampleorgid", 
        type: "ORGANIZATION", 
      }, 
    ], 
    requested_timestamp: Time.parse("2017-02-13T09:35:40.05Z"), 
    resources: [
      {
        type: "ORGANIZATION", 
        value: "o-exampleorgid", 
      }, 
    ], 
    state: "REQUESTED", 
  }, 
}

Response structure


resp.handshake.id #=> String
resp.handshake.arn #=> String
resp.handshake.parties #=> Array
resp.handshake.parties[0].id #=> String
resp.handshake.parties[0].type #=> String, one of "ACCOUNT", "ORGANIZATION", "EMAIL"
resp.handshake.state #=> String, one of "REQUESTED", "OPEN", "CANCELED", "ACCEPTED", "DECLINED", "EXPIRED"
resp.handshake.requested_timestamp #=> Time
resp.handshake.expiration_timestamp #=> Time
resp.handshake.action #=> String, one of "INVITE", "ENABLE_ALL_FEATURES", "APPROVE_ALL_FEATURES", "ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE"
resp.handshake.resources #=> Array
resp.handshake.resources[0].value #=> String
resp.handshake.resources[0].type #=> String, one of "ACCOUNT", "ORGANIZATION", "ORGANIZATION_FEATURE_SET", "EMAIL", "MASTER_EMAIL", "MASTER_NAME", "NOTES", "PARENT_HANDSHAKE"
resp.handshake.resources[0].resources #=> Types::HandshakeResources

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



3119
3120
3121
3122
 
# File 'lib/aws-sdk-organizations/client.rb', line 3119

def enable_all_features(params = {}, options = {})
  req = build_request(:enable_all_features, params)
  req.send_request(options)
end

#enable_aws_service_access(params = {}) ⇒ Struct

Provides an Amazon Web Services service (the service that is specified by ‘ServicePrincipal`) with permissions to view the structure of an organization, create a [service-linked role] in all the accounts in the organization, and allow the service to perform operations on behalf of the organization and its accounts. Establishing these permissions can be a first step in enabling the integration of an Amazon Web Services service with Organizations.

We recommend that you enable integration between Organizations and the specified Amazon Web Services service by using the console or commands that are provided by the specified service. Doing so ensures that the service is aware that it can create the resources that are required for the integration. How the service creates those resources in the organization’s accounts depends on that service. For more information, see the documentation for the other Amazon Web Services service.

For more information about enabling services to integrate with Organizations, see [Using Organizations with other Amazon Web Services services] in the *Organizations User Guide*.

This operation can be called only from the organization’s management account.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html [2]: docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html

Examples:

Request syntax with placeholder values


resp = client.enable_aws_service_access({
  service_principal: "ServicePrincipal", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :service_principal (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3016
3017
3018
3019
 
# File 'lib/aws-sdk-organizations/client.rb', line 3016

def enable_aws_service_access(params = {}, options = {})
  req = build_request(:enable_aws_service_access, params)
  req.send_request(options)
end

#enable_policy_type(params = {}) ⇒ Types::EnablePolicyTypeResponse

Enables a policy type in a root. After you enable a policy type in a root, you can attach policies of that type to the root, any organizational unit (OU), or account in that root. You can undo this by using the DisablePolicyType operation.

This is an asynchronous request that Amazon Web Services performs in the background. Amazon Web Services recommends that you first use ListRoots to see the status of policy types for a specified root, and then use this operation.

This operation can be called only from the organization’s management account or by a member account that is a delegated administrator.

You can enable a policy type in a root only if that policy type is available in the organization. To view the status of available policy types in the organization, use ListRoots.

Examples:

Example: 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

resp = client.enable_policy_type({
  policy_type: "SERVICE_CONTROL_POLICY", 
  root_id: "r-examplerootid111", 
})

resp.to_h outputs the following:
{
  root: {
    arn: "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111", 
    id: "r-examplerootid111", 
    name: "Root", 
    policy_types: [
      {
        status: "ENABLED", 
        type: "SERVICE_CONTROL_POLICY", 
      }, 
    ], 
  }, 
}

Request syntax with placeholder values


resp = client.enable_policy_type({
  root_id: "RootId", # required
  policy_type: "SERVICE_CONTROL_POLICY", # required, accepts SERVICE_CONTROL_POLICY, RESOURCE_CONTROL_POLICY, TAG_POLICY, BACKUP_POLICY, AISERVICES_OPT_OUT_POLICY, CHATBOT_POLICY, DECLARATIVE_POLICY_EC2, SECURITYHUB_POLICY
})

Response structure


resp.root.id #=> String
resp.root.arn #=> String
resp.root.name #=> String
resp.root.policy_types #=> Array
resp.root.policy_types[0].type #=> String, one of "SERVICE_CONTROL_POLICY", "RESOURCE_CONTROL_POLICY", "TAG_POLICY", "BACKUP_POLICY", "AISERVICES_OPT_OUT_POLICY", "CHATBOT_POLICY", "DECLARATIVE_POLICY_EC2", "SECURITYHUB_POLICY"
resp.root.policy_types[0].status #=> String, one of "ENABLED", "PENDING_ENABLE", "PENDING_DISABLE"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



3233
3234
3235
3236
 
# File 'lib/aws-sdk-organizations/client.rb', line 3233

def enable_policy_type(params = {}, options = {})
  req = build_request(:enable_policy_type, params)
  req.send_request(options)
end

#invite_account_to_organization(params = {}) ⇒ Types::InviteAccountToOrganizationResponse

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

If you receive an exception that indicates that you exceeded your account limits for the organization or that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists after an hour, contact [Amazon Web Services Support].

If the request includes tags, then the requester must have the ‘organizations:TagResource` permission.

This operation can be called only from the organization’s management account.

[1]: console.aws.amazon.com/support/home#/

Examples:

Example: To invite an account to join an organization


# The following example shows the admin of the master account owned by [email protected] inviting the account owned by
# [email protected] to join an organization.

resp = client.({
  notes: "This is a request for Juan's account to join Bill's organization", 
  target: {
    id: "[email protected]", 
    type: "EMAIL", 
  }, 
})

resp.to_h outputs the following:
{
  handshake: {
    action: "INVITE", 
    arn: "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", 
    expiration_timestamp: Time.parse("2017-02-16T09:36:05.02Z"), 
    id: "h-examplehandshakeid111", 
    parties: [
      {
        id: "o-exampleorgid", 
        type: "ORGANIZATION", 
      }, 
      {
        id: "[email protected]", 
        type: "EMAIL", 
      }, 
    ], 
    requested_timestamp: Time.parse("2017-02-01T09:36:05.02Z"), 
    resources: [
      {
        resources: [
          {
            type: "MASTER_EMAIL", 
            value: "[email protected]", 
          }, 
          {
            type: "MASTER_NAME", 
            value: "Org Master Account", 
          }, 
          {
            type: "ORGANIZATION_FEATURE_SET", 
            value: "FULL", 
          }, 
        ], 
        type: "ORGANIZATION", 
        value: "o-exampleorgid", 
      }, 
      {
        type: "EMAIL", 
        value: "[email protected]", 
      }, 
    ], 
    state: "OPEN", 
  }, 
}

Request syntax with placeholder values


resp = client.({
  target: { # required
    id: "HandshakePartyId", # required
    type: "ACCOUNT", # required, accepts ACCOUNT, ORGANIZATION, EMAIL
  },
  notes: "HandshakeNotes",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.handshake.id #=> String
resp.handshake.arn #=> String
resp.handshake.parties #=> Array
resp.handshake.parties[0].id #=> String
resp.handshake.parties[0].type #=> String, one of "ACCOUNT", "ORGANIZATION", "EMAIL"
resp.handshake.state #=> String, one of "REQUESTED", "OPEN", "CANCELED", "ACCEPTED", "DECLINED", "EXPIRED"
resp.handshake.requested_timestamp #=> Time
resp.handshake.expiration_timestamp #=> Time
resp.handshake.action #=> String, one of "INVITE", "ENABLE_ALL_FEATURES", "APPROVE_ALL_FEATURES", "ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE"
resp.handshake.resources #=> Array
resp.handshake.resources[0].value #=> String
resp.handshake.resources[0].type #=> String, one of "ACCOUNT", "ORGANIZATION", "ORGANIZATION_FEATURE_SET", "EMAIL", "MASTER_EMAIL", "MASTER_NAME", "NOTES", "PARENT_HANDSHAKE"
resp.handshake.resources[0].resources #=> Types::HandshakeResources

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :target (required, Types::HandshakeParty) —

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

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

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

    ‘–target Id=123456789012,Type=ACCOUNT`

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

    ‘–target [email protected],Type=EMAIL`

  • :notes (String) —

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

  • :tags (Array<Types::Tag>) —

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

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

    <note markdown=“1”> If any one of the tags is not valid or if you exceed the allowed number of tags for an account, then the entire request fails and invitations are not sent.

    </note>

    [1]: docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html

Returns:

See Also:



3410
3411
3412
3413
 
# File 'lib/aws-sdk-organizations/client.rb', line 3410

def (params = {}, options = {})
  req = build_request(:invite_account_to_organization, params)
  req.send_request(options)
end

#leave_organization(params = {}) ⇒ Struct

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

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

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

  • You can leave an organization as a member account only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the Organizations console, API, or CLI commands, the information required of standalone accounts is not automatically collected. For each account that you want to make standalone, you must perform the following steps. If any of the steps are already completed for this account, that step doesn’t appear.

    • Choose a support plan

    • Provide and verify the required contact information

    • Provide a current payment method

    Amazon Web Services uses the payment method to charge for any billable (not free tier) Amazon Web Services activity that occurs while the account isn’t attached to an organization. For more information, see [Considerations before removing an account from an organization] in the *Organizations User Guide*.

  • The account that you want to leave must not be a delegated administrator account for any Amazon Web Services service enabled for your organization. If the account is a delegated administrator, you must first change the delegated administrator account to another account that is remaining in the organization.

  • After the account leaves the organization, all tags that were attached to the account object in the organization are deleted. Amazon Web Services accounts outside of an organization do not support tags.

  • A newly created account has a waiting period before it can be removed from its organization. You must wait until at least seven days after the account was created. Invited accounts aren’t subject to this waiting period.

  • If you are using an organization principal to call ‘LeaveOrganization` across multiple accounts, you can only do this up to 5 accounts per second in a single organization.

[1]: docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_account-before-remove.html

Examples:

Example: To leave an organization as a member account


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

resp = client.leave_organization({
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3487
3488
3489
3490
 
# File 'lib/aws-sdk-organizations/client.rb', line 3487

def leave_organization(params = {}, options = {})
  req = build_request(:leave_organization, params)
  req.send_request(options)
end

#list_accounts(params = {}) ⇒ Types::ListAccountsResponse

Lists all the accounts in the organization. To request only the accounts in a specified root or organizational unit (OU), use the ListAccountsForParent operation instead.

<note markdown=“1”> 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.

</note>

This operation can be called only from the organization’s management account or by a member account that is a delegated administrator.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: 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:

resp = client.list_accounts({
})

resp.to_h outputs the following:
{
  accounts: [
    {
      arn: "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111", 
      email: "[email protected]", 
      id: "111111111111", 
      joined_method: "INVITED", 
      joined_timestamp: Time.parse("20161215T193015Z"), 
      name: "Master Account", 
      status: "ACTIVE", 
    }, 
    {
      arn: "arn:aws:organizations::111111111111:account/o-exampleorgid/222222222222", 
      email: "[email protected]", 
      id: "222222222222", 
      joined_method: "INVITED", 
      joined_timestamp: Time.parse("20161215T210221Z"), 
      name: "Developer Account", 
      status: "ACTIVE", 
    }, 
    {
      arn: "arn:aws:organizations::111111111111:account/o-exampleorgid/333333333333", 
      email: "[email protected]", 
      id: "333333333333", 
      joined_method: "INVITED", 
      joined_timestamp: Time.parse("20161215T210347Z"), 
      name: "Test Account", 
      status: "ACTIVE", 
    }, 
    {
      arn: "arn:aws:organizations::111111111111:account/o-exampleorgid/444444444444", 
      email: "[email protected]", 
      id: "444444444444", 
      joined_method: "INVITED", 
      joined_timestamp: Time.parse("20161215T210332Z"), 
      name: "Production Account", 
      status: "ACTIVE", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_accounts({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.accounts #=> Array
resp.accounts[0].id #=> String
resp.accounts[0].arn #=> String
resp.accounts[0].email #=> String
resp.accounts[0].name #=> String
resp.accounts[0].status #=> String, one of "ACTIVE", "SUSPENDED", "PENDING_CLOSURE"
resp.accounts[0].state #=> String, one of "PENDING_ACTIVATION", "ACTIVE", "SUSPENDED", "PENDING_CLOSURE", "CLOSED"
resp.accounts[0].joined_method #=> String, one of "INVITED", "CREATED"
resp.accounts[0].joined_timestamp #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

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

  • :max_results (Integer) —

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

Returns:

See Also:



3673
3674
3675
3676
 
# File 'lib/aws-sdk-organizations/client.rb', line 3673

def list_accounts(params = {}, options = {})
  req = build_request(:list_accounts, params)
  req.send_request(options)
end

#list_accounts_for_parent(params = {}) ⇒ Types::ListAccountsForParentResponse

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

<note markdown=“1”> 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.

</note>

This operation can be called only from the organization’s management account or by a member account that is a delegated administrator.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: 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

resp = client.list_accounts_for_parent({
  parent_id: "ou-examplerootid111-exampleouid111", 
})

resp.to_h outputs the following:
{
  accounts: [
    {
      arn: "arn:aws:organizations::111111111111:account/o-exampleorgid/333333333333", 
      email: "[email protected]", 
      id: "333333333333", 
      joined_method: "INVITED", 
      joined_timestamp: Time.parse(1481835795.536), 
      name: "Development Account", 
      status: "ACTIVE", 
    }, 
    {
      arn: "arn:aws:organizations::111111111111:account/o-exampleorgid/444444444444", 
      email: "[email protected]", 
      id: "444444444444", 
      joined_method: "INVITED", 
      joined_timestamp: Time.parse(1481835812.143), 
      name: "Test Account", 
      status: "ACTIVE", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_accounts_for_parent({
  parent_id: "ParentId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.accounts #=> Array
resp.accounts[0].id #=> String
resp.accounts[0].arn #=> String
resp.accounts[0].email #=> String
resp.accounts[0].name #=> String
resp.accounts[0].status #=> String, one of "ACTIVE", "SUSPENDED", "PENDING_CLOSURE"
resp.accounts[0].state #=> String, one of "PENDING_ACTIVATION", "ACTIVE", "SUSPENDED", "PENDING_CLOSURE", "CLOSED"
resp.accounts[0].joined_method #=> String, one of "INVITED", "CREATED"
resp.accounts[0].joined_timestamp #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :parent_id (required, String) —

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

  • :next_token (String) —

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

  • :max_results (Integer) —

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

Returns:

See Also:



3784
3785
3786
3787
 
# File 'lib/aws-sdk-organizations/client.rb', line 3784

def list_accounts_for_parent(params = {}, options = {})
  req = build_request(:list_accounts_for_parent, params)
  req.send_request(options)
end

#list_accounts_with_invalid_effective_policy(params = {}) ⇒ Types::ListAccountsWithInvalidEffectivePolicyResponse

Lists all the accounts in an organization that have invalid effective policies. An *invalid effective policy* is an [effective policy] that fails validation checks, resulting in the effective policy not being fully enforced on all the intended accounts within an organization.

This operation can be called only from the organization’s management account or by a member account that is a delegated administrator.

[1]: docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_effective.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To list all accounts in an organization with invalid effective policy


# The following example shows you how to request a list of the accounts in an organization having invalid effective policy
# for a policy type:

resp = client.list_accounts_with_invalid_effective_policy({
  policy_type: "BACKUP_POLICY", 
})

resp.to_h outputs the following:
{
  accounts: [
    {
      email: "[email protected]", 
      id: "111111111111", 
      name: "Management Account", 
    }, 
    {
      email: "[email protected]", 
      id: "222222222222", 
      name: "Developer Account", 
    }, 
    {
      email: "[email protected]", 
      id: "333333333333", 
      name: "Test Account", 
    }, 
    {
      email: "[email protected]", 
      id: "444444444444", 
      name: "Production Account", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_accounts_with_invalid_effective_policy({
  policy_type: "TAG_POLICY", # required, accepts TAG_POLICY, BACKUP_POLICY, AISERVICES_OPT_OUT_POLICY, CHATBOT_POLICY, DECLARATIVE_POLICY_EC2, SECURITYHUB_POLICY
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.accounts #=> Array
resp.accounts[0].id #=> String
resp.accounts[0].arn #=> String
resp.accounts[0].email #=> String
resp.accounts[0].name #=> String
resp.accounts[0].status #=> String, one of "ACTIVE", "SUSPENDED", "PENDING_CLOSURE"
resp.accounts[0].state #=> String, one of "PENDING_ACTIVATION", "ACTIVE", "SUSPENDED", "PENDING_CLOSURE", "CLOSED"
resp.accounts[0].joined_method #=> String, one of "INVITED", "CREATED"
resp.accounts[0].joined_timestamp #=> Time
resp.policy_type #=> String, one of "TAG_POLICY", "BACKUP_POLICY", "AISERVICES_OPT_OUT_POLICY", "CHATBOT_POLICY", "DECLARATIVE_POLICY_EC2", "SECURITYHUB_POLICY"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



3916
3917
3918
3919
 
# File 'lib/aws-sdk-organizations/client.rb', line 3916

def list_accounts_with_invalid_effective_policy(params = {}, options = {})
  req = build_request(:list_accounts_with_invalid_effective_policy, params)
  req.send_request(options)
end

#list_aws_service_access_for_organization(params = {}) ⇒ Types::ListAWSServiceAccessForOrganizationResponse

Returns a list of the Amazon Web Services services that you enabled to integrate with your organization. After a service on this list creates the resources that it requires for the integration, it can perform operations on your organization and its accounts.

For more information about integrating other services with Organizations, including the list of services that currently work with Organizations, see [Using Organizations with other Amazon Web Services services] in the *Organizations User Guide*.

This operation can be called only from the organization’s management account or by a member account that is a delegated administrator.

[1]: docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_aws_service_access_for_organization({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.enabled_service_principals #=> Array
resp.enabled_service_principals[0].service_principal #=> String
resp.enabled_service_principals[0].date_enabled #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

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

  • :max_results (Integer) —

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

Returns:

See Also:



3553
3554
3555
3556
 
# File 'lib/aws-sdk-organizations/client.rb', line 3553

def list_aws_service_access_for_organization(params = {}, options = {})
  req = build_request(:list_aws_service_access_for_organization, params)
  req.send_request(options)
end

#list_children(params = {}) ⇒ Types::ListChildrenResponse

Lists all of the organizational units (OUs) or accounts that are contained in the specified parent OU or root. This operation, along with ListParents enables you to traverse the tree structure that makes up this root.

<note markdown=“1”> 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.

</note>

This operation can be called only from the organization’s management account or by a member account that is a delegated administrator.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: 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

resp = client.list_children({
  child_type: "ORGANIZATIONAL_UNIT", 
  parent_id: "ou-examplerootid111-exampleouid111", 
})

resp.to_h outputs the following:
{
  children: [
    {
      id: "ou-examplerootid111-exampleouid111", 
      type: "ORGANIZATIONAL_UNIT", 
    }, 
    {
      id: "ou-examplerootid111-exampleouid222", 
      type: "ORGANIZATIONAL_UNIT", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_children({
  parent_id: "ParentId", # required
  child_type: "ACCOUNT", # required, accepts ACCOUNT, ORGANIZATIONAL_UNIT
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.children #=> Array
resp.children[0].id #=> String
resp.children[0].type #=> String, one of "ACCOUNT", "ORGANIZATIONAL_UNIT"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :parent_id (required, 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 lowercase letters or digits.

    • **Organizational unit (OU)** - A string that begins with “ou-” followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second “-” dash and from 8 to 32 additional lowercase letters or digits.

    [1]: wikipedia.org/wiki/regex

  • :child_type (required, String) —

    Filters the output to include only the specified child type.

  • :next_token (String) —

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

  • :max_results (Integer) —

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

Returns:

See Also:



4029
4030
4031
4032
 
# File 'lib/aws-sdk-organizations/client.rb', line 4029

def list_children(params = {}, options = {})
  req = build_request(:list_children, params)
  req.send_request(options)
end

#list_create_account_status(params = {}) ⇒ Types::ListCreateAccountStatusResponse

Lists the account creation requests that match the specified status that is currently being tracked for the organization.

<note markdown=“1”> 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.

</note>

This operation can be called only from the organization’s management account or by a member account that is a delegated administrator.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: 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:

resp = client.({
  states: [
    "SUCCEEDED", 
  ], 
})

resp.to_h outputs the following:
{
  create_account_statuses: [
    {
      account_id: "444444444444", 
      account_name: "Developer Test Account", 
      completed_timestamp: Time.parse("2017-01-15T13:45:23.6Z"), 
      id: "car-exampleaccountcreationrequestid1", 
      requested_timestamp: Time.parse("2017-01-15T13:45:23.01Z"), 
      state: "SUCCEEDED", 
    }, 
  ], 
}

Example: 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:

resp = client.({
  states: [
    "IN_PROGRESS", 
  ], 
})

resp.to_h outputs the following:
{
  create_account_statuses: [
    {
      account_name: "Production Account", 
      id: "car-exampleaccountcreationrequestid2", 
      requested_timestamp: Time.parse("2017-01-15T13:45:23.01Z"), 
      state: "IN_PROGRESS", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.({
  states: ["IN_PROGRESS"], # accepts IN_PROGRESS, SUCCEEDED, FAILED
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp. #=> Array
resp.[0].id #=> String
resp.[0]. #=> String
resp.[0].state #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
resp.[0].requested_timestamp #=> Time
resp.[0].completed_timestamp #=> Time
resp.[0]. #=> String
resp.[0]. #=> String
resp.[0].failure_reason #=> String, one of "ACCOUNT_LIMIT_EXCEEDED", "EMAIL_ALREADY_EXISTS", "INVALID_ADDRESS", "INVALID_EMAIL", "CONCURRENT_ACCOUNT_MODIFICATION", "INTERNAL_FAILURE", "GOVCLOUD_ACCOUNT_ALREADY_EXISTS", "MISSING_BUSINESS_VALIDATION", "FAILED_BUSINESS_VALIDATION", "PENDING_BUSINESS_VALIDATION", "INVALID_IDENTITY_FOR_BUSINESS_VALIDATION", "UNKNOWN_BUSINESS_VALIDATION", "MISSING_PAYMENT_INSTRUMENT", "INVALID_PAYMENT_INSTRUMENT", "UPDATE_EXISTING_RESOURCE_POLICY_WITH_TAGS_NOT_SUPPORTED"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :states (Array<String>) —

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

  • :next_token (String) —

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

  • :max_results (Integer) —

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

Returns:

See Also:



4153
4154
4155
4156
 
# File 'lib/aws-sdk-organizations/client.rb', line 4153

def (params = {}, options = {})
  req = build_request(:list_create_account_status, params)
  req.send_request(options)
end

#list_delegated_administrators(params = {}) ⇒ Types::ListDelegatedAdministratorsResponse

Lists the Amazon Web Services accounts that are designated as delegated administrators in this organization.

This operation can be called only from the organization’s management account or by a member account that is a delegated administrator.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_delegated_administrators({
  service_principal: "ServicePrincipal",
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.delegated_administrators #=> Array
resp.delegated_administrators[0].id #=> String
resp.delegated_administrators[0].arn #=> String
resp.delegated_administrators[0].email #=> String
resp.delegated_administrators[0].name #=> String
resp.delegated_administrators[0].status #=> String, one of "ACTIVE", "SUSPENDED", "PENDING_CLOSURE"
resp.delegated_administrators[0].joined_method #=> String, one of "INVITED", "CREATED"
resp.delegated_administrators[0].joined_timestamp #=> Time
resp.delegated_administrators[0].delegation_enabled_date #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :service_principal (String) —

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

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

  • :next_token (String) —

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

  • :max_results (Integer) —

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

Returns:

See Also:



4222
4223
4224
4225
 
# File 'lib/aws-sdk-organizations/client.rb', line 4222

def list_delegated_administrators(params = {}, options = {})
  req = build_request(:list_delegated_administrators, params)
  req.send_request(options)
end

#list_delegated_services_for_account(params = {}) ⇒ Types::ListDelegatedServicesForAccountResponse

List the Amazon Web Services services for which the specified account is a delegated administrator.

This operation can be called only from the organization’s management account or by a member account that is a delegated administrator.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.({
  account_id: "AccountId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.delegated_services #=> Array
resp.delegated_services[0].service_principal #=> String
resp.delegated_services[0].delegation_enabled_date #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_id (required, String) —

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

  • :next_token (String) —

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

  • :max_results (Integer) —

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

Returns:

See Also:



4282
4283
4284
4285
 
# File 'lib/aws-sdk-organizations/client.rb', line 4282

def (params = {}, options = {})
  req = build_request(:list_delegated_services_for_account, params)
  req.send_request(options)
end

#list_effective_policy_validation_errors(params = {}) ⇒ Types::ListEffectivePolicyValidationErrorsResponse

Lists all the validation errors on an [effective policy] for a specified account and policy type.

This operation can be called only from the organization’s management account or by a member account that is a delegated administrator.

[1]: docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_effective.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To list all effective policy validation errors for an account policy type


# The following example shows you how to request a list of effective policy validation errors for an account and policy
# type:

resp = client.list_effective_policy_validation_errors({
  account_id: "111111111111", 
  policy_type: "BACKUP_POLICY", 
})

resp.to_h outputs the following:
{
  account_id: "111111111111", 
  effective_policy_validation_errors: [
    {
      contributing_policies: [
        "p-examplepolicyid111", 
      ], 
      error_code: "ELEMENTS_TOO_FEW", 
      error_message: "tag_value is less than the allowed minimum limit 1", 
      path_to_error: "plans/backup_daily/selections/tags/dailydatatype/tag_value", 
    }, 
    {
      contributing_policies: [
        "p-examplepolicyid111", 
        "p-examplepolicyid222", 
      ], 
      error_code: "ELEMENTS_TOO_MANY", 
      error_message: "rules exceeds the allowed maximum limit 10", 
      path_to_error: "plans/backup_daily/rules", 
    }, 
  ], 
  evaluation_timestamp: Time.parse("2024-03-04T19:39:38.376000+00:00"), 
  path: "o-exampleorgid/r-examplerootid111/111111111111/", 
  policy_type: "BACKUP_POLICY", 
}

Request syntax with placeholder values


resp = client.list_effective_policy_validation_errors({
  account_id: "AccountId", # required
  policy_type: "TAG_POLICY", # required, accepts TAG_POLICY, BACKUP_POLICY, AISERVICES_OPT_OUT_POLICY, CHATBOT_POLICY, DECLARATIVE_POLICY_EC2, SECURITYHUB_POLICY
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp. #=> String
resp.policy_type #=> String, one of "TAG_POLICY", "BACKUP_POLICY", "AISERVICES_OPT_OUT_POLICY", "CHATBOT_POLICY", "DECLARATIVE_POLICY_EC2", "SECURITYHUB_POLICY"
resp.path #=> String
resp.evaluation_timestamp #=> Time
resp.next_token #=> String
resp.effective_policy_validation_errors #=> Array
resp.effective_policy_validation_errors[0].error_code #=> String
resp.effective_policy_validation_errors[0].error_message #=> String
resp.effective_policy_validation_errors[0].path_to_error #=> String
resp.effective_policy_validation_errors[0].contributing_policies #=> Array
resp.effective_policy_validation_errors[0].contributing_policies[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



4422
4423
4424
4425
 
# File 'lib/aws-sdk-organizations/client.rb', line 4422

def list_effective_policy_validation_errors(params = {}, options = {})
  req = build_request(:list_effective_policy_validation_errors, params)
  req.send_request(options)
end

#list_handshakes_for_account(params = {}) ⇒ Types::ListHandshakesForAccountResponse

Lists the current handshakes that are associated with the account of the requesting user.

Handshakes that are ‘ACCEPTED`, `DECLINED`, `CANCELED`, or `EXPIRED` appear in the results of this API for only 30 days after changing to that state. After that, they’re deleted and no longer accessible.

<note markdown=“1”> 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.

</note>

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: 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:

resp = client.({
})

resp.to_h outputs the following:
{
  handshakes: [
    {
      action: "INVITE", 
      arn: "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", 
      expiration_timestamp: Time.parse("2017-01-28T14:35:23.3Z"), 
      id: "h-examplehandshakeid111", 
      parties: [
        {
          id: "o-exampleorgid", 
          type: "ORGANIZATION", 
        }, 
        {
          id: "[email protected]", 
          type: "EMAIL", 
        }, 
      ], 
      requested_timestamp: Time.parse("2017-01-13T14:35:23.3Z"), 
      resources: [
        {
          resources: [
            {
              type: "MASTER_EMAIL", 
              value: "[email protected]", 
            }, 
            {
              type: "MASTER_NAME", 
              value: "Org Master Account", 
            }, 
            {
              type: "ORGANIZATION_FEATURE_SET", 
              value: "FULL", 
            }, 
          ], 
          type: "ORGANIZATION", 
          value: "o-exampleorgid", 
        }, 
        {
          type: "EMAIL", 
          value: "[email protected]", 
        }, 
      ], 
      state: "OPEN", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.({
  filter: {
    action_type: "INVITE", # accepts INVITE, ENABLE_ALL_FEATURES, APPROVE_ALL_FEATURES, ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE
    parent_handshake_id: "HandshakeId",
  },
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.handshakes #=> Array
resp.handshakes[0].id #=> String
resp.handshakes[0].arn #=> String
resp.handshakes[0].parties #=> Array
resp.handshakes[0].parties[0].id #=> String
resp.handshakes[0].parties[0].type #=> String, one of "ACCOUNT", "ORGANIZATION", "EMAIL"
resp.handshakes[0].state #=> String, one of "REQUESTED", "OPEN", "CANCELED", "ACCEPTED", "DECLINED", "EXPIRED"
resp.handshakes[0].requested_timestamp #=> Time
resp.handshakes[0].expiration_timestamp #=> Time
resp.handshakes[0].action #=> String, one of "INVITE", "ENABLE_ALL_FEATURES", "APPROVE_ALL_FEATURES", "ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE"
resp.handshakes[0].resources #=> Array
resp.handshakes[0].resources[0].value #=> String
resp.handshakes[0].resources[0].type #=> String, one of "ACCOUNT", "ORGANIZATION", "ORGANIZATION_FEATURE_SET", "EMAIL", "MASTER_EMAIL", "MASTER_NAME", "NOTES", "PARENT_HANDSHAKE"
resp.handshakes[0].resources[0].resources #=> Types::HandshakeResources
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filter (Types::HandshakeFilter) —

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

  • :next_token (String) —

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

  • :max_results (Integer) —

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

Returns:

See Also:



4569
4570
4571
4572
 
# File 'lib/aws-sdk-organizations/client.rb', line 4569

def (params = {}, options = {})
  req = build_request(:list_handshakes_for_account, params)
  req.send_request(options)
end

#list_handshakes_for_organization(params = {}) ⇒ Types::ListHandshakesForOrganizationResponse

Lists the handshakes that are associated with the organization that the requesting user is part of. The ‘ListHandshakesForOrganization` operation returns a list of handshake structures. Each structure contains details and status about a handshake.

Handshakes that are ‘ACCEPTED`, `DECLINED`, `CANCELED`, or `EXPIRED` appear in the results of this API for only 30 days after changing to that state. After that, they’re deleted and no longer accessible.

<note markdown=“1”> 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.

</note>

This operation can be called only from the organization’s management account or by a member account that is a delegated administrator.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: 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:

resp = client.list_handshakes_for_organization({
})

resp.to_h outputs the following:
{
  handshakes: [
    {
      action: "INVITE", 
      arn: "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", 
      expiration_timestamp: Time.parse("2017-01-28T14:35:23.3Z"), 
      id: "h-examplehandshakeid111", 
      parties: [
        {
          id: "o-exampleorgid", 
          type: "ORGANIZATION", 
        }, 
        {
          id: "[email protected]", 
          type: "EMAIL", 
        }, 
      ], 
      requested_timestamp: Time.parse("2017-01-13T14:35:23.3Z"), 
      resources: [
        {
          resources: [
            {
              type: "MASTER_EMAIL", 
              value: "[email protected]", 
            }, 
            {
              type: "MASTER_NAME", 
              value: "Org Master Account", 
            }, 
            {
              type: "ORGANIZATION_FEATURE_SET", 
              value: "FULL", 
            }, 
          ], 
          type: "ORGANIZATION", 
          value: "o-exampleorgid", 
        }, 
        {
          type: "EMAIL", 
          value: "[email protected]", 
        }, 
      ], 
      state: "OPEN", 
    }, 
    {
      action: "INVITE", 
      arn: "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", 
      expiration_timestamp: Time.parse("2017-01-28T14:35:23.3Z"), 
      id: "h-examplehandshakeid222", 
      parties: [
        {
          id: "o-exampleorgid", 
          type: "ORGANIZATION", 
        }, 
        {
          id: "[email protected]", 
          type: "EMAIL", 
        }, 
      ], 
      requested_timestamp: Time.parse("2017-01-13T14:35:23.3Z"), 
      resources: [
        {
          resources: [
            {
              type: "MASTER_EMAIL", 
              value: "[email protected]", 
            }, 
            {
              type: "MASTER_NAME", 
              value: "Master Account", 
            }, 
          ], 
          type: "ORGANIZATION", 
          value: "o-exampleorgid", 
        }, 
        {
          type: "EMAIL", 
          value: "[email protected]", 
        }, 
        {
          type: "NOTES", 
          value: "This is an invitation to Anika's account to join Bill's organization.", 
        }, 
      ], 
      state: "ACCEPTED", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_handshakes_for_organization({
  filter: {
    action_type: "INVITE", # accepts INVITE, ENABLE_ALL_FEATURES, APPROVE_ALL_FEATURES, ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE
    parent_handshake_id: "HandshakeId",
  },
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.handshakes #=> Array
resp.handshakes[0].id #=> String
resp.handshakes[0].arn #=> String
resp.handshakes[0].parties #=> Array
resp.handshakes[0].parties[0].id #=> String
resp.handshakes[0].parties[0].type #=> String, one of "ACCOUNT", "ORGANIZATION", "EMAIL"
resp.handshakes[0].state #=> String, one of "REQUESTED", "OPEN", "CANCELED", "ACCEPTED", "DECLINED", "EXPIRED"
resp.handshakes[0].requested_timestamp #=> Time
resp.handshakes[0].expiration_timestamp #=> Time
resp.handshakes[0].action #=> String, one of "INVITE", "ENABLE_ALL_FEATURES", "APPROVE_ALL_FEATURES", "ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE"
resp.handshakes[0].resources #=> Array
resp.handshakes[0].resources[0].value #=> String
resp.handshakes[0].resources[0].type #=> String, one of "ACCOUNT", "ORGANIZATION", "ORGANIZATION_FEATURE_SET", "EMAIL", "MASTER_EMAIL", "MASTER_NAME", "NOTES", "PARENT_HANDSHAKE"
resp.handshakes[0].resources[0].resources #=> Types::HandshakeResources
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filter (Types::HandshakeFilter) —

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

  • :next_token (String) —

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

  • :max_results (Integer) —

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

Returns:

See Also:



4760
4761
4762
4763
 
# File 'lib/aws-sdk-organizations/client.rb', line 4760

def list_handshakes_for_organization(params = {}, options = {})
  req = build_request(:list_handshakes_for_organization, params)
  req.send_request(options)
end

#list_organizational_units_for_parent(params = {}) ⇒ Types::ListOrganizationalUnitsForParentResponse

Lists the organizational units (OUs) in a parent organizational unit or root.

<note markdown=“1”> 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.

</note>

This operation can be called only from the organization’s management account or by a member account that is a delegated administrator.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: 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

resp = client.list_organizational_units_for_parent({
  parent_id: "r-examplerootid111", 
})

resp.to_h outputs the following:
{
  organizational_units: [
    {
      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", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_organizational_units_for_parent({
  parent_id: "ParentId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.organizational_units #=> Array
resp.organizational_units[0].id #=> String
resp.organizational_units[0].arn #=> String
resp.organizational_units[0].name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :parent_id (required, 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 lowercase letters or digits.

    • **Organizational unit (OU)** - A string that begins with “ou-” followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second “-” dash and from 8 to 32 additional lowercase letters or digits.

    [1]: wikipedia.org/wiki/regex

  • :next_token (String) —

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

  • :max_results (Integer) —

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

Returns:

See Also:



4869
4870
4871
4872
 
# File 'lib/aws-sdk-organizations/client.rb', line 4869

def list_organizational_units_for_parent(params = {}, options = {})
  req = build_request(:list_organizational_units_for_parent, params)
  req.send_request(options)
end

#list_parents(params = {}) ⇒ Types::ListParentsResponse

Lists the root or organizational units (OUs) that serve as the immediate parent of the specified child OU or account. This operation, along with ListChildren enables you to traverse the tree structure that makes up this root.

<note markdown=“1”> 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.

</note>

This operation can be called only from the organization’s management account or by a member account that is a delegated administrator.

<note markdown=“1”> In the current release, a child can have only a single parent.

</note>

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: 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

resp = client.list_parents({
  child_id: "444444444444", 
})

resp.to_h outputs the following:
{
  parents: [
    {
      id: "ou-examplerootid111-exampleouid111", 
      type: "ORGANIZATIONAL_UNIT", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_parents({
  child_id: "ChildId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.parents #=> Array
resp.parents[0].id #=> String
resp.parents[0].type #=> String, one of "ROOT", "ORGANIZATIONAL_UNIT"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :child_id (required, String) —

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

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

    • Account - A string that consists of exactly 12 digits.

    • **Organizational unit (OU)** - A string that begins with “ou-” followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second “-” dash and from 8 to 32 additional lowercase letters or digits.

    [1]: wikipedia.org/wiki/regex

  • :next_token (String) —

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

  • :max_results (Integer) —

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

Returns:

See Also:



4976
4977
4978
4979
 
# File 'lib/aws-sdk-organizations/client.rb', line 4976

def list_parents(params = {}, options = {})
  req = build_request(:list_parents, params)
  req.send_request(options)
end

#list_policies(params = {}) ⇒ Types::ListPoliciesResponse

Retrieves the list of all policies in an organization of a specified type.

<note markdown=“1”> 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.

</note>

This operation can be called only from the organization’s management account or by a member account that is a delegated administrator.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To retrieve a list policies in the organization


# The following example shows how to get a list of service control policies (SCPs):/n/n

resp = client.list_policies({
  filter: "SERVICE_CONTROL_POLICY", 
})

resp.to_h outputs the following:
{
  policies: [
    {
      arn: "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111", 
      aws_managed: 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", 
      aws_managed: 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", 
      aws_managed: true, 
      description: "Allows access to every operation", 
      id: "p-FullAWSAccess", 
      name: "FullAWSAccess", 
      type: "SERVICE_CONTROL_POLICY", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_policies({
  filter: "SERVICE_CONTROL_POLICY", # required, accepts SERVICE_CONTROL_POLICY, RESOURCE_CONTROL_POLICY, TAG_POLICY, BACKUP_POLICY, AISERVICES_OPT_OUT_POLICY, CHATBOT_POLICY, DECLARATIVE_POLICY_EC2, SECURITYHUB_POLICY
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.policies #=> Array
resp.policies[0].id #=> String
resp.policies[0].arn #=> String
resp.policies[0].name #=> String
resp.policies[0].description #=> String
resp.policies[0].type #=> String, one of "SERVICE_CONTROL_POLICY", "RESOURCE_CONTROL_POLICY", "TAG_POLICY", "BACKUP_POLICY", "AISERVICES_OPT_OUT_POLICY", "CHATBOT_POLICY", "DECLARATIVE_POLICY_EC2", "SECURITYHUB_POLICY"
resp.policies[0].aws_managed #=> Boolean
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



5114
5115
5116
5117
 
# File 'lib/aws-sdk-organizations/client.rb', line 5114

def list_policies(params = {}, options = {})
  req = build_request(:list_policies, params)
  req.send_request(options)
end

#list_policies_for_target(params = {}) ⇒ Types::ListPoliciesForTargetResponse

Lists the policies that are directly attached to the specified target root, organizational unit (OU), or account. You must specify the policy type that you want included in the returned list.

<note markdown=“1”> 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.

</note>

This operation can be called only from the organization’s management account or by a member account that is a delegated administrator.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: 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

resp = client.list_policies_for_target({
  filter: "SERVICE_CONTROL_POLICY", 
  target_id: "444444444444", 
})

resp.to_h outputs the following:
{
  policies: [
    {
      arn: "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid222", 
      aws_managed: 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", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_policies_for_target({
  target_id: "PolicyTargetId", # required
  filter: "SERVICE_CONTROL_POLICY", # required, accepts SERVICE_CONTROL_POLICY, RESOURCE_CONTROL_POLICY, TAG_POLICY, BACKUP_POLICY, AISERVICES_OPT_OUT_POLICY, CHATBOT_POLICY, DECLARATIVE_POLICY_EC2, SECURITYHUB_POLICY
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.policies #=> Array
resp.policies[0].id #=> String
resp.policies[0].arn #=> String
resp.policies[0].name #=> String
resp.policies[0].description #=> String
resp.policies[0].type #=> String, one of "SERVICE_CONTROL_POLICY", "RESOURCE_CONTROL_POLICY", "TAG_POLICY", "BACKUP_POLICY", "AISERVICES_OPT_OUT_POLICY", "CHATBOT_POLICY", "DECLARATIVE_POLICY_EC2", "SECURITYHUB_POLICY"
resp.policies[0].aws_managed #=> Boolean
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



5262
5263
5264
5265
 
# File 'lib/aws-sdk-organizations/client.rb', line 5262

def list_policies_for_target(params = {}, options = {})
  req = build_request(:list_policies_for_target, params)
  req.send_request(options)
end

#list_roots(params = {}) ⇒ Types::ListRootsResponse

Lists the roots that are defined in the current organization.

<note markdown=“1”> 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.

</note>

This operation can be called only from the organization’s management account or by a member account that is a delegated administrator.

<note markdown=“1”> Policy types can be enabled and disabled in roots. This is distinct from whether they’re 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.

</note>

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: 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

resp = client.list_roots({
})

resp.to_h outputs the following:
{
  roots: [
    {
      arn: "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111", 
      id: "r-examplerootid111", 
      name: "Root", 
      policy_types: [
        {
          status: "ENABLED", 
          type: "SERVICE_CONTROL_POLICY", 
        }, 
      ], 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_roots({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.roots #=> Array
resp.roots[0].id #=> String
resp.roots[0].arn #=> String
resp.roots[0].name #=> String
resp.roots[0].policy_types #=> Array
resp.roots[0].policy_types[0].type #=> String, one of "SERVICE_CONTROL_POLICY", "RESOURCE_CONTROL_POLICY", "TAG_POLICY", "BACKUP_POLICY", "AISERVICES_OPT_OUT_POLICY", "CHATBOT_POLICY", "DECLARATIVE_POLICY_EC2", "SECURITYHUB_POLICY"
resp.roots[0].policy_types[0].status #=> String, one of "ENABLED", "PENDING_ENABLE", "PENDING_DISABLE"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

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

  • :max_results (Integer) —

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

Returns:

See Also:



5362
5363
5364
5365
 
# File 'lib/aws-sdk-organizations/client.rb', line 5362

def list_roots(params = {}, options = {})
  req = build_request(:list_roots, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists tags that are attached to the specified resource.

You can attach tags to the following resources in Organizations.

  • Amazon Web Services account

  • Organization root

  • Organizational unit (OU)

  • Policy (any type)

This operation can be called only from the organization’s management account or by a member account that is a delegated administrator.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_id: "TaggableResourceId", # required
  next_token: "NextToken",
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_id (required, String) —

    The ID of the resource with the tags to list.

    You can specify any of the following taggable resources.

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

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

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

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

  • :next_token (String) —

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

Returns:

See Also:



5430
5431
5432
5433
 
# File 'lib/aws-sdk-organizations/client.rb', line 5430

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#list_targets_for_policy(params = {}) ⇒ Types::ListTargetsForPolicyResponse

Lists all the roots, organizational units (OUs), and accounts that the specified policy is attached to.

<note markdown=“1”> 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.

</note>

This operation can be called only from the organization’s management account or by a member account that is a delegated administrator.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: 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

resp = client.list_targets_for_policy({
  policy_id: "p-FullAWSAccess", 
})

resp.to_h outputs the following:
{
  targets: [
    {
      arn: "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111", 
      name: "Root", 
      target_id: "r-examplerootid111", 
      type: "ROOT", 
    }, 
    {
      arn: "arn:aws:organizations::111111111111:account/o-exampleorgid/333333333333;", 
      name: "Developer Test Account", 
      target_id: "333333333333", 
      type: "ACCOUNT", 
    }, 
    {
      arn: "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111", 
      name: "Accounting", 
      target_id: "ou-examplerootid111-exampleouid111", 
      type: "ORGANIZATIONAL_UNIT", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_targets_for_policy({
  policy_id: "PolicyId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.targets #=> Array
resp.targets[0].target_id #=> String
resp.targets[0].arn #=> String
resp.targets[0].name #=> String
resp.targets[0].type #=> String, one of "ACCOUNT", "ORGANIZATIONAL_UNIT", "ROOT"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :policy_id (required, String) —

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

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

    [1]: wikipedia.org/wiki/regex

  • :next_token (String) —

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

  • :max_results (Integer) —

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

Returns:

See Also:



5542
5543
5544
5545
 
# File 'lib/aws-sdk-organizations/client.rb', line 5542

def list_targets_for_policy(params = {}, options = {})
  req = build_request(:list_targets_for_policy, params)
  req.send_request(options)
end

#move_account(params = {}) ⇒ Struct

Moves an account from its current source parent root or organizational unit (OU) to the specified destination parent root or OU.

This operation can be called only from the organization’s management account.

Examples:

Example: 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

resp = client.({
  account_id: "333333333333", 
  destination_parent_id: "ou-examplerootid111-exampleouid111", 
  source_parent_id: "r-examplerootid111", 
})

Request syntax with placeholder values


resp = client.({
  account_id: "AccountId", # required
  source_parent_id: "ParentId", # required
  destination_parent_id: "ParentId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_id (required, 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.

    [1]: wikipedia.org/wiki/regex

  • :source_parent_id (required, 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 lowercase letters or digits.

    • **Organizational unit (OU)** - A string that begins with “ou-” followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second “-” dash and from 8 to 32 additional lowercase letters or digits.

    [1]: wikipedia.org/wiki/regex

  • :destination_parent_id (required, 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 lowercase letters or digits.

    • **Organizational unit (OU)** - A string that begins with “ou-” followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second “-” dash and from 8 to 32 additional lowercase letters or digits.

    [1]: wikipedia.org/wiki/regex

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5626
5627
5628
5629
 
# File 'lib/aws-sdk-organizations/client.rb', line 5626

def (params = {}, options = {})
  req = build_request(:move_account, params)
  req.send_request(options)
end

#put_resource_policy(params = {}) ⇒ Types::PutResourcePolicyResponse

Creates or updates a resource policy.

This operation can be called only from the organization’s management account..

Examples:

Request syntax with placeholder values


resp = client.put_resource_policy({
  content: "ResourcePolicyContent", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.resource_policy.resource_policy_summary.id #=> String
resp.resource_policy.resource_policy_summary.arn #=> String
resp.resource_policy.content #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :content (required, String) —

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

    [1]: docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scps_syntax.html

  • :tags (Array<Types::Tag>) —

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

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

    </note>

    [1]: docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html

Returns:

See Also:



5690
5691
5692
5693
 
# File 'lib/aws-sdk-organizations/client.rb', line 5690

def put_resource_policy(params = {}, options = {})
  req = build_request(:put_resource_policy, params)
  req.send_request(options)
end

#register_delegated_administrator(params = {}) ⇒ Struct

Enables the specified member account to administer the Organizations features of the specified Amazon Web Services service. It grants read-only access to Organizations service data. The account still requires IAM permissions to access and administer the Amazon Web Services service.

You can run this action only for Amazon Web Services services that support this feature. For a current list of services that support it, see the column *Supports Delegated Administrator* in the table at

Amazon Web Services Services that you can use with Organizations][1

in the *Organizations User Guide.*

This operation can be called only from the organization’s management account.

[1]: docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services_list.html

Examples:

Request syntax with placeholder values


resp = client.register_delegated_administrator({
  account_id: "AccountId", # required
  service_principal: "ServicePrincipal", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_id (required, String) —

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

  • :service_principal (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5735
5736
5737
5738
 
# File 'lib/aws-sdk-organizations/client.rb', line 5735

def register_delegated_administrator(params = {}, options = {})
  req = build_request(:register_delegated_administrator, params)
  req.send_request(options)
end

#remove_account_from_organization(params = {}) ⇒ Struct

Removes the specified account from the organization.

The removed account becomes a standalone account that isn’t a member of any organization. It’s no longer subject to any policies and is responsible for its own bill payments. The organization’s management account is no longer charged for any expenses accrued by the member account after it’s removed from the organization.

This operation can be called only from the organization’s management account. Member accounts can remove themselves with LeaveOrganization instead.

  • You can remove an account from your organization only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the Organizations console, API, or CLI commands, the information required of standalone accounts is not automatically collected. For more information, see [Considerations before removing an account from an organization] in the *Organizations User Guide*.

  • The account that you want to leave must not be a delegated administrator account for any Amazon Web Services service enabled for your organization. If the account is a delegated administrator, you must first change the delegated administrator account to another account that is remaining in the organization.

  • After the account leaves the organization, all tags that were attached to the account object in the organization are deleted. Amazon Web Services accounts outside of an organization do not support tags.

[1]: docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_account-before-remove.html

Examples:

Example: To remove an account from an organization as the master account


# The following example shows you how to remove an account from an organization:

resp = client.({
  account_id: "333333333333", 
})

Request syntax with placeholder values


resp = client.({
  account_id: "AccountId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_id (required, 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.

    [1]: wikipedia.org/wiki/regex

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5808
5809
5810
5811
 
# File 'lib/aws-sdk-organizations/client.rb', line 5808

def (params = {}, options = {})
  req = build_request(:remove_account_from_organization, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Adds one or more tags to the specified resource.

Currently, you can attach tags to the following resources in Organizations.

  • Amazon Web Services account

  • Organization root

  • Organizational unit (OU)

  • Policy (any type)

This operation can be called only from the organization’s management account or by a member account that is a delegated administrator.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_id: "TaggableResourceId", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_id (required, String) —

    The ID of the resource to add a tag to.

    You can specify any of the following taggable resources.

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

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

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

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

  • :tags (required, Array<Types::Tag>) —

    A list of tags to add to the specified resource.

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

    <note markdown=“1”> If any one of the tags is not valid or if you exceed the maximum allowed number of tags for a resource, then the entire request fails.

    </note>

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5874
5875
5876
5877
 
# File 'lib/aws-sdk-organizations/client.rb', line 5874

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes any tags with the specified keys from the specified resource.

You can attach tags to the following resources in Organizations.

  • Amazon Web Services account

  • Organization root

  • Organizational unit (OU)

  • Policy (any type)

This operation can be called only from the organization’s management account or by a member account that is a delegated administrator.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_id: "TaggableResourceId", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_id (required, String) —

    The ID of the resource to remove a tag from.

    You can specify any of the following taggable resources.

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

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

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

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

  • :tag_keys (required, Array<String>) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5926
5927
5928
5929
 
# File 'lib/aws-sdk-organizations/client.rb', line 5926

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_organizational_unit(params = {}) ⇒ Types::UpdateOrganizationalUnitResponse

Renames the specified organizational unit (OU). The ID and ARN don’t change. The child OUs and accounts remain in place, and any attached policies of the OU remain attached.

This operation can be called only from the organization’s management account.

Examples:

Example: To rename an organizational unit


# The following example shows how to rename an OU. The output confirms the new name:/n/n

resp = client.update_organizational_unit({
  name: "AccountingOU", 
  organizational_unit_id: "ou-examplerootid111-exampleouid111", 
})

resp.to_h outputs the following:
{
  organizational_unit: {
    arn: "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111", 
    id: "ou-examplerootid111-exampleouid111", 
    name: "AccountingOU", 
  }, 
}

Request syntax with placeholder values


resp = client.update_organizational_unit({
  organizational_unit_id: "OrganizationalUnitId", # required
  name: "OrganizationalUnitName",
})

Response structure


resp.organizational_unit.id #=> String
resp.organizational_unit.arn #=> String
resp.organizational_unit.name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :organizational_unit_id (required, 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 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second “-” dash and from 8 to 32 additional lowercase letters or digits.

    [1]: wikipedia.org/wiki/regex

  • :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.

    [1]: wikipedia.org/wiki/regex

Returns:

See Also:



6001
6002
6003
6004
 
# File 'lib/aws-sdk-organizations/client.rb', line 6001

def update_organizational_unit(params = {}, options = {})
  req = build_request(:update_organizational_unit, params)
  req.send_request(options)
end

#update_policy(params = {}) ⇒ Types::UpdatePolicyResponse

Updates an existing policy with a new name, description, or content. If you don’t supply any parameter, that value remains unchanged. You can’t change a policy’s type.

This operation can be called only from the organization’s management account or by a member account that is a delegated administrator.

Examples:

Example: 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

resp = client.update_policy({
  description: "This description replaces the original.", 
  name: "Renamed-Policy", 
  policy_id: "p-examplepolicyid111", 
})

resp.to_h outputs the following:
{
  policy: {
    content: "{ \"Version\": \"2012-10-17\", \"Statement\": { \"Effect\": \"Allow\", \"Action\": \"ec2:*\", \"Resource\": \"*\" } }", 
    policy_summary: {
      arn: "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111", 
      aws_managed: false, 
      description: "This description replaces the original.", 
      id: "p-examplepolicyid111", 
      name: "Renamed-Policy", 
      type: "SERVICE_CONTROL_POLICY", 
    }, 
  }, 
}

Example: 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

resp = client.update_policy({
  content: "{ \\\"Version\\\": \\\"2012-10-17\\\", \\\"Statement\\\": {\\\"Effect\\\": \\\"Allow\\\", \\\"Action\\\": \\\"s3:*\\\", \\\"Resource\\\": \\\"*\\\" } }", 
  policy_id: "p-examplepolicyid111", 
})

resp.to_h outputs the following:
{
  policy: {
    content: "{ \\\"Version\\\": \\\"2012-10-17\\\", \\\"Statement\\\": { \\\"Effect\\\": \\\"Allow\\\", \\\"Action\\\": \\\"s3:*\\\", \\\"Resource\\\": \\\"*\\\" } }", 
    policy_summary: {
      arn: "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111", 
      aws_managed: false, 
      description: "This description replaces the original.", 
      id: "p-examplepolicyid111", 
      name: "Renamed-Policy", 
      type: "SERVICE_CONTROL_POLICY", 
    }, 
  }, 
}

Request syntax with placeholder values


resp = client.update_policy({
  policy_id: "PolicyId", # required
  name: "PolicyName",
  description: "PolicyDescription",
  content: "PolicyContent",
})

Response structure


resp.policy.policy_summary.id #=> String
resp.policy.policy_summary.arn #=> String
resp.policy.policy_summary.name #=> String
resp.policy.policy_summary.description #=> String
resp.policy.policy_summary.type #=> String, one of "SERVICE_CONTROL_POLICY", "RESOURCE_CONTROL_POLICY", "TAG_POLICY", "BACKUP_POLICY", "AISERVICES_OPT_OUT_POLICY", "CHATBOT_POLICY", "DECLARATIVE_POLICY_EC2", "SECURITYHUB_POLICY"
resp.policy.policy_summary.aws_managed #=> Boolean
resp.policy.content #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



6131
6132
6133
6134
 
# File 'lib/aws-sdk-organizations/client.rb', line 6131

def update_policy(params = {}, options = {})
  req = build_request(:update_policy, params)
  req.send_request(options)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


6160
6161
6162
 
# File 'lib/aws-sdk-organizations/client.rb', line 6160

def waiter_names
  []
end