/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.organizations; import javax.annotation.Generated; import com.amazonaws.*; import com.amazonaws.regions.*; import com.amazonaws.services.organizations.model.*; /** * Interface for accessing Organizations. *

* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.organizations.AbstractAWSOrganizations} instead. *

*

*

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

*

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

*

* Support and feedback for Organizations *

*

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

*

* Endpoint to call When using the CLI or the Amazon Web Services SDK *

*

* For the current release of Organizations, specify the us-east-1 region for all Amazon Web Services API * and CLI calls made from the commercial Amazon Web Services Regions outside of China. If calling from one of the * Amazon Web Services Regions in China, then specify cn-northwest-1. You can do this in the CLI by using * these parameters and commands: *

* *

* Recording API Requests *

*

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

*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSOrganizations { /** * The region metadata service name for computing region endpoints. You can use this value to retrieve metadata * (such as supported regions) of the service. * * @see RegionUtils#getRegionsForService(String) */ String ENDPOINT_PREFIX = "organizations"; /** * Overrides the default endpoint for this client ("organizations.us-east-1.amazonaws.com"). Callers can use this * method to control which AWS region they want to work with. *

* Callers can pass in just the endpoint (ex: "organizations.us-east-1.amazonaws.com") or a full URL, including the * protocol (ex: "organizations.us-east-1.amazonaws.com"). If the protocol is not specified here, the default * protocol from this client's {@link ClientConfiguration} will be used, which by default is HTTPS. *

* For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available * endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- * choose-endpoint *

* This method is not threadsafe. An endpoint should be configured when the client is created and before any * service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in * transit or retrying. * * @param endpoint * The endpoint (ex: "organizations.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: * "organizations.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate * with. * @deprecated use {@link AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)} for * example: * {@code builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));} */ @Deprecated void setEndpoint(String endpoint); /** * An alternative to {@link AWSOrganizations#setEndpoint(String)}, sets the regional endpoint for this client's * service calls. Callers can use this method to control which AWS region they want to work with. *

* By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the * {@link ClientConfiguration} supplied at construction. *

* This method is not threadsafe. A region should be configured when the client is created and before any service * requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit * or retrying. * * @param region * The region this client will communicate with. See {@link Region#getRegion(com.amazonaws.regions.Regions)} * for accessing a given region. Must not be null and must be a region where the service is available. * * @see Region#getRegion(com.amazonaws.regions.Regions) * @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration) * @see Region#isServiceSupported(String) * @deprecated use {@link AwsClientBuilder#setRegion(String)} */ @Deprecated void setRegion(Region region); /** *

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

* *

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

* * @param acceptHandshakeRequest * @return Result of the AcceptHandshake operation returned by the service. * @throws AccessDeniedException * You don't have permissions to perform the requested operation. The user or role that is making the * request must have at least one IAM permissions policy attached that grants the required permissions. For * more information, see Access * Management in the IAM User Guide. * @throws AWSOrganizationsNotInUseException * Your account isn't a member of an organization. To make this request, you must use the credentials of an * account that belongs to an organization. * @throws HandshakeConstraintViolationException * The requested operation would violate the constraint identified in the reason code.

*

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

*
*