Class SupportClient

Client to interact with AWS Support

Guzzle\Common\AbstractHasDispatcher implements Guzzle\Common\HasDispatcherInterface

Guzzle\Http\Client implements Guzzle\Http\ClientInterface

Guzzle\Service\Client implements Guzzle\Service\ClientInterface

Aws\Common\Client\AbstractClient implements Aws\Common\Client\AwsClientInterface

Aws\Support\SupportClient

Namespace: Aws\Support
Link: User guide
Link: API docs
Located at Aws/Support/SupportClient.php

Methods summary

public static factory ( array|Collection $config = array() )

Factory method to create a new AWS Support client using an array of configuration options.
public addAttachmentsToSet ( array $args = array() )

Executes the AddAttachmentsToSet operation.
public addCommunicationToCase ( array $args = array() )

Executes the AddCommunicationToCase operation.
public createCase ( array $args = array() )

Executes the CreateCase operation.
public describeAttachment ( array $args = array() )

Executes the DescribeAttachment operation.
public describeCases ( array $args = array() )

Executes the DescribeCases operation.
public describeCommunications ( array $args = array() )

Executes the DescribeCommunications operation.
public describeServices ( array $args = array() )

Executes the DescribeServices operation.
public describeSeverityLevels ( array $args = array() )

Executes the DescribeSeverityLevels operation.
public describeTrustedAdvisorCheckRefreshStatuses ( array $args = array() )

Executes the DescribeTrustedAdvisorCheckRefreshStatuses operation.
public describeTrustedAdvisorCheckResult ( array $args = array() )

Executes the DescribeTrustedAdvisorCheckResult operation.
public describeTrustedAdvisorCheckSummaries ( array $args = array() )

Executes the DescribeTrustedAdvisorCheckSummaries operation.
public describeTrustedAdvisorChecks ( array $args = array() )

Executes the DescribeTrustedAdvisorChecks operation.
public refreshTrustedAdvisorCheck ( array $args = array() )

Executes the RefreshTrustedAdvisorCheck operation.
public resolveCase ( array $args = array() )

Executes the ResolveCase operation.
public getDescribeCasesIterator ( array $args = array() )

The input array uses the parameters of the DescribeCases operation
public getDescribeCommunicationsIterator ( array $args = array() )

The input array uses the parameters of the DescribeCommunications operation
public getDescribeServicesIterator ( array $args = array() )

The input array uses the parameters of the DescribeServices operation
public getDescribeTrustedAdvisorCheckRefreshStatusesIterator ( array $args = array() )

The input array uses the parameters of the DescribeTrustedAdvisorCheckRefreshStatuses operation
public getDescribeTrustedAdvisorCheckSummariesIterator ( array $args = array() )

The input array uses the parameters of the DescribeTrustedAdvisorCheckSummaries operation
public getDescribeSeverityLevelsIterator ( array $args = array() )

The input array uses the parameters of the DescribeSeverityLevels operation
public getDescribeTrustedAdvisorChecksIterator ( array $args = array() )

The input array uses the parameters of the DescribeTrustedAdvisorChecks operation

Methods detail


                     public static
                    Aws\Support\SupportClient


factory( array|Guzzle\Common\Collection $config = array() )

Factory method to create a new AWS Support client using an array of configuration options.

Parameters

$config: array|Guzzle\Common\Collection
$config Client configuration data

Returns

Aws\Support\SupportClient

Link

http://docs.aws.amazon.com/aws-sdk-php/v2/guide/configuration.html#client-configuration-options

Overrides

Guzzle\Service\Client::factory


                     public 
                    Guzzle\Service\Resource\Model


addAttachmentsToSet( array $args = array() )

Executes the AddAttachmentsToSet operation.

Adds one or more attachments to an 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.

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 ExpiryTime 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 MB.

Examples

Basic formatting example

$result = $client->addAttachmentsToSet(array(
    'attachmentSetId' => 'string',
    // attachments is required
    'attachments' => array(
        array(
            'fileName' => 'string',
            'data' => 'string',
        ),
        // ... repeated
    ),
));

