AWS SDK for .NET Documentation
Amazon.AWSSupport.Model Namespace
AmazonAmazon.AWSSupport.Model Did this page help you?   Yes   No    Tell us about it...
 
Declaration Syntax
C#
namespace Amazon.AWSSupport.Model
Types
All TypesClasses
IconTypeDescription
AddCommunicationToCaseRequest
Container for the parameters to the AddCommunicationToCase operation.

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 behavior on the AWS Support Your Support Cases web form.


AddCommunicationToCaseResponse
Returns information about the AddCommunicationToCaseResult response and response metadata.

AddCommunicationToCaseResult

Contains the following objects or data if successful. Otherwise, returns an error.


CaseCreationLimitExceededException
AmazonAWSSupport exception

CaseDetails

A JSON-formatted object that contains the metadata for a support case. It is contained the response from a DescribeCases request. CaseDetails contains the following fields:

  1. CaseID. The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case- 12345678910-2013-c4c1d2bf33c5cf47 .
  2. CategoryCode. The category of problem for the AWS Support case. Corresponds to the CategoryCode values returned by a call to DescribeServices.
  3. DisplayId. The identifier for the case on pages in the AWS Support Center.
  4. Language. The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
  5. RecentCommunications. One or more Communication objects. Fields of these objects are Body , CaseId , SubmittedBy , and TimeCreated .
  6. NextToken. A resumption point for pagination.
  7. ServiceCode. The identifier for the AWS service that corresponds to the service code defined in the call to DescribeServices.
  8. SeverityCode. The severity code assigned to the case. Contains one of the values returned by the call to DescribeSeverityLevels.
  9. Status. The status of the case in the AWS Support Center.
  10. Subject. The subject line of the case.
  11. SubmittedBy. The email address of the account that submitted the case.
  12. TimeCreated. The time the case was created, in ISO-8601 format.

CaseIdNotFoundException
AmazonAWSSupport exception

Category

A JSON-formatted name/value pair that represents the category name and category code of the problem, selected from the DescribeServices response for each AWS service.


Communication

Exposes the fields used by a communication for an AWS Support case.


CreateCaseRequest
Container for the parameters to the CreateCase operation.

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

  1. ServiceCode. The code for an AWS service. You obtain the ServiceCode by calling DescribeServices.
  2. 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.
  3. 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.
  4. Subject. The Subject field on the AWS Support Center Open a new case page.
  5. CommunicationBody. The Description field on the AWS Support Center Open a new case page.
  6. Language. The human language in which AWS Support handles the case. English and Japanese are currently supported.
  7. CcEmailAddresses. The AWS Support Center CC field on the Open a new 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 .
  8. 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."

NOTE: The AWS Support API does not currently support the ability to add attachments to cases. You can, however, call AddCommunicationToCase to add information to an open case.

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


CreateCaseResponse
Returns information about the CreateCaseResult response and response metadata.

CreateCaseResult

The AWS Support case ID returned by a successful completion of the CreateCase action.


DescribeCasesRequest
Container for the parameters to the DescribeCases operation.

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.

The response returns the following in JSON format:

  1. One or more CaseDetails data types.
  2. One or more NextToken values, which specify where to paginate the returned records represented by the CaseDetails objects.

DescribeCasesResponse
Returns information about the DescribeCasesResult response and response metadata.

DescribeCasesResult

Returns an array of CaseDetails objects and a NextToken that defines a point for pagination in the result set.


DescribeCommunicationsRequest
Container for the parameters to the DescribeCommunications operation.

Returns communications regarding the support case. You can use the AfterTime and BeforeTime parameters to filter by date. The CaseId parameter enables you to identify a specific case by its CaseId value.

The MaxResults and NextToken parameters enable you 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.


DescribeCommunicationsResponse
Returns information about the DescribeCommunicationsResult response and response metadata.

DescribeCommunicationsResult

Contains the following objects or data if successful. Otherwise, returns an error.


DescribeServicesRequest
Container for the parameters to the DescribeServices operation.

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 Open a new 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.


DescribeServicesResponse
Returns information about the DescribeServicesResult response and response metadata.

