Amazon.AWSSupport.Model

Container for the parameters to the AddAttachmentsToSet operation. Adds one or more attachments to an attachment set.

An attachment set is a temporary container for attachments that you add to a case or case communication. The set is available for 1 hour after it's created. The expiryTime returned in the response is when the set expires.

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

Container for the parameters to the AddCommunicationToCase operation. Adds additional customer communication to a Amazon Web Services Support case. Use the caseId parameter to identify the case to which to add communication. To list a set of email addresses to copy on the communication, use the ccEmailAddresses parameter. The communicationBody value contains the text of the communication.

To attach files larger than 5 MB to the communication, use the uploadIds parameter.

The result of the AddCommunicationToCase operation.

An attachment to a case communication. The attachment consists of the file name and the content of the file. Each attachment file size should not exceed 5 MB. File types that are supported include the following: pdf, jpeg,.doc, .log, .text

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.

An attachment with the specified ID could not be found.

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 three attachments and 5 MB per attachment.

Paginators for the AWSSupport service

The case creation limit for the account has been exceeded.

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

• caseId - The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-exen-2025-c4c1d2bf33c5cf47.

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

• displayId - The identifier for the case on pages in the Amazon Web Services Support Center.

• language - The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports Chinese (“zh”), English ("en"), Japanese ("ja") , Chinese ("zh"), Spanish ("es"), Portuguese ("pt"), French ("fr"), Korean (“ko”), and Turkish ("tr"). You must specify the ISO 639-1 code for the language parameter if you want support in that language.

• nextToken - A resumption point for pagination.

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

• serviceCode - The identifier for the Amazon Web Services 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. The possible values are: low, normal, high, urgent, and critical.

• status - The status of the case in the Amazon Web Services Support Center. Valid values:

  • all-open

  • customer-action-completed

  • opened

  • pending-customer-action

  • reopened

  • resolved

  • unassigned

  • work-in-progress

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

The requested caseId couldn't be located.

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

A communication associated with a support case. The communication consists of the case ID, the message body, attachment information, the submitter of the communication, and the date and time of the communication.

A JSON-formatted object that contains the CommunicationTypeOptions for creating a case for a certain communication channel. It is contained in the response from a DescribeCreateCaseOptions request. CommunicationTypeOptions contains the following fields:

• datesWithoutSupport - A JSON-formatted list containing date and time ranges for periods without support in UTC time. Date and time format is RFC 3339 : 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'.

• supportedHours - A JSON-formatted list containing time ranges when support are available. Time format is RFC 3339 : 'HH:mm:ss.SSS'.

• type - A string value indicating the communication type that the aforementioned rules apply to. At the moment the type value can assume one of 3 values at the moment chat, web and call.

Container for the parameters to the CompleteAttachmentUpload operation. Completes an attachment upload that was started with GetAttachmentUploadLinks. After you upload a part of the file to its presigned Amazon S3 URL, call CompleteAttachmentUpload with the partIndex and eTag of that part. You can include one part per call, or multiple parts in a single call. After CompleteAttachmentUpload has been called for every part of the file, the service processes the upload asynchronously. The attachment-ready status might not be reflected immediately. Use DescribeAttachmentUploadStatus to poll for the uploadStatus to become attachment-ready before passing the uploadId to CreateCase or AddCommunicationToCase.

This is the response object from the CompleteAttachmentUpload operation.

Identifies a single uploaded part of a multipart attachment upload. Pass a list of CompletedUpload objects to CompleteAttachmentUpload to finalize the upload.

Container for the parameters to the CreateCase operation. Creates a case in the Amazon Web Services Support Center. This operation is similar to how you create a case in the Amazon Web Services Support Center Create Case page.

The Amazon Web Services Support API doesn't support requesting service limit increases. You can submit a service limit increase in the following ways:

• Submit a request from the Amazon Web Services Support Center Create Case page.

• Use the Service Quotas RequestServiceQuotaIncrease operation.

A successful CreateCase request returns a Amazon Web Services Support case number. You can use the DescribeCases operation and specify the case number to get existing Amazon Web Services Support cases. After you create a case, use the AddCommunicationToCase operation to add additional communication or attachments to an existing case.