Parameters

$args

array
$arg Associative array containing the following keys (required keys are bold):

attachmentSetId => (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 => (array<associative-array>)

One or more attachments to add to the set. The limit is 3 attachments per set, and the size limit is 5 MB per attachment.
- (associative-array)
  
  An attachment to a case communication. The attachment consists of the file name and the content of the file.
  - fileName => (string)
    
    The name of the attachment file.
  - data => (string)
    
    The supplied string value will be automatically base64 encoded by the SDK. Base64 encoding this value before passing it into an operation will double-encode the data.
    
    The content of the attachment file.

Returns

Guzzle\Service\Resource\Model
Returns a response Model object

attachmentSetId => (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 => (string)

The time and date when the attachment set expires.


                     public 
                    Guzzle\Service\Resource\Model


addCommunicationToCase( array $args = array() )

Executes the AddCommunicationToCase operation.

Adds additional customer communication to an AWS Support case. You use the CaseId value to identify the case to add communication to. You can list a set of email addresses to copy on the communication using the CcEmailAddresses value. The CommunicationBody 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 Center.

Examples

Basic formatting example

$result = $client->addCommunicationToCase(array(
    'caseId' => 'string',
    // communicationBody is required
    'communicationBody' => 'string',
    'ccEmailAddresses' => array('string', ... ),
    'attachmentSetId' => 'string',
));

Add communications to a support case

$client->addCommunicationToCase(array(
    'caseId'            => $caseId,
    'communicationBody' => 'Message one.',
));

$client->addCommunicationToCase(array(
    'caseId'            => $caseId,
    'communicationBody' => 'Message two.',
));

$client->addCommunicationToCase(array(
    'caseId'            => $caseId,
    'communicationBody' => 'Message three.',
));

Parameters

$args

array
$arg Associative array containing the following keys (required keys are bold):

caseId => (string)

The AWS 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
communicationBody => (string)

The body of an email communication to add to the support case.
ccEmailAddresses => (array<string>)

The email addresses in the CC line of an email to be added to the support case.
attachmentSetId => (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

Returns

Guzzle\Service\Resource\Model
Returns a response Model object

result => (bool)

True if AddCommunicationToCase succeeds. Otherwise, returns an error.


                     public 
                    Guzzle\Service\Resource\Model


createCase( array $args = array() )

Executes the CreateCase operation.

Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center Create Case page. Its parameters require you to specify the following information:

IssueType. 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."
ServiceCode. The code for an AWS service. You obtain the ServiceCode by calling DescribeServices.
CategoryCode. The category for the service defined for the ServiceCode value. You also obtain the category code for a service by calling DescribeServices. Each AWS service defines its own set of category codes.
SeverityCode. 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 DescribeSeverityLevels.
Subject. The Subject field on the AWS Support Center Create Case page.
CommunicationBody. The Description field on the AWS Support Center Create Case page.
AttachmentSetId. The ID of a set of attachments that has been created by using AddAttachmentsToSet.
Language. The human language in which AWS Support handles the case. English and Japanese are currently supported.
CcEmailAddresses. The AWS Support Center CC field on the Create Case 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 AWS SDK.

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

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

Examples

Basic formatting example

$result = $client->createCase(array(
    // subject is required
    'subject' => 'string',
    'serviceCode' => 'string',
    'severityCode' => 'string',
    'categoryCode' => 'string',
    // communicationBody is required
    'communicationBody' => 'string',
    'ccEmailAddresses' => array('string', ... ),
    'language' => 'string',
    'issueType' => 'string',
    'attachmentSetId' => 'string',
));

Create a support case

$result = $client->createCase(array(
    'subject'           => 'Test Case',
    'serviceCode'       => $service['code'], // (e.g., amazon-dynamodb)
    'severityCode'      => $level['code'], //(e.g., low)
    'categoryCode'      => $service['categories'][0]['code'], // (e.g., feature-request)
    'communicationBody' => 'Initial Message.',
));
$caseId = $result['caseId'];

Parameters

$args

array
$arg Associative array containing the following keys (required keys are bold):

subject => (string)

The title of the AWS Support case.
serviceCode => (string)

The code for the AWS service returned by the call to DescribeServices.
severityCode => (string)

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

The availability of severity levels depends on each customer's support subscription. In other words, your subscription may not necessarily require the urgent level of response time.
categoryCode => (string)

The category of problem for the AWS Support case.
communicationBody => (string)

The communication body text when you create an AWS Support case by calling CreateCase.
ccEmailAddresses => (array<string>)

A list of email addresses that AWS Support copies on case correspondence.
language => (string)

The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
issueType => (string)

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."
attachmentSetId => (string)

The ID of a set of one or more attachments for the case. Create the set by using AddAttachmentsToSet.

Returns

Guzzle\Service\Resource\Model
Returns a response Model object

caseId => (string)

The AWS 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


                     public 
                    Guzzle\Service\Resource\Model


describeAttachment( array $args = array() )

Executes the DescribeAttachment operation.

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 AttachmentDetails objects that are returned by the DescribeCommunications operation.

Examples

Basic formatting example

$result = $client->describeAttachment(array(
    // attachmentId is required
    'attachmentId' => 'string',
));

Parameters

$args

array
$arg Associative array containing the following keys (required keys are bold):

attachmentId => (string)

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

Returns

Guzzle\Service\Resource\Model
Returns a response Model object

attachment => (associative-array)

The attachment content and file name.
- fileName => (string)
  
  The name of the attachment file.
- data => (string)
  
  The content of the attachment file.


                     public 
                    Guzzle\Service\Resource\Model


describeCases( array $args = array() )

Executes the DescribeCases operation.

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 AfterTime and BeforeTime request parameters. You can set values for the IncludeResolvedCases and IncludeCommunications request parameters to control how much information is returned.

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:

One or more CaseDetails data types.
One or more NextToken values, which specify where to paginate the returned records represented by the CaseDetails objects.

Examples

Basic formatting example

$result = $client->describeCases(array(
    'caseIdList' => array('string', ... ),
    'displayId' => 'string',
    'afterTime' => 'string',
    'beforeTime' => 'string',
    'includeResolvedCases' => true || false,
    'nextToken' => 'string',
    'maxResults' => integer,
    'language' => 'string',
    'includeCommunications' => true || false,
));

Parameters

$args

array
$arg Associative array containing the following keys (required keys are bold):

caseIdList => (array<string>)

A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.
displayId => (string)

The ID displayed for a case in the AWS Support Center user interface.
afterTime => (string)

The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
beforeTime => (string)

The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
includeResolvedCases => (bool)

Specifies whether resolved support cases should be included in the DescribeCases results. The default is false.
nextToken => (string)

A resumption point for pagination.
maxResults => (int)

The maximum number of results to return before paginating.
language => (string)

The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
includeCommunications => (bool)

Specifies whether communications should be included in the DescribeCases results. The default is true.

Returns

Guzzle\Service\Resource\Model
Returns a response Model object

cases => (array<associative-array>)

The details for the cases that match the request.
- (associative-array)
  A JSON-formatted object that contains the metadata for a support case. It is contained the response from a DescribeCases request. CaseDetails contains the following fields:
  1. CaseID. The AWS 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.
  2. CategoryCode. The category of problem for the AWS Support case. Corresponds to the CategoryCode values returned by a call to DescribeServices.
  3. DisplayId. The identifier for the case on pages in the AWS Support Center.
  4. Language. The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
  5. RecentCommunications. One or more Communication objects. Fields of these objects are Attachments, Body, CaseId, SubmittedBy, and TimeCreated.
  6. NextToken. A resumption point for pagination.
  7. ServiceCode. The identifier for the AWS service that corresponds to the service code defined in the call to DescribeServices.
  8. SeverityCode. The severity code assigned to the case. Contains one of the values returned by the call to DescribeSeverityLevels.
  9. Status. The status of the case in the AWS Support Center.
  10. Subject. The subject line of the case.
  11. SubmittedBy. The email address of the account that submitted the case.
  12. TimeCreated. The time the case was created, in ISO-8601 format.
  - caseId => (string)
    
    The AWS 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
  - displayId => (string)
    
    The ID displayed for the case in the AWS Support Center. This is a numeric string.
  - subject => (string)
    
    The subject line for the case in the AWS Support Center.
  - status => (string)
    
    The status of the case.
  - serviceCode => (string)
    
    The code for the AWS service returned by the call to DescribeServices.
  - categoryCode => (string)
    
    The category of problem for the AWS Support case.
  - severityCode => (string)
    
    The code for the severity level returned by the call to DescribeSeverityLevels.
  - submittedBy => (string)
    
    The email address of the account that submitted the case.
  - timeCreated => (string)
    
    The time that the case was case created in the AWS Support Center.
  - recentCommunications => (associative-array)
    
    The five most recent communications between you and AWS Support Center, including the IDs of any attachments to the communications. Also includes a nextToken that you can use to retrieve earlier communications.
    - communications => (array<associative-array>)
      
      The five most recent communications associated with the case.
      - (associative-array)
        
        A communication associated with an AWS Support case. The communication consists of the case ID, the message body, attachment information, the account email address, and the date and time of the communication.
        
        caseId => (string)
        
        The AWS 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
        
        body => (string)
        
        The text of the communication between the customer and AWS Support.
        
        submittedBy => (string)
        
        The email address of the account that submitted the AWS Support case.
        
        timeCreated => (string)
        
        The time the communication was created.
        
        attachmentSet => (array<associative-array>)
        
        Information about the attachments to the case communication.
        
        (associative-array)
        
        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.
        
        attachmentId => (string)
        
        The ID of the attachment.
        
        fileName => (string)
        
        The file name of the attachment.
    - nextToken => (string)
      
      A resumption point for pagination.
  - ccEmailAddresses => (array<string>)
    
    The email addresses that receive copies of communication about the case.
  - language => (string)
    
    The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
nextToken => (string)

A resumption point for pagination.


                     public 
                    Guzzle\Service\Resource\Model


describeCommunications( array $args = array() )

Executes the DescribeCommunications operation.

Returns communications (and attachments) for one or more support cases. You can use the AfterTime and BeforeTime parameters to filter by date. You can use the CaseId 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 MaxResults and NextToken parameters to control the pagination of the result set. Set MaxResults to the number of cases you want displayed on each page, and use NextToken to specify the resumption of pagination.

Examples

Basic formatting example

$result = $client->describeCommunications(array(
    // caseId is required
    'caseId' => 'string',
    'beforeTime' => 'string',
    'afterTime' => 'string',
    'nextToken' => 'string',
    'maxResults' => integer,
));

Describe communications

$numberOfCommunications = 0;
$communications = $client->getIterator('DescribeCommunications', array('caseId' => $caseId));
foreach ($communications as $communication) {
    echo $communication['body'];
    $numberOfCommunications++;
}
//> Message three. Message two. Message one. Initial Message.

echo $numberOfCommunications;
//> 4

Parameters

$args

array
$arg Associative array containing the following keys (required keys are bold):

caseId => (string)

The AWS 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
beforeTime => (string)

The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
afterTime => (string)

The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
nextToken => (string)

A resumption point for pagination.
maxResults => (int)

The maximum number of results to return before paginating.

Returns

Guzzle\Service\Resource\Model
Returns a response Model object

communications => (array<associative-array>)

The communications for the case.
- (associative-array)
  
  A communication associated with an AWS Support case. The communication consists of the case ID, the message body, attachment information, the account email address, and the date and time of the communication.
  - caseId => (string)
    
    The AWS 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
  - body => (string)
    
    The text of the communication between the customer and AWS Support.
  - submittedBy => (string)
    
    The email address of the account that submitted the AWS Support case.
  - timeCreated => (string)
    
    The time the communication was created.
  - attachmentSet => (array<associative-array>)
    
    Information about the attachments to the case communication.
    - (associative-array)
      
      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.
      - attachmentId => (string)
        
        The ID of the attachment.
      - fileName => (string)
        
        The file name of the attachment.
nextToken => (string)

A resumption point for pagination.


                     public 
                    Guzzle\Service\Resource\Model


describeServices( array $args = array() )

Executes the DescribeServices operation.

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 CreateCase 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 Service and Category drop-down lists on the AWS Support Center Create Case page. The values in those fields, however, do not necessarily match the service codes and categories returned by the DescribeServices 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 codes.

Examples

Basic formatting example

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

Describe the services that can be referenced in AWS Support cases

$result = $client->describeServices();
$service = $result['services'][5];

Parameters

$args

array
$arg Associative array containing the following keys (required keys are bold):

serviceCodeList => (array<string>)

A JSON-formatted list of service codes available for AWS services.
language => (string)

The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.

Returns

Guzzle\Service\Resource\Model
Returns a response Model object

services => (array<associative-array>)

A JSON-formatted list of AWS services.
- (associative-array)
  
  Information about an AWS service returned by the DescribeServices operation.
  - code => (string)
    
    The code for an AWS service returned by the DescribeServices response. The Name element contains the corresponding friendly name.
  - name => (string)
    
    The friendly name for an AWS service. The Code element contains the corresponding code.
  - categories => (array<associative-array>)
    
    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 AWS Support when you call CreateCase.
    - (associative-array)
      
      A JSON-formatted name/value pair that represents the category name and category code of the problem, selected from the DescribeServices response for each AWS service.
      - code => (string)
        
        The category code for the support case.
      - name => (string)
        
        The category name for the support case.


                     public 
                    Guzzle\Service\Resource\Model


describeSeverityLevels( array $args = array() )

Executes the DescribeSeverityLevels operation.

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 CaseDetails data type included in any CreateCase request.

Examples

Basic formatting example

$result = $client->describeSeverityLevels(array(
    'language' => 'string',
));

Describe the severity levels that can be referenced in AWS Support cases

$result = $client->describeSeverityLevels();
$level = $result['severityLevels'][0];

Parameters

$args

array
$arg Associative array containing the following keys (required keys are bold):

language => (string)

The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.

Returns

Guzzle\Service\Resource\Model
Returns a response Model object

severityLevels => (array<associative-array>)

The available severity levels for the support case. Available severity levels are defined by your service level agreement with AWS.
- (associative-array)
  
  A code and name pair that represent a severity level that can be applied to a support case.
  - code => (string)
    
    One of four values: "low," "medium," "high," and "urgent". These values correspond to response times returned to the caller in SeverityLevel.name.
  - name => (string)
    
    The name of the severity level that corresponds to the severity level code.


                     public 
                    Guzzle\Service\Resource\Model


describeTrustedAdvisorCheckRefreshStatuses( array $args = array() )

Executes the DescribeTrustedAdvisorCheckRefreshStatuses operation.

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

Examples

Basic formatting example

$result = $client->describeTrustedAdvisorCheckRefreshStatuses(array(
    // checkIds is required
    'checkIds' => array('string', ... ),
));

Parameters

$args

array
$arg Associative array containing the following keys (required keys are bold):

checkIds => (array<string>)

The IDs of the Trusted Advisor checks.

Returns

Guzzle\Service\Resource\Model
Returns a response Model object

statuses => (array<associative-array>)

The refresh status of the specified Trusted Advisor checks.
- (associative-array)
  
  The refresh status of a Trusted Advisor check.
  - checkId => (string)
    
    The unique identifier for the Trusted Advisor check.
  - status => (string)
    
    The status of the Trusted Advisor check for which a refresh has been requested: "none", "enqueued", "processing", "success", or "abandoned".
  - millisUntilNextRefreshable => (int)
    
    The amount of time, in milliseconds, until the Trusted Advisor check is eligible for refresh.


                     public 
                    Guzzle\Service\Resource\Model


describeTrustedAdvisorCheckResult( array $args = array() )

Executes the DescribeTrustedAdvisorCheckResult operation.

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

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: "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.

Examples

Basic formatting example

$result = $client->describeTrustedAdvisorCheckResult(array(
    // checkId is required
    'checkId' => 'string',
    'language' => 'string',
));

Parameters

$args

array
$arg Associative array containing the following keys (required keys are bold):

checkId => (string)

The unique identifier for the Trusted Advisor check.
language => (string)

The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.

Returns

Guzzle\Service\Resource\Model
Returns a response Model object

result => (associative-array)

The detailed results of the Trusted Advisor check.
- checkId => (string)
  
  The unique identifier for the Trusted Advisor check.
- timestamp => (string)
  
  The time of the last refresh of the check.
- status => (string)
  
  The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".
- resourcesSummary => (associative-array)
  
  Details about AWS resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries.
  - resourcesProcessed => (int)
    
    The number of AWS resources that were analyzed by the Trusted Advisor check.
  - resourcesFlagged => (int)
    
    The number of AWS resources that were flagged (listed) by the Trusted Advisor check.
  - resourcesIgnored => (int)
    
    The number of AWS resources ignored by Trusted Advisor because information was unavailable.
  - resourcesSuppressed => (int)
    
    The number of AWS resources ignored by Trusted Advisor because they were marked as suppressed by the user.
- categorySpecificSummary => (associative-array)
  
  Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.
  - costOptimizing => (associative-array)
    
    The summary information about cost savings for a Trusted Advisor check that is in the Cost Optimizing category.
    - estimatedMonthlySavings => (int)
      
      The estimated monthly savings that might be realized if the recommended actions are taken.
    - estimatedPercentMonthlySavings => (int)
      
      The estimated percentage of savings that might be realized if the recommended actions are taken.
- flaggedResources => (array<associative-array>)
  
  The details about each resource listed in the check result.
  - (associative-array)
    
    Contains information about a resource identified by a Trusted Advisor check.
    - status => (string)
      
      The status code for the resource identified in the Trusted Advisor check.
    - region => (string)
      
      The AWS region in which the identified resource is located.
    - resourceId => (string)
      
      The unique identifier for the identified resource.
    - isSuppressed => (bool)
      
      Specifies whether the AWS resource was ignored by Trusted Advisor because it was marked as suppressed by the user.
    - metadata => (array<string>)
      
      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.


                     public 
                    Guzzle\Service\Resource\Model


describeTrustedAdvisorCheckSummaries( array $args = array() )

Executes the DescribeTrustedAdvisorCheckSummaries operation.

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

The response contains an array of TrustedAdvisorCheckSummary objects.

Examples

Basic formatting example

$result = $client->describeTrustedAdvisorCheckSummaries(array(
    // checkIds is required
    'checkIds' => array('string', ... ),
));

Parameters

$args

array
$arg Associative array containing the following keys (required keys are bold):

checkIds => (array<string>)

The IDs of the Trusted Advisor checks.

Returns

Guzzle\Service\Resource\Model
Returns a response Model object

summaries => (array<associative-array>)

The summary information for the requested Trusted Advisor checks.
- (associative-array)
  
  A summary of a Trusted Advisor check result, including the alert status, last refresh, and number of resources examined.
  - checkId => (string)
    
    The unique identifier for the Trusted Advisor check.
  - timestamp => (string)
    
    The time of the last refresh of the check.
  - status => (string)
    
    The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".
  - hasFlaggedResources => (bool)
    
    Specifies whether the Trusted Advisor check has flagged resources.
  - resourcesSummary => (associative-array)
    
    Details about AWS resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries.
    - resourcesProcessed => (int)
      
      The number of AWS resources that were analyzed by the Trusted Advisor check.
    - resourcesFlagged => (int)
      
      The number of AWS resources that were flagged (listed) by the Trusted Advisor check.
    - resourcesIgnored => (int)
      
      The number of AWS resources ignored by Trusted Advisor because information was unavailable.
    - resourcesSuppressed => (int)
      
      The number of AWS resources ignored by Trusted Advisor because they were marked as suppressed by the user.
  - categorySpecificSummary => (associative-array)
    
    Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.
    - costOptimizing => (associative-array)
      
      The summary information about cost savings for a Trusted Advisor check that is in the Cost Optimizing category.
      - estimatedMonthlySavings => (int)
        
        The estimated monthly savings that might be realized if the recommended actions are taken.
      - estimatedPercentMonthlySavings => (int)
        
        The estimated percentage of savings that might be realized if the recommended actions are taken.


                     public 
                    Guzzle\Service\Resource\Model


describeTrustedAdvisorChecks( array $args = array() )

Executes the DescribeTrustedAdvisorChecks operation.

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 TrustedAdvisorCheckDescription for each check.

Examples

Basic formatting example

$result = $client->describeTrustedAdvisorChecks(array(
    // language is required
    'language' => 'string',
));

Parameters

$args

array
$arg Associative array containing the following keys (required keys are bold):

language => (string)

The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.

Returns

Guzzle\Service\Resource\Model
Returns a response Model object

checks => (array<associative-array>)

Information about all available Trusted Advisor checks.
- (associative-array)
  
  The description and metadata for a Trusted Advisor check.
  - id => (string)
    
    The unique identifier for the Trusted Advisor check.
  - name => (string)
    
    The display name for the Trusted Advisor check.
  - description => (string)
    
    The description of the Trusted Advisor check, which includes the alert criteria and recommended actions (contains HTML markup).
  - category => (string)
    
    The category of the Trusted Advisor check.
  - metadata => (array<string>)
    
    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.


                     public 
                    Guzzle\Service\Resource\Model


refreshTrustedAdvisorCheck( array $args = array() )

Executes the RefreshTrustedAdvisorCheck operation.

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

The response contains a TrustedAdvisorCheckRefreshStatus object, which contains these fields:

Status. The refresh status of the check: "none", "enqueued", "processing", "success", or "abandoned".
MillisUntilNextRefreshable. The amount of time, in milliseconds, until the check is eligible for refresh.
CheckId. The unique identifier for the check.

Examples

Basic formatting example

$result = $client->refreshTrustedAdvisorCheck(array(
    // checkId is required
    'checkId' => 'string',
));

Parameters

$args

array
$arg Associative array containing the following keys (required keys are bold):

checkId => (string)

The unique identifier for the Trusted Advisor check.

Returns

Guzzle\Service\Resource\Model
Returns a response Model object

status => (associative-array)

The current refresh status for a check, including the amount of time until the check is eligible for refresh.
- checkId => (string)
  
  The unique identifier for the Trusted Advisor check.
- status => (string)
  
  The status of the Trusted Advisor check for which a refresh has been requested: "none", "enqueued", "processing", "success", or "abandoned".
- millisUntilNextRefreshable => (int)
  
  The amount of time, in milliseconds, until the Trusted Advisor check is eligible for refresh.


                     public 
                    Guzzle\Service\Resource\Model


resolveCase( array $args = array() )

Executes the ResolveCase operation.

Takes a CaseId and returns the initial state of the case along with the state of the case after the call to ResolveCase completed.

Examples

Basic formatting example

$result = $client->resolveCase(array(
    'caseId' => 'string',
));

Resolve a support case

$result = $client->resolveCase(array(
    'caseId' => $caseId
));
echo "The initial case status was: {$result['initialCaseStatus']}.\n";
echo "The final case status was: {$result['finalCaseStatus']}.\n";

Parameters

$args

array
$arg Associative array containing the following keys (required keys are bold):

caseId => (string)

The AWS 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

Returns

Guzzle\Service\Resource\Model
Returns a response Model object

initialCaseStatus => (string)

The status of the case when the ResolveCase request was sent.
finalCaseStatus => (string)

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


                     public 
                    Guzzle\Service\Resource\ResourceIteratorInterface


getDescribeCasesIterator( array $args = array() )

The input array uses the parameters of the DescribeCases operation

Parameters

$args: array
$args

Returns

Guzzle\Service\Resource\ResourceIteratorInterface


                     public 
                    Guzzle\Service\Resource\ResourceIteratorInterface


getDescribeCommunicationsIterator( array $args = array() )

The input array uses the parameters of the DescribeCommunications operation

Parameters

$args: array
$args

Returns

Guzzle\Service\Resource\ResourceIteratorInterface


                     public 
                    Guzzle\Service\Resource\ResourceIteratorInterface


getDescribeServicesIterator( array $args = array() )

The input array uses the parameters of the DescribeServices operation

Parameters

$args: array
$args

Returns

Guzzle\Service\Resource\ResourceIteratorInterface


                     public 
                    Guzzle\Service\Resource\ResourceIteratorInterface


getDescribeTrustedAdvisorCheckRefreshStatusesIterator( array $args = array() )

The input array uses the parameters of the DescribeTrustedAdvisorCheckRefreshStatuses operation

Parameters

$args: array
$args

Returns

Guzzle\Service\Resource\ResourceIteratorInterface


                     public 
                    Guzzle\Service\Resource\ResourceIteratorInterface


getDescribeTrustedAdvisorCheckSummariesIterator( array $args = array() )

The input array uses the parameters of the DescribeTrustedAdvisorCheckSummaries operation

Parameters

$args: array
$args

Returns

Guzzle\Service\Resource\ResourceIteratorInterface


                     public 
                    Guzzle\Service\Resource\ResourceIteratorInterface


getDescribeSeverityLevelsIterator( array $args = array() )

The input array uses the parameters of the DescribeSeverityLevels operation

Parameters

$args: array
$args

Returns

Guzzle\Service\Resource\ResourceIteratorInterface


                     public 
                    Guzzle\Service\Resource\ResourceIteratorInterface


getDescribeTrustedAdvisorChecksIterator( array $args = array() )

The input array uses the parameters of the DescribeTrustedAdvisorChecks operation

Parameters

$args: array
$args

Returns

Guzzle\Service\Resource\ResourceIteratorInterface

Magic methods summary

Constants summary

`string`	`LATEST_API_VERSION`	`'2013-04-15'`	#

Constants inherited from Guzzle\Service\Client

COMMAND_PARAMS

Constants inherited from Guzzle\Http\Client

CURL_OPTIONS, DEFAULT_SELECT_TIMEOUT, DISABLE_REDIRECTS, MAX_HANDLES, REQUEST_OPTIONS, SSL_CERT_AUTHORITY

Constants inherited from Guzzle\Http\ClientInterface

CREATE_REQUEST, HTTP_DATE

Properties summary

Properties inherited from Aws\Common\Client\AbstractClient

$aggregator, $credentials, $signature, $waiterFactory

Properties inherited from Guzzle\Service\Client

$commandFactory, $inflector, $resourceIteratorFactory, $serviceDescription

Properties inherited from Guzzle\Http\Client

$defaultHeaders, $requestFactory, $userAgent

Properties inherited from Guzzle\Common\AbstractHasDispatcher

$eventDispatcher

Namespaces

Classes

Class SupportClient

Methods summary

Methods detail

Parameters

Returns

Link

Overrides

Examples

Parameters

Returns

Examples

Parameters

Returns

Examples

Parameters

Returns

Examples

Parameters

Returns

Examples

Parameters

Returns

Examples

Parameters

Returns

Examples

Parameters

Returns

Examples

Parameters

Returns

Examples

Parameters

Returns

Examples

Parameters

Returns

Examples

Parameters

Returns

Examples

Parameters

Returns

Examples

Parameters

Returns

Examples

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Methods inherited from Aws\Common\Client\AbstractClient

Methods inherited from Guzzle\Service\Client

Methods inherited from Guzzle\Http\Client

Methods inherited from Guzzle\Common\AbstractHasDispatcher

Magic methods summary

Constants summary

Constants inherited from Guzzle\Service\Client

Constants inherited from Guzzle\Http\Client

Constants inherited from Guzzle\Http\ClientInterface

Properties summary

Properties inherited from Aws\Common\Client\AbstractClient

Properties inherited from Guzzle\Service\Client

Properties inherited from Guzzle\Http\Client

Properties inherited from Guzzle\Common\AbstractHasDispatcher