{ "version": "2.0", "service": "Amazon Web Services Support

The Amazon Web Services Support API Reference is intended for programmers who need detailed information about the Amazon Web Services Support operations and data types. You can use the API to manage your support cases programmatically. The Amazon Web Services Support API uses HTTP methods that return results in JSON format.

You can also use the Amazon Web Services Support API to access features for Trusted Advisor. You can return a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks.

You can manage your support cases with the following Amazon Web Services Support API operations:

You can also use the Amazon Web Services Support API to call the Trusted Advisor operations. For more information, see Trusted Advisor in the Amazon Web Services Support User Guide.

For authentication of requests, Amazon Web Services Support uses Signature Version 4 Signing Process.

For more information about this service and the endpoints to use, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.

", "operations": { "AddAttachmentsToSet": "

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.

", "AddCommunicationToCase": "

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.

Amazon Web Services Support automatically redacts sensitive information from support cases to protect your data. The following information is replaced with [REDACTED_BY_Amazon Web Services] and is not stored:

This sensitive information is never required by Amazon Web Services Support.

 ", "CompleteAttachmentUpload": "

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.

", "CreateCase": "

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:

Amazon Web Services Support automatically redacts sensitive information from support cases to protect your data. The following information is replaced with [REDACTED_BY_Amazon Web Services] and is not stored:

This sensitive information is never required by Amazon Web Services Support.

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.

", "DescribeAttachment": "

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.

DescribeAttachment can't return attachments larger than 5 MB. If the specified attachmentId refers to an attachment larger than 5 MB, the request fails with InvalidParameterValueException.

To download an attachment of any size, including attachments larger than 5 MB, use GetAttachmentDownloadLink. GetAttachmentDownloadLink returns an Amazon S3 presigned URL that you can use to download the attachment directly.

", "DescribeAttachmentUploadStatus": "

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.

", "DescribeCases": "

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:

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.

Each Communication returned by this operation includes attachment information in two fields:

Amazon Web Services recommends that you use the attachments field and download each attachment with GetAttachmentDownloadLink, which supports attachments of any size. The attachmentSet field and DescribeAttachment return only attachments that are 5 MB or smaller.

", "DescribeCommunications": "

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.

Each Communication returned by this operation includes attachment information in two fields:

Amazon Web Services recommends that you use the attachments field and download each attachment with GetAttachmentDownloadLink, which supports attachments of any size. The attachmentSet field and DescribeAttachment return only attachments that are 5 MB or smaller.

", "DescribeCreateCaseOptions": "

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.

", "DescribeServices": "

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.

", "DescribeSeverityLevels": "

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.

", "DescribeSupportedLanguages": "

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.

", "DescribeTrustedAdvisorCheckRefreshStatuses": "

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.

", "DescribeTrustedAdvisorCheckResult": "

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:

In addition, the response contains these fields:

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.

", "DescribeTrustedAdvisorCheckSummaries": "

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.

", "DescribeTrustedAdvisorChecks": "

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.

", "GetAttachmentDownloadLink": "

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.

", "GetAttachmentUploadLinks": "

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.

", "RefreshTrustedAdvisorCheck": "

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.

", "ResolveCase": "

Resolves a support case. This operation takes a caseId and returns the initial and final state of the case.

" }, "shapes": { "AddAttachmentsToSetRequest": { "base": null, "refs": {} }, "AddAttachmentsToSetResponse": { "base": "

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

", "refs": {} }, "AddCommunicationToCaseRequest": { "base": null, "refs": {} }, "AddCommunicationToCaseResponse": { "base": "

The result of the AddCommunicationToCase operation.

", "refs": {} }, "AfterTime": { "base": null, "refs": { "DescribeCasesRequest$afterTime": "

The start date for a filtered date search on support case communications. Case communications are available for 24 months after creation.

", "DescribeCommunicationsRequest$afterTime": "

The start date for a filtered date search on support case communications. Case communications are available for 24 months after creation.

" } }, "Attachment": { "base": "

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

", "refs": { "Attachments$member": null, "DescribeAttachmentResponse$attachment": "

This object includes the attachment content and file name.

In the previous response syntax, the value for the data parameter appears as blob, which is represented as a base64-encoded string. The value for fileName is the name of the attachment, such as troubleshoot-screenshot.png.

" } }, "AttachmentDetails": { "base": "

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.

", "refs": { "AttachmentSet$member": null } }, "AttachmentId": { "base": null, "refs": { "AttachmentDetails$attachmentId": "

The ID of the attachment.

", "DescribeAttachmentRequest$attachmentId": "

The ID of the attachment to return. Attachment IDs are returned by the DescribeCommunications operation.

If the specified attachment is larger than 5 MB, this operation returns InvalidParameterValueException. To download attachments larger than 5 MB, use GetAttachmentDownloadLink.

", "GetAttachmentDownloadLinkRequest$attachmentId": "

The unique identifier of the attachment for which to retrieve a download link. Attachment IDs are returned in the AttachmentDetails objects in the attachments field of a Communication returned by DescribeCommunications or DescribeCases.

" } }, "AttachmentIdNotFound": { "base": "

An attachment with the specified ID could not be found.

", "refs": {} }, "AttachmentLimitExceeded": { "base": "

The limit for the number of attachment sets created in a short period of time has been exceeded.

", "refs": {} }, "AttachmentSet": { "base": null, "refs": { "Communication$attachments": "

Information about all attachments on the case communication. This includes attachments added through AddAttachmentsToSet and attachments uploaded through GetAttachmentUploadLinks.

Use this field to enumerate every attachment on the communication. To download an attachment listed in this field, use GetAttachmentDownloadLink. GetAttachmentDownloadLink returns a presigned URL that works for attachments of any size.

", "Communication$attachmentSet": "

Information about the attachments to the case communication that are 5 MB or smaller. This field doesn't include attachments larger than 5 MB. To enumerate every attachment on the communication, including attachments larger than 5 MB, use the attachments field instead.

" } }, "AttachmentSetExpired": { "base": "

The expiration time of the attachment set has passed. The set expires 1 hour after it is created.

", "refs": {} }, "AttachmentSetId": { "base": null, "refs": { "AddAttachmentsToSetRequest$attachmentSetId": "

The ID of the 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.

", "AddAttachmentsToSetResponse$attachmentSetId": "

The ID of the attachment set. If an attachmentSetId was not specified, a new attachment set is created, and the ID of the set is returned in the response. If an attachmentSetId was specified, the attachments are added to the specified set, if it exists.

", "AddCommunicationToCaseRequest$attachmentSetId": "

The ID of a set of one or more attachments for the communication to add to the case. Create the set by calling AddAttachmentsToSet. Each attachment in the set must be 5 MB or smaller. To attach files larger than 5 MB, use uploadIds.

", "CreateCaseRequest$attachmentSetId": "

The ID of a set of one or more attachments for the case. Create the set by using the AddAttachmentsToSet operation. Each attachment in the set must be 5 MB or smaller. To attach files larger than 5 MB, use uploadIds.

" } }, "AttachmentSetIdNotFound": { "base": "

An attachment set with the specified ID could not be found.

", "refs": {} }, "AttachmentSetSizeLimitExceeded": { "base": "

A limit for the size of an attachment set has been exceeded. The limits are three attachments and 5 MB per attachment.

", "refs": {} }, "Attachments": { "base": null, "refs": { "AddAttachmentsToSetRequest$attachments": "

One or more attachments to add to the set. You can add up to three attachments per set. The size limit is 5 MB per attachment.

In the Attachment object, use the data parameter to specify the contents of the attachment file. In the previous request syntax, the value for data appear as blob, which is represented as a base64-encoded string. The value for fileName is the name of the attachment, such as troubleshoot-screenshot.png.

" } }, "AvailabilityErrorMessage": { "base": null, "refs": { "ThrottlingException$message": null } }, "BeforeTime": { "base": null, "refs": { "DescribeCasesRequest$beforeTime": "

The end date for a filtered date search on support case communications. Case communications are available for 24 months after creation.

", "DescribeCommunicationsRequest$beforeTime": "

The end date for a filtered date search on support case communications. Case communications are available for 24 months after creation.

" } }, "Boolean": { "base": null, "refs": { "TrustedAdvisorCheckSummary$hasFlaggedResources": "

Specifies whether the Trusted Advisor check has flagged resources.

", "TrustedAdvisorResourceDetail$isSuppressed": "

Specifies whether the Amazon Web Services resource was ignored by Trusted Advisor because it was marked as suppressed by the user.

" } }, "CaseCreationLimitExceeded": { "base": "

The case creation limit for the account has been exceeded.

", "refs": {} }, "CaseDetails": { "base": "

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:

", "refs": { "CaseList$member": null } }, "CaseId": { "base": null, "refs": { "AddCommunicationToCaseRequest$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

", "CaseDetails$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

", "CaseIdList$member": null, "Communication$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

", "CreateCaseResponse$caseId": "

The support case ID requested or returned in the call. The case ID is an alphanumeric string in the following format: case-12345678910-exen-2025-c4c1d2bf33c5cf47

", "DescribeCommunicationsRequest$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

", "ResolveCaseRequest$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

" } }, "CaseIdList": { "base": null, "refs": { "DescribeCasesRequest$caseIdList": "

A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.

" } }, "CaseIdNotFound": { "base": "

The requested caseId couldn't be located.

", "refs": {} }, "CaseList": { "base": null, "refs": { "DescribeCasesResponse$cases": "

The details for the cases that match the request.

" } }, "CaseStatus": { "base": null, "refs": { "ResolveCaseResponse$initialCaseStatus": "

The status of the case when the ResolveCase request was sent.

", "ResolveCaseResponse$finalCaseStatus": "

The status of the case after the ResolveCase request was processed.

" } }, "Category": { "base": "

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.

", "refs": { "CategoryList$member": null } }, "CategoryCode": { "base": null, "refs": { "CaseDetails$categoryCode": "

The category of problem for the support case.

", "Category$code": "

The category code for the support case.

", "CreateCaseRequest$categoryCode": "

The category of problem for the support case. You also use the DescribeServices operation to get the category code for a service. Each Amazon Web Services service defines its own set of category codes.

", "DescribeCreateCaseOptionsRequest$categoryCode": "

The category of problem for the support case. You also use the DescribeServices operation to get the category code for a service. Each Amazon Web Services service defines its own set of category codes.

" } }, "CategoryList": { "base": null, "refs": { "Service$categories": "

A list of categories that describe the type of support issue a case describes. Categories consist of a category name and a category code. Category names and codes are passed to Amazon Web Services Support when you call CreateCase.

" } }, "CategoryName": { "base": null, "refs": { "Category$name": "

The category name for the support case.

" } }, "CcEmailAddress": { "base": null, "refs": { "CcEmailAddressList$member": null } }, "CcEmailAddressList": { "base": null, "refs": { "AddCommunicationToCaseRequest$ccEmailAddresses": "

The email addresses in the CC line of an email to be added to the support case.

", "CaseDetails$ccEmailAddresses": "

The email addresses that receive copies of communication about the case.

", "CreateCaseRequest$ccEmailAddresses": "

A list of email addresses that Amazon Web Services Support copies on case correspondence. Amazon Web Services Support identifies the account that creates the case when you specify your Amazon Web Services credentials in an HTTP POST method or use the Amazon Web Services SDKs.

" } }, "Code": { "base": null, "refs": { "SupportedLanguage$code": "

2 digit ISO 639-1 code. e.g. en

" } }, "Communication": { "base": "

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.

", "refs": { "CommunicationList$member": null } }, "CommunicationBody": { "base": null, "refs": { "AddCommunicationToCaseRequest$communicationBody": "

The body of an email communication to add to the support case.

", "CreateCaseRequest$communicationBody": "

The communication body text that describes the issue. This text appears in the Description field on the Amazon Web Services Support Center Create Case page.

" } }, "CommunicationList": { "base": null, "refs": { "DescribeCommunicationsResponse$communications": "

The communications for the case.

", "RecentCaseCommunications$communications": "

The five most recent communications associated with the case.

" } }, "CommunicationTypeOptions": { "base": "

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:

", "refs": { "CommunicationTypeOptionsList$member": null } }, "CommunicationTypeOptionsList": { "base": null, "refs": { "DescribeCreateCaseOptionsResponse$communicationTypes": "

A JSON-formatted array that contains the available communication type options, along with the available support timeframes for the given inputs.

" } }, "CompleteAttachmentUploadRequest": { "base": null, "refs": {} }, "CompleteAttachmentUploadResponse": { "base": null, "refs": {} }, "CompletedUpload": { "base": "

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

", "refs": { "CompletedUploadList$member": null } }, "CompletedUploadList": { "base": null, "refs": { "CompleteAttachmentUploadRequest$completedUploads": "

The list of parts being reported as completed in this call. Each entry must contain the partIndex of an uploaded part and the ETag returned by Amazon S3 when that part was uploaded.

" } }, "CoralAvailabilityThrottledResource": { "base": null, "refs": { "ThrottlingReason$resource": "

The resource that caused the request to be throttled.

" } }, "CoralAvailabilityThrottlingReason": { "base": null, "refs": { "ThrottlingReason$reason": "

The reason that the request was throttled.

" } }, "CreateCaseRequest": { "base": null, "refs": {} }, "CreateCaseResponse": { "base": "

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

", "refs": {} }, "Data": { "base": null, "refs": { "Attachment$data": "

The content of the attachment file.

" } }, "DateInterval": { "base": "

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

", "refs": { "DatesWithoutSupportList$member": null } }, "DatesWithoutSupportList": { "base": null, "refs": { "CommunicationTypeOptions$datesWithoutSupport": "

A JSON-formatted list containing date and time ranges for periods without support

" } }, "DescribeAttachmentLimitExceeded": { "base": "

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

", "refs": {} }, "DescribeAttachmentRequest": { "base": null, "refs": {} }, "DescribeAttachmentResponse": { "base": "

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

", "refs": {} }, "DescribeAttachmentUploadStatusRequest": { "base": null, "refs": {} }, "DescribeAttachmentUploadStatusResponse": { "base": null, "refs": {} }, "DescribeCasesRequest": { "base": null, "refs": {} }, "DescribeCasesResponse": { "base": "

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

", "refs": {} }, "DescribeCommunicationsRequest": { "base": null, "refs": {} }, "DescribeCommunicationsResponse": { "base": "

The communications returned by the DescribeCommunications operation.

", "refs": {} }, "DescribeCreateCaseOptionsRequest": { "base": null, "refs": {} }, "DescribeCreateCaseOptionsResponse": { "base": null, "refs": {} }, "DescribeServicesRequest": { "base": null, "refs": {} }, "DescribeServicesResponse": { "base": "

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

", "refs": {} }, "DescribeSeverityLevelsRequest": { "base": null, "refs": {} }, "DescribeSeverityLevelsResponse": { "base": "

The list of severity levels returned by the DescribeSeverityLevels operation.

", "refs": {} }, "DescribeSupportedLanguagesRequest": { "base": null, "refs": {} }, "DescribeSupportedLanguagesResponse": { "base": null, "refs": {} }, "DescribeTrustedAdvisorCheckRefreshStatusesRequest": { "base": null, "refs": {} }, "DescribeTrustedAdvisorCheckRefreshStatusesResponse": { "base": "

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

", "refs": {} }, "DescribeTrustedAdvisorCheckResultRequest": { "base": "

", "refs": {} }, "DescribeTrustedAdvisorCheckResultResponse": { "base": "

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

", "refs": {} }, "DescribeTrustedAdvisorCheckSummariesRequest": { "base": null, "refs": {} }, "DescribeTrustedAdvisorCheckSummariesResponse": { "base": "

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

", "refs": {} }, "DescribeTrustedAdvisorChecksRequest": { "base": null, "refs": {} }, "DescribeTrustedAdvisorChecksResponse": { "base": "

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

", "refs": {} }, "Display": { "base": null, "refs": { "SupportedLanguage$display": "

Language display value e.g. ENGLISH

" } }, "DisplayId": { "base": null, "refs": { "CaseDetails$displayId": "

The ID displayed for the case in the Amazon Web Services Support Center. This is a numeric string.

", "DescribeCasesRequest$displayId": "

The ID displayed for a case in the Amazon Web Services Support Center user interface.

" } }, "Double": { "base": null, "refs": { "TrustedAdvisorCostOptimizingSummary$estimatedMonthlySavings": "

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

", "TrustedAdvisorCostOptimizingSummary$estimatedPercentMonthlySavings": "

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

" } }, "DownloadUrl": { "base": "

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

", "refs": { "GetAttachmentDownloadLinkResponse$downloadUrl": "

The presigned download URL and the date and time the URL expires.

" } }, "DryRunOperationException": { "base": "

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

", "refs": {} }, "ETag": { "base": null, "refs": { "CompletedUpload$eTag": "

The ETag returned in the response headers when the part was uploaded to Amazon S3. The ETag value identifies the part contents.

" } }, "EndIndex": { "base": null, "refs": { "UploadRange$endIndex": "

The ending part index of the range, exclusive. The range is half-open: startIndex is inclusive and endIndex is exclusive. For example, a range with startIndex of 1 and endIndex of 4 requests URLs for parts 1, 2, and 3. The range size (endIndex - startIndex) must not exceed 10. If you omit endIndex, the service defaults to startIndex + 10, capped by the total number of parts.

" } }, "EndTime": { "base": null, "refs": { "SupportedHour$endTime": "

End Time. RFC 3339 format 'HH:mm:ss.SSS'.

" } }, "ErrorMessage": { "base": null, "refs": { "AttachmentIdNotFound$message": "

An attachment with the specified ID could not be found.

", "AttachmentLimitExceeded$message": "

The limit for the number of attachment sets created in a short period of time has been exceeded.

", "AttachmentSetExpired$message": "

The expiration time of the attachment set has passed. The set expires one hour after it is created.

", "AttachmentSetIdNotFound$message": "

An attachment set with the specified ID could not be found.

", "AttachmentSetSizeLimitExceeded$message": "

A limit for the size of an attachment set has been exceeded. The limits are three attachments and 5 MB per attachment.

", "CaseCreationLimitExceeded$message": "

An error message that indicates that you have exceeded the number of cases you can have open.

", "CaseIdNotFound$message": "

The requested CaseId could not be located.

", "DescribeAttachmentLimitExceeded$message": "

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

", "DryRunOperationException$message": null, "InternalServerError$message": "

An internal server error occurred.

", "UploadIdNotFound$message": null } }, "ExpiryTime": { "base": null, "refs": { "AddAttachmentsToSetResponse$expiryTime": "

The time and date when the attachment set expires.

" } }, "FieldIntegerValue": { "base": null, "refs": { "CompletedUpload$partIndex": "

The index of the uploaded part. This is the same partIndex value returned for the corresponding entry in the uploadUrls field of the GetAttachmentUploadLinks response.

", "UploadProgress$totalParts": "

The total number of parts that the file is split into.

", "UploadProgress$completedPartsCount": "

The number of parts that have been successfully uploaded.

" } }, "FileName": { "base": null, "refs": { "Attachment$fileName": "

The name of the attachment file.

", "AttachmentDetails$fileName": "

The file name of the attachment.

", "DescribeAttachmentUploadStatusResponse$fileName": "

The name of the file being uploaded, including the file extension.

", "GetAttachmentDownloadLinkResponse$fileName": "

The name of the attachment file, including the file extension.

", "GetAttachmentUploadLinksRequest$fileName": "

The name of the file to upload, including the file extension. This value is required when you initiate a new upload.

" } }, "FileSize": { "base": null, "refs": { "GetAttachmentUploadLinksRequest$fileSizeBytes": "

The total size of the file in bytes. The service uses this value to calculate the total number of parts and the size of each part. Required when you initiate a new upload (when uploadId isn't provided). Valid range: 1 to 157,286,400 bytes (approximately 150 MB).

" } }, "GetAttachmentDownloadLinkRequest": { "base": null, "refs": {} }, "GetAttachmentDownloadLinkResponse": { "base": null, "refs": {} }, "GetAttachmentUploadLinksRequest": { "base": null, "refs": {} }, "GetAttachmentUploadLinksResponse": { "base": null, "refs": {} }, "HttpsUrl": { "base": null, "refs": { "DownloadUrl$url": "

The presigned HTTPS URL that you can use to download the attachment. Download URLs are served from downloadv1.attachments.support.{region}.amazonaws.com. The downloadv1 prefix is subject to change.

", "UploadUrl$url": "

The presigned HTTPS URL that you use to upload a single part with HTTP PUT. Upload URLs are served from uploadv1.attachments.support.{region}.amazonaws.com. The uploadv1 prefix is subject to change.

" } }, "IncludeCommunications": { "base": null, "refs": { "DescribeCasesRequest$includeCommunications": "

Specifies whether to include communications in the DescribeCases response. By default, communications are included.

" } }, "IncludeResolvedCases": { "base": null, "refs": { "DescribeCasesRequest$includeResolvedCases": "

Specifies whether to include resolved support cases in the DescribeCases response. By default, resolved cases aren't included.

" } }, "Integer": { "base": null, "refs": { "GetAttachmentUploadLinksResponse$totalParts": "

The total number of parts that the file is split into. Upload one part to each presigned URL.

", "GetAttachmentUploadLinksResponse$nextIndex": "

The next part index to request presigned URLs for. If all upload URLs for the file have been returned, this field is null. Use this value as the startIndex in uploadRange on a subsequent call to GetAttachmentUploadLinks to retrieve the next batch of upload URLs.

", "UploadUrl$partIndex": "

The index of the part that this URL uploads.

" } }, "InternalServerError": { "base": "

An internal server error occurred.

", "refs": {} }, "IssueType": { "base": null, "refs": { "CreateCaseRequest$issueType": "

The type of issue for the case. You can specify customer-service or technical. If you don't specify a value, the default is technical.

", "DescribeCreateCaseOptionsRequest$issueType": "

The type of issue for the case. You can specify customer-service or technical. If you don't specify a value, the default is technical.

" } }, "Language": { "base": null, "refs": { "CaseDetails$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.

", "CreateCaseRequest$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.

", "DescribeCasesRequest$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.

", "DescribeCreateCaseOptionsRequest$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.

", "DescribeServicesRequest$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.

", "DescribeSeverityLevelsRequest$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.

", "SupportedLanguage$language": "

Full language description e.g. ENGLISH

" } }, "Long": { "base": null, "refs": { "TrustedAdvisorCheckRefreshStatus$millisUntilNextRefreshable": "

The amount of time, in milliseconds, until the Trusted Advisor check is eligible for refresh.

", "TrustedAdvisorResourcesSummary$resourcesProcessed": "

The number of Amazon Web Services resources that were analyzed by the Trusted Advisor check.

", "TrustedAdvisorResourcesSummary$resourcesFlagged": "

The number of Amazon Web Services resources that were flagged (listed) by the Trusted Advisor check.

", "TrustedAdvisorResourcesSummary$resourcesIgnored": "

The number of Amazon Web Services resources ignored by Trusted Advisor because information was unavailable.

", "TrustedAdvisorResourcesSummary$resourcesSuppressed": "

The number of Amazon Web Services resources ignored by Trusted Advisor because they were marked as suppressed by the user.

" } }, "MaxResults": { "base": null, "refs": { "DescribeCasesRequest$maxResults": "

The maximum number of results to return before paginating.

", "DescribeCommunicationsRequest$maxResults": "

The maximum number of results to return before paginating.

" } }, "NextToken": { "base": null, "refs": { "DescribeCasesRequest$nextToken": "

A resumption point for pagination.

", "DescribeCasesResponse$nextToken": "

A resumption point for pagination.

", "DescribeCommunicationsRequest$nextToken": "

A resumption point for pagination.

", "DescribeCommunicationsResponse$nextToken": "

A resumption point for pagination.

", "RecentCaseCommunications$nextToken": "

A resumption point for pagination.

" } }, "NullableBooleanType": { "base": null, "refs": { "AddAttachmentsToSetRequest$dryRun": "

Specifies whether to validate the request without actually adding the attachments. When set to true, the request is validated but no attachments are stored, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

", "AddCommunicationToCaseRequest$dryRun": "

Specifies whether to validate the request without actually adding the communication to the case. When set to true, the request is validated but the communication isn't added, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

", "CompleteAttachmentUploadRequest$dryRun": "

Specifies whether to validate the request without actually completing the upload. When set to true, the request is validated but the upload isn't finalized, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

", "CreateCaseRequest$dryRun": "

Specifies whether to validate the request without actually creating the case. When set to true, the request is validated but no case is created, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

", "DescribeAttachmentRequest$dryRun": "

Specifies whether to validate the request without actually retrieving the attachment. When set to true, the request is validated but no attachment content is returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

", "DescribeAttachmentUploadStatusRequest$dryRun": "

Specifies whether to validate the request without actually returning upload status. When set to true, the request is validated but no status is returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

", "DescribeCasesRequest$dryRun": "

Specifies whether to validate the request without actually returning case data. When set to true, the request is validated but no cases are returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

", "DescribeCommunicationsRequest$dryRun": "

Specifies whether to validate the request without actually returning communications. When set to true, the request is validated but no communications are returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

", "DescribeCreateCaseOptionsRequest$dryRun": "

Specifies whether to validate the request without actually returning case option data. When set to true, the request is validated but no options are returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

", "DescribeServicesRequest$dryRun": "

Specifies whether to validate the request without actually returning the list of services. When set to true, the request is validated but no services are returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

", "DescribeSeverityLevelsRequest$dryRun": "

Specifies whether to validate the request without actually returning severity levels. When set to true, the request is validated but no severity levels are returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

", "DescribeSupportedLanguagesRequest$dryRun": "

Specifies whether to validate the request without actually returning supported languages. When set to true, the request is validated but no languages are returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

", "GetAttachmentDownloadLinkRequest$dryRun": "

Specifies whether to validate the request without actually returning a download link. When set to true, the request is validated but no URL is returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

", "GetAttachmentUploadLinksRequest$dryRun": "

Specifies whether to validate the request without actually generating upload URLs. When set to true, the request is validated but no URLs are returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

", "ResolveCaseRequest$dryRun": "

Specifies whether to validate the request without actually resolving the case. When set to true, the request is validated but the case isn't resolved, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

" } }, "PartSizeBytes": { "base": null, "refs": { "GetAttachmentUploadLinksResponse$partSizeBytes": "

The size, in bytes, of each part. Split the file into parts of this size before you upload them to the presigned URLs. For an upload with n total parts, parts 1 through n - 1 are exactly this size; the last part may be smaller. Maximum: 104,857,600 bytes (approximately 100 MB).

" } }, "RecentCaseCommunications": { "base": "

The five most recent communications associated with the case.

", "refs": { "CaseDetails$recentCommunications": "

The five most recent communications between you and Amazon Web Services Support Center, including the IDs of any attachments to the communications. Also includes a nextToken that you can use to retrieve earlier communications.

" } }, "RefreshTrustedAdvisorCheckRequest": { "base": "

", "refs": {} }, "RefreshTrustedAdvisorCheckResponse": { "base": "

The current refresh status of a Trusted Advisor check.

", "refs": {} }, "ResolveCaseRequest": { "base": null, "refs": {} }, "ResolveCaseResponse": { "base": "

The status of the case returned by the ResolveCase operation.

", "refs": {} }, "Result": { "base": null, "refs": { "AddCommunicationToCaseResponse$result": "

True if AddCommunicationToCase succeeds. Otherwise, returns an error.

" } }, "Service": { "base": "

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

", "refs": { "ServiceList$member": null } }, "ServiceCode": { "base": null, "refs": { "CaseDetails$serviceCode": "

The code for the Amazon Web Services service. You can get a list of codes and the corresponding service names by calling DescribeServices.

", "CreateCaseRequest$serviceCode": "

The code for the Amazon Web Services service. You can use the DescribeServices operation to get the possible serviceCode values.

", "DescribeCreateCaseOptionsRequest$serviceCode": "

The code for the Amazon Web Services service. You can use the DescribeServices operation to get the possible serviceCode values.

", "Service$code": "

The code for an Amazon Web Services service returned by the DescribeServices response. The name element contains the corresponding friendly name.

", "ServiceCodeList$member": null } }, "ServiceCodeList": { "base": null, "refs": { "DescribeServicesRequest$serviceCodeList": "

A JSON-formatted list of service codes available for Amazon Web Services services.

" } }, "ServiceList": { "base": null, "refs": { "DescribeServicesResponse$services": "

A JSON-formatted list of Amazon Web Services services.

" } }, "ServiceName": { "base": null, "refs": { "Service$name": "

The friendly name for an Amazon Web Services service. The code element contains the corresponding code.

" } }, "SeverityCode": { "base": null, "refs": { "CaseDetails$severityCode": "

The code for the severity level returned by the call to DescribeSeverityLevels.

", "CreateCaseRequest$severityCode": "

A value that indicates the urgency of the case. This value determines the response time according to your service level agreement with Amazon Web Services Support. You can use the DescribeSeverityLevels operation to get the possible values for severityCode.

For more information, see SeverityLevel and Choosing a Severity in the Amazon Web Services Support User Guide.

The availability of severity levels depends on the support plan for the Amazon Web Services account.

" } }, "SeverityLevel": { "base": "

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.

", "refs": { "SeverityLevelsList$member": null } }, "SeverityLevelCode": { "base": null, "refs": { "SeverityLevel$code": "

The code for case severity level.

Valid values: low | normal | high | urgent | critical

" } }, "SeverityLevelName": { "base": null, "refs": { "SeverityLevel$name": "

The name of the severity level that corresponds to the severity level code.

The values returned by the API are different from the values that appear in the Amazon Web Services Support Center. For example, the API uses the code low, but the name appears as General guidance in Support Center.

The following are the API code names and how they appear in the console:

For more information, see Choosing a severity in the Amazon Web Services Support User Guide.

" } }, "SeverityLevelsList": { "base": null, "refs": { "DescribeSeverityLevelsResponse$severityLevels": "

The available severity levels for the support case. Available severity levels are defined by your service level agreement with Amazon Web Services.

" } }, "StartIndex": { "base": null, "refs": { "UploadRange$startIndex": "

The starting part index of the range, inclusive. Part indexes start at 1.

" } }, "StartTime": { "base": null, "refs": { "SupportedHour$startTime": "

Start Time. RFC 3339 format 'HH:mm:ss.SSS'.

" } }, "Status": { "base": null, "refs": { "CaseDetails$status": "

The status of the case.

Valid values:

" } }, "String": { "base": null, "refs": { "DescribeTrustedAdvisorCheckResultRequest$checkId": "

The unique identifier for the Trusted Advisor check.

", "DescribeTrustedAdvisorCheckResultRequest$language": "

The ISO 639-1 code for the language that you want your check results to appear in.

The Amazon Web Services Support API currently supports the following languages for Trusted Advisor:

", "DescribeTrustedAdvisorChecksRequest$language": "

The ISO 639-1 code for the language that you want your checks to appear in.

The Amazon Web Services Support API currently supports the following languages for Trusted Advisor:

", "RefreshTrustedAdvisorCheckRequest$checkId": "

The unique identifier for the Trusted Advisor check to refresh.

Specifying the check ID of a check that is automatically refreshed causes an InvalidParameterValue error.

", "StringList$member": null, "TrustedAdvisorCheckDescription$id": "

The unique identifier for the Trusted Advisor check.

", "TrustedAdvisorCheckDescription$name": "

The display name for the Trusted Advisor check.

", "TrustedAdvisorCheckDescription$description": "

The description of the Trusted Advisor check, which includes the alert criteria and recommended operations (contains HTML markup).

", "TrustedAdvisorCheckDescription$category": "

The category of the Trusted Advisor check.

", "TrustedAdvisorCheckRefreshStatus$checkId": "

The unique identifier for the Trusted Advisor check.

", "TrustedAdvisorCheckRefreshStatus$status": "

The status of the Trusted Advisor check for which a refresh has been requested:

", "TrustedAdvisorCheckResult$checkId": "

The unique identifier for the Trusted Advisor check.

", "TrustedAdvisorCheckResult$timestamp": "

The time of the last refresh of the check.

", "TrustedAdvisorCheckResult$status": "

The alert status of the check: \"ok\" (green), \"warning\" (yellow), \"error\" (red), or \"not_available\".

", "TrustedAdvisorCheckSummary$checkId": "

The unique identifier for the Trusted Advisor check.

", "TrustedAdvisorCheckSummary$timestamp": "

The time of the last refresh of the check.

", "TrustedAdvisorCheckSummary$status": "

The alert status of the check: \"ok\" (green), \"warning\" (yellow), \"error\" (red), or \"not_available\".

", "TrustedAdvisorResourceDetail$status": "

The status code for the resource identified in the Trusted Advisor check.

", "TrustedAdvisorResourceDetail$region": "

The Amazon Web Services Region in which the identified resource is located.

", "TrustedAdvisorResourceDetail$resourceId": "

The unique identifier for the identified resource.

" } }, "StringList": { "base": null, "refs": { "DescribeTrustedAdvisorCheckRefreshStatusesRequest$checkIds": "

The IDs of the Trusted Advisor checks to get the status.

If you specify the check ID of a check that is automatically refreshed, you might see an InvalidParameterValue error.

", "DescribeTrustedAdvisorCheckSummariesRequest$checkIds": "

The IDs of the Trusted Advisor checks.

", "TrustedAdvisorCheckDescription$metadata": "

The column headings for the data returned by the Trusted Advisor check. The order of the headings corresponds to the order of the data in the Metadata element of the TrustedAdvisorResourceDetail for the check. Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data.

", "TrustedAdvisorResourceDetail$metadata": "

Additional information about the identified resource. The exact metadata and its order can be obtained by inspecting the TrustedAdvisorCheckDescription object returned by the call to DescribeTrustedAdvisorChecks. Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data.

" } }, "Subject": { "base": null, "refs": { "CaseDetails$subject": "

The subject line for the case in the Amazon Web Services Support Center.

", "CreateCaseRequest$subject": "

The title of the support case. The title appears in the Subject field on the Amazon Web Services Support Center Create Case page.

" } }, "SubmittedBy": { "base": null, "refs": { "CaseDetails$submittedBy": "

The email address of the account that submitted the case.

", "Communication$submittedBy": "

The identity of the account that submitted, or responded to, the support case. Customer entries include the IAM role as well as the email address (for example, \"AdminRole (Role) <janedoe@example.com>). Entries from the Amazon Web Services Support team display \"Amazon Web Services,\" and don't show an email address.

" } }, "SupportedHour": { "base": "

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

", "refs": { "SupportedHoursList$member": null } }, "SupportedHoursList": { "base": null, "refs": { "CommunicationTypeOptions$supportedHours": "

A JSON-formatted list containing time ranges when support is available.

" } }, "SupportedLanguage": { "base": "

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.

", "refs": { "SupportedLanguagesList$member": null } }, "SupportedLanguagesList": { "base": null, "refs": { "DescribeSupportedLanguagesResponse$supportedLanguages": "

A JSON-formatted array that contains the available ISO 639-1 language codes.

" } }, "ThrottlingException": { "base": "

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

", "refs": {} }, "ThrottlingReason": { "base": "

Information about why a request was throttled.

", "refs": { "ThrottlingReasonList$member": null } }, "ThrottlingReasonList": { "base": null, "refs": { "ThrottlingException$throttlingReasons": "

A list of one or more reasons that the request was throttled.

" } }, "TimeCreated": { "base": null, "refs": { "CaseDetails$timeCreated": "

The time that the case was created in the Amazon Web Services Support Center.

", "Communication$timeCreated": "

The time the communication was created.

" } }, "TrustedAdvisorCategorySpecificSummary": { "base": "

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

", "refs": { "TrustedAdvisorCheckResult$categorySpecificSummary": "

Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.

", "TrustedAdvisorCheckSummary$categorySpecificSummary": "

Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.

" } }, "TrustedAdvisorCheckDescription": { "base": "

The description and metadata for a Trusted Advisor check.

", "refs": { "TrustedAdvisorCheckList$member": null } }, "TrustedAdvisorCheckList": { "base": null, "refs": { "DescribeTrustedAdvisorChecksResponse$checks": "

Information about all available Trusted Advisor checks.

" } }, "TrustedAdvisorCheckRefreshStatus": { "base": "

The refresh status of a Trusted Advisor check.

", "refs": { "RefreshTrustedAdvisorCheckResponse$status": "

The current refresh status for a check, including the amount of time until the check is eligible for refresh.

", "TrustedAdvisorCheckRefreshStatusList$member": null } }, "TrustedAdvisorCheckRefreshStatusList": { "base": null, "refs": { "DescribeTrustedAdvisorCheckRefreshStatusesResponse$statuses": "

The refresh status of the specified Trusted Advisor checks.

" } }, "TrustedAdvisorCheckResult": { "base": "

The results of a Trusted Advisor check returned by DescribeTrustedAdvisorCheckResult.

", "refs": { "DescribeTrustedAdvisorCheckResultResponse$result": "

The detailed results of the Trusted Advisor check.

" } }, "TrustedAdvisorCheckSummary": { "base": "

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

", "refs": { "TrustedAdvisorCheckSummaryList$member": null } }, "TrustedAdvisorCheckSummaryList": { "base": null, "refs": { "DescribeTrustedAdvisorCheckSummariesResponse$summaries": "

The summary information for the requested Trusted Advisor checks.

" } }, "TrustedAdvisorCostOptimizingSummary": { "base": "

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

", "refs": { "TrustedAdvisorCategorySpecificSummary$costOptimizing": "

The summary information about cost savings for a Trusted Advisor check that is in the Cost Optimizing category.

" } }, "TrustedAdvisorResourceDetail": { "base": "

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

", "refs": { "TrustedAdvisorResourceDetailList$member": null } }, "TrustedAdvisorResourceDetailList": { "base": null, "refs": { "TrustedAdvisorCheckResult$flaggedResources": "

The details about each resource listed in the check result.

" } }, "TrustedAdvisorResourcesSummary": { "base": "

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

", "refs": { "TrustedAdvisorCheckResult$resourcesSummary": null, "TrustedAdvisorCheckSummary$resourcesSummary": null } }, "Type": { "base": null, "refs": { "CommunicationTypeOptions$type": "

A string value indicating the communication type. At the moment the type value can assume one of 3 values at the moment chat, web and call.

" } }, "UploadId": { "base": null, "refs": { "CompleteAttachmentUploadRequest$uploadId": "

The identifier associated with the upload to complete.

", "DescribeAttachmentUploadStatusRequest$uploadId": "

The unique identifier for the upload. The uploadId is returned by GetAttachmentUploadLinks when you initiate the upload.

", "GetAttachmentUploadLinksRequest$uploadId": "

The unique identifier of an in-progress multipart upload, returned by a previous call to GetAttachmentUploadLinks. Specify uploadId to retrieve additional presigned upload URLs for an upload that has already been initiated. Required when fileSizeBytes isn't provided. Length: 1 to 2,048 characters.

", "GetAttachmentUploadLinksResponse$uploadId": "

The unique identifier for the multipart upload. Use this value in subsequent calls to GetAttachmentUploadLinks, DescribeAttachmentUploadStatus, and CompleteAttachmentUpload, and to attach the upload to a case through the uploadIds parameter on CreateCase or AddCommunicationToCase.

", "UploadIds$member": null } }, "UploadIdNotFound": { "base": "

The specified uploadId couldn't be located.

", "refs": {} }, "UploadIds": { "base": null, "refs": { "AddCommunicationToCaseRequest$uploadIds": "

A list of upload IDs that identify attachments to add to the case. Each uploadId is returned by the GetAttachmentUploadLinks operation. The upload must reach the attachment-ready state by calling CompleteAttachmentUpload before it can be passed here. Use uploadIds to attach files of any supported size, including files larger than 5 MB.

", "CreateCaseRequest$uploadIds": "

A list of upload IDs that identify attachments to add to the case. Each uploadId is returned by the GetAttachmentUploadLinks operation. The upload must reach the attachment-ready state by calling CompleteAttachmentUpload before it can be passed here. Use uploadIds to attach files of any supported size, including files larger than 5 MB.

" } }, "UploadProgress": { "base": "

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

", "refs": { "DescribeAttachmentUploadStatusResponse$uploadProgress": "

The progress of the multipart upload, including the total number of parts and the number of parts that have been successfully uploaded.

" } }, "UploadRange": { "base": "

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

", "refs": { "GetAttachmentUploadLinksRequest$uploadRange": "

The range of part indexes for which to return presigned upload URLs. Use this parameter to page through the upload URLs for a large file across multiple calls. If you omit this parameter, the service determines the range to return.

" } }, "UploadStatus": { "base": null, "refs": { "CompleteAttachmentUploadResponse$uploadStatus": "

The status of the multipart upload after the operation finalizes the attachment. Valid values: attachment-ready, attachment-not-ready, and failed.

", "DescribeAttachmentUploadStatusResponse$uploadStatus": "

The current status of the multipart upload. Valid values: attachment-ready, attachment-not-ready, and failed.

" } }, "UploadUrl": { "base": "

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.

", "refs": { "UploadUrlList$member": null } }, "UploadUrlList": { "base": null, "refs": { "GetAttachmentUploadLinksResponse$uploadUrls": "

The list of presigned upload URLs for the requested range of parts. The list contains at most 10 URLs per call. Upload each part to its corresponding URL by using HTTP PUT before the URL expires.

" } }, "ValidatedCategoryCode": { "base": null, "refs": { "DescribeSupportedLanguagesRequest$categoryCode": "

The category of problem for the support case. You also use the DescribeServices operation to get the category code for a service. Each Amazon Web Services service defines its own set of category codes.

" } }, "ValidatedCommunicationBody": { "base": null, "refs": { "Communication$body": "

The text of the communication between the customer and Amazon Web Services Support.

" } }, "ValidatedDateTime": { "base": null, "refs": { "DateInterval$startDateTime": "

A JSON object containing start and date time (UTC). Date and time format is RFC 3339 : 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'.

", "DateInterval$endDateTime": "

End Date Time (UTC). RFC 3339 format : 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'.

", "DownloadUrl$expiryDate": "

The date and time, in ISO-8601 format, when the presigned URL expires. Download the attachment before this time.

", "UploadUrl$expiryDate": "

The date and time, in ISO-8601 format, when the presigned URL expires. Upload the part before this time.

" } }, "ValidatedIssueTypeString": { "base": null, "refs": { "DescribeSupportedLanguagesRequest$issueType": "

The type of issue for the case. You can specify customer-service or technical.

" } }, "ValidatedLanguageAvailability": { "base": null, "refs": { "DescribeCreateCaseOptionsResponse$languageAvailability": "

Language availability can be any of the following:

" } }, "ValidatedServiceCode": { "base": null, "refs": { "DescribeSupportedLanguagesRequest$serviceCode": "

The code for the Amazon Web Services service. You can use the DescribeServices operation to get the possible serviceCode values.

" } } } }