doc.go 3.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
  2. // Package support provides the client and types for making API
  3. // requests to AWS Support.
  4. //
  5. // The AWS Support API reference is intended for programmers who need detailed
  6. // information about the AWS Support operations and data types. This service
  7. // enables you to manage your AWS Support cases programmatically. It uses HTTP
  8. // methods that return results in JSON format.
  9. //
  10. // The AWS Support service also exposes a set of Trusted Advisor (http://aws.amazon.com/premiumsupport/trustedadvisor/)
  11. // features. You can retrieve a list of checks and their descriptions, get check
  12. // results, specify checks to refresh, and get the refresh status of checks.
  13. //
  14. // The following list describes the AWS Support case management operations:
  15. //
  16. // * Service names, issue categories, and available severity levels. The
  17. // DescribeServices and DescribeSeverityLevels operations return AWS service
  18. // names, service codes, service categories, and problem severity levels.
  19. // You use these values when you call the CreateCase operation.
  20. //
  21. // * Case creation, case details, and case resolution. The CreateCase, DescribeCases,
  22. // DescribeAttachment, and ResolveCase operations create AWS Support cases,
  23. // retrieve information about cases, and resolve cases.
  24. //
  25. // * Case communication. The DescribeCommunications, AddCommunicationToCase,
  26. // and AddAttachmentsToSet operations retrieve and add communications and
  27. // attachments to AWS Support cases.
  28. //
  29. // The following list describes the operations available from the AWS Support
  30. // service for Trusted Advisor:
  31. //
  32. // * DescribeTrustedAdvisorChecks returns the list of checks that run against
  33. // your AWS resources.
  34. //
  35. // * Using the checkId for a specific check returned by DescribeTrustedAdvisorChecks,
  36. // you can call DescribeTrustedAdvisorCheckResult to obtain the results for
  37. // the check you specified.
  38. //
  39. // * DescribeTrustedAdvisorCheckSummaries returns summarized results for
  40. // one or more Trusted Advisor checks.
  41. //
  42. // * RefreshTrustedAdvisorCheck requests that Trusted Advisor rerun a specified
  43. // check.
  44. //
  45. // * DescribeTrustedAdvisorCheckRefreshStatuses reports the refresh status
  46. // of one or more checks.
  47. //
  48. // For authentication of requests, AWS Support uses Signature Version 4 Signing
  49. // Process (http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).
  50. //
  51. // See About the AWS Support API (http://docs.aws.amazon.com/awssupport/latest/user/Welcome.html)
  52. // in the AWS Support User Guide for information about how to use this service
  53. // to create and manage your support cases, and how to call Trusted Advisor
  54. // for results of checks on your resources.
  55. //
  56. // See https://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15 for more information on this service.
  57. //
  58. // See support package documentation for more information.
  59. // https://docs.aws.amazon.com/sdk-for-go/api/service/support/
  60. //
  61. // Using the Client
  62. //
  63. // To contact AWS Support 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 Support client Support for more
  74. // information on creating client for this service.
  75. // https://docs.aws.amazon.com/sdk-for-go/api/service/support/#New
  76. package support