SupportClient Class

Member Function Documentation

SupportClient::SupportClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a SupportClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

SupportClient::SupportClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads SupportClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] AddAttachmentsToSetResponse *SupportClient::addAttachmentsToSet(const AddAttachmentsToSetRequest &request)

Sends request to the SupportClient service, and returns a pointer to an AddAttachmentsToSetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Adds one or more attachments to an attachment set. If an <code>attachmentSetId</code> is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an <code>attachmentSetId</code> is specified, the attachments are added to the specified set, if it

exists>

An attachment set is a temporary container for attachments that are to be added to a case or case communication. The set is available for one hour after it is created; the <code>expiryTime</code> returned in the response indicates when the set expires. The maximum number of attachments in a set is 3, and the maximum size of any attachment in the set is 5

[slot] AddCommunicationToCaseResponse *SupportClient::addCommunicationToCase(const AddCommunicationToCaseRequest &request)

Sends request to the SupportClient service, and returns a pointer to an AddCommunicationToCaseResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Adds additional customer communication to an AWS Support case. You use the <code>caseId</code> value to identify the case to add communication to. You can list a set of email addresses to copy on the communication using the <code>ccEmailAddresses</code> value. The <code>communicationBody</code> value contains the text of the

communication>

The response indicates the success or failure of the

request>

This operation implements a subset of the features of the AWS Support

[slot] CreateCaseResponse *SupportClient::createCase(const CreateCaseRequest &request)

Sends request to the SupportClient service, and returns a pointer to an CreateCaseResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page. Its parameters require you to specify the following information:

</p <ul> <li>

<b>issueType.</b> The type of issue for the case. You can specify either "customer-service" or "technical." If you do not indicate a value, the default is "technical."

</p </li> <li>

<b>serviceCode.</b> The code for an AWS service. You obtain the <code>serviceCode</code> by calling <a>DescribeServices</a>.

</p </li> <li>

<b>categoryCode.</b> The category for the service defined for the <code>serviceCode</code> value. You also obtain the category code for a service by calling <a>DescribeServices</a>. Each AWS service defines its own set of category codes.

</p </li> <li>

<b>severityCode.</b> A value that indicates the urgency of the case, which in turn determines the response time according to your service level agreement with AWS Support. You obtain the SeverityCode by calling

<a>DescribeSeverityLevels</a>> </li> <li>

<b>subject.</b> The <b>Subject</b> field on the AWS Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a>

page> </li> <li>

<b>communicationBody.</b> The <b>Description</b> field on the AWS Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a>

page> </li> <li>

<b>attachmentSetId.</b> The ID of a set of attachments that has been created by using

<a>AddAttachmentsToSet</a>> </li> <li>

<b>language.</b> The human language in which AWS Support handles the case. English and Japanese are currently

supported> </li> <li>

<b>ccEmailAddresses.</b> The AWS Support Center <b>CC</b> field on the <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page. You can list email addresses to be copied on any correspondence about the case. The account that opens the case is already identified by passing the AWS Credentials in the HTTP POST method or in a method or function call from one of the programming languages supported by an <a href="http://aws.amazon.com/tools/">AWS SDK</a>.

</p </li> </ul> <note>

To add additional communication or attachments to an existing case, use

<a>AddCommunicationToCase</a>> </note>

A successful <a>CreateCase</a> request returns an AWS Support case number. Case numbers are used by the <a>DescribeCases</a> operation to retrieve existing AWS Support cases.

[slot] DescribeAttachmentResponse *SupportClient::describeAttachment(const DescribeAttachmentRequest &request)

Sends request to the SupportClient service, and returns a pointer to an DescribeAttachmentResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns the attachment that has the specified ID. 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 <a>AttachmentDetails</a> objects that are returned by the <a>DescribeCommunications</a>

[slot] DescribeCasesResponse *SupportClient::describeCases(const DescribeCasesRequest &request)

Sends request to the SupportClient service, and returns a pointer to an DescribeCasesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns a list of cases that you specify by passing one or more case IDs. In addition, you can filter the cases by date by setting values for the <code>afterTime</code> and <code>beforeTime</code> request parameters. You can set values for the <code>includeResolvedCases</code> and <code>includeCommunications</code> request parameters to control how much information is returned.

</p

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>

The response returns the following in JSON

format> <ul> <li>

One or more <a>CaseDetails</a> data types.

</p </li> <li>

One or more <code>nextToken</code> values, which specify where to paginate the returned records represented by the <code>CaseDetails</code>

[slot] DescribeCommunicationsResponse *SupportClient::describeCommunications(const DescribeCommunicationsRequest &request)

Sends request to the SupportClient service, and returns a pointer to an DescribeCommunicationsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns communications (and attachments) for one or more support cases. You can use the <code>afterTime</code> and <code>beforeTime</code> parameters to filter by date. You can use the <code>caseId</code> parameter to restrict the results to a particular

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 <code>maxResults</code> and <code>nextToken</code> parameters to control the pagination of the result set. Set <code>maxResults</code> to the number of cases you want displayed on each page, and use <code>nextToken</code> to specify the resumption of

