C# Class Amazon.AWSSupport.AmazonAWSSupportClient

Implementation for accessing AWSSupport AWS Support

The AWS Support API reference is intended for programmers who need detailed information about the AWS Support operations and data types. This service enables you to manage your AWS Support cases programmatically. It uses HTTP methods that return results in JSON format.

The AWS Support service also exposes a set of Trusted Advisor features. You can retrieve a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks.

The following list describes the AWS Support case management operations:

The following list describes the operations available from the AWS Support service for Trusted Advisor:

For authentication of requests, AWS Support uses Signature Version 4 Signing Process.

See About the AWS Support API in the AWS Support User Guide for information about how to use this service to create and manage your support cases, and how to call Trusted Advisor for results of checks on your resources.

Inheritance: AmazonServiceClient, IAmazonAWSSupport
Datei anzeigen Open project: aws/aws-sdk-net

Public Methods

Method Description
AddAttachmentsToSet ( AddAttachmentsToSetRequest request ) : AddAttachmentsToSetResponse

Adds one or more attachments to an attachment set. If an attachmentSetId is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an attachmentSetId is specified, the attachments are added to the specified set, if it exists.

An attachment set is a temporary container for attachments that are to be added to a case or case communication. The set is available for one hour after it is created; the expiryTime returned in the response indicates when the set expires. The maximum number of attachments in a set is 3, and the maximum size of any attachment in the set is 5 MB.

AddAttachmentsToSetAsync ( AddAttachmentsToSetRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the AddAttachmentsToSet operation.

AddCommunicationToCase ( AddCommunicationToCaseRequest request ) : AddCommunicationToCaseResponse

Adds additional customer communication to an AWS Support case. You use the caseId value to identify the case to add communication to. You can list a set of email addresses to copy on the communication using the ccEmailAddresses value. The communicationBody value contains the text of the communication.

The response indicates the success or failure of the request.

This operation implements a subset of the features of the AWS Support Center.

AddCommunicationToCaseAsync ( AddCommunicationToCaseRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the AddCommunicationToCase operation.

AmazonAWSSupportClient ( ) : System

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 credentials ) : System

Constructs AmazonAWSSupportClient with AWS Credentials

AmazonAWSSupportClient ( AWSCredentials credentials, AmazonAWSSupportConfig clientConfig ) : System

Constructs AmazonAWSSupportClient with AWS Credentials and an AmazonAWSSupportClient Configuration object.

AmazonAWSSupportClient ( AWSCredentials credentials, RegionEndpoint region ) : System

Constructs AmazonAWSSupportClient with AWS Credentials

AmazonAWSSupportClient ( AmazonAWSSupportConfig config ) : System

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 region ) : System

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 ( string awsAccessKeyId, string awsSecretAccessKey ) : System

Constructs AmazonAWSSupportClient with AWS Access Key ID and AWS Secret Key

AmazonAWSSupportClient ( string awsAccessKeyId, string awsSecretAccessKey, AmazonAWSSupportConfig clientConfig ) : System

Constructs AmazonAWSSupportClient with AWS Access Key ID, AWS Secret Key and an AmazonAWSSupportClient Configuration object.

AmazonAWSSupportClient ( string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region ) : System

Constructs AmazonAWSSupportClient with AWS Access Key ID and AWS Secret Key

AmazonAWSSupportClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken ) : System

Constructs AmazonAWSSupportClient with AWS Access Key ID and AWS Secret Key

AmazonAWSSupportClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonAWSSupportConfig clientConfig ) : System

Constructs AmazonAWSSupportClient with AWS Access Key ID, AWS Secret Key and an AmazonAWSSupportClient Configuration object.

AmazonAWSSupportClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region ) : System

Constructs AmazonAWSSupportClient with AWS Access Key ID and AWS Secret Key

