C# (CSharp) Amazon.AWSSupport.Model Namespace

Nested Namespaces

Amazon.AWSSupport.Model.Internal

Classes

Name Description
AddAttachmentsToSetRequest Container for the parameters to the AddAttachmentsToSet operation. 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.

AddAttachmentsToSetResponse Configuration for accessing Amazon AddAttachmentsToSet service
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 features of the AWS Support Center.

AddCommunicationToCaseResponse Returns information about the AddCommunicationToCaseResult response and response metadata.
AddCommunicationToCaseResult

Returns the objects or data listed below if successful. Otherwise, returns an error.

AttachmentIdNotFoundException
AttachmentLimitExceededException
AttachmentSetExpiredException
AttachmentSetIdNotFoundException
AttachmentSetSizeLimitExceededException
CaseCreationLimitExceededException
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:
  • 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.

  • categoryCode. The category of problem for the AWS Support case. Corresponds to the CategoryCode values returned by a call to DescribeServices.

  • displayId. The identifier for the case on pages in the AWS Support Center.

  • 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.

  • recentCommunications. One or more Communication objects. Fields of these objects are attachments, body, caseId, submittedBy, and timeCreated.

  • nextToken. A resumption point for pagination.

  • serviceCode. The identifier for the AWS service that corresponds to the service code defined in the call to DescribeServices.

  • severityCode. The severity code assigned to the case. Contains one of the values returned by the call to DescribeSeverityLevels.

  • status. The status of the case in the AWS Support Center.

  • subject. The subject line of the case.

  • submittedBy. The email address of the account that submitted the case.

  • timeCreated. The time the case was created, in ISO-8601 format.

CaseIdNotFoundException
Category

JSON-formatted name/value pair that represents the name and category of 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 action 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. Represents a code for an AWS service. You obtain the ServiceCode by calling DescribeServices.
  2. CategoryCode . Represents a category for the service defined for the ServiceCode value. You also obtain the cateogory code for a service by calling DescribeServices. Each AWS service defines its own set of category codes.
  3. SeverityCode . Represents a value that specifies the urgency of the case, and the time interval in which your service level agreement specifies a response from AWS Support. You obtain the SeverityCode by calling DescribeSeverityLevels.
  4. Subject . Represents the Subject field on the AWS Support Center Open a new case page.
  5. CommunicationBody . Represents the Description field on the AWS Support Center Open a new case page.
  6. Language . Specifies the human language in which AWS Support handles the case. The API currently supports English and Japanese.
  7. CcEmailAddresses . Represents 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.

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 DescribeCases request to retrieve existing AWS Support support cases.

CreateCaseResponse Returns information about the CreateCase response and response metadata.
CreateCaseResult

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

DescribeAttachmentLimitExceededException
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 an array of CaseDetails objects and a nextToken that defines a point for pagination in the result set.
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 (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.

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 DescribeServices 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 The list of severity levels returned by the DescribeSeverityLevels operation.
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.

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.

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:

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 DescribeTrustedAdvisorCheck response and response metadata.
DescribeTrustedAdvisorCheckResultResult

Returns the objects or data listed below 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 DescribeTrustedAdvisorCheckSummaries response and response metadata.
DescribeTrustedAdvisorCheckSummariesResult

Returns the objects or data listed below 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 Information about the Trusted Advisor checks returned by the DescribeTrustedAdvisorChecks operation.
DescribeTrustedAdvisorChecksResult

Returns the objects or data listed below if successful. Otherwise, returns an error.

InternalServerErrorException
RecentCaseCommunications

List of Commmunication objects.

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.

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.

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 Information about an AWS service returned by the DescribeServices operation.
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.
TrustedAdvisorCheckResult

The results of a Trusted Advisor check returned by DescribeTrustedAdvisorCheckResult.

TrustedAdvisorCheckSummary

Reports a summary of the Trusted Advisor check. This object contains the following child objects that report summary information about specific checks by category and resource:

  • TrustedAdvisorCategorySpecificSummary
  • TrustedAdvisorResourcesSummary
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.