AWS SDK for PHP 3.x

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 an Amazon Web Services Support case.
CreateCase ( array $params = [] )
Creates a case in the Amazon Web Services Support Center.
DescribeAttachment ( array $params = [] )
Returns the attachment that has the specified ID.
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.
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.
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.
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 a Business, Enterprise On-Ramp, or Enterprise Support 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 Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error 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>',
        ],
        // ...
    ],
]);

Parameter Details

Members

attachmentSetId

Type: string

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

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

Result Syntax

[
    'attachmentSetId' => '<string>',
    'expiryTime' => '<string>',
]

Result Details

Members

attachmentSetId

Type: string

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

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.

AddCommunicationToCase

$result = $client->addCommunicationToCase([/* ... */]);
$promise = $client->addCommunicationToCaseAsync([/* ... */]);

Adds additional customer communication to an Amazon Web Services Support case. Use the caseId parameter to identify the case to which to add communication. You can list a set of email addresses to copy on the communication by using the ccEmailAddresses parameter. The communicationBody value contains the text of the communication.

You must have a Business, Enterprise On-Ramp, or Enterprise Support 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 Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error 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
]);

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

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

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 caseId couldn'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.

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.

A successful CreateCase request returns an 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 a Business, Enterprise On-Ramp, or Enterprise Support 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 Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error 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
    'issueType' => '<string>',
    'language' => '<string>',
    'serviceCode' => '<string>',
    'severityCode' => '<string>',
    'subject' => '<string>', // REQUIRED
]);

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.

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.

issueType

Type: string

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

language

Type: string

The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports English ("en") and Japanese ("ja"). You must specify the ISO 639-1 code for the language parameter 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 serviceCode values.

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.

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

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 a Business, Enterprise On-Ramp, or Enterprise Support 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 Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

Parameter Syntax

$result = $client->describeAttachment([
    'attachmentId' => '<string>', // REQUIRED
]);

Parameter Details

Members

attachmentId

Required: Yes
Type: string

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

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 data parameter appears as blob, which is represented as a base64-encoded string. The value for fileName is the name of the attachment, such as troubleshoot-screenshot.png.

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.

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 nextToken values, which specify where to paginate the returned records represented by the CaseDetails objects.

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

You must have a Business, Enterprise On-Ramp, or Enterprise Support 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 Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

Parameter Syntax

$result = $client->describeCases([
    'afterTime' => '<string>',
    'beforeTime' => '<string>',
    'caseIdList' => ['<string>', ...],
    'displayId' => '<string>',
    '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 12 months after creation.

beforeTime

Type: string

The end date for a filtered date search on support case communications. Case communications are available for 12 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.

includeCommunications

Type: boolean

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

includeResolvedCases

Type: boolean

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

language

Type: string

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>',
                            ],
                            // ...
                        ],
                        '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 caseId couldn't be located.

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 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.

You can use the maxResults and nextToken parameters to control the pagination of the 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 a Business, Enterprise On-Ramp, or Enterprise Support 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 Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

Parameter Syntax

$result = $client->describeCommunications([
    'afterTime' => '<string>',
    'beforeTime' => '<string>',
    'caseId' => '<string>', // REQUIRED
    '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 12 months after creation.

beforeTime

Type: string

The end date for a filtered date search on support case communications. Case communications are available for 12 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-2013-c4c1d2bf33c5cf47

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>',
                ],
                // ...
            ],
            '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 caseId couldn't be located.

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 a Business, Enterprise On-Ramp, or Enterprise Support 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 Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

Parameter Syntax

$result = $client->describeServices([
    'language' => '<string>',
    'serviceCodeList' => ['<string>', ...],
]);

Parameter Details

Members

language

Type: string

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.

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 a Business, Enterprise On-Ramp, or Enterprise Support 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 Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

Parameter Syntax

$result = $client->describeSeverityLevels([
    'language' => '<string>',
]);

Parameter Details

Members

language

Type: string

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.

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 a Business, Enterprise On-Ramp, or Enterprise Support 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 Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error 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 InvalidParameterValue error.

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.

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:

TrustedAdvisorCategorySpecificSummary
TrustedAdvisorResourceDetail
TrustedAdvisorResourcesSummary

In addition, the response contains these fields:

status - The alert status of the check can be ok (green), warning (yellow), error (red), or not_available.
timestamp - The time of the last refresh of the check.
checkId - The unique identifier for the check.

You must have a Business, Enterprise On-Ramp, or Enterprise Support 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 Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

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.

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 a Business, Enterprise On-Ramp, or Enterprise Support 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 Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

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.

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 Business, Enterprise On-Ramp, or Enterprise Support 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 Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error 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.

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.

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 a Business, Enterprise On-Ramp, or Enterprise Support 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 Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

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 InvalidParameterValue error.

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 a Business, Enterprise On-Ramp, or Enterprise Support 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 Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

Parameter Syntax

$result = $client->resolveCase([
    'caseId' => '<string>',
]);

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-2013-c4c1d2bf33c5cf47

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 caseId couldn't be located.

Shapes

Attachment

Description

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

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-2013-c4c1d2bf33c5cf47.
categoryCode - The category of problem for the support case. Corresponds to the CategoryCode values returned by a call to DescribeServices.
displayId - The identifier for the case on pages in the Amazon Web Services Support Center.
language - The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports English ("en") and Japanese ("ja"). You must specify the ISO 639-1 code for the language parameter if you want support in that language.
nextToken - A resumption point for pagination.
recentCommunications - One or more Communication objects. Fields of these objects are attachments, body, caseId, submittedBy, and timeCreated.
serviceCode - The identifier for the Amazon Web Services service that corresponds to the service code defined in the call to DescribeServices.
severityCode - The severity code assigned to the case. Contains one of the values returned by the call to DescribeSeverityLevels. The possible values are: low, normal, high, urgent, and critical.
status - The status of the case in the Amazon Web Services Support Center. Valid values:
- 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-2013-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

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 nextToken that 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:

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 CaseId could not be located.

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.

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-2013-c4c1d2bf33c5cf47

submittedBy

Type: string

The identity of the account that submitted, or responded to, the support case. Customer entries include the role or IAM user 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.

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.

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 name element contains the corresponding friendly name.

name

Type: string

The friendly name for an Amazon Web Services service. The code element 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.

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.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

AWS Support 2013-04-15

Operation Summary

Paginators

Operations

AddAttachmentsToSet

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AddCommunicationToCase

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateCase

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeAttachment

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeCases

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeCommunications

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeServices

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeSeverityLevels

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeTrustedAdvisorCheckRefreshStatuses

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details