AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class 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.

Class AddAttachmentsToSetResponse

The ID and expiry time of the attachment set returned by the AddAttachmentsToSet operation.

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

Class AddCommunicationToCaseResponse

The result of the AddCommunicationToCase operation.

Class Attachment

An attachment to a case communication. The attachment consists of the file name and the content of the file.

Class AttachmentDetails

The file name and ID of an attachment to a case communication. You can use the ID to retrieve the attachment with the DescribeAttachment operation.

Class AttachmentIdNotFoundException

AWSSupport exception

Class AttachmentLimitExceededException

AWSSupport exception

Class AttachmentSetExpiredException

AWSSupport exception

Class AttachmentSetIdNotFoundException

AWSSupport exception

Class AttachmentSetSizeLimitExceededException

AWSSupport exception

Class CaseCreationLimitExceededException

AWSSupport exception

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

Class CaseIdNotFoundException

AWSSupport exception

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

Class Communication

A communication associated with an AWS Support case. The communication consists of the case ID, the message body, attachment information, the account email address, and the date and time of the communication.

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

Class CreateCaseResponse

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

Class DescribeAttachmentLimitExceededException

AWSSupport exception

Class DescribeAttachmentRequest

Container for the parameters to the DescribeAttachment operation. 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.

Class DescribeAttachmentResponse

The content and file name of the attachment returned by the DescribeAttachment operation.

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

Class DescribeCasesResponse

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

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

Class DescribeCommunicationsResponse

The communications returned by the DescribeCommunications operation.

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

Class DescribeServicesResponse

The list of AWS services returned by the DescribeServices operation.

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

Class DescribeSeverityLevelsResponse

The list of severity levels returned by the DescribeSeverityLevels operation.

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

Class DescribeTrustedAdvisorCheckRefreshStatusesResponse

The statuses of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckRefreshStatuses operation.

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

Class DescribeTrustedAdvisorCheckResultResponse

The result of the Trusted Advisor check returned by the DescribeTrustedAdvisorCheckResult operation.

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

Class DescribeTrustedAdvisorChecksResponse

Information about the Trusted Advisor checks returned by the DescribeTrustedAdvisorChecks operation.

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

Class DescribeTrustedAdvisorCheckSummariesResponse

The summaries of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckSummaries operation.

Class InternalServerErrorException

AWSSupport exception

Class RecentCaseCommunications

The five most recent communications associated with the case.

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

Class RefreshTrustedAdvisorCheckResponse

The current refresh status of a Trusted Advisor check.

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

Class ResolveCaseResponse

The status of the case returned by the ResolveCase operation.

Class Service

Information about an AWS service returned by the DescribeServices operation.

Class SeverityLevel

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

Class TrustedAdvisorCategorySpecificSummary

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

Class TrustedAdvisorCheckDescription

The description and metadata for a Trusted Advisor check.

Class TrustedAdvisorCheckRefreshStatus

The refresh status of a Trusted Advisor check.

Class TrustedAdvisorCheckResult

The results of a Trusted Advisor check returned by DescribeTrustedAdvisorCheckResult.

Class TrustedAdvisorCheckSummary

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

Class TrustedAdvisorCostOptimizingSummary

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

Class TrustedAdvisorResourceDetail

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

Class TrustedAdvisorResourcesSummary

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