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.
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 |
![]() |
AddAttachmentsToSetResponse | Configuration for accessing Amazon AddAttachmentsToSet service |
![]() |
AddAttachmentsToSetResult | The ID and expiry time of the attachment set returned by the AddAttachmentsToSet operation. |
![]() |
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 | Configuration for accessing Amazon AddCommunicationToCase service |
![]() |
AddCommunicationToCaseResult | The result of the AddCommunicationToCase operation. |
![]() |
Attachment | An attachment to a case communication. The attachment consists of the file name and the content of the file. |
![]() |
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. |
![]() |
AttachmentIdNotFoundException | AWSSupport exception |
![]() |
AttachmentLimitExceededException | AWSSupport exception |
![]() |
AttachmentSetExpiredException | AWSSupport exception |
![]() |
AttachmentSetIdNotFoundException | AWSSupport exception |
![]() |
AttachmentSetSizeLimitExceededException | AWSSupport exception |
![]() |
CaseCreationLimitExceededException | AWSSupport 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:
|
![]() |
CaseIdNotFoundException | AWSSupport 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 | 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. |
![]() |
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:
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. |
![]() |
CreateCaseResponse | Configuration for accessing Amazon CreateCase service |
![]() |
CreateCaseResult | The AWS Support case ID returned by a successful completion of the CreateCase operation. |
![]() |
DescribeAttachmentLimitExceededException | AWSSupport exception |
![]() |
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. |
![]() |
DescribeAttachmentResponse | Configuration for accessing Amazon DescribeAttachment service |
![]() |
DescribeAttachmentResult | The content and file name of the attachment returned by the DescribeAttachment operation. |
![]() |
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:
|
![]() |
DescribeCasesResponse | Configuration for accessing Amazon DescribeCases service |
![]() |
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 |
![]() |
DescribeCommunicationsResponse | Configuration for accessing Amazon DescribeCommunications service |
![]() |
DescribeCommunicationsResult | The communications returned by the DescribeCommunications operation. |
![]() |
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 |
![]() |
DescribeServicesResponse | Configuration for accessing Amazon DescribeServices service |
![]() |
DescribeServicesResult | The list of AWS services returned by the DescribeServices operation. |
![]() |
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 | Configuration for accessing Amazon DescribeSeverityLevels service |
![]() |
DescribeSeverityLevelsResult | The list of severity levels returned by the DescribeSeverityLevels operation. |
![]() |
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 | Configuration for accessing Amazon DescribeTrustedAdvisorCheckRefreshStatuses service |
![]() |
DescribeTrustedAdvisorCheckRefreshStatusesResult | The statuses of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckRefreshStatuses operation. |
![]() |
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:
|
![]() |
DescribeTrustedAdvisorCheckResultResponse | Configuration for accessing Amazon DescribeTrustedAdvisorCheckResult service |
![]() |
DescribeTrustedAdvisorCheckResultResult | The result of the Trusted Advisor check returned by the DescribeTrustedAdvisorCheckResult operation. |
![]() |
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 | Configuration for accessing Amazon DescribeTrustedAdvisorChecks service |
![]() |
DescribeTrustedAdvisorChecksResult | Information about the Trusted Advisor checks returned by the DescribeTrustedAdvisorChecks operation. |
![]() |
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 | Configuration for accessing Amazon DescribeTrustedAdvisorCheckSummaries service |
![]() |
DescribeTrustedAdvisorCheckSummariesResult | The summaries of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckSummaries operation. |
![]() |
InternalServerErrorException | AWSSupport exception |
![]() |
RecentCaseCommunications | 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 TrustedAdvisorCheckRefreshStatus object, which contains these fields:
|
![]() |
RefreshTrustedAdvisorCheckResponse | Configuration for accessing Amazon RefreshTrustedAdvisorCheck service |
![]() |
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 | Configuration for accessing Amazon ResolveCase service |
![]() |
ResolveCaseResult | The status of the case returned by the ResolveCase operation. |
![]() |
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 | 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. |