doc.go 4.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
  2. // Package organizations provides the client and types for making API
  3. // requests to AWS Organizations.
  4. //
  5. // Organizations is a web service that enables you to consolidate your multiple
  6. // Amazon Web Services accounts into an organization and centrally manage your
  7. // accounts and their resources.
  8. //
  9. // This guide provides descriptions of the Organizations operations. For more
  10. // information about using this service, see the Organizations User Guide (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html).
  11. //
  12. // # Support and feedback for Organizations
  13. //
  14. // We welcome your feedback. Send your comments to feedback-awsorganizations@amazon.com
  15. // (mailto:feedback-awsorganizations@amazon.com) or post your feedback and questions
  16. // in the Organizations support forum (http://forums.aws.amazon.com/forum.jspa?forumID=219).
  17. // For more information about the Amazon Web Services support forums, see Forums
  18. // Help (http://forums.aws.amazon.com/help.jspa).
  19. //
  20. // # Endpoint to call When using the CLI or the Amazon Web Services SDK
  21. //
  22. // For the current release of Organizations, specify the us-east-1 region for
  23. // all Amazon Web Services API and CLI calls made from the commercial Amazon
  24. // Web Services Regions outside of China. If calling from one of the Amazon
  25. // Web Services Regions in China, then specify cn-northwest-1. You can do this
  26. // in the CLI by using these parameters and commands:
  27. //
  28. // - Use the following parameter with each command to specify both the endpoint
  29. // and its region: --endpoint-url https://organizations.us-east-1.amazonaws.com
  30. // (from commercial Amazon Web Services Regions outside of China) or --endpoint-url
  31. // https://organizations.cn-northwest-1.amazonaws.com.cn (from Amazon Web
  32. // Services Regions in China)
  33. //
  34. // - Use the default endpoint, but configure your default region with this
  35. // command: aws configure set default.region us-east-1 (from commercial Amazon
  36. // Web Services Regions outside of China) or aws configure set default.region
  37. // cn-northwest-1 (from Amazon Web Services Regions in China)
  38. //
  39. // - Use the following parameter with each command to specify the endpoint:
  40. // --region us-east-1 (from commercial Amazon Web Services Regions outside
  41. // of China) or --region cn-northwest-1 (from Amazon Web Services Regions
  42. // in China)
  43. //
  44. // # Recording API Requests
  45. //
  46. // Organizations supports CloudTrail, a service that records Amazon Web Services
  47. // API calls for your Amazon Web Services account and delivers log files to
  48. // an Amazon S3 bucket. By using information collected by CloudTrail, you can
  49. // determine which requests the Organizations service received, who made the
  50. // request and when, and so on. For more about Organizations and its support
  51. // for CloudTrail, see Logging Organizations Events with CloudTrail (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_incident-response.html#orgs_cloudtrail-integration)
  52. // in the Organizations User Guide. To learn more about CloudTrail, including
  53. // how to turn it on and find your log files, see the CloudTrail User Guide
  54. // (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html).
  55. //
  56. // See https://docs.aws.amazon.com/goto/WebAPI/organizations-2016-11-28 for more information on this service.
  57. //
  58. // See organizations package documentation for more information.
  59. // https://docs.aws.amazon.com/sdk-for-go/api/service/organizations/
  60. //
  61. // # Using the Client
  62. //
  63. // To contact AWS Organizations with the SDK use the New function to create
  64. // a new service client. With that client you can make API requests to the service.
  65. // These clients are safe to use concurrently.
  66. //
  67. // See the SDK's documentation for more information on how to use the SDK.
  68. // https://docs.aws.amazon.com/sdk-for-go/api/
  69. //
  70. // See aws.Config documentation for more information on configuring SDK clients.
  71. // https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
  72. //
  73. // See the AWS Organizations client Organizations for more
  74. // information on creating client for this service.
  75. // https://docs.aws.amazon.com/sdk-for-go/api/service/organizations/#New
  76. package organizations