AWS Support 2013-04-15
- Client: Aws\Support\SupportClient
- Service ID: support
- Version: 2013-04-15
This page describes the parameters and results for the operations of the AWS Support (2013-04-15), and shows how to use the Aws\Support\SupportClient object to call the described operations. This documentation is specific to the 2013-04-15 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- AddAttachmentsToSet ( array $params = [] )
- Adds one or more attachments to an attachment set.
- AddCommunicationToCase ( array $params = [] )
- Adds additional customer communication to a Amazon Web Services Support case.
- CompleteAttachmentUpload ( array $params = [] )
- Completes an attachment upload that was started with GetAttachmentUploadLinks.
- CreateCase ( array $params = [] )
- Creates a case in the Amazon Web Services Support Center.
- DescribeAttachment ( array $params = [] )
- Returns the attachment that has the specified ID.
- DescribeAttachmentUploadStatus ( array $params = [] )
- Returns the current status, file name, and progress of a multipart attachment upload that was started with GetAttachmentUploadLinks.
- DescribeCases ( array $params = [] )
- Returns a list of cases that you specify by passing one or more case IDs.
- DescribeCommunications ( array $params = [] )
- Returns communications and attachments for one or more support cases.
- DescribeCreateCaseOptions ( array $params = [] )
- Returns a list of CreateCaseOption types along with the corresponding supported hours and language availability.
- DescribeServices ( array $params = [] )
- Returns the current list of Amazon Web Services services and a list of service categories for each service.
- DescribeSeverityLevels ( array $params = [] )
- Returns the list of severity levels that you can assign to a support case.
- DescribeSupportedLanguages ( array $params = [] )
- Returns a list of supported languages for a specified categoryCode, issueType and serviceCode.
- DescribeTrustedAdvisorCheckRefreshStatuses ( array $params = [] )
- Returns the refresh status of the Trusted Advisor checks that have the specified check IDs.
- DescribeTrustedAdvisorCheckResult ( array $params = [] )
- Returns the results of the Trusted Advisor check that has the specified check ID.
- DescribeTrustedAdvisorCheckSummaries ( array $params = [] )
- Returns the results for the Trusted Advisor check summaries for the check IDs that you specified.
- DescribeTrustedAdvisorChecks ( array $params = [] )
- Returns information about all available Trusted Advisor checks, including the name, ID, category, description, and metadata.
- GetAttachmentDownloadLink ( array $params = [] )
- Returns a presigned download URL for an attachment that is associated with a case communication.
- GetAttachmentUploadLinks ( array $params = [] )
- Returns one or more presigned upload URLs for uploading a large file attachment to a support case by using a multipart upload workflow.
- RefreshTrustedAdvisorCheck ( array $params = [] )
- Refreshes the Trusted Advisor check that you specify using the check ID.
- ResolveCase ( array $params = [] )
- Resolves a support case.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
- DescribeCases
- DescribeCommunications
- DescribeServices
- DescribeTrustedAdvisorCheckRefreshStatuses
- DescribeTrustedAdvisorCheckSummaries
Operations
AddAttachmentsToSet
$result = $client->addAttachmentsToSet([/* ... */]); $promise = $client->addAttachmentsToSetAsync([/* ... */]);
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.
-
You must have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan to use the Amazon Web Services Support API. If you're in an Amazon Web Services Region that doesn't offer one of these Amazon Web Services Support plans, or if you haven't transitioned to one of these plans, you can use the Amazon Web Services Support API with a Business, Enterprise On-Ramp, or Enterprise Support plan.
-
If you call the Amazon Web Services Support API from an account that doesn't have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
Parameter Syntax
$result = $client->addAttachmentsToSet([
'attachmentSetId' => '<string>',
'attachments' => [ // REQUIRED
[
'data' => <string || resource || Psr\Http\Message\StreamInterface>,
'fileName' => '<string>',
],
// ...
],
'dryRun' => true || false,
]);
Parameter Details
Members
- attachmentSetId
-
- Type: string
The ID of the attachment set. If an
attachmentSetIdis not specified, a new attachment set is created, and the ID of the set is returned in the response. If anattachmentSetIdis specified, the attachments are added to the specified set, if it exists. - attachments
-
- Required: Yes
- Type: Array of Attachment structures
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
Attachmentobject, use thedataparameter to specify the contents of the attachment file. In the previous request syntax, the value fordataappear asblob, which is represented as a base64-encoded string. The value forfileNameis the name of the attachment, such astroubleshoot-screenshot.png. - dryRun
-
- Type: boolean
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 aDryRunOperationException. When omitted or set tofalse, the request runs normally.
Result Syntax
[
'attachmentSetId' => '<string>',
'expiryTime' => '<string>',
]
Result Details
Members
- attachmentSetId
-
- Type: string
The ID of the attachment set. If an
attachmentSetIdwas not specified, a new attachment set is created, and the ID of the set is returned in the response. If anattachmentSetIdwas specified, the attachments are added to the specified set, if it exists. - expiryTime
-
- Type: string
The time and date when the attachment set expires.
Errors
- InternalServerError:
An internal server error occurred.
- AttachmentSetIdNotFound:
An attachment set with the specified ID could not be found.
- AttachmentSetExpired:
The expiration time of the attachment set has passed. The set expires 1 hour after it is created.
- AttachmentSetSizeLimitExceeded:
A limit for the size of an attachment set has been exceeded. The limits are three attachments and 5 MB per attachment.
- AttachmentLimitExceeded:
The limit for the number of attachment sets created in a short period of time has been exceeded.
- DryRunOperationException:
The request was valid, but the operation wasn't performed because
dryRunwas set totrue.
AddCommunicationToCase
$result = $client->addCommunicationToCase([/* ... */]); $promise = $client->addCommunicationToCaseAsync([/* ... */]);
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:
-
Amazon Web Services secret keys - The complete key is replaced. Example:
[REDACTED_BY_Amazon Web Services] -
Private keys - The complete key is replaced. Example:
[REDACTED_BY_Amazon Web Services] -
Credit card numbers - The number is redacted, but the last 4 digits remain. Example:
[REDACTED_BY_Amazon Web Services]-7016
This sensitive information is never required by Amazon Web Services Support.
-
You must have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan to use the Amazon Web Services Support API. If you're in an Amazon Web Services Region that doesn't offer one of these Amazon Web Services Support plans, or if you haven't transitioned to one of these plans, you can use the Amazon Web Services Support API with a Business, Enterprise On-Ramp, or Enterprise Support plan.
-
If you call the Amazon Web Services Support API from an account that doesn't have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
Parameter Syntax
$result = $client->addCommunicationToCase([
'attachmentSetId' => '<string>',
'caseId' => '<string>',
'ccEmailAddresses' => ['<string>', ...],
'communicationBody' => '<string>', // REQUIRED
'dryRun' => true || false,
'uploadIds' => ['<string>', ...],
]);
Parameter Details
Members
- attachmentSetId
-
- Type: string
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. - caseId
-
- Type: string
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
- ccEmailAddresses
-
- Type: Array of strings
The email addresses in the CC line of an email to be added to the support case.
- communicationBody
-
- Required: Yes
- Type: string
The body of an email communication to add to the support case.
- dryRun
-
- Type: boolean
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 aDryRunOperationException. When omitted or set tofalse, the request runs normally. - uploadIds
-
- Type: Array of strings
A list of upload IDs that identify attachments to add to the case. Each
uploadIdis returned by the GetAttachmentUploadLinks operation. The upload must reach theattachment-readystate by calling CompleteAttachmentUpload before it can be passed here. UseuploadIdsto attach files of any supported size, including files larger than 5 MB.
Result Syntax
[
'result' => true || false,
]
Result Details
Members
- result
-
- Type: boolean
True if AddCommunicationToCase succeeds. Otherwise, returns an error.
Errors
- InternalServerError:
An internal server error occurred.
- CaseIdNotFound:
The requested
caseIdcouldn't be located.- AttachmentSetIdNotFound:
An attachment set with the specified ID could not be found.
- AttachmentSetExpired:
The expiration time of the attachment set has passed. The set expires 1 hour after it is created.
- DryRunOperationException:
The request was valid, but the operation wasn't performed because
dryRunwas set totrue.
CompleteAttachmentUpload
$result = $client->completeAttachmentUpload([/* ... */]); $promise = $client->completeAttachmentUploadAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->completeAttachmentUpload([
'completedUploads' => [ // REQUIRED
[
'eTag' => '<string>', // REQUIRED
'partIndex' => <integer>, // REQUIRED
],
// ...
],
'dryRun' => true || false,
'uploadId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- completedUploads
-
- Required: Yes
- Type: Array of CompletedUpload structures
The list of parts being reported as completed in this call. Each entry must contain the
partIndexof an uploaded part and theETagreturned by Amazon S3 when that part was uploaded. - dryRun
-
- Type: boolean
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 aDryRunOperationException. When omitted or set tofalse, the request runs normally. - uploadId
-
- Required: Yes
- Type: string
The identifier associated with the upload to complete.
Result Syntax
[
'uploadStatus' => 'attachment-ready|attachment-not-ready|failed',
]
Result Details
Members
- uploadStatus
-
- Required: Yes
- Type: string
The status of the multipart upload after the operation finalizes the attachment. Valid values:
attachment-ready,attachment-not-ready, andfailed.
Errors
- InternalServerError:
An internal server error occurred.
- DryRunOperationException:
The request was valid, but the operation wasn't performed because
dryRunwas set totrue.- UploadIdNotFound:
The specified
uploadIdcouldn't be located.
CreateCase
$result = $client->createCase([/* ... */]); $promise = $client->createCaseAsync([/* ... */]);
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.
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:
-
Amazon Web Services secret keys - The complete key is replaced. Example:
[REDACTED_BY_Amazon Web Services] -
Private keys - The complete key is replaced. Example:
[REDACTED_BY_Amazon Web Services] -
Credit card numbers - The number is redacted, but the last 4 digits remain. Example:
[REDACTED_BY_Amazon Web Services]-7016
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.
-
You must have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan to use the Amazon Web Services Support API. If you're in an Amazon Web Services Region that doesn't offer one of these Amazon Web Services Support plans, or if you haven't transitioned to one of these plans, you can use the Amazon Web Services Support API with a Business, Enterprise On-Ramp, or Enterprise Support plan.
-
If you call the Amazon Web Services Support API from an account that doesn't have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
Parameter Syntax
$result = $client->createCase([
'attachmentSetId' => '<string>',
'categoryCode' => '<string>',
'ccEmailAddresses' => ['<string>', ...],
'communicationBody' => '<string>', // REQUIRED
'dryRun' => true || false,
'issueType' => '<string>',
'language' => '<string>',
'serviceCode' => '<string>',
'severityCode' => '<string>',
'subject' => '<string>', // REQUIRED
'uploadIds' => ['<string>', ...],
]);
Parameter Details
Members
- attachmentSetId
-
- Type: string
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. - categoryCode
-
- Type: string
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.
- ccEmailAddresses
-
- Type: Array of strings
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.
- communicationBody
-
- Required: Yes
- Type: string
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.
- dryRun
-
- Type: boolean
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 aDryRunOperationException. When omitted or set tofalse, the request runs normally. - issueType
-
- Type: string
The type of issue for the case. You can specify
customer-serviceortechnical. If you don't specify a value, the default istechnical. - language
-
- Type: string
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
languageparameter if you want support in that language. - serviceCode
-
- Type: string
The code for the Amazon Web Services service. You can use the DescribeServices operation to get the possible
serviceCodevalues. - severityCode
-
- Type: string
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.
- subject
-
- Required: Yes
- Type: string
The title of the support case. The title appears in the Subject field on the Amazon Web Services Support Center Create Case page.
- uploadIds
-
- Type: Array of strings
A list of upload IDs that identify attachments to add to the case. Each
uploadIdis returned by the GetAttachmentUploadLinks operation. The upload must reach theattachment-readystate by calling CompleteAttachmentUpload before it can be passed here. UseuploadIdsto attach files of any supported size, including files larger than 5 MB.
Result Syntax
[
'caseId' => '<string>',
]
Result Details
Members
- caseId
-
- Type: string
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
Errors
- InternalServerError:
An internal server error occurred.
- CaseCreationLimitExceeded:
The case creation limit for the account has been exceeded.
- AttachmentSetIdNotFound:
An attachment set with the specified ID could not be found.
- AttachmentSetExpired:
The expiration time of the attachment set has passed. The set expires 1 hour after it is created.
- DryRunOperationException:
The request was valid, but the operation wasn't performed because
dryRunwas set totrue.
DescribeAttachment
$result = $client->describeAttachment([/* ... */]); $promise = $client->describeAttachmentAsync([/* ... */]);
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.
-
You must have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan to use the Amazon Web Services Support API. If you're in an Amazon Web Services Region that doesn't offer one of these Amazon Web Services Support plans, or if you haven't transitioned to one of these plans, you can use the Amazon Web Services Support API with a Business, Enterprise On-Ramp, or Enterprise Support plan.
-
If you call the Amazon Web Services Support API from an account that doesn't have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
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.
Parameter Syntax
$result = $client->describeAttachment([
'attachmentId' => '<string>', // REQUIRED
'dryRun' => true || false,
]);
Parameter Details
Members
- attachmentId
-
- Required: Yes
- Type: string
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. - dryRun
-
- Type: boolean
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 aDryRunOperationException. When omitted or set tofalse, the request runs normally.
Result Syntax
[
'attachment' => [
'data' => <string || resource || Psr\Http\Message\StreamInterface>,
'fileName' => '<string>',
],
]
Result Details
Members
- attachment
-
- Type: Attachment structure
This object includes the attachment content and file name.
In the previous response syntax, the value for the
dataparameter appears asblob, which is represented as a base64-encoded string. The value forfileNameis the name of the attachment, such astroubleshoot-screenshot.png.
Errors
- InternalServerError:
An internal server error occurred.
- DescribeAttachmentLimitExceeded:
The limit for the number of DescribeAttachment requests in a short period of time has been exceeded.
- AttachmentIdNotFound:
An attachment with the specified ID could not be found.
- DryRunOperationException:
The request was valid, but the operation wasn't performed because
dryRunwas set totrue.
DescribeAttachmentUploadStatus
$result = $client->describeAttachmentUploadStatus([/* ... */]); $promise = $client->describeAttachmentUploadStatusAsync([/* ... */]);
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.
-
You must have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan to use the Amazon Web Services Support API. If you're in an Amazon Web Services Region that doesn't offer one of these Amazon Web Services Support plans, or if you haven't transitioned to one of these plans, you can use the Amazon Web Services Support API with a Business, Enterprise On-Ramp, or Enterprise Support plan.
-
If you call the Amazon Web Services Support API from an account that doesn't have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
Parameter Syntax
$result = $client->describeAttachmentUploadStatus([
'dryRun' => true || false,
'uploadId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- dryRun
-
- Type: boolean
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 aDryRunOperationException. When omitted or set tofalse, the request runs normally. - uploadId
-
- Required: Yes
- Type: string
The unique identifier for the upload. The
uploadIdis returned by GetAttachmentUploadLinks when you initiate the upload.
Result Syntax
[
'fileName' => '<string>',
'uploadProgress' => [
'completedPartsCount' => <integer>,
'totalParts' => <integer>,
],
'uploadStatus' => 'attachment-ready|attachment-not-ready|failed',
]
Result Details
Members
- fileName
-
- Required: Yes
- Type: string
The name of the file being uploaded, including the file extension.
- uploadProgress
-
- Type: UploadProgress structure
The progress of the multipart upload, including the total number of parts and the number of parts that have been successfully uploaded.
- uploadStatus
-
- Required: Yes
- Type: string
The current status of the multipart upload. Valid values:
attachment-ready,attachment-not-ready, andfailed.
Errors
- InternalServerError:
An internal server error occurred.
- DryRunOperationException:
The request was valid, but the operation wasn't performed because
dryRunwas set totrue.- UploadIdNotFound:
The specified
uploadIdcouldn't be located.
DescribeCases
$result = $client->describeCases([/* ... */]); $promise = $client->describeCasesAsync([/* ... */]);
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
nextTokenvalues, which specify where to paginate the returned records represented by theCaseDetailsobjects.
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.
-
You must have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan to use the Amazon Web Services Support API. If you're in an Amazon Web Services Region that doesn't offer one of these Amazon Web Services Support plans, or if you haven't transitioned to one of these plans, you can use the Amazon Web Services Support API with a Business, Enterprise On-Ramp, or Enterprise Support plan.
-
If you call the Amazon Web Services Support API from an account that doesn't have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
Each Communication returned by this operation includes attachment information in two fields:
-
attachmentSet: returns only attachments that are 5 MB or smaller. Attachments larger than 5 MB are not included in this field. -
attachments: returns all attachments regardless of size.
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.
Parameter Syntax
$result = $client->describeCases([
'afterTime' => '<string>',
'beforeTime' => '<string>',
'caseIdList' => ['<string>', ...],
'displayId' => '<string>',
'dryRun' => true || false,
'includeCommunications' => true || false,
'includeResolvedCases' => true || false,
'language' => '<string>',
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- afterTime
-
- Type: string
The start date for a filtered date search on support case communications. Case communications are available for 24 months after creation.
- beforeTime
-
- Type: string
The end date for a filtered date search on support case communications. Case communications are available for 24 months after creation.
- caseIdList
-
- Type: Array of strings
A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.
- displayId
-
- Type: string
The ID displayed for a case in the Amazon Web Services Support Center user interface.
- dryRun
-
- Type: boolean
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 aDryRunOperationException. When omitted or set tofalse, the request runs normally. - includeCommunications
-
- Type: boolean
Specifies whether to include communications in the
DescribeCasesresponse. By default, communications are included. - includeResolvedCases
-
- Type: boolean
Specifies whether to include resolved support cases in the
DescribeCasesresponse. By default, resolved cases aren't included. - language
-
- Type: string
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
languageparameter if you want support in that language. - maxResults
-
- Type: int
The maximum number of results to return before paginating.
- nextToken
-
- Type: string
A resumption point for pagination.
Result Syntax
[
'cases' => [
[
'caseId' => '<string>',
'categoryCode' => '<string>',
'ccEmailAddresses' => ['<string>', ...],
'displayId' => '<string>',
'language' => '<string>',
'recentCommunications' => [
'communications' => [
[
'attachmentSet' => [
[
'attachmentId' => '<string>',
'fileName' => '<string>',
],
// ...
],
'attachments' => [
[
'attachmentId' => '<string>',
'fileName' => '<string>',
],
// ...
],
'body' => '<string>',
'caseId' => '<string>',
'submittedBy' => '<string>',
'timeCreated' => '<string>',
],
// ...
],
'nextToken' => '<string>',
],
'serviceCode' => '<string>',
'severityCode' => '<string>',
'status' => '<string>',
'subject' => '<string>',
'submittedBy' => '<string>',
'timeCreated' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- cases
-
- Type: Array of CaseDetails structures
The details for the cases that match the request.
- nextToken
-
- Type: string
A resumption point for pagination.
Errors
- InternalServerError:
An internal server error occurred.
- CaseIdNotFound:
The requested
caseIdcouldn't be located.- DryRunOperationException:
The request was valid, but the operation wasn't performed because
dryRunwas set totrue.
DescribeCommunications
$result = $client->describeCommunications([/* ... */]); $promise = $client->describeCommunicationsAsync([/* ... */]);
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.
-
You must have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan to use the Amazon Web Services Support API. If you're in an Amazon Web Services Region that doesn't offer one of these Amazon Web Services Support plans, or if you haven't transitioned to one of these plans, you can use the Amazon Web Services Support API with a Business, Enterprise On-Ramp, or Enterprise Support plan.
-
If you call the Amazon Web Services Support API from an account that doesn't have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
Each Communication returned by this operation includes attachment information in two fields:
-
attachmentSet: returns only attachments that are 5 MB or smaller. Attachments larger than 5 MB are not included in this field. -
attachments: returns all attachments regardless of size.
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.
Parameter Syntax
$result = $client->describeCommunications([
'afterTime' => '<string>',
'beforeTime' => '<string>',
'caseId' => '<string>', // REQUIRED
'dryRun' => true || false,
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- afterTime
-
- Type: string
The start date for a filtered date search on support case communications. Case communications are available for 24 months after creation.
- beforeTime
-
- Type: string
The end date for a filtered date search on support case communications. Case communications are available for 24 months after creation.
- caseId
-
- Required: Yes
- Type: string
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
- dryRun
-
- Type: boolean
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 aDryRunOperationException. When omitted or set tofalse, the request runs normally. - maxResults
-
- Type: int
The maximum number of results to return before paginating.
- nextToken
-
- Type: string
A resumption point for pagination.
Result Syntax
[
'communications' => [
[
'attachmentSet' => [
[
'attachmentId' => '<string>',
'fileName' => '<string>',
],
// ...
],
'attachments' => [
[
'attachmentId' => '<string>',
'fileName' => '<string>',
],
// ...
],
'body' => '<string>',
'caseId' => '<string>',
'submittedBy' => '<string>',
'timeCreated' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- communications
-
- Type: Array of Communication structures
The communications for the case.
- nextToken
-
- Type: string
A resumption point for pagination.
Errors
- InternalServerError:
An internal server error occurred.
- CaseIdNotFound:
The requested
caseIdcouldn't be located.- DryRunOperationException:
The request was valid, but the operation wasn't performed because
dryRunwas set totrue.
DescribeCreateCaseOptions
$result = $client->describeCreateCaseOptions([/* ... */]); $promise = $client->describeCreateCaseOptionsAsync([/* ... */]);
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.
-
You must have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan to use the Amazon Web Services Support API. If you're in an Amazon Web Services Region that doesn't offer one of these Amazon Web Services Support plans, or if you haven't transitioned to one of these plans, you can use the Amazon Web Services Support API with a Business, Enterprise On-Ramp, or Enterprise Support plan.
-
If you call the Amazon Web Services Support API from an account that doesn't have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
Parameter Syntax
$result = $client->describeCreateCaseOptions([
'categoryCode' => '<string>', // REQUIRED
'dryRun' => true || false,
'issueType' => '<string>', // REQUIRED
'language' => '<string>', // REQUIRED
'serviceCode' => '<string>', // REQUIRED
]);
Parameter Details
Members
- categoryCode
-
- Required: Yes
- Type: string
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.
- dryRun
-
- Type: boolean
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 aDryRunOperationException. When omitted or set tofalse, the request runs normally. - issueType
-
- Required: Yes
- Type: string
The type of issue for the case. You can specify
customer-serviceortechnical. If you don't specify a value, the default istechnical. - language
-
- Required: Yes
- Type: string
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
languageparameter if you want support in that language. - serviceCode
-
- Required: Yes
- Type: string
The code for the Amazon Web Services service. You can use the DescribeServices operation to get the possible
serviceCodevalues.
Result Syntax
[
'communicationTypes' => [
[
'datesWithoutSupport' => [
[
'endDateTime' => '<string>',
'startDateTime' => '<string>',
],
// ...
],
'supportedHours' => [
[
'endTime' => '<string>',
'startTime' => '<string>',
],
// ...
],
'type' => '<string>',
],
// ...
],
'languageAvailability' => '<string>',
]
Result Details
Members
- communicationTypes
-
- Type: Array of CommunicationTypeOptions structures
A JSON-formatted array that contains the available communication type options, along with the available support timeframes for the given inputs.
- languageAvailability
-
- Type: string
Language availability can be any of the following:
-
available
-
best_effort
-
unavailable
Errors
- InternalServerError:
An internal server error occurred.
- ThrottlingException:
You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.
- DryRunOperationException:
The request was valid, but the operation wasn't performed because
dryRunwas set totrue.
DescribeServices
$result = $client->describeServices([/* ... */]); $promise = $client->describeServicesAsync([/* ... */]);
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.
-
You must have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan to use the Amazon Web Services Support API. If you're in an Amazon Web Services Region that doesn't offer one of these Amazon Web Services Support plans, or if you haven't transitioned to one of these plans, you can use the Amazon Web Services Support API with a Business, Enterprise On-Ramp, or Enterprise Support plan.
-
If you call the Amazon Web Services Support API from an account that doesn't have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
Parameter Syntax
$result = $client->describeServices([
'dryRun' => true || false,
'language' => '<string>',
'serviceCodeList' => ['<string>', ...],
]);
Parameter Details
Members
- dryRun
-
- Type: boolean
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 aDryRunOperationException. When omitted or set tofalse, the request runs normally. - language
-
- Type: string
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
languageparameter if you want support in that language. - serviceCodeList
-
- Type: Array of strings
A JSON-formatted list of service codes available for Amazon Web Services services.
Result Syntax
[
'services' => [
[
'categories' => [
[
'code' => '<string>',
'name' => '<string>',
],
// ...
],
'code' => '<string>',
'name' => '<string>',
],
// ...
],
]
Result Details
Members
- services
-
- Type: Array of Service structures
A JSON-formatted list of Amazon Web Services services.
Errors
- InternalServerError:
An internal server error occurred.
- DryRunOperationException:
The request was valid, but the operation wasn't performed because
dryRunwas set totrue.
DescribeSeverityLevels
$result = $client->describeSeverityLevels([/* ... */]); $promise = $client->describeSeverityLevelsAsync([/* ... */]);
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.
-
You must have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan to use the Amazon Web Services Support API. If you're in an Amazon Web Services Region that doesn't offer one of these Amazon Web Services Support plans, or if you haven't transitioned to one of these plans, you can use the Amazon Web Services Support API with a Business, Enterprise On-Ramp, or Enterprise Support plan.
-
If you call the Amazon Web Services Support API from an account that doesn't have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
Parameter Syntax
$result = $client->describeSeverityLevels([
'dryRun' => true || false,
'language' => '<string>',
]);
Parameter Details
Members
- dryRun
-
- Type: boolean
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 aDryRunOperationException. When omitted or set tofalse, the request runs normally. - language
-
- Type: string
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
languageparameter if you want support in that language.
Result Syntax
[
'severityLevels' => [
[
'code' => '<string>',
'name' => '<string>',
],
// ...
],
]
Result Details
Members
- severityLevels
-
- Type: Array of SeverityLevel structures
The available severity levels for the support case. Available severity levels are defined by your service level agreement with Amazon Web Services.
Errors
- InternalServerError:
An internal server error occurred.
- DryRunOperationException:
The request was valid, but the operation wasn't performed because
dryRunwas set totrue.
DescribeSupportedLanguages
$result = $client->describeSupportedLanguages([/* ... */]); $promise = $client->describeSupportedLanguagesAsync([/* ... */]);
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.
-
You must have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan to use the Amazon Web Services Support API. If you're in an Amazon Web Services Region that doesn't offer one of these Amazon Web Services Support plans, or if you haven't transitioned to one of these plans, you can use the Amazon Web Services Support API with a Business, Enterprise On-Ramp, or Enterprise Support plan.
-
If you call the Amazon Web Services Support API from an account that doesn't have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
Parameter Syntax
$result = $client->describeSupportedLanguages([
'categoryCode' => '<string>', // REQUIRED
'dryRun' => true || false,
'issueType' => '<string>', // REQUIRED
'serviceCode' => '<string>', // REQUIRED
]);
Parameter Details
Members
- categoryCode
-
- Required: Yes
- Type: string
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.
- dryRun
-
- Type: boolean
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 aDryRunOperationException. When omitted or set tofalse, the request runs normally. - issueType
-
- Required: Yes
- Type: string
The type of issue for the case. You can specify
customer-serviceortechnical. - serviceCode
-
- Required: Yes
- Type: string
The code for the Amazon Web Services service. You can use the DescribeServices operation to get the possible
serviceCodevalues.
Result Syntax
[
'supportedLanguages' => [
[
'code' => '<string>',
'display' => '<string>',
'language' => '<string>',
],
// ...
],
]
Result Details
Members
- supportedLanguages
-
- Type: Array of SupportedLanguage structures
A JSON-formatted array that contains the available ISO 639-1 language codes.
Errors
- InternalServerError:
An internal server error occurred.
- ThrottlingException:
You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.
- DryRunOperationException:
The request was valid, but the operation wasn't performed because
dryRunwas set totrue.
DescribeTrustedAdvisorCheckRefreshStatuses
$result = $client->describeTrustedAdvisorCheckRefreshStatuses([/* ... */]); $promise = $client->describeTrustedAdvisorCheckRefreshStatusesAsync([/* ... */]);
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.
-
You must have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan to use the Amazon Web Services Support API. If you're in an Amazon Web Services Region that doesn't offer one of these Amazon Web Services Support plans, or if you haven't transitioned to one of these plans, you can use the Amazon Web Services Support API with a Business, Enterprise On-Ramp, or Enterprise Support plan.
-
If you call the Amazon Web Services Support API from an account that doesn't have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
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.
Parameter Syntax
$result = $client->describeTrustedAdvisorCheckRefreshStatuses([
'checkIds' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- checkIds
-
- Required: Yes
- Type: Array of strings
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
InvalidParameterValueerror.
Result Syntax
[
'statuses' => [
[
'checkId' => '<string>',
'millisUntilNextRefreshable' => <integer>,
'status' => '<string>',
],
// ...
],
]
Result Details
Members
- statuses
-
- Required: Yes
- Type: Array of TrustedAdvisorCheckRefreshStatus structures
The refresh status of the specified Trusted Advisor checks.
Errors
- InternalServerError:
An internal server error occurred.
- ThrottlingException:
You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.
DescribeTrustedAdvisorCheckResult
$result = $client->describeTrustedAdvisorCheckResult([/* ... */]); $promise = $client->describeTrustedAdvisorCheckResultAsync([/* ... */]);
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:
-
status - The alert status of the check can be
ok(green),warning(yellow),error(red), ornot_available. -
timestamp - The time of the last refresh of the check.
-
checkId - The unique identifier for the check.
-
You must have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan to use the Amazon Web Services Support API. If you're in an Amazon Web Services Region that doesn't offer one of these Amazon Web Services Support plans, or if you haven't transitioned to one of these plans, you can use the Amazon Web Services Support API with a Business, Enterprise On-Ramp, or Enterprise Support plan.
-
If you call the Amazon Web Services Support API from an account that doesn't have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
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.
Parameter Syntax
$result = $client->describeTrustedAdvisorCheckResult([
'checkId' => '<string>', // REQUIRED
'language' => '<string>',
]);
Parameter Details
Members
- checkId
-
- Required: Yes
- Type: string
The unique identifier for the Trusted Advisor check.
- language
-
- Type: string
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:
-
Chinese, Simplified -
zh -
Chinese, Traditional -
zh_TW -
English -
en -
French -
fr -
German -
de -
Indonesian -
id -
Italian -
it -
Japanese -
ja -
Korean -
ko -
Portuguese, Brazilian -
pt_BR -
Spanish -
es
Result Syntax
[
'result' => [
'categorySpecificSummary' => [
'costOptimizing' => [
'estimatedMonthlySavings' => <float>,
'estimatedPercentMonthlySavings' => <float>,
],
],
'checkId' => '<string>',
'flaggedResources' => [
[
'isSuppressed' => true || false,
'metadata' => ['<string>', ...],
'region' => '<string>',
'resourceId' => '<string>',
'status' => '<string>',
],
// ...
],
'resourcesSummary' => [
'resourcesFlagged' => <integer>,
'resourcesIgnored' => <integer>,
'resourcesProcessed' => <integer>,
'resourcesSuppressed' => <integer>,
],
'status' => '<string>',
'timestamp' => '<string>',
],
]
Result Details
Members
- result
-
- Type: TrustedAdvisorCheckResult structure
The detailed results of the Trusted Advisor check.
Errors
- InternalServerError:
An internal server error occurred.
- ThrottlingException:
You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.
DescribeTrustedAdvisorCheckSummaries
$result = $client->describeTrustedAdvisorCheckSummaries([/* ... */]); $promise = $client->describeTrustedAdvisorCheckSummariesAsync([/* ... */]);
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.
-
You must have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan to use the Amazon Web Services Support API. If you're in an Amazon Web Services Region that doesn't offer one of these Amazon Web Services Support plans, or if you haven't transitioned to one of these plans, you can use the Amazon Web Services Support API with a Business, Enterprise On-Ramp, or Enterprise Support plan.
-
If you call the Amazon Web Services Support API from an account that doesn't have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
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.
Parameter Syntax
$result = $client->describeTrustedAdvisorCheckSummaries([
'checkIds' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- checkIds
-
- Required: Yes
- Type: Array of strings
The IDs of the Trusted Advisor checks.
Result Syntax
[
'summaries' => [
[
'categorySpecificSummary' => [
'costOptimizing' => [
'estimatedMonthlySavings' => <float>,
'estimatedPercentMonthlySavings' => <float>,
],
],
'checkId' => '<string>',
'hasFlaggedResources' => true || false,
'resourcesSummary' => [
'resourcesFlagged' => <integer>,
'resourcesIgnored' => <integer>,
'resourcesProcessed' => <integer>,
'resourcesSuppressed' => <integer>,
],
'status' => '<string>',
'timestamp' => '<string>',
],
// ...
],
]
Result Details
Members
- summaries
-
- Required: Yes
- Type: Array of TrustedAdvisorCheckSummary structures
The summary information for the requested Trusted Advisor checks.
Errors
- InternalServerError:
An internal server error occurred.
- ThrottlingException:
You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.
DescribeTrustedAdvisorChecks
$result = $client->describeTrustedAdvisorChecks([/* ... */]); $promise = $client->describeTrustedAdvisorChecksAsync([/* ... */]);
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.
-
You must have a Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn't have a Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support. -
The names and descriptions for Trusted Advisor checks are subject to change. We recommend that you specify the check ID in your code to uniquely identify a 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.
Parameter Syntax
$result = $client->describeTrustedAdvisorChecks([
'language' => '<string>', // REQUIRED
]);
Parameter Details
Members
- language
-
- Required: Yes
- Type: string
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:
-
Chinese, Simplified -
zh -
Chinese, Traditional -
zh_TW -
English -
en -
French -
fr -
German -
de -
Indonesian -
id -
Italian -
it -
Japanese -
ja -
Korean -
ko -
Portuguese, Brazilian -
pt_BR -
Spanish -
es
Result Syntax
[
'checks' => [
[
'category' => '<string>',
'description' => '<string>',
'id' => '<string>',
'metadata' => ['<string>', ...],
'name' => '<string>',
],
// ...
],
]
Result Details
Members
- checks
-
- Required: Yes
- Type: Array of TrustedAdvisorCheckDescription structures
Information about all available Trusted Advisor checks.
Errors
- InternalServerError:
An internal server error occurred.
- ThrottlingException:
You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.
GetAttachmentDownloadLink
$result = $client->getAttachmentDownloadLink([/* ... */]); $promise = $client->getAttachmentDownloadLinkAsync([/* ... */]);
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.
-
You must have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan to use the Amazon Web Services Support API. If you're in an Amazon Web Services Region that doesn't offer one of these Amazon Web Services Support plans, or if you haven't transitioned to one of these plans, you can use the Amazon Web Services Support API with a Business, Enterprise On-Ramp, or Enterprise Support plan.
-
If you call the Amazon Web Services Support API from an account that doesn't have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
Parameter Syntax
$result = $client->getAttachmentDownloadLink([
'attachmentId' => '<string>', // REQUIRED
'dryRun' => true || false,
]);
Parameter Details
Members
- attachmentId
-
- Required: Yes
- Type: string
The unique identifier of the attachment for which to retrieve a download link. Attachment IDs are returned in the
AttachmentDetailsobjects in theattachmentsfield of a Communication returned by DescribeCommunications or DescribeCases. - dryRun
-
- Type: boolean
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 aDryRunOperationException. When omitted or set tofalse, the request runs normally.
Result Syntax
[
'downloadUrl' => [
'expiryDate' => '<string>',
'url' => '<string>',
],
'fileName' => '<string>',
]
Result Details
Members
- downloadUrl
-
- Required: Yes
- Type: DownloadUrl structure
The presigned download URL and the date and time the URL expires.
- fileName
-
- Required: Yes
- Type: string
The name of the attachment file, including the file extension.
Errors
- AttachmentIdNotFound:
An attachment with the specified ID could not be found.
- InternalServerError:
An internal server error occurred.
- DryRunOperationException:
The request was valid, but the operation wasn't performed because
dryRunwas set totrue.
GetAttachmentUploadLinks
$result = $client->getAttachmentUploadLinks([/* ... */]); $promise = $client->getAttachmentUploadLinksAsync([/* ... */]);
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.
-
You must have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan to use the Amazon Web Services Support API. If you're in an Amazon Web Services Region that doesn't offer one of these Amazon Web Services Support plans, or if you haven't transitioned to one of these plans, you can use the Amazon Web Services Support API with a Business, Enterprise On-Ramp, or Enterprise Support plan.
-
If you call the Amazon Web Services Support API from an account that doesn't have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
Parameter Syntax
$result = $client->getAttachmentUploadLinks([
'dryRun' => true || false,
'fileName' => '<string>', // REQUIRED
'fileSizeBytes' => <integer>,
'uploadId' => '<string>',
'uploadRange' => [
'endIndex' => <integer>,
'startIndex' => <integer>, // REQUIRED
],
]);
Parameter Details
Members
- dryRun
-
- Type: boolean
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 aDryRunOperationException. When omitted or set tofalse, the request runs normally. - fileName
-
- Required: Yes
- Type: string
The name of the file to upload, including the file extension. This value is required when you initiate a new upload.
- fileSizeBytes
-
- Type: long (int|float)
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
uploadIdisn't provided). Valid range: 1 to 157,286,400 bytes (approximately 150 MB). - uploadId
-
- Type: string
The unique identifier of an in-progress multipart upload, returned by a previous call to
GetAttachmentUploadLinks. SpecifyuploadIdto retrieve additional presigned upload URLs for an upload that has already been initiated. Required whenfileSizeBytesisn't provided. Length: 1 to 2,048 characters. - uploadRange
-
- Type: UploadRange structure
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.
Result Syntax
[
'nextIndex' => <integer>,
'partSizeBytes' => <integer>,
'totalParts' => <integer>,
'uploadId' => '<string>',
'uploadUrls' => [
[
'expiryDate' => '<string>',
'partIndex' => <integer>,
'url' => '<string>',
],
// ...
],
]
Result Details
Members
- nextIndex
-
- Type: int
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 thestartIndexinuploadRangeon a subsequent call toGetAttachmentUploadLinksto retrieve the next batch of upload URLs. - partSizeBytes
-
- Required: Yes
- Type: long (int|float)
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
ntotal parts, parts 1 throughn- 1 are exactly this size; the last part may be smaller. Maximum: 104,857,600 bytes (approximately 100 MB). - totalParts
-
- Required: Yes
- Type: int
The total number of parts that the file is split into. Upload one part to each presigned URL.
- uploadId
-
- Required: Yes
- Type: string
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 theuploadIdsparameter on CreateCase or AddCommunicationToCase. - uploadUrls
-
- Required: Yes
- Type: Array of UploadUrl structures
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
PUTbefore the URL expires.
Errors
- InternalServerError:
An internal server error occurred.
- DryRunOperationException:
The request was valid, but the operation wasn't performed because
dryRunwas set totrue.- UploadIdNotFound:
The specified
uploadIdcouldn't be located.
RefreshTrustedAdvisorCheck
$result = $client->refreshTrustedAdvisorCheck([/* ... */]); $promise = $client->refreshTrustedAdvisorCheckAsync([/* ... */]);
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.
-
You must have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan to use the Amazon Web Services Support API. If you're in an Amazon Web Services Region that doesn't offer one of these Amazon Web Services Support plans, or if you haven't transitioned to one of these plans, you can use the Amazon Web Services Support API with a Business, Enterprise On-Ramp, or Enterprise Support plan.
-
If you call the Amazon Web Services Support API from an account that doesn't have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
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.
Parameter Syntax
$result = $client->refreshTrustedAdvisorCheck([
'checkId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- checkId
-
- Required: Yes
- Type: string
The unique identifier for the Trusted Advisor check to refresh.
Specifying the check ID of a check that is automatically refreshed causes an
InvalidParameterValueerror.
Result Syntax
[
'status' => [
'checkId' => '<string>',
'millisUntilNextRefreshable' => <integer>,
'status' => '<string>',
],
]
Result Details
Members
- status
-
- Required: Yes
- Type: TrustedAdvisorCheckRefreshStatus structure
The current refresh status for a check, including the amount of time until the check is eligible for refresh.
Errors
- InternalServerError:
An internal server error occurred.
ResolveCase
$result = $client->resolveCase([/* ... */]); $promise = $client->resolveCaseAsync([/* ... */]);
Resolves a support case. This operation takes a caseId and returns the initial and final state of the case.
-
You must have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan to use the Amazon Web Services Support API. If you're in an Amazon Web Services Region that doesn't offer one of these Amazon Web Services Support plans, or if you haven't transitioned to one of these plans, you can use the Amazon Web Services Support API with a Business, Enterprise On-Ramp, or Enterprise Support plan.
-
If you call the Amazon Web Services Support API from an account that doesn't have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
Parameter Syntax
$result = $client->resolveCase([
'caseId' => '<string>',
'dryRun' => true || false,
]);
Parameter Details
Members
- caseId
-
- Type: string
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
- dryRun
-
- Type: boolean
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 aDryRunOperationException. When omitted or set tofalse, the request runs normally.
Result Syntax
[
'finalCaseStatus' => '<string>',
'initialCaseStatus' => '<string>',
]
Result Details
Members
- finalCaseStatus
-
- Type: string
The status of the case after the ResolveCase request was processed.
- initialCaseStatus
-
- Type: string
The status of the case when the ResolveCase request was sent.
Errors
- InternalServerError:
An internal server error occurred.
- CaseIdNotFound:
The requested
caseIdcouldn't be located.- DryRunOperationException:
The request was valid, but the operation wasn't performed because
dryRunwas set totrue.
Shapes
Attachment
Description
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
Members
- data
-
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The content of the attachment file.
- fileName
-
- Type: string
The name of the attachment file.
AttachmentDetails
Description
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.
Members
- attachmentId
-
- Type: string
The ID of the attachment.
- fileName
-
- Type: string
The file name of the attachment.
AttachmentIdNotFound
Description
An attachment with the specified ID could not be found.
Members
- message
-
- Type: string
An attachment with the specified ID could not be found.
AttachmentLimitExceeded
Description
The limit for the number of attachment sets created in a short period of time has been exceeded.
Members
- message
-
- Type: string
The limit for the number of attachment sets created in a short period of time has been exceeded.
AttachmentSetExpired
Description
The expiration time of the attachment set has passed. The set expires 1 hour after it is created.
Members
- message
-
- Type: string
The expiration time of the attachment set has passed. The set expires one hour after it is created.
AttachmentSetIdNotFound
Description
An attachment set with the specified ID could not be found.
Members
- message
-
- Type: string
An attachment set with the specified ID could not be found.
AttachmentSetSizeLimitExceeded
Description
A limit for the size of an attachment set has been exceeded. The limits are three attachments and 5 MB per attachment.
Members
- message
-
- Type: string
A limit for the size of an attachment set has been exceeded. The limits are three attachments and 5 MB per attachment.
CaseCreationLimitExceeded
Description
The case creation limit for the account has been exceeded.
Members
- message
-
- Type: string
An error message that indicates that you have exceeded the number of cases you can have open.
CaseDetails
Description
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
CategoryCodevalues 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
languageparameter 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, andtimeCreated. -
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, andcritical. -
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.
Members
- caseId
-
- Type: string
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
-
- Type: string
The category of problem for the support case.
- ccEmailAddresses
-
- Type: Array of strings
The email addresses that receive copies of communication about the case.
- displayId
-
- Type: string
The ID displayed for the case in the Amazon Web Services Support Center. This is a numeric string.
- language
-
- Type: string
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
languageparameter if you want support in that language. - recentCommunications
-
- Type: RecentCaseCommunications structure
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
nextTokenthat you can use to retrieve earlier communications. - serviceCode
-
- Type: string
The code for the Amazon Web Services service. You can get a list of codes and the corresponding service names by calling DescribeServices.
- severityCode
-
- Type: string
The code for the severity level returned by the call to DescribeSeverityLevels.
- status
-
- Type: string
The status of the case.
Valid values:
-
all-open -
customer-action-completed -
opened -
pending-customer-action -
reopened -
resolved -
unassigned -
work-in-progress
- subject
-
- Type: string
The subject line for the case in the Amazon Web Services Support Center.
- submittedBy
-
- Type: string
The email address of the account that submitted the case.
- timeCreated
-
- Type: string
The time that the case was created in the Amazon Web Services Support Center.
CaseIdNotFound
Description
The requested caseId couldn't be located.
Members
- message
-
- Type: string
The requested
CaseIdcould not be located.
Category
Description
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.
Members
- code
-
- Type: string
The category code for the support case.
- name
-
- Type: string
The category name for the support case.
Communication
Description
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.
Members
- attachmentSet
-
- Type: Array of AttachmentDetails structures
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
attachmentsfield instead. - attachments
-
- Type: Array of AttachmentDetails structures
Information about all attachments on the case communication. This includes attachments added through
AddAttachmentsToSetand attachments uploaded throughGetAttachmentUploadLinks.Use this field to enumerate every attachment on the communication. To download an attachment listed in this field, use GetAttachmentDownloadLink.
GetAttachmentDownloadLinkreturns a presigned URL that works for attachments of any size. - body
-
- Type: string
The text of the communication between the customer and Amazon Web Services Support.
- caseId
-
- Type: string
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
- submittedBy
-
- Type: string
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.
- timeCreated
-
- Type: string
The time the communication was created.
CommunicationTypeOptions
Description
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,webandcall.
Members
- datesWithoutSupport
-
- Type: Array of DateInterval structures
A JSON-formatted list containing date and time ranges for periods without support
- supportedHours
-
- Type: Array of SupportedHour structures
A JSON-formatted list containing time ranges when support is available.
- type
-
- Type: string
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.
CompletedUpload
Description
Identifies a single uploaded part of a multipart attachment upload. Pass a list of CompletedUpload objects to CompleteAttachmentUpload to finalize the upload.
Members
- eTag
-
- Required: Yes
- Type: string
The ETag returned in the response headers when the part was uploaded to Amazon S3. The
ETagvalue identifies the part contents. - partIndex
-
- Required: Yes
- Type: int
The index of the uploaded part. This is the same
partIndexvalue returned for the corresponding entry in theuploadUrlsfield of theGetAttachmentUploadLinksresponse.
DateInterval
Description
Date and time (UTC) format in RFC 3339 : 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'.
Members
- endDateTime
-
- Type: string
End Date Time (UTC). RFC 3339 format : 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'.
- startDateTime
-
- Type: string
A JSON object containing start and date time (UTC). Date and time format is RFC 3339 : 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'.
DescribeAttachmentLimitExceeded
Description
The limit for the number of DescribeAttachment requests in a short period of time has been exceeded.
Members
- message
-
- Type: string
The limit for the number of DescribeAttachment requests in a short period of time has been exceeded.
DownloadUrl
Description
A presigned URL for downloading an attachment, along with the date and time the URL expires. Returned by GetAttachmentDownloadLink.
Members
- expiryDate
-
- Required: Yes
- Type: string
The date and time, in ISO-8601 format, when the presigned URL expires. Download the attachment before this time.
- url
-
- Required: Yes
- Type: string
The presigned HTTPS URL that you can use to download the attachment. Download URLs are served from
downloadv1.attachments.support.{region}.amazonaws.com. Thedownloadv1prefix is subject to change.
DryRunOperationException
Description
The request was valid, but the operation wasn't performed because dryRun was set to true.
Members
- message
-
- Type: string
InternalServerError
Description
An internal server error occurred.
Members
- message
-
- Type: string
An internal server error occurred.
RecentCaseCommunications
Description
The five most recent communications associated with the case.
Members
- communications
-
- Type: Array of Communication structures
The five most recent communications associated with the case.
- nextToken
-
- Type: string
A resumption point for pagination.
Service
Description
Information about an Amazon Web Services service returned by the DescribeServices operation.
Members
- categories
-
- Type: Array of Category structures
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.
- code
-
- Type: string
The code for an Amazon Web Services service returned by the DescribeServices response. The
nameelement contains the corresponding friendly name. - name
-
- Type: string
The friendly name for an Amazon Web Services service. The
codeelement contains the corresponding code.
SeverityLevel
Description
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.
Members
- code
-
- Type: string
The code for case severity level.
Valid values:
low|normal|high|urgent|critical - name
-
- Type: string
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:
-
low- General guidance -
normal- System impaired -
high- Production system impaired -
urgent- Production system down -
critical- Business-critical system down
For more information, see Choosing a severity in the Amazon Web Services Support User Guide.
SupportedHour
Description
Time range object with startTime and endTime range in RFC 3339 format. 'HH:mm:ss.SSS'.
Members
- endTime
-
- Type: string
End Time. RFC 3339 format
'HH:mm:ss.SSS'. - startTime
-
- Type: string
Start Time. RFC 3339 format
'HH:mm:ss.SSS'.
SupportedLanguage
Description
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.
Members
- code
-
- Type: string
2 digit ISO 639-1 code. e.g.
en - display
-
- Type: string
Language display value e.g.
ENGLISH - language
-
- Type: string
Full language description e.g.
ENGLISH
ThrottlingException
Description
You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.
Members
- message
-
- Type: string
- throttlingReasons
-
- Type: Array of ThrottlingReason structures
A list of one or more reasons that the request was throttled.
ThrottlingReason
Description
Information about why a request was throttled.
Members
- reason
-
- Type: string
The reason that the request was throttled.
- resource
-
- Type: string
The resource that caused the request to be throttled.
TrustedAdvisorCategorySpecificSummary
Description
The container for summary information that relates to the category of the Trusted Advisor check.
Members
- costOptimizing
-
- Type: TrustedAdvisorCostOptimizingSummary structure
The summary information about cost savings for a Trusted Advisor check that is in the Cost Optimizing category.
TrustedAdvisorCheckDescription
Description
The description and metadata for a Trusted Advisor check.
Members
- category
-
- Required: Yes
- Type: string
The category of the Trusted Advisor check.
- description
-
- Required: Yes
- Type: string
The description of the Trusted Advisor check, which includes the alert criteria and recommended operations (contains HTML markup).
- id
-
- Required: Yes
- Type: string
The unique identifier for the Trusted Advisor check.
- metadata
-
- Required: Yes
- Type: Array of strings
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.
- name
-
- Required: Yes
- Type: string
The display name for the Trusted Advisor check.
TrustedAdvisorCheckRefreshStatus
Description
The refresh status of a Trusted Advisor check.
Members
- checkId
-
- Required: Yes
- Type: string
The unique identifier for the Trusted Advisor check.
- millisUntilNextRefreshable
-
- Required: Yes
- Type: long (int|float)
The amount of time, in milliseconds, until the Trusted Advisor check is eligible for refresh.
- status
-
- Required: Yes
- Type: string
The status of the Trusted Advisor check for which a refresh has been requested:
-
none- The check is not refreshed or the non-success status exceeds the timeout -
enqueued- The check refresh requests has entered the refresh queue -
processing- The check refresh request is picked up by the rule processing engine -
success- The check is successfully refreshed -
abandoned- The check refresh has failed
TrustedAdvisorCheckResult
Description
The results of a Trusted Advisor check returned by DescribeTrustedAdvisorCheckResult.
Members
- categorySpecificSummary
-
- Required: Yes
- Type: TrustedAdvisorCategorySpecificSummary structure
Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.
- checkId
-
- Required: Yes
- Type: string
The unique identifier for the Trusted Advisor check.
- flaggedResources
-
- Required: Yes
- Type: Array of TrustedAdvisorResourceDetail structures
The details about each resource listed in the check result.
- resourcesSummary
-
- Required: Yes
- Type: TrustedAdvisorResourcesSummary structure
Details about Amazon Web Services resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries.
- status
-
- Required: Yes
- Type: string
The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".
- timestamp
-
- Required: Yes
- Type: string
The time of the last refresh of the check.
TrustedAdvisorCheckSummary
Description
A summary of a Trusted Advisor check result, including the alert status, last refresh, and number of resources examined.
Members
- categorySpecificSummary
-
- Required: Yes
- Type: TrustedAdvisorCategorySpecificSummary structure
Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.
- checkId
-
- Required: Yes
- Type: string
The unique identifier for the Trusted Advisor check.
- hasFlaggedResources
-
- Type: boolean
Specifies whether the Trusted Advisor check has flagged resources.
- resourcesSummary
-
- Required: Yes
- Type: TrustedAdvisorResourcesSummary structure
Details about Amazon Web Services resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries.
- status
-
- Required: Yes
- Type: string
The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".
- timestamp
-
- Required: Yes
- Type: string
The time of the last refresh of the check.
TrustedAdvisorCostOptimizingSummary
Description
The estimated cost savings that might be realized if the recommended operations are taken.
Members
- estimatedMonthlySavings
-
- Required: Yes
- Type: double
The estimated monthly savings that might be realized if the recommended operations are taken.
- estimatedPercentMonthlySavings
-
- Required: Yes
- Type: double
The estimated percentage of savings that might be realized if the recommended operations are taken.
TrustedAdvisorResourceDetail
Description
Contains information about a resource identified by a Trusted Advisor check.
Members
- isSuppressed
-
- Type: boolean
Specifies whether the Amazon Web Services resource was ignored by Trusted Advisor because it was marked as suppressed by the user.
- metadata
-
- Required: Yes
- Type: Array of strings
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.
- region
-
- Type: string
The Amazon Web Services Region in which the identified resource is located.
- resourceId
-
- Required: Yes
- Type: string
The unique identifier for the identified resource.
- status
-
- Required: Yes
- Type: string
The status code for the resource identified in the Trusted Advisor check.
TrustedAdvisorResourcesSummary
Description
Details about Amazon Web Services resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries.
Members
- resourcesFlagged
-
- Required: Yes
- Type: long (int|float)
The number of Amazon Web Services resources that were flagged (listed) by the Trusted Advisor check.
- resourcesIgnored
-
- Required: Yes
- Type: long (int|float)
The number of Amazon Web Services resources ignored by Trusted Advisor because information was unavailable.
- resourcesProcessed
-
- Required: Yes
- Type: long (int|float)
The number of Amazon Web Services resources that were analyzed by the Trusted Advisor check.
- resourcesSuppressed
-
- Required: Yes
- Type: long (int|float)
The number of Amazon Web Services resources ignored by Trusted Advisor because they were marked as suppressed by the user.
UploadIdNotFound
Description
The specified uploadId couldn't be located.
Members
- message
-
- Type: string
UploadProgress
Description
The progress of a multipart attachment upload, returned by DescribeAttachmentUploadStatus.
Members
- completedPartsCount
-
- Type: int
The number of parts that have been successfully uploaded.
- totalParts
-
- Type: int
The total number of parts that the file is split into.
UploadRange
Description
The range of part indexes for which to return presigned upload URLs from GetAttachmentUploadLinks.
Members
- endIndex
-
- Type: int
The ending part index of the range, exclusive. The range is half-open:
startIndexis inclusive andendIndexis exclusive. For example, a range withstartIndexof 1 andendIndexof 4 requests URLs for parts 1, 2, and 3. The range size (endIndex-startIndex) must not exceed 10. If you omitendIndex, the service defaults tostartIndex+ 10, capped by the total number of parts. - startIndex
-
- Required: Yes
- Type: int
The starting part index of the range, inclusive. Part indexes start at 1.
UploadUrl
Description
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.
Members
- expiryDate
-
- Required: Yes
- Type: string
The date and time, in ISO-8601 format, when the presigned URL expires. Upload the part before this time.
- partIndex
-
- Required: Yes
- Type: int
The index of the part that this URL uploads.
- url
-
- Required: Yes
- Type: string
The presigned HTTPS URL that you use to upload a single part with HTTP
PUT. Upload URLs are served fromuploadv1.attachments.support.{region}.amazonaws.com. Theuploadv1prefix is subject to change.