The caseId is separate from the displayId that appears in the Amazon Web Services Support Center. Use the DescribeCases operation to get the displayId.

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

Date and time (UTC) format in RFC 3339 : 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'.

The limit for the number of DescribeAttachment requests in a short period of time has been exceeded.

Container for the parameters to the DescribeAttachment operation. Returns the attachment that has the specified ID. Attachments can include screenshots, error logs, or other files that describe your issue. 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.

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

Container for the parameters to the DescribeAttachmentUploadStatus operation. Returns the current status, file name, and progress of a multipart attachment upload that was started with GetAttachmentUploadLinks. Use this operation to track where an upload is in the workflow. While parts are still being uploaded and reported through CompleteAttachmentUpload, the uploadStatus is attachment-not-ready and uploadProgress reports the total number of parts and how many have been completed so far. After every part has been reported and the service finishes processing the upload asynchronously, the uploadStatus becomes attachment-ready and the uploadId can be attached to a case through CreateCase or AddCommunicationToCase.

This is the response object from the DescribeAttachmentUploadStatus operation.

Container for the parameters to the DescribeCases operation. Returns a list of cases that you specify by passing one or more case IDs. You can use the afterTime and beforeTime parameters to filter the cases by date. You can set values for the includeResolvedCases and includeCommunications parameters to specify how much information to return.

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.

Case data is available for 24 months after creation. If a case was created more than 24 months ago, a request might return an error.

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

Container for the parameters to the DescribeCommunications operation. Returns communications and attachments for one or more support cases. Use the afterTime and beforeTime parameters to filter by date. You can use the caseId parameter to restrict the results to a specific case.

Case data is available for 24 months after creation. If a case was created more than 24 months ago, a request for data might cause an error.

You can use the maxResults and nextToken parameters to control the pagination of the results. Set maxResults to the number of cases that you want to display on each page, and use nextToken to specify the resumption of pagination.

The communications returned by the DescribeCommunications operation.

Container for the parameters to the DescribeCreateCaseOptions operation. Returns a list of CreateCaseOption types along with the corresponding supported hours and language availability. You can specify the language categoryCode, issueType and serviceCode used to retrieve the CreateCaseOptions.

This is the response object from the DescribeCreateCaseOptions operation.

Container for the parameters to the DescribeServices operation. Returns the current list of Amazon Web Services services and a list of service categories for each service. You then use service names and categories in your CreateCase requests. Each Amazon Web Services service has its own set of categories.

The service codes and category codes correspond to the values that appear in the Service and Category lists on the Amazon Web Services Support Center Create Case page. The values in those fields don't necessarily match the service codes and categories returned by the DescribeServices operation. Always use the service codes and categories that the DescribeServices operation returns, so that you have the most recent set of service and category codes.

The list of Amazon Web Services services returned by the DescribeServices operation.

Container for the parameters to the DescribeSeverityLevels operation. Returns the list of severity levels that you can assign to a support case. The severity level for a case is also a field in the CaseDetails data type that you include for a CreateCase request.

The list of severity levels returned by the DescribeSeverityLevels operation.

Container for the parameters to the DescribeSupportedLanguages operation. Returns a list of supported languages for a specified categoryCode, issueType and serviceCode. The returned supported languages will include a ISO 639-1 code for the language, and the language display name.

This is the response object from the DescribeSupportedLanguages operation.

Container for the parameters to the DescribeTrustedAdvisorCheckRefreshStatuses operation. Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.

Some checks are refreshed automatically, and you can't return their refresh statuses by using the DescribeTrustedAdvisorCheckRefreshStatuses operation. If you call this operation for these checks, you might see an InvalidParameterValue error.

To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.

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

Container for the parameters to the DescribeTrustedAdvisorCheckResult operation. Returns the results of the Trusted Advisor check that has the specified check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.

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 can be 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.

To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.

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

Container for the parameters to the DescribeTrustedAdvisorChecks operation. Returns information about all available Trusted Advisor checks, including the name, ID, category, description, and metadata. You must specify a language code.

The response contains a TrustedAdvisorCheckDescription object for each check. You must set the Amazon Web Services Region to us-east-1.

To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.

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

Container for the parameters to the DescribeTrustedAdvisorCheckSummaries operation. Returns the results for the Trusted Advisor check summaries for the check IDs that you specified. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.

