doc.go 3.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. // Code generated by smithy-go-codegen DO NOT EDIT.
  2. // Package organizations provides the API client, operations, and parameter types
  3. // for 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].
  11. //
  12. // # Support and feedback for Organizations
  13. //
  14. // We welcome your feedback. You can post your feedback and questions in the [Organizations support forum]. For
  15. // more information about the Amazon Web Services Support forums, see [Forums Help].
  16. //
  17. // # Endpoint to call When using the CLI or the Amazon Web Services SDK
  18. //
  19. // For the current release of Organizations, specify the us-east-1 region for all
  20. // Amazon Web Services API and CLI calls made from the commercial Amazon Web
  21. // Services Regions outside of China. If calling from one of the Amazon Web
  22. // Services Regions in China, then specify cn-northwest-1 . You can do this in the
  23. // CLI by using these parameters and commands:
  24. //
  25. // - Use the following parameter with each command to specify both the endpoint
  26. // and its region:
  27. //
  28. // --endpoint-url https://organizations.us-east-1.amazonaws.com (from commercial
  29. //
  30. // Amazon Web Services Regions outside of China)
  31. //
  32. // or
  33. //
  34. // --endpoint-url https://organizations.cn-northwest-1.amazonaws.com.cn (from
  35. //
  36. // Amazon Web Services Regions in China)
  37. //
  38. // - Use the default endpoint, but configure your default region with this
  39. // command:
  40. //
  41. // aws configure set default.region us-east-1 (from commercial Amazon Web Services
  42. //
  43. // Regions outside of China)
  44. //
  45. // or
  46. //
  47. // aws configure set default.region cn-northwest-1 (from Amazon Web Services
  48. //
  49. // Regions in China)
  50. //
  51. // - Use the following parameter with each command to specify the endpoint:
  52. //
  53. // --region us-east-1 (from commercial Amazon Web Services Regions outside of
  54. //
  55. // China)
  56. //
  57. // or
  58. //
  59. // --region cn-northwest-1 (from Amazon Web Services Regions in China)
  60. //
  61. // # Recording API Requests
  62. //
  63. // Organizations supports CloudTrail, a service that records Amazon Web Services
  64. // API calls for your Amazon Web Services account and delivers log files to an
  65. // Amazon S3 bucket. By using information collected by CloudTrail, you can
  66. // determine which requests the Organizations service received, who made the
  67. // request and when, and so on. For more about Organizations and its support for
  68. // CloudTrail, see [Logging Organizations API calls with CloudTrail]in the Organizations User Guide. To learn more about
  69. // CloudTrail, including how to turn it on and find your log files, see the [CloudTrail User Guide].
  70. //
  71. // [Forums Help]: https://forums.aws.amazon.com/help.jspa
  72. // [Organizations support forum]: https://forums.aws.amazon.com/forum.jspa?forumID=219
  73. // [CloudTrail User Guide]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html
  74. // [Organizations User Guide]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html
  75. // [Logging Organizations API calls with CloudTrail]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_incident-response.html#orgs_cloudtrail-integration
  76. package organizations