BeginAddAttachmentsToSet ( AddAttachmentsToSetRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the AddAttachmentsToSet operation.

BeginAddCommunicationToCase ( AddCommunicationToCaseRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the AddCommunicationToCase operation.

BeginCreateCase ( CreateCaseRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the CreateCase operation.

BeginDescribeAttachment ( DescribeAttachmentRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DescribeAttachment operation.

BeginDescribeCases ( DescribeCasesRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DescribeCases operation.

BeginDescribeCommunications ( DescribeCommunicationsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DescribeCommunications operation.

BeginDescribeServices ( DescribeServicesRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DescribeServices operation.

BeginDescribeSeverityLevels ( DescribeSeverityLevelsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DescribeSeverityLevels operation.

BeginDescribeTrustedAdvisorCheckRefreshStatuses ( DescribeTrustedAdvisorCheckRefreshStatusesRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DescribeTrustedAdvisorCheckRefreshStatuses operation.

BeginDescribeTrustedAdvisorCheckResult ( DescribeTrustedAdvisorCheckResultRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DescribeTrustedAdvisorCheckResult operation.

BeginDescribeTrustedAdvisorCheckSummaries ( DescribeTrustedAdvisorCheckSummariesRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DescribeTrustedAdvisorCheckSummaries operation.

BeginDescribeTrustedAdvisorChecks ( DescribeTrustedAdvisorChecksRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DescribeTrustedAdvisorChecks operation.

BeginRefreshTrustedAdvisorCheck ( RefreshTrustedAdvisorCheckRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the RefreshTrustedAdvisorCheck operation.

BeginResolveCase ( ResolveCaseRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the ResolveCase operation.

CreateCase ( CreateCaseRequest request ) : CreateCaseResponse

Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center Create Case page. Its parameters require you to specify the following information:

  • issueType. The type of issue for the case. You can specify either "customer-service" or "technical." If you do not indicate a value, the default is "technical."

  • serviceCode. The code for an AWS service. You obtain the serviceCode by calling DescribeServices.

  • categoryCode. The category for the service defined for the serviceCode value. You also obtain the category code for a service by calling DescribeServices. Each AWS service defines its own set of category codes.

  • severityCode. A value that indicates the urgency of the case, which in turn determines the response time according to your service level agreement with AWS Support. You obtain the SeverityCode by calling DescribeSeverityLevels.

  • subject. The Subject field on the AWS Support Center Create Case page.

  • communicationBody. The Description field on the AWS Support Center Create Case page.

  • attachmentSetId. The ID of a set of attachments that has been created by using AddAttachmentsToSet.

  • language. The human language in which AWS Support handles the case. English and Japanese are currently supported.

  • ccEmailAddresses. The AWS Support Center CC field on the Create Case page. You can list email addresses to be copied on any correspondence about the case. The account that opens the case is already identified by passing the AWS Credentials in the HTTP POST method or in a method or function call from one of the programming languages supported by an AWS SDK.

To add additional communication or attachments to an existing case, use AddCommunicationToCase.

A successful CreateCase request returns an AWS Support case number. Case numbers are used by the DescribeCases operation to retrieve existing AWS Support cases.

CreateCaseAsync ( CreateCaseRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the CreateCase operation.

DescribeAttachment ( DescribeAttachmentRequest request ) : DescribeAttachmentResponse

Returns the attachment that has the specified ID. 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.

DescribeAttachmentAsync ( DescribeAttachmentRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DescribeAttachment operation.

DescribeCases ( DescribeCasesRequest request ) : DescribeCasesResponse

Returns a list of cases that you specify by passing one or more case IDs. In addition, you can filter the cases by date by setting values for the afterTime and beforeTime request parameters. You can set values for the includeResolvedCases and includeCommunications request parameters to control how much information is returned.

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.

The response returns the following in JSON format:

  • One or more CaseDetails data types.

  • One or more nextToken values, which specify where to paginate the returned records represented by the CaseDetails objects.

DescribeCasesAsync ( DescribeCasesRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DescribeCases operation.

DescribeCommunications ( DescribeCommunicationsRequest request ) : DescribeCommunicationsResponse

Returns communications (and attachments) for one or more support cases. You can use the afterTime and beforeTime parameters to filter by date. You can use the caseId parameter to restrict the results to a particular case.

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 maxResults and nextToken parameters to control the pagination of the result set. Set maxResults to the number of cases you want displayed on each page, and use nextToken to specify the resumption of pagination.

DescribeCommunicationsAsync ( DescribeCommunicationsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DescribeCommunications operation.

DescribeServices ( ) : DescribeServicesResponse

Returns the current list of AWS services and a list of service categories that applies to each one. You then use service names and categories in your CreateCase requests. Each AWS service has its own set of categories.

The service codes and category codes correspond to the values that are displayed in the Service and Category drop-down lists on the AWS Support Center Create Case page. The values in those fields, however, do not necessarily match the service codes and categories returned by the DescribeServices request. Always use the service codes and categories obtained programmatically. This practice ensures that you always have the most recent set of service and category codes.

DescribeServices ( DescribeServicesRequest request ) : DescribeServicesResponse

Returns the current list of AWS services and a list of service categories that applies to each one. You then use service names and categories in your CreateCase requests. Each AWS service has its own set of categories.

The service codes and category codes correspond to the values that are displayed in the Service and Category drop-down lists on the AWS Support Center Create Case page. The values in those fields, however, do not necessarily match the service codes and categories returned by the DescribeServices request. Always use the service codes and categories obtained programmatically. This practice ensures that you always have the most recent set of service and category codes.

DescribeServicesAsync ( DescribeServicesRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DescribeServices operation.

DescribeServicesAsync ( System cancellationToken = default(CancellationToken) ) : Task

Returns the current list of AWS services and a list of service categories that applies to each one. You then use service names and categories in your CreateCase requests. Each AWS service has its own set of categories.

The service codes and category codes correspond to the values that are displayed in the Service and Category drop-down lists on the AWS Support Center Create Case page. The values in those fields, however, do not necessarily match the service codes and categories returned by the DescribeServices request. Always use the service codes and categories obtained programmatically. This practice ensures that you always have the most recent set of service and category codes.

DescribeSeverityLevels ( ) : DescribeSeverityLevelsResponse

Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the CaseDetails data type included in any CreateCase request.

DescribeSeverityLevels ( DescribeSeverityLevelsRequest request ) : DescribeSeverityLevelsResponse

Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the CaseDetails data type included in any CreateCase request.

DescribeSeverityLevelsAsync ( DescribeSeverityLevelsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DescribeSeverityLevels operation.

DescribeSeverityLevelsAsync ( System cancellationToken = default(CancellationToken) ) : Task

Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the CaseDetails data type included in any CreateCase request.

DescribeTrustedAdvisorCheckRefreshStatuses ( DescribeTrustedAdvisorCheckRefreshStatusesRequest request ) : DescribeTrustedAdvisorCheckRefreshStatusesResponse

Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

Some checks are refreshed automatically, and their refresh statuses cannot be retrieved by using this operation. Use of the DescribeTrustedAdvisorCheckRefreshStatuses operation for these checks causes an InvalidParameterValue error.

DescribeTrustedAdvisorCheckRefreshStatusesAsync ( DescribeTrustedAdvisorCheckRefreshStatusesRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DescribeTrustedAdvisorCheckRefreshStatuses operation.

DescribeTrustedAdvisorCheckResult ( DescribeTrustedAdvisorCheckResultRequest request ) : DescribeTrustedAdvisorCheckResultResponse

Returns the results of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

The response contains a TrustedAdvisorCheckResult object, which contains these three objects:

In addition, the response contains these fields:

  • status. The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".

  • timestamp. The time of the last refresh of the check.

  • checkId. The unique identifier for the check.

DescribeTrustedAdvisorCheckResultAsync ( DescribeTrustedAdvisorCheckResultRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DescribeTrustedAdvisorCheckResult operation.

DescribeTrustedAdvisorCheckSummaries ( DescribeTrustedAdvisorCheckSummariesRequest request ) : DescribeTrustedAdvisorCheckSummariesResponse

Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

The response contains an array of TrustedAdvisorCheckSummary objects.

DescribeTrustedAdvisorCheckSummariesAsync ( DescribeTrustedAdvisorCheckSummariesRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DescribeTrustedAdvisorCheckSummaries operation.

DescribeTrustedAdvisorChecks ( DescribeTrustedAdvisorChecksRequest request ) : DescribeTrustedAdvisorChecksResponse

Returns information about all available Trusted Advisor checks, including name, ID, category, description, and metadata. You must specify a language code; English ("en") and Japanese ("ja") are currently supported. The response contains a TrustedAdvisorCheckDescription for each check.

DescribeTrustedAdvisorChecksAsync ( DescribeTrustedAdvisorChecksRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DescribeTrustedAdvisorChecks operation.

EndAddAttachmentsToSet ( IAsyncResult asyncResult ) : AddAttachmentsToSetResponse

Finishes the asynchronous execution of the AddAttachmentsToSet operation.

EndAddCommunicationToCase ( IAsyncResult asyncResult ) : AddCommunicationToCaseResponse

Finishes the asynchronous execution of the AddCommunicationToCase operation.

EndCreateCase ( IAsyncResult asyncResult ) : CreateCaseResponse

Finishes the asynchronous execution of the CreateCase operation.

EndDescribeAttachment ( IAsyncResult asyncResult ) : DescribeAttachmentResponse

Finishes the asynchronous execution of the DescribeAttachment operation.

EndDescribeCases ( IAsyncResult asyncResult ) : DescribeCasesResponse

Finishes the asynchronous execution of the DescribeCases operation.

EndDescribeCommunications ( IAsyncResult asyncResult ) : DescribeCommunicationsResponse

Finishes the asynchronous execution of the DescribeCommunications operation.

EndDescribeServices ( IAsyncResult asyncResult ) : DescribeServicesResponse

Finishes the asynchronous execution of the DescribeServices operation.

EndDescribeSeverityLevels ( IAsyncResult asyncResult ) : DescribeSeverityLevelsResponse

Finishes the asynchronous execution of the DescribeSeverityLevels operation.

EndDescribeTrustedAdvisorCheckRefreshStatuses ( IAsyncResult asyncResult ) : DescribeTrustedAdvisorCheckRefreshStatusesResponse

Finishes the asynchronous execution of the DescribeTrustedAdvisorCheckRefreshStatuses operation.

EndDescribeTrustedAdvisorCheckResult ( IAsyncResult asyncResult ) : DescribeTrustedAdvisorCheckResultResponse

Finishes the asynchronous execution of the DescribeTrustedAdvisorCheckResult operation.

EndDescribeTrustedAdvisorCheckSummaries ( IAsyncResult asyncResult ) : DescribeTrustedAdvisorCheckSummariesResponse

Finishes the asynchronous execution of the DescribeTrustedAdvisorCheckSummaries operation.

EndDescribeTrustedAdvisorChecks ( IAsyncResult asyncResult ) : DescribeTrustedAdvisorChecksResponse

Finishes the asynchronous execution of the DescribeTrustedAdvisorChecks operation.

EndRefreshTrustedAdvisorCheck ( IAsyncResult asyncResult ) : RefreshTrustedAdvisorCheckResponse

Finishes the asynchronous execution of the RefreshTrustedAdvisorCheck operation.

EndResolveCase ( IAsyncResult asyncResult ) : ResolveCaseResponse

Finishes the asynchronous execution of the ResolveCase operation.

RefreshTrustedAdvisorCheck ( RefreshTrustedAdvisorCheckRequest request ) : RefreshTrustedAdvisorCheckResponse

Requests a refresh of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

Some checks are refreshed automatically, and they cannot be refreshed by using this operation. Use of the RefreshTrustedAdvisorCheck operation for these checks causes an InvalidParameterValue error.

The response contains a TrustedAdvisorCheckRefreshStatus object, which contains these fields:

  • status. The refresh status of the check: "none", "enqueued", "processing", "success", or "abandoned".

  • millisUntilNextRefreshable. The amount of time, in milliseconds, until the check is eligible for refresh.

  • checkId. The unique identifier for the check.

RefreshTrustedAdvisorCheckAsync ( RefreshTrustedAdvisorCheckRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the RefreshTrustedAdvisorCheck operation.

ResolveCase ( ResolveCaseRequest request ) : ResolveCaseResponse

Takes a caseId and returns the initial state of the case along with the state of the case after the call to ResolveCase completed.

ResolveCaseAsync ( ResolveCaseRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the ResolveCase operation.

Protected Methods

Method Description
CreateSigner ( ) : AbstractAWSSigner

Creates the signer for the service.

Dispose ( bool disposing ) : void

Disposes the service client.

Method Details

AddAttachmentsToSet() public method

Adds one or more attachments to an attachment set. If an attachmentSetId is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an attachmentSetId is specified, the attachments are added to the specified set, if it exists.

An attachment set is a temporary container for attachments that are to be added to a case or case communication. The set is available for one hour after it is created; the expiryTime returned in the response indicates when the set expires. The maximum number of attachments in a set is 3, and the maximum size of any attachment in the set is 5 MB.

/// The limit for the number of attachment sets created in a short period of time has /// been exceeded. /// /// The expiration time of the attachment set has passed. The set expires 1 hour after /// it is created. /// /// An attachment set with the specified ID could not be found. /// /// A limit for the size of an attachment set has been exceeded. The limits are 3 attachments /// and 5 MB per attachment. /// /// An internal server error occurred. ///
public AddAttachmentsToSet ( AddAttachmentsToSetRequest request ) : AddAttachmentsToSetResponse
request Amazon.AWSSupport.Model.AddAttachmentsToSetRequest Container for the necessary parameters to execute the AddAttachmentsToSet service method.
return Amazon.AWSSupport.Model.AddAttachmentsToSetResponse

AddAttachmentsToSetAsync() public method

Initiates the asynchronous execution of the AddAttachmentsToSet operation.
public AddAttachmentsToSetAsync ( AddAttachmentsToSetRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.AWSSupport.Model.AddAttachmentsToSetRequest Container for the necessary parameters to execute the AddAttachmentsToSet operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

AddCommunicationToCase() public method

Adds additional customer communication to an AWS Support case. You use the caseId value to identify the case to add communication to. You can list a set of email addresses to copy on the communication using the ccEmailAddresses value. The communicationBody value contains the text of the communication.

The response indicates the success or failure of the request.

This operation implements a subset of the features of the AWS Support Center.

/// The expiration time of the attachment set has passed. The set expires 1 hour after /// it is created. /// /// An attachment set with the specified ID could not be found. /// /// The requested caseId could not be located. /// /// An internal server error occurred. ///
public AddCommunicationToCase ( AddCommunicationToCaseRequest request ) : AddCommunicationToCaseResponse
request Amazon.AWSSupport.Model.AddCommunicationToCaseRequest Container for the necessary parameters to execute the AddCommunicationToCase service method.
return Amazon.AWSSupport.Model.AddCommunicationToCaseResponse

AddCommunicationToCaseAsync() public method

Initiates the asynchronous execution of the AddCommunicationToCase operation.
public AddCommunicationToCaseAsync ( AddCommunicationToCaseRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.AWSSupport.Model.AddCommunicationToCaseRequest Container for the necessary parameters to execute the AddCommunicationToCase operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

AmazonAWSSupportClient() public method

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>
public AmazonAWSSupportClient ( ) : System
return System

AmazonAWSSupportClient() public method

Constructs AmazonAWSSupportClient with AWS Credentials
public AmazonAWSSupportClient ( AWSCredentials credentials ) : System
credentials Amazon.Runtime.AWSCredentials AWS Credentials
return System

AmazonAWSSupportClient() public method

Constructs AmazonAWSSupportClient with AWS Credentials and an AmazonAWSSupportClient Configuration object.
public AmazonAWSSupportClient ( AWSCredentials credentials, AmazonAWSSupportConfig clientConfig ) : System
credentials Amazon.Runtime.AWSCredentials AWS Credentials
clientConfig AmazonAWSSupportConfig The AmazonAWSSupportClient Configuration Object
return System

AmazonAWSSupportClient() public method

Constructs AmazonAWSSupportClient with AWS Credentials
public AmazonAWSSupportClient ( AWSCredentials credentials, RegionEndpoint region ) : System
credentials Amazon.Runtime.AWSCredentials AWS Credentials
region RegionEndpoint The region to connect.
return System

AmazonAWSSupportClient() public method

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>
public AmazonAWSSupportClient ( AmazonAWSSupportConfig config ) : System
config AmazonAWSSupportConfig The AmazonAWSSupportClient Configuration Object
return System

AmazonAWSSupportClient() public method

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>
public AmazonAWSSupportClient ( RegionEndpoint region ) : System
region RegionEndpoint The region to connect.
return System

AmazonAWSSupportClient() public method

Constructs AmazonAWSSupportClient with AWS Access Key ID and AWS Secret Key
public AmazonAWSSupportClient ( string awsAccessKeyId, string awsSecretAccessKey ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
return System

AmazonAWSSupportClient() public method

Constructs AmazonAWSSupportClient with AWS Access Key ID, AWS Secret Key and an AmazonAWSSupportClient Configuration object.
public AmazonAWSSupportClient ( string awsAccessKeyId, string awsSecretAccessKey, AmazonAWSSupportConfig clientConfig ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
clientConfig AmazonAWSSupportConfig The AmazonAWSSupportClient Configuration Object
return System

AmazonAWSSupportClient() public method

Constructs AmazonAWSSupportClient with AWS Access Key ID and AWS Secret Key
public AmazonAWSSupportClient ( string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
region RegionEndpoint The region to connect.
return System

AmazonAWSSupportClient() public method

Constructs AmazonAWSSupportClient with AWS Access Key ID and AWS Secret Key
public AmazonAWSSupportClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
awsSessionToken string AWS Session Token
return System

AmazonAWSSupportClient() public method

Constructs AmazonAWSSupportClient with AWS Access Key ID, AWS Secret Key and an AmazonAWSSupportClient Configuration object.
public AmazonAWSSupportClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonAWSSupportConfig clientConfig ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
awsSessionToken string AWS Session Token
clientConfig AmazonAWSSupportConfig The AmazonAWSSupportClient Configuration Object
return System

AmazonAWSSupportClient() public method

Constructs AmazonAWSSupportClient with AWS Access Key ID and AWS Secret Key
public AmazonAWSSupportClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
awsSessionToken string AWS Session Token
region RegionEndpoint The region to connect.
return System

BeginAddAttachmentsToSet() public method

Initiates the asynchronous execution of the AddAttachmentsToSet operation.
public BeginAddAttachmentsToSet ( AddAttachmentsToSetRequest request, AsyncCallback callback, object state ) : IAsyncResult
request AddAttachmentsToSetRequest Container for the necessary parameters to execute the AddAttachmentsToSet operation on AmazonAWSSupportClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginAddCommunicationToCase() public method

Initiates the asynchronous execution of the AddCommunicationToCase operation.
public BeginAddCommunicationToCase ( AddCommunicationToCaseRequest request, AsyncCallback callback, object state ) : IAsyncResult
request AddCommunicationToCaseRequest Container for the necessary parameters to execute the AddCommunicationToCase operation on AmazonAWSSupportClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginCreateCase() public method

Initiates the asynchronous execution of the CreateCase operation.
public BeginCreateCase ( CreateCaseRequest request, AsyncCallback callback, object state ) : IAsyncResult
request CreateCaseRequest Container for the necessary parameters to execute the CreateCase operation on AmazonAWSSupportClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDescribeAttachment() public method

Initiates the asynchronous execution of the DescribeAttachment operation.
public BeginDescribeAttachment ( DescribeAttachmentRequest request, AsyncCallback callback, object state ) : IAsyncResult
request DescribeAttachmentRequest Container for the necessary parameters to execute the DescribeAttachment operation on AmazonAWSSupportClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDescribeCases() public method

Initiates the asynchronous execution of the DescribeCases operation.
public BeginDescribeCases ( DescribeCasesRequest request, AsyncCallback callback, object state ) : IAsyncResult
request DescribeCasesRequest Container for the necessary parameters to execute the DescribeCases operation on AmazonAWSSupportClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDescribeCommunications() public method

Initiates the asynchronous execution of the DescribeCommunications operation.
public BeginDescribeCommunications ( DescribeCommunicationsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request DescribeCommunicationsRequest Container for the necessary parameters to execute the DescribeCommunications operation on AmazonAWSSupportClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDescribeServices() public method

Initiates the asynchronous execution of the DescribeServices operation.
public BeginDescribeServices ( DescribeServicesRequest request, AsyncCallback callback, object state ) : IAsyncResult
request DescribeServicesRequest Container for the necessary parameters to execute the DescribeServices operation on AmazonAWSSupportClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDescribeSeverityLevels() public method

Initiates the asynchronous execution of the DescribeSeverityLevels operation.
public BeginDescribeSeverityLevels ( DescribeSeverityLevelsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request DescribeSeverityLevelsRequest Container for the necessary parameters to execute the DescribeSeverityLevels operation on AmazonAWSSupportClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDescribeTrustedAdvisorCheckRefreshStatuses() public method

Initiates the asynchronous execution of the DescribeTrustedAdvisorCheckRefreshStatuses operation.
public BeginDescribeTrustedAdvisorCheckRefreshStatuses ( DescribeTrustedAdvisorCheckRefreshStatusesRequest request, AsyncCallback callback, object state ) : IAsyncResult
request DescribeTrustedAdvisorCheckRefreshStatusesRequest Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckRefreshStatuses operation on AmazonAWSSupportClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDescribeTrustedAdvisorCheckResult() public method

Initiates the asynchronous execution of the DescribeTrustedAdvisorCheckResult operation.
public BeginDescribeTrustedAdvisorCheckResult ( DescribeTrustedAdvisorCheckResultRequest request, AsyncCallback callback, object state ) : IAsyncResult
request DescribeTrustedAdvisorCheckResultRequest Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckResult operation on AmazonAWSSupportClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDescribeTrustedAdvisorCheckSummaries() public method

Initiates the asynchronous execution of the DescribeTrustedAdvisorCheckSummaries operation.
public BeginDescribeTrustedAdvisorCheckSummaries ( DescribeTrustedAdvisorCheckSummariesRequest request, AsyncCallback callback, object state ) : IAsyncResult
request DescribeTrustedAdvisorCheckSummariesRequest Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckSummaries operation on AmazonAWSSupportClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDescribeTrustedAdvisorChecks() public method

Initiates the asynchronous execution of the DescribeTrustedAdvisorChecks operation.
public BeginDescribeTrustedAdvisorChecks ( DescribeTrustedAdvisorChecksRequest request, AsyncCallback callback, object state ) : IAsyncResult
request DescribeTrustedAdvisorChecksRequest Container for the necessary parameters to execute the DescribeTrustedAdvisorChecks operation on AmazonAWSSupportClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginRefreshTrustedAdvisorCheck() public method

Initiates the asynchronous execution of the RefreshTrustedAdvisorCheck operation.
public BeginRefreshTrustedAdvisorCheck ( RefreshTrustedAdvisorCheckRequest request, AsyncCallback callback, object state ) : IAsyncResult
request RefreshTrustedAdvisorCheckRequest Container for the necessary parameters to execute the RefreshTrustedAdvisorCheck operation on AmazonAWSSupportClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginResolveCase() public method

Initiates the asynchronous execution of the ResolveCase operation.
public BeginResolveCase ( ResolveCaseRequest request, AsyncCallback callback, object state ) : IAsyncResult
request ResolveCaseRequest Container for the necessary parameters to execute the ResolveCase operation on AmazonAWSSupportClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

CreateCase() public method

Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center Create Case page. Its parameters require you to specify the following information:
  • issueType. The type of issue for the case. You can specify either "customer-service" or "technical." If you do not indicate a value, the default is "technical."

  • serviceCode. The code for an AWS service. You obtain the serviceCode by calling DescribeServices.

  • categoryCode. The category for the service defined for the serviceCode value. You also obtain the category code for a service by calling DescribeServices. Each AWS service defines its own set of category codes.

  • severityCode. A value that indicates the urgency of the case, which in turn determines the response time according to your service level agreement with AWS Support. You obtain the SeverityCode by calling DescribeSeverityLevels.

  • subject. The Subject field on the AWS Support Center Create Case page.

  • communicationBody. The Description field on the AWS Support Center Create Case page.

  • attachmentSetId. The ID of a set of attachments that has been created by using AddAttachmentsToSet.

  • language. The human language in which AWS Support handles the case. English and Japanese are currently supported.

  • ccEmailAddresses. The AWS Support Center CC field on the Create Case page. You can list email addresses to be copied on any correspondence about the case. The account that opens the case is already identified by passing the AWS Credentials in the HTTP POST method or in a method or function call from one of the programming languages supported by an AWS SDK.

To add additional communication or attachments to an existing case, use AddCommunicationToCase.

A successful CreateCase request returns an AWS Support case number. Case numbers are used by the DescribeCases operation to retrieve existing AWS Support cases.

/// The expiration time of the attachment set has passed. The set expires 1 hour after /// it is created. /// /// An attachment set with the specified ID could not be found. /// /// The case creation limit for the account has been exceeded. /// /// An internal server error occurred. ///
public CreateCase ( CreateCaseRequest request ) : CreateCaseResponse
request CreateCaseRequest Container for the necessary parameters to execute the CreateCase service method.
return CreateCaseResponse

CreateCaseAsync() public method

Initiates the asynchronous execution of the CreateCase operation.
public CreateCaseAsync ( CreateCaseRequest request, System cancellationToken = default(CancellationToken) ) : Task
request CreateCaseRequest Container for the necessary parameters to execute the CreateCase operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

CreateSigner() protected method

Creates the signer for the service.
protected CreateSigner ( ) : AbstractAWSSigner
return AbstractAWSSigner

DescribeAttachment() public method

Returns the attachment that has the specified ID. 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.
/// An attachment with the specified ID could not be found. /// /// The limit for the number of DescribeAttachment requests in a short period of /// time has been exceeded. /// /// An internal server error occurred. ///
public DescribeAttachment ( DescribeAttachmentRequest request ) : DescribeAttachmentResponse
request DescribeAttachmentRequest Container for the necessary parameters to execute the DescribeAttachment service method.
return DescribeAttachmentResponse

DescribeAttachmentAsync() public method

Initiates the asynchronous execution of the DescribeAttachment operation.
public DescribeAttachmentAsync ( DescribeAttachmentRequest request, System cancellationToken = default(CancellationToken) ) : Task
request DescribeAttachmentRequest Container for the necessary parameters to execute the DescribeAttachment operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeCases() public method

Returns a list of cases that you specify by passing one or more case IDs. In addition, you can filter the cases by date by setting values for the afterTime and beforeTime request parameters. You can set values for the includeResolvedCases and includeCommunications request parameters to control how much information is returned.

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.

The response returns the following in JSON format:

  • One or more CaseDetails data types.

  • One or more nextToken values, which specify where to paginate the returned records represented by the CaseDetails objects.

/// The requested caseId could not be located. /// /// An internal server error occurred. ///
public DescribeCases ( DescribeCasesRequest request ) : DescribeCasesResponse
request DescribeCasesRequest Container for the necessary parameters to execute the DescribeCases service method.
return DescribeCasesResponse

DescribeCasesAsync() public method

Initiates the asynchronous execution of the DescribeCases operation.
public DescribeCasesAsync ( DescribeCasesRequest request, System cancellationToken = default(CancellationToken) ) : Task
request DescribeCasesRequest Container for the necessary parameters to execute the DescribeCases operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeCommunications() public method

Returns communications (and attachments) for one or more support cases. You can use the afterTime and beforeTime parameters to filter by date. You can use the caseId parameter to restrict the results to a particular case.

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 maxResults and nextToken parameters to control the pagination of the result set. Set maxResults to the number of cases you want displayed on each page, and use nextToken to specify the resumption of pagination.

/// The requested caseId could not be located. /// /// An internal server error occurred. ///
public DescribeCommunications ( DescribeCommunicationsRequest request ) : DescribeCommunicationsResponse
request DescribeCommunicationsRequest Container for the necessary parameters to execute the DescribeCommunications service method.
return DescribeCommunicationsResponse

DescribeCommunicationsAsync() public method

Initiates the asynchronous execution of the DescribeCommunications operation.
public DescribeCommunicationsAsync ( DescribeCommunicationsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request DescribeCommunicationsRequest Container for the necessary parameters to execute the DescribeCommunications operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeServices() public method

Returns the current list of AWS services and a list of service categories that applies to each one. You then use service names and categories in your CreateCase requests. Each AWS service has its own set of categories.

The service codes and category codes correspond to the values that are displayed in the Service and Category drop-down lists on the AWS Support Center Create Case page. The values in those fields, however, do not necessarily match the service codes and categories returned by the DescribeServices request. Always use the service codes and categories obtained programmatically. This practice ensures that you always have the most recent set of service and category codes.

/// An internal server error occurred. ///
public DescribeServices ( ) : DescribeServicesResponse
return DescribeServicesResponse

DescribeServices() public method

Returns the current list of AWS services and a list of service categories that applies to each one. You then use service names and categories in your CreateCase requests. Each AWS service has its own set of categories.

The service codes and category codes correspond to the values that are displayed in the Service and Category drop-down lists on the AWS Support Center Create Case page. The values in those fields, however, do not necessarily match the service codes and categories returned by the DescribeServices request. Always use the service codes and categories obtained programmatically. This practice ensures that you always have the most recent set of service and category codes.

/// An internal server error occurred. ///
public DescribeServices ( DescribeServicesRequest request ) : DescribeServicesResponse
request DescribeServicesRequest Container for the necessary parameters to execute the DescribeServices service method.
return DescribeServicesResponse

DescribeServicesAsync() public method

Initiates the asynchronous execution of the DescribeServices operation.
public DescribeServicesAsync ( DescribeServicesRequest request, System cancellationToken = default(CancellationToken) ) : Task
request DescribeServicesRequest Container for the necessary parameters to execute the DescribeServices operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeServicesAsync() public method

Returns the current list of AWS services and a list of service categories that applies to each one. You then use service names and categories in your CreateCase requests. Each AWS service has its own set of categories.

The service codes and category codes correspond to the values that are displayed in the Service and Category drop-down lists on the AWS Support Center Create Case page. The values in those fields, however, do not necessarily match the service codes and categories returned by the DescribeServices request. Always use the service codes and categories obtained programmatically. This practice ensures that you always have the most recent set of service and category codes.

/// An internal server error occurred. ///
public DescribeServicesAsync ( System cancellationToken = default(CancellationToken) ) : Task
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeSeverityLevels() public method

Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the CaseDetails data type included in any CreateCase request.
/// An internal server error occurred. ///
public DescribeSeverityLevels ( ) : DescribeSeverityLevelsResponse
return DescribeSeverityLevelsResponse

DescribeSeverityLevels() public method

Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the CaseDetails data type included in any CreateCase request.
/// An internal server error occurred. ///
public DescribeSeverityLevels ( DescribeSeverityLevelsRequest request ) : DescribeSeverityLevelsResponse
request DescribeSeverityLevelsRequest Container for the necessary parameters to execute the DescribeSeverityLevels service method.
return DescribeSeverityLevelsResponse

DescribeSeverityLevelsAsync() public method

Initiates the asynchronous execution of the DescribeSeverityLevels operation.
public DescribeSeverityLevelsAsync ( DescribeSeverityLevelsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request DescribeSeverityLevelsRequest Container for the necessary parameters to execute the DescribeSeverityLevels operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeSeverityLevelsAsync() public method

Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the CaseDetails data type included in any CreateCase request.
/// An internal server error occurred. ///
public DescribeSeverityLevelsAsync ( System cancellationToken = default(CancellationToken) ) : Task
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeTrustedAdvisorCheckRefreshStatuses() public method

Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

Some checks are refreshed automatically, and their refresh statuses cannot be retrieved by using this operation. Use of the DescribeTrustedAdvisorCheckRefreshStatuses operation for these checks causes an InvalidParameterValue error.

/// An internal server error occurred. ///
public DescribeTrustedAdvisorCheckRefreshStatuses ( DescribeTrustedAdvisorCheckRefreshStatusesRequest request ) : DescribeTrustedAdvisorCheckRefreshStatusesResponse
request DescribeTrustedAdvisorCheckRefreshStatusesRequest Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckRefreshStatuses service method.
return DescribeTrustedAdvisorCheckRefreshStatusesResponse

DescribeTrustedAdvisorCheckRefreshStatusesAsync() public method

Initiates the asynchronous execution of the DescribeTrustedAdvisorCheckRefreshStatuses operation.
public DescribeTrustedAdvisorCheckRefreshStatusesAsync ( DescribeTrustedAdvisorCheckRefreshStatusesRequest request, System cancellationToken = default(CancellationToken) ) : Task
request DescribeTrustedAdvisorCheckRefreshStatusesRequest Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckRefreshStatuses operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeTrustedAdvisorCheckResult() public method

Returns the results of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

The response contains a TrustedAdvisorCheckResult object, which contains these three objects:

In addition, the response contains these fields:

  • status. The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".

  • timestamp. The time of the last refresh of the check.

  • checkId. The unique identifier for the check.

/// An internal server error occurred. ///
public DescribeTrustedAdvisorCheckResult ( DescribeTrustedAdvisorCheckResultRequest request ) : DescribeTrustedAdvisorCheckResultResponse
request DescribeTrustedAdvisorCheckResultRequest Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckResult service method.
return DescribeTrustedAdvisorCheckResultResponse

DescribeTrustedAdvisorCheckResultAsync() public method

Initiates the asynchronous execution of the DescribeTrustedAdvisorCheckResult operation.
public DescribeTrustedAdvisorCheckResultAsync ( DescribeTrustedAdvisorCheckResultRequest request, System cancellationToken = default(CancellationToken) ) : Task
request DescribeTrustedAdvisorCheckResultRequest Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckResult operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeTrustedAdvisorCheckSummaries() public method

Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

The response contains an array of TrustedAdvisorCheckSummary objects.

/// An internal server error occurred. ///
public DescribeTrustedAdvisorCheckSummaries ( DescribeTrustedAdvisorCheckSummariesRequest request ) : DescribeTrustedAdvisorCheckSummariesResponse
request DescribeTrustedAdvisorCheckSummariesRequest Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckSummaries service method.
return DescribeTrustedAdvisorCheckSummariesResponse

DescribeTrustedAdvisorCheckSummariesAsync() public method

Initiates the asynchronous execution of the DescribeTrustedAdvisorCheckSummaries operation.
public DescribeTrustedAdvisorCheckSummariesAsync ( DescribeTrustedAdvisorCheckSummariesRequest request, System cancellationToken = default(CancellationToken) ) : Task
request DescribeTrustedAdvisorCheckSummariesRequest Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckSummaries operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeTrustedAdvisorChecks() public method

Returns information about all available Trusted Advisor checks, including name, ID, category, description, and metadata. You must specify a language code; English ("en") and Japanese ("ja") are currently supported. The response contains a TrustedAdvisorCheckDescription for each check.
/// An internal server error occurred. ///
public DescribeTrustedAdvisorChecks ( DescribeTrustedAdvisorChecksRequest request ) : DescribeTrustedAdvisorChecksResponse
request DescribeTrustedAdvisorChecksRequest Container for the necessary parameters to execute the DescribeTrustedAdvisorChecks service method.
return DescribeTrustedAdvisorChecksResponse

DescribeTrustedAdvisorChecksAsync() public method

Initiates the asynchronous execution of the DescribeTrustedAdvisorChecks operation.
public DescribeTrustedAdvisorChecksAsync ( DescribeTrustedAdvisorChecksRequest request, System cancellationToken = default(CancellationToken) ) : Task
request DescribeTrustedAdvisorChecksRequest Container for the necessary parameters to execute the DescribeTrustedAdvisorChecks operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

Dispose() protected method

Disposes the service client.
protected Dispose ( bool disposing ) : void
disposing bool
return void

EndAddAttachmentsToSet() public method

Finishes the asynchronous execution of the AddAttachmentsToSet operation.
public EndAddAttachmentsToSet ( IAsyncResult asyncResult ) : AddAttachmentsToSetResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginAddAttachmentsToSet.
return AddAttachmentsToSetResponse

EndAddCommunicationToCase() public method

Finishes the asynchronous execution of the AddCommunicationToCase operation.
public EndAddCommunicationToCase ( IAsyncResult asyncResult ) : AddCommunicationToCaseResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginAddCommunicationToCase.
return AddCommunicationToCaseResponse

EndCreateCase() public method

Finishes the asynchronous execution of the CreateCase operation.
public EndCreateCase ( IAsyncResult asyncResult ) : CreateCaseResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginCreateCase.
return CreateCaseResponse

EndDescribeAttachment() public method

Finishes the asynchronous execution of the DescribeAttachment operation.
public EndDescribeAttachment ( IAsyncResult asyncResult ) : DescribeAttachmentResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDescribeAttachment.
return DescribeAttachmentResponse

EndDescribeCases() public method

Finishes the asynchronous execution of the DescribeCases operation.
public EndDescribeCases ( IAsyncResult asyncResult ) : DescribeCasesResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDescribeCases.
return DescribeCasesResponse

EndDescribeCommunications() public method

Finishes the asynchronous execution of the DescribeCommunications operation.
public EndDescribeCommunications ( IAsyncResult asyncResult ) : DescribeCommunicationsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDescribeCommunications.
return DescribeCommunicationsResponse

EndDescribeServices() public method

Finishes the asynchronous execution of the DescribeServices operation.
public EndDescribeServices ( IAsyncResult asyncResult ) : DescribeServicesResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDescribeServices.
return DescribeServicesResponse

EndDescribeSeverityLevels() public method

Finishes the asynchronous execution of the DescribeSeverityLevels operation.
public EndDescribeSeverityLevels ( IAsyncResult asyncResult ) : DescribeSeverityLevelsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDescribeSeverityLevels.
return DescribeSeverityLevelsResponse

EndDescribeTrustedAdvisorCheckRefreshStatuses() public method

Finishes the asynchronous execution of the DescribeTrustedAdvisorCheckRefreshStatuses operation.
public EndDescribeTrustedAdvisorCheckRefreshStatuses ( IAsyncResult asyncResult ) : DescribeTrustedAdvisorCheckRefreshStatusesResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDescribeTrustedAdvisorCheckRefreshStatuses.
return DescribeTrustedAdvisorCheckRefreshStatusesResponse

EndDescribeTrustedAdvisorCheckResult() public method

Finishes the asynchronous execution of the DescribeTrustedAdvisorCheckResult operation.
public EndDescribeTrustedAdvisorCheckResult ( IAsyncResult asyncResult ) : DescribeTrustedAdvisorCheckResultResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDescribeTrustedAdvisorCheckResult.
return DescribeTrustedAdvisorCheckResultResponse

EndDescribeTrustedAdvisorCheckSummaries() public method

Finishes the asynchronous execution of the DescribeTrustedAdvisorCheckSummaries operation.
public EndDescribeTrustedAdvisorCheckSummaries ( IAsyncResult asyncResult ) : DescribeTrustedAdvisorCheckSummariesResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDescribeTrustedAdvisorCheckSummaries.
return DescribeTrustedAdvisorCheckSummariesResponse

EndDescribeTrustedAdvisorChecks() public method

Finishes the asynchronous execution of the DescribeTrustedAdvisorChecks operation.
public EndDescribeTrustedAdvisorChecks ( IAsyncResult asyncResult ) : DescribeTrustedAdvisorChecksResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDescribeTrustedAdvisorChecks.
return DescribeTrustedAdvisorChecksResponse

EndRefreshTrustedAdvisorCheck() public method

Finishes the asynchronous execution of the RefreshTrustedAdvisorCheck operation.
public EndRefreshTrustedAdvisorCheck ( IAsyncResult asyncResult ) : RefreshTrustedAdvisorCheckResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginRefreshTrustedAdvisorCheck.
return RefreshTrustedAdvisorCheckResponse

EndResolveCase() public method

Finishes the asynchronous execution of the ResolveCase operation.
public EndResolveCase ( IAsyncResult asyncResult ) : ResolveCaseResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginResolveCase.
return ResolveCaseResponse

RefreshTrustedAdvisorCheck() public method

Requests a refresh of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

Some checks are refreshed automatically, and they cannot be refreshed by using this operation. Use of the RefreshTrustedAdvisorCheck operation for these checks causes an InvalidParameterValue error.

The response contains a TrustedAdvisorCheckRefreshStatus object, which contains these fields:

  • status. The refresh status of the check: "none", "enqueued", "processing", "success", or "abandoned".

  • millisUntilNextRefreshable. The amount of time, in milliseconds, until the check is eligible for refresh.

  • checkId. The unique identifier for the check.

/// An internal server error occurred. ///
public RefreshTrustedAdvisorCheck ( RefreshTrustedAdvisorCheckRequest request ) : RefreshTrustedAdvisorCheckResponse
request RefreshTrustedAdvisorCheckRequest Container for the necessary parameters to execute the RefreshTrustedAdvisorCheck service method.
return RefreshTrustedAdvisorCheckResponse

RefreshTrustedAdvisorCheckAsync() public method

Initiates the asynchronous execution of the RefreshTrustedAdvisorCheck operation.
public RefreshTrustedAdvisorCheckAsync ( RefreshTrustedAdvisorCheckRequest request, System cancellationToken = default(CancellationToken) ) : Task
request RefreshTrustedAdvisorCheckRequest Container for the necessary parameters to execute the RefreshTrustedAdvisorCheck operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

ResolveCase() public method

Takes a caseId and returns the initial state of the case along with the state of the case after the call to ResolveCase completed.
/// The requested caseId could not be located. /// /// An internal server error occurred. ///
public ResolveCase ( ResolveCaseRequest request ) : ResolveCaseResponse
request ResolveCaseRequest Container for the necessary parameters to execute the ResolveCase service method.
return ResolveCaseResponse

ResolveCaseAsync() public method

Initiates the asynchronous execution of the ResolveCase operation.
public ResolveCaseAsync ( ResolveCaseRequest request, System cancellationToken = default(CancellationToken) ) : Task
request ResolveCaseRequest Container for the necessary parameters to execute the ResolveCase operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task