[slot] DescribeServicesResponse *SupportClient::describeServices(const DescribeServicesRequest &request)

Sends request to the SupportClient service, and returns a pointer to an DescribeServicesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns the current list of AWS services and a list of service categories that applies to each one. You then use service names and categories in your <a>CreateCase</a> requests. Each AWS service has its own set of

categories>

The service codes and category codes correspond to the values that are displayed in the <b>Service</b> and <b>Category</b> drop-down lists on the AWS Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page. The values in those fields, however, do not necessarily match the service codes and categories returned by the <code>DescribeServices</code> request. Always use the service codes and categories obtained programmatically. This practice ensures that you always have the most recent set of service and category

[slot] DescribeSeverityLevelsResponse *SupportClient::describeSeverityLevels(const DescribeSeverityLevelsRequest &request)

Sends request to the SupportClient service, and returns a pointer to an DescribeSeverityLevelsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the <a>CaseDetails</a> data type included in any <a>CreateCase</a> request.

[slot] DescribeTrustedAdvisorCheckRefreshStatusesResponse *SupportClient::describeTrustedAdvisorCheckRefreshStatuses(const DescribeTrustedAdvisorCheckRefreshStatusesRequest &request)

Sends request to the SupportClient service, and returns a pointer to an DescribeTrustedAdvisorCheckRefreshStatusesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling

<a>DescribeTrustedAdvisorChecks</a>> <note>

Some checks are refreshed automatically, and their refresh statuses cannot be retrieved by using this operation. Use of the <code>DescribeTrustedAdvisorCheckRefreshStatuses</code> operation for these checks causes an <code>InvalidParameterValue</code>

[slot] DescribeTrustedAdvisorCheckResultResponse *SupportClient::describeTrustedAdvisorCheckResult(const DescribeTrustedAdvisorCheckResultRequest &request)

Sends request to the SupportClient service, and returns a pointer to an DescribeTrustedAdvisorCheckResultResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns the results of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling

<a>DescribeTrustedAdvisorChecks</a>>

The response contains a <a>TrustedAdvisorCheckResult</a> object, which contains these three

objects> <ul> <li>

<a>TrustedAdvisorCategorySpecificSummary</a>

</p </li> <li>

<a>TrustedAdvisorResourceDetail</a>

</p </li> <li>

<a>TrustedAdvisorResourcesSummary</a>

</p </li> </ul>

In addition, the response contains these

fields> <ul> <li>

<b>status.</b> The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or

"not_available"> </li> <li>

<b>timestamp.</b> The time of the last refresh of the

check> </li> <li>

<b>checkId.</b> The unique identifier for the

[slot] DescribeTrustedAdvisorCheckSummariesResponse *SupportClient::describeTrustedAdvisorCheckSummaries(const DescribeTrustedAdvisorCheckSummariesRequest &request)

Sends request to the SupportClient service, and returns a pointer to an DescribeTrustedAdvisorCheckSummariesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling

<a>DescribeTrustedAdvisorChecks</a>>

The response contains an array of <a>TrustedAdvisorCheckSummary</a>

[slot] DescribeTrustedAdvisorChecksResponse *SupportClient::describeTrustedAdvisorChecks(const DescribeTrustedAdvisorChecksRequest &request)

Sends request to the SupportClient service, and returns a pointer to an DescribeTrustedAdvisorChecksResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns information about all available Trusted Advisor checks, including name, ID, category, description, and metadata. You must specify a language code; English ("en") and Japanese ("ja") are currently supported. The response contains a <a>TrustedAdvisorCheckDescription</a> for each

[slot] RefreshTrustedAdvisorCheckResponse *SupportClient::refreshTrustedAdvisorCheck(const RefreshTrustedAdvisorCheckRequest &request)

Sends request to the SupportClient service, and returns a pointer to an RefreshTrustedAdvisorCheckResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Requests a refresh of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling

<a>DescribeTrustedAdvisorChecks</a>> <note>

Some checks are refreshed automatically, and they cannot be refreshed by using this operation. Use of the <code>RefreshTrustedAdvisorCheck</code> operation for these checks causes an <code>InvalidParameterValue</code>

error> </note>

The response contains a <a>TrustedAdvisorCheckRefreshStatus</a> object, which contains these

fields> <ul> <li>

<b>status.</b> The refresh status of the check: "none", "enqueued", "processing", "success", or

"abandoned"> </li> <li>

<b>millisUntilNextRefreshable.</b> The amount of time, in milliseconds, until the check is eligible for

refresh> </li> <li>

<b>checkId.</b> The unique identifier for the

[slot] ResolveCaseResponse *SupportClient::resolveCase(const ResolveCaseRequest &request)

Sends request to the SupportClient service, and returns a pointer to an ResolveCaseResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Takes a <code>caseId</code> and returns the initial state of the case along with the state of the case after the call to <a>ResolveCase</a>