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.

Parameter Syntax

$result = $client->addAttachmentsToSet([
    'attachmentSetId' => '<string>',
    'attachments' => [ // REQUIRED
        [
            'data' => <string || resource || Psr\Http\Message\StreamInterface>,
            'fileName' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

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.

Parameter Syntax

$result = $client->addCommunicationToCase([
    'attachmentSetId' => '<string>',
    'caseId' => '<string>',
    'ccEmailAddresses' => ['<string>', ...],
    'communicationBody' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'result' => true || false,
]

Result Details

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.

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

Result Syntax

[
    'caseId' => '<string>',
]

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'attachment' => [
        'data' => <string || resource || Psr\Http\Message\StreamInterface>,
        'fileName' => '<string>',
    ],
]

Result Details

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.

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

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

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.

Parameter Syntax

$result = $client->describeCommunications([
    'afterTime' => '<string>',
    'beforeTime' => '<string>',
    'caseId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'communications' => [
        [
            'attachmentSet' => [
                [
                    'attachmentId' => '<string>',
                    'fileName' => '<string>',
                ],
                // ...
            ],
            'body' => '<string>',
            'caseId' => '<string>',
            'submittedBy' => '<string>',
            'timeCreated' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerError:

An internal server error occurred.

CaseIdNotFound:

The requested caseId couldn't be located.

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.

Parameter Syntax

$result = $client->describeCreateCaseOptions([
    'categoryCode' => '<string>', // REQUIRED
    'issueType' => '<string>', // REQUIRED
    'language' => '<string>', // REQUIRED
    'serviceCode' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'communicationTypes' => [
        [
            'datesWithoutSupport' => [
                [
                    'endDateTime' => '<string>',
                    'startDateTime' => '<string>',
                ],
                // ...
            ],
            'supportedHours' => [
                [
                    'endTime' => '<string>',
                    'startTime' => '<string>',
                ],
                // ...
            ],
            'type' => '<string>',
        ],
        // ...
    ],
    'languageAvailability' => '<string>',
]

Result Details

Errors

InternalServerError:

An internal server error occurred.

ThrottlingException:

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

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.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'services' => [
        [
            'categories' => [
                [
                    'code' => '<string>',
                    'name' => '<string>',
                ],
                // ...
            ],
            'code' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
]

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'severityLevels' => [
        [
            'code' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerError:

An internal server error occurred.

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.

Parameter Syntax

$result = $client->describeSupportedLanguages([
    'categoryCode' => '<string>', // REQUIRED
    'issueType' => '<string>', // REQUIRED
    'serviceCode' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'supportedLanguages' => [
        [
            'code' => '<string>',
            'display' => '<string>',
            'language' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerError:

An internal server error occurred.

ThrottlingException:

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

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.

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

Result Syntax

[
    'statuses' => [
        [
            'checkId' => '<string>',
            'millisUntilNextRefreshable' => <integer>,
            'status' => '<string>',
        ],
        // ...
    ],
]

Result Details

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:

• TrustedAdvisorCategorySpecificSummary

• TrustedAdvisorResourceDetail

• TrustedAdvisorResourcesSummary

In addition, the response contains these fields:

• status - The alert status of the check can be ok (green), warning (yellow), error (red), or not_available.

• timestamp - The time of the last refresh of the check.

• checkId - The unique identifier for the check.

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

Parameter Syntax

$result = $client->describeTrustedAdvisorCheckResult([
    'checkId' => '<string>', // REQUIRED
    'language' => '<string>',
]);

Parameter Details

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

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.

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->describeTrustedAdvisorCheckSummaries([
    'checkIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

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

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.

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

Result Syntax

[
    'checks' => [
        [
            'category' => '<string>',
            'description' => '<string>',
            'id' => '<string>',
            'metadata' => ['<string>', ...],
            'name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerError:

An internal server error occurred.

ThrottlingException:

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

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.

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

Result Syntax

[
    'status' => [
        'checkId' => '<string>',
        'millisUntilNextRefreshable' => <integer>,
        'status' => '<string>',
    ],
]

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'finalCaseStatus' => '<string>',
    'initialCaseStatus' => '<string>',
]

Result Details

Errors

InternalServerError:

An internal server error occurred.

CaseIdNotFound:

The requested caseId couldn't be located.