doc.go 2.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
  2. // Package cloudtrail provides the client and types for making API
  3. // requests to AWS CloudTrail.
  4. //
  5. // This is the CloudTrail API Reference. It provides descriptions of actions,
  6. // data types, common parameters, and common errors for CloudTrail.
  7. //
  8. // CloudTrail is a web service that records Amazon Web Services API calls for
  9. // your Amazon Web Services account and delivers log files to an Amazon S3 bucket.
  10. // The recorded information includes the identity of the user, the start time
  11. // of the Amazon Web Services API call, the source IP address, the request parameters,
  12. // and the response elements returned by the service.
  13. //
  14. // As an alternative to the API, you can use one of the Amazon Web Services
  15. // SDKs, which consist of libraries and sample code for various programming
  16. // languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs
  17. // provide programmatic access to CloudTrail. For example, the SDKs handle cryptographically
  18. // signing requests, managing errors, and retrying requests automatically. For
  19. // more information about the Amazon Web Services SDKs, including how to download
  20. // and install them, see Tools to Build on Amazon Web Services (http://aws.amazon.com/tools/).
  21. //
  22. // See the CloudTrail User Guide (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-user-guide.html)
  23. // for information about the data that is included with each Amazon Web Services
  24. // API call listed in the log files.
  25. //
  26. // See https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01 for more information on this service.
  27. //
  28. // See cloudtrail package documentation for more information.
  29. // https://docs.aws.amazon.com/sdk-for-go/api/service/cloudtrail/
  30. //
  31. // # Using the Client
  32. //
  33. // To contact AWS CloudTrail with the SDK use the New function to create
  34. // a new service client. With that client you can make API requests to the service.
  35. // These clients are safe to use concurrently.
  36. //
  37. // See the SDK's documentation for more information on how to use the SDK.
  38. // https://docs.aws.amazon.com/sdk-for-go/api/
  39. //
  40. // See aws.Config documentation for more information on configuring SDK clients.
  41. // https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
  42. //
  43. // See the AWS CloudTrail client CloudTrail for more
  44. // information on creating client for this service.
  45. // https://docs.aws.amazon.com/sdk-for-go/api/service/cloudtrail/#New
  46. package cloudtrail