The response contains an array of TrustedAdvisorCheckSummary objects.

To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.

Understanding the Trusted Advisor Resources processed value

The Resources processed value, resourcesProcessed, usually shows both flagged resources (those with warnings or errors) and resources in good standing (ok status resources). However, some checks report flagged resources only. To understand what a specific check reports, review the detailed check information in the Trusted Advisor check reference. If you see a Green criterion listed in the Alert criteria, then the check reports all resources. If there's no Green criterion listed in the Alert criteria, then the check reports only flagged resources. For example, the Amazon EC2 Reserved Instance optimization check (cX3c2R1chu) doesn't list a Green criterion in the Alert criteria. So, this check only reports flagged resources.

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

A presigned URL for downloading an attachment, along with the date and time the URL expires. Returned by GetAttachmentDownloadLink.

The request was valid, but the operation wasn't performed because dryRun was set to true.

Container for the parameters to the GetAttachmentDownloadLink operation. Returns a presigned download URL for an attachment that is associated with a case communication. The download link works for an attachment of any size, including attachments added through AddAttachmentsToSet and attachments uploaded through GetAttachmentUploadLinks. The download URL is time-limited and expires at the date and time indicated in the downloadUrl response field. Download the attachment from the URL before it expires.

This is the response object from the GetAttachmentDownloadLink operation.

Container for the parameters to the GetAttachmentUploadLinks operation. Returns one or more presigned upload URLs for uploading a large file attachment to a support case by using a multipart upload workflow. The maximum file size that you can upload with this workflow is 150 MB, and parts can be up to 100 MB each. Initiate a new upload by providing fileName and fileSizeBytes; the response returns a unique uploadId, the part size, the total number of parts, and a list of presigned upload URLs for the requested range of parts. A maximum of 10 upload URLs are returned per call. To retrieve more upload URLs for an upload that's already in progress, call GetAttachmentUploadLinks again with the existing uploadId and a new uploadRange.

Upload each part to its presigned URL by using HTTP PUT and capture the ETag from the response. After you upload all parts, call CompleteAttachmentUpload with the uploadId and the list of part indexes and ETags to finalize the upload. You can then attach the upload to a case by passing the uploadId in the uploadIds parameter of CreateCase or AddCommunicationToCase. To monitor progress before completion, call DescribeAttachmentUploadStatus.

This is the response object from the GetAttachmentUploadLinks operation.

An internal server error occurred.

The five most recent communications associated with the case.

Container for the parameters to the RefreshTrustedAdvisorCheck operation. Refreshes the Trusted Advisor check that you specify using the check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.

Some checks are refreshed automatically. If you call the RefreshTrustedAdvisorCheck operation to refresh them, you might see the InvalidParameterValue error.

The response contains a TrustedAdvisorCheckRefreshStatus object.

To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.

The current refresh status of a Trusted Advisor check.

Container for the parameters to the ResolveCase operation. Resolves a support case. This operation takes a caseId and returns the initial and final state of the case.

The status of the case returned by the ResolveCase operation.

Information about an Amazon Web Services service returned by the DescribeServices operation.

A code and name pair that represents the severity level of a support case. The available values depend on the support plan for the account. For more information, see Choosing a severity in the Amazon Web Services Support User Guide.

Time range object with startTime and endTime range in RFC 3339 format. 'HH:mm:ss.SSS'.

A JSON-formatted object that contains the available ISO 639-1 language code, language name and langauge display value. The language code is what should be used in the CreateCase call.

You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.

Information about why a request was throttled.

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

The description and metadata for a Trusted Advisor check.

The refresh status of a Trusted Advisor check.

The results of a Trusted Advisor check returned by DescribeTrustedAdvisorCheckResult.

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

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

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

Details about Amazon Web Services resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries.

The specified uploadId couldn't be located.

The progress of a multipart attachment upload, returned by DescribeAttachmentUploadStatus.

The range of part indexes for which to return presigned upload URLs from GetAttachmentUploadLinks.

A presigned URL for uploading a single part of a multipart attachment upload, along with the part index and the date and time the URL expires. Returned by GetAttachmentUploadLinks.

Paginators for the AWSSupport service

Paginator for the DescribeCases operation

Paginator for the DescribeCommunications operation