github.com/aavshr/aws-sdk-go@v1.41.3/service/support/doc.go (about) 1 // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. 2 3 // Package support provides the client and types for making API 4 // requests to AWS Support. 5 // 6 // The AWS Support API Reference is intended for programmers who need detailed 7 // information about the AWS Support operations and data types. You can use 8 // the API to manage your support cases programmatically. The AWS Support API 9 // uses HTTP methods that return results in JSON format. 10 // 11 // * You must have a Business or Enterprise Support plan to use the AWS Support 12 // API. 13 // 14 // * If you call the AWS Support API from an account that does not have a 15 // Business or Enterprise Support plan, the SubscriptionRequiredException 16 // error message appears. For information about changing your support plan, 17 // see AWS Support (http://aws.amazon.com/premiumsupport/). 18 // 19 // The AWS Support service also exposes a set of AWS Trusted Advisor (http://aws.amazon.com/premiumsupport/trustedadvisor/) 20 // features. You can retrieve a list of checks and their descriptions, get check 21 // results, specify checks to refresh, and get the refresh status of checks. 22 // 23 // The following list describes the AWS Support case management operations: 24 // 25 // * Service names, issue categories, and available severity levels - The 26 // DescribeServices and DescribeSeverityLevels operations return AWS service 27 // names, service codes, service categories, and problem severity levels. 28 // You use these values when you call the CreateCase operation. 29 // 30 // * Case creation, case details, and case resolution - The CreateCase, DescribeCases, 31 // DescribeAttachment, and ResolveCase operations create AWS Support cases, 32 // retrieve information about cases, and resolve cases. 33 // 34 // * Case communication - The DescribeCommunications, AddCommunicationToCase, 35 // and AddAttachmentsToSet operations retrieve and add communications and 36 // attachments to AWS Support cases. 37 // 38 // The following list describes the operations available from the AWS Support 39 // service for Trusted Advisor: 40 // 41 // * DescribeTrustedAdvisorChecks returns the list of checks that run against 42 // your AWS resources. 43 // 44 // * Using the checkId for a specific check returned by DescribeTrustedAdvisorChecks, 45 // you can call DescribeTrustedAdvisorCheckResult to obtain the results for 46 // the check that you specified. 47 // 48 // * DescribeTrustedAdvisorCheckSummaries returns summarized results for 49 // one or more Trusted Advisor checks. 50 // 51 // * RefreshTrustedAdvisorCheck requests that Trusted Advisor rerun a specified 52 // check. 53 // 54 // * DescribeTrustedAdvisorCheckRefreshStatuses reports the refresh status 55 // of one or more checks. 56 // 57 // For authentication of requests, AWS Support uses Signature Version 4 Signing 58 // Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). 59 // 60 // See About the AWS Support API (https://docs.aws.amazon.com/awssupport/latest/user/Welcome.html) 61 // in the AWS Support User Guide for information about how to use this service 62 // to create and manage your support cases, and how to call Trusted Advisor 63 // for results of checks on your resources. 64 // 65 // See https://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15 for more information on this service. 66 // 67 // See support package documentation for more information. 68 // https://docs.aws.amazon.com/sdk-for-go/api/service/support/ 69 // 70 // Using the Client 71 // 72 // To contact AWS Support with the SDK use the New function to create 73 // a new service client. With that client you can make API requests to the service. 74 // These clients are safe to use concurrently. 75 // 76 // See the SDK's documentation for more information on how to use the SDK. 77 // https://docs.aws.amazon.com/sdk-for-go/api/ 78 // 79 // See aws.Config documentation for more information on configuring SDK clients. 80 // https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config 81 // 82 // See the AWS Support client Support for more 83 // information on creating client for this service. 84 // https://docs.aws.amazon.com/sdk-for-go/api/service/support/#New 85 package support