DescribeServicesResult

Contains the following objects or data if successful. Otherwise, returns an error.


DescribeSeverityLevelsRequest
Container for the parameters to the DescribeSeverityLevels operation.

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.


DescribeSeverityLevelsResponse
Returns information about the DescribeSeverityLevelsResult response and response metadata.

DescribeSeverityLevelsResult

Contains the following objects or data if successful. Otherwise, returns an error.


DescribeTrustedAdvisorCheckRefreshStatusesRequest
Container for the parameters to the DescribeTrustedAdvisorCheckRefreshStatuses operation.

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


DescribeTrustedAdvisorCheckRefreshStatusesResponse
Returns information about the DescribeTrustedAdvisorCheckRefreshStatusesResult response and response metadata.

DescribeTrustedAdvisorCheckRefreshStatusesResult

Contains the following objects or data if successful. Otherwise, returns an error.


DescribeTrustedAdvisorCheckResultRequest
Container for the parameters to the DescribeTrustedAdvisorCheckResult operation.

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:

  • TrustedAdvisorCategorySpecificSummary
  • TrustedAdvisorResourceDetail
  • TrustedAdvisorResourcesSummary

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.

DescribeTrustedAdvisorCheckResultResponse
Returns information about the DescribeTrustedAdvisorCheckResultResult response and response metadata.

DescribeTrustedAdvisorCheckResultResult

Contains the following objects or data if successful. Otherwise, returns an error.


DescribeTrustedAdvisorChecksRequest
Container for the parameters to the DescribeTrustedAdvisorChecks operation.

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.


DescribeTrustedAdvisorChecksResponse
Returns information about the DescribeTrustedAdvisorChecksResult response and response metadata.

DescribeTrustedAdvisorChecksResult

Contains the following objects or data if successful. Otherwise, returns an error.


DescribeTrustedAdvisorCheckSummariesRequest
Container for the parameters to the DescribeTrustedAdvisorCheckSummaries operation.

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.


DescribeTrustedAdvisorCheckSummariesResponse
Returns information about the DescribeTrustedAdvisorCheckSummariesResult response and response metadata.

DescribeTrustedAdvisorCheckSummariesResult

Contains the following objects or data if successful. Otherwise, returns an error.


InternalServerErrorException
AmazonAWSSupport exception

RecentCaseCommunications

Contains the five most recent communications associated with the case.


RefreshTrustedAdvisorCheckRequest
Container for the parameters to the RefreshTrustedAdvisorCheck operation.

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

The response contains a RefreshTrustedAdvisorCheckResult 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.

RefreshTrustedAdvisorCheckResponse
Returns information about the RefreshTrustedAdvisorCheckResult response and response metadata.

RefreshTrustedAdvisorCheckResult

The current refresh status of a Trusted Advisor check.


ResolveCaseRequest
Container for the parameters to the ResolveCase operation.

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


ResolveCaseResponse
Returns information about the ResolveCaseResult response and response metadata.

ResolveCaseResult

Contains the following objects or data if successful. Otherwise, returns an error.


Service

Represents an AWS Service returned by the DescribeServices action.


SeverityLevel

A code and name pair that represent a severity level that can be applied to a support case.


TrustedAdvisorCategorySpecificSummary

The container for summary information that relates to the category of the Trusted Advisor check.


TrustedAdvisorCheckDescription

The description and metadata for a Trusted Advisor check.


TrustedAdvisorCheckRefreshStatus

The refresh status of a Trusted Advisor check.


TrustedAdvisorCheckResponse
Returns information about the TrustedAdvisorCheckResult response and response metadata.

TrustedAdvisorCheckResult

The results of a Trusted Advisor check returned by DescribeTrustedAdvisorCheckResult.


TrustedAdvisorCheckSummary

A summary of a Trusted Advisor check result, including the alert status, last refresh, and number of resources examined.


TrustedAdvisorCostOptimizingSummary

The estimated cost savings that might be realized if the recommended actions are taken.


TrustedAdvisorResourceDetail

Contains information about a resource identified by a Trusted Advisor check.


TrustedAdvisorResourcesSummary

Details about AWS resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries.