AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Implementation for accessing AWSSupport
Amazon Web Services SupportThe Amazon Web Services Support API Reference is intended for programmers who need detailed information about the Amazon Web Services Support operations and data types. You can use the API to manage your support cases programmatically. The Amazon Web Services Support API uses HTTP methods that return results in JSON format.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have
a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException
error message appears. For information about changing your support plan, see Amazon
Web Services Support.
You can also use the Amazon Web Services Support API to access features for Trusted Advisor. You can return a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks.
You can manage your support cases with the following Amazon Web Services Support API operations:
The CreateCase, DescribeCases, DescribeAttachment, and ResolveCase operations create Amazon Web Services Support cases, retrieve information about cases, and resolve cases.
The DescribeCommunications, AddCommunicationToCase, and AddAttachmentsToSet operations retrieve and add communications and attachments to Amazon Web Services Support cases.
The DescribeServices and DescribeSeverityLevels operations return Amazon Web Service names, service codes, service categories, and problem severity levels. You use these values when you call the CreateCase operation.
You can also use the Amazon Web Services Support API to call the Trusted Advisor operations. For more information, see Trusted Advisor in the Amazon Web Services Support User Guide.
For authentication of requests, Amazon Web Services Support uses Signature Version 4 Signing Process.
For more information about this service and the endpoints to use, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.
Namespace: Amazon.AWSSupport
Assembly: AWSSDK.AWSSupport.dll
Version: 3.x.y.z
public class AmazonAWSSupportClient : AmazonServiceClient IAmazonAWSSupport, IAmazonService, IDisposable
The AmazonAWSSupportClient type exposes the following members
Name | Description | |
---|---|---|
![]() |
AmazonAWSSupportClient() |
Constructs AmazonAWSSupportClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
![]() |
AmazonAWSSupportClient(RegionEndpoint) |
Constructs AmazonAWSSupportClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
![]() |
AmazonAWSSupportClient(AmazonAWSSupportConfig) |
Constructs AmazonAWSSupportClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
![]() |
AmazonAWSSupportClient(AWSCredentials) |
Constructs AmazonAWSSupportClient with AWS Credentials |
![]() |
AmazonAWSSupportClient(AWSCredentials, RegionEndpoint) |
Constructs AmazonAWSSupportClient with AWS Credentials |
![]() |
AmazonAWSSupportClient(AWSCredentials, AmazonAWSSupportConfig) |
Constructs AmazonAWSSupportClient with AWS Credentials and an AmazonAWSSupportClient Configuration object. |
![]() |
AmazonAWSSupportClient(string, string) |
Constructs AmazonAWSSupportClient with AWS Access Key ID and AWS Secret Key |
![]() |
AmazonAWSSupportClient(string, string, RegionEndpoint) |
Constructs AmazonAWSSupportClient with AWS Access Key ID and AWS Secret Key |
![]() |
AmazonAWSSupportClient(string, string, AmazonAWSSupportConfig) |
Constructs AmazonAWSSupportClient with AWS Access Key ID, AWS Secret Key and an AmazonAWSSupportClient Configuration object. |
![]() |
AmazonAWSSupportClient(string, string, string) |
Constructs AmazonAWSSupportClient with AWS Access Key ID and AWS Secret Key |
![]() |
AmazonAWSSupportClient(string, string, string, RegionEndpoint) |
Constructs AmazonAWSSupportClient with AWS Access Key ID and AWS Secret Key |
![]() |
AmazonAWSSupportClient(string, string, string, AmazonAWSSupportConfig) |
Constructs AmazonAWSSupportClient with AWS Access Key ID, AWS Secret Key and an AmazonAWSSupportClient Configuration object. |
Name | Type | Description | |
---|---|---|---|
![]() |
Config | Amazon.Runtime.IClientConfig | Inherited from Amazon.Runtime.AmazonServiceClient. |
![]() |
Paginators | Amazon.AWSSupport.Model.IAWSSupportPaginatorFactory |
Paginators for the service |
Name | Description | |
---|---|---|
![]() |
AddAttachmentsToSet(AddAttachmentsToSetRequest) |
Adds one or more attachments to an attachment set.
An attachment set is a temporary container for attachments that you add to a case
or case communication. The set is available for 1 hour after it's created. The
|
![]() |
AddAttachmentsToSetAsync(AddAttachmentsToSetRequest, CancellationToken) |
Adds one or more attachments to an attachment set.
An attachment set is a temporary container for attachments that you add to a case
or case communication. The set is available for 1 hour after it's created. The
|
![]() |
AddCommunicationToCase(AddCommunicationToCaseRequest) |
Adds additional customer communication to an Amazon Web Services Support case. Use
the
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the
Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have
a Business, Enterprise On-Ramp, or Enterprise Support plan, the |
![]() |
AddCommunicationToCaseAsync(AddCommunicationToCaseRequest, CancellationToken) |
Adds additional customer communication to an Amazon Web Services Support case. Use
the
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the
Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have
a Business, Enterprise On-Ramp, or Enterprise Support plan, the |
![]() |
CreateCase(CreateCaseRequest) |
Creates a case in the Amazon Web Services Support Center. This operation is similar to how you create a case in the Amazon Web Services Support Center Create Case page. The Amazon Web Services Support API doesn't support requesting service limit increases. You can submit a service limit increase in the following ways:
A successful
The
|
![]() |
CreateCaseAsync(CreateCaseRequest, CancellationToken) |
Creates a case in the Amazon Web Services Support Center. This operation is similar to how you create a case in the Amazon Web Services Support Center Create Case page. The Amazon Web Services Support API doesn't support requesting service limit increases. You can submit a service limit increase in the following ways:
A successful
The
|
![]() |
DescribeAttachment(DescribeAttachmentRequest) |
Returns the attachment that has the specified ID. Attachments can include screenshots,
error logs, or other files that describe your issue. Attachment IDs are generated
by the case management system when you add an attachment to a case or case communication.
Attachment IDs are returned in the AttachmentDetails objects that are returned
by the DescribeCommunications operation.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the
Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have
a Business, Enterprise On-Ramp, or Enterprise Support plan, the |
![]() |
DescribeAttachmentAsync(DescribeAttachmentRequest, CancellationToken) |
Returns the attachment that has the specified ID. Attachments can include screenshots,
error logs, or other files that describe your issue. Attachment IDs are generated
by the case management system when you add an attachment to a case or case communication.
Attachment IDs are returned in the AttachmentDetails objects that are returned
by the DescribeCommunications operation.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the
Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have
a Business, Enterprise On-Ramp, or Enterprise Support plan, the |
![]() |
DescribeCases(DescribeCasesRequest) |
Returns a list of cases that you specify by passing one or more case IDs. You can
use the The response returns the following in JSON format:
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request might return an error.
|
![]() |
DescribeCasesAsync(DescribeCasesRequest, CancellationToken) |
Returns a list of cases that you specify by passing one or more case IDs. You can
use the The response returns the following in JSON format:
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request might return an error.
|
![]() |
DescribeCommunications(DescribeCommunicationsRequest) |
Returns communications and attachments for one or more support cases. Use the Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.
You can use the
|
![]() |
DescribeCommunicationsAsync(DescribeCommunicationsRequest, CancellationToken) |
Returns communications and attachments for one or more support cases. Use the Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.
You can use the
|
![]() |
DescribeCreateCaseOptions(DescribeCreateCaseOptionsRequest) |
Returns a list of CreateCaseOption types along with the corresponding supported hours
and language availability. You can specify the
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the
Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have
a Business, Enterprise On-Ramp, or Enterprise Support plan, the |
![]() |
DescribeCreateCaseOptionsAsync(DescribeCreateCaseOptionsRequest, CancellationToken) |
Returns a list of CreateCaseOption types along with the corresponding supported hours
and language availability. You can specify the
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the
Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have
a Business, Enterprise On-Ramp, or Enterprise Support plan, the |
![]() |
DescribeServices() |
Returns the current list of Amazon Web Services services and a list of service categories for each service. You then use service names and categories in your CreateCase requests. Each Amazon Web Services service has its own set of categories.
The service codes and category codes correspond to the values that appear in the Service
and Category lists on the Amazon Web Services Support Center Create
Case page. The values in those fields don't necessarily match the service codes
and categories returned by the
|
![]() |
DescribeServices(DescribeServicesRequest) |
Returns the current list of Amazon Web Services services and a list of service categories for each service. You then use service names and categories in your CreateCase requests. Each Amazon Web Services service has its own set of categories.
The service codes and category codes correspond to the values that appear in the Service
and Category lists on the Amazon Web Services Support Center Create
Case page. The values in those fields don't necessarily match the service codes
and categories returned by the
|
![]() |
DescribeServicesAsync(CancellationToken) |
Returns the current list of Amazon Web Services services and a list of service categories for each service. You then use service names and categories in your CreateCase requests. Each Amazon Web Services service has its own set of categories.
The service codes and category codes correspond to the values that appear in the Service
and Category lists on the Amazon Web Services Support Center Create
Case page. The values in those fields don't necessarily match the service codes
and categories returned by the
|
![]() |
DescribeServicesAsync(DescribeServicesRequest, CancellationToken) |
Returns the current list of Amazon Web Services services and a list of service categories for each service. You then use service names and categories in your CreateCase requests. Each Amazon Web Services service has its own set of categories.
The service codes and category codes correspond to the values that appear in the Service
and Category lists on the Amazon Web Services Support Center Create
Case page. The values in those fields don't necessarily match the service codes
and categories returned by the
|
![]() |
DescribeSeverityLevels() |
Returns the list of severity levels that you can assign to a support case. The severity
level for a case is also a field in the CaseDetails data type that you include
for a CreateCase request.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the
Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have
a Business, Enterprise On-Ramp, or Enterprise Support plan, the |
![]() |
DescribeSeverityLevels(DescribeSeverityLevelsRequest) |
Returns the list of severity levels that you can assign to a support case. The severity
level for a case is also a field in the CaseDetails data type that you include
for a CreateCase request.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the
Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have
a Business, Enterprise On-Ramp, or Enterprise Support plan, the |
![]() |
DescribeSeverityLevelsAsync(CancellationToken) |
Returns the list of severity levels that you can assign to a support case. The severity
level for a case is also a field in the CaseDetails data type that you include
for a CreateCase request.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the
Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have
a Business, Enterprise On-Ramp, or Enterprise Support plan, the |
![]() |
DescribeSeverityLevelsAsync(DescribeSeverityLevelsRequest, CancellationToken) |
Returns the list of severity levels that you can assign to a support case. The severity
level for a case is also a field in the CaseDetails data type that you include
for a CreateCase request.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the
Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have
a Business, Enterprise On-Ramp, or Enterprise Support plan, the |
![]() |
DescribeSupportedLanguages(DescribeSupportedLanguagesRequest) |
Returns a list of supported languages for a specified
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the
Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have
a Business, Enterprise On-Ramp, or Enterprise Support plan, the |
![]() |
DescribeSupportedLanguagesAsync(DescribeSupportedLanguagesRequest, CancellationToken) |
Returns a list of supported languages for a specified
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the
Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have
a Business, Enterprise On-Ramp, or Enterprise Support plan, the |
![]() |
DescribeTrustedAdvisorCheckRefreshStatuses(DescribeTrustedAdvisorCheckRefreshStatusesRequest) |
Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
Some checks are refreshed automatically, and you can't return their refresh statuses
by using the
To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide. |
![]() |
DescribeTrustedAdvisorCheckRefreshStatusesAsync(DescribeTrustedAdvisorCheckRefreshStatusesRequest, CancellationToken) |
Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
Some checks are refreshed automatically, and you can't return their refresh statuses
by using the
To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide. |
![]() |
DescribeTrustedAdvisorCheckResult(DescribeTrustedAdvisorCheckResultRequest) |
Returns the results of the Trusted Advisor check that has the specified check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation. The response contains a TrustedAdvisorCheckResult object, which contains these three objects: In addition, the response contains these fields:
To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide. |
![]() |
DescribeTrustedAdvisorCheckResultAsync(DescribeTrustedAdvisorCheckResultRequest, CancellationToken) |
Returns the results of the Trusted Advisor check that has the specified check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation. The response contains a TrustedAdvisorCheckResult object, which contains these three objects: In addition, the response contains these fields:
To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide. |
![]() |
DescribeTrustedAdvisorChecks(DescribeTrustedAdvisorChecksRequest) |
Returns information about all available Trusted Advisor checks, including the name, ID, category, description, and metadata. You must specify a language code. The response contains a TrustedAdvisorCheckDescription object for each check. You must set the Amazon Web Services Region to us-east-1.
To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide. |
![]() |
DescribeTrustedAdvisorChecksAsync(DescribeTrustedAdvisorChecksRequest, CancellationToken) |
Returns information about all available Trusted Advisor checks, including the name, ID, category, description, and metadata. You must specify a language code. The response contains a TrustedAdvisorCheckDescription object for each check. You must set the Amazon Web Services Region to us-east-1.
To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide. |
![]() |
DescribeTrustedAdvisorCheckSummaries(DescribeTrustedAdvisorCheckSummariesRequest) |
Returns the results for the Trusted Advisor check summaries for the check IDs that you specified. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation. The response contains an array of TrustedAdvisorCheckSummary objects.
To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide. |
![]() |
DescribeTrustedAdvisorCheckSummariesAsync(DescribeTrustedAdvisorCheckSummariesRequest, CancellationToken) |
Returns the results for the Trusted Advisor check summaries for the check IDs that you specified. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation. The response contains an array of TrustedAdvisorCheckSummary objects.
To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide. |
![]() |
DetermineServiceOperationEndpoint(AmazonWebServiceRequest) |
Returns the endpoint that will be used for a particular request. |
![]() |
Dispose() | Inherited from Amazon.Runtime.AmazonServiceClient. |
![]() |
RefreshTrustedAdvisorCheck(RefreshTrustedAdvisorCheckRequest) |
Refreshes the Trusted Advisor check that you specify using the check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
Some checks are refreshed automatically. If you call the The response contains a TrustedAdvisorCheckRefreshStatus object.
To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide. |
![]() |
RefreshTrustedAdvisorCheckAsync(RefreshTrustedAdvisorCheckRequest, CancellationToken) |
Refreshes the Trusted Advisor check that you specify using the check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
Some checks are refreshed automatically. If you call the The response contains a TrustedAdvisorCheckRefreshStatus object.
To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide. |
![]() |
ResolveCase(ResolveCaseRequest) |
Resolves a support case. This operation takes a
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the
Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have
a Business, Enterprise On-Ramp, or Enterprise Support plan, the |
![]() |
ResolveCaseAsync(ResolveCaseRequest, CancellationToken) |
Resolves a support case. This operation takes a
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the
Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have
a Business, Enterprise On-Ramp, or Enterprise Support plan, the |
Name | Description | |
---|---|---|
![]() |
AfterResponseEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
![]() |
BeforeRequestEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
![]() |
ExceptionEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5