Class: AWS.Support

var params = {
  communicationBody: 'STRING_VALUE', /* required */
  attachmentSetId: 'STRING_VALUE',
  caseId: 'STRING_VALUE',
  ccEmailAddresses: [
    'STRING_VALUE',
    /* more items */
  ]
};
support.addCommunicationToCase(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • caseId — (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

  • 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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • result — (Boolean)

      True if AddCommunicationToCase succeeds. Otherwise, returns an error.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  communicationBody: 'STRING_VALUE', /* required */
  subject: 'STRING_VALUE', /* required */
  attachmentSetId: 'STRING_VALUE',
  categoryCode: 'STRING_VALUE',
  ccEmailAddresses: [
    'STRING_VALUE',
    /* more items */
  ],
  issueType: 'STRING_VALUE',
  language: 'STRING_VALUE',
  serviceCode: 'STRING_VALUE',
  severityCode: 'STRING_VALUE'
};
support.createCase(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • subject — (String)

    The title of the support case. The title appears in the Subject field on the Amazon Web Services Support Center Create Case page.

  • serviceCode — (String)

    The code for the Amazon Web Services service. You can use the DescribeServices operation to get the possible serviceCode values.

  • severityCode — (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.

    Note: The availability of severity levels depends on the support plan for the Amazon Web Services account.
  • categoryCode — (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.

  • communicationBody — (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.

  • ccEmailAddresses — (Array<String>)

    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.

  • language — (String)

    The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1 code for the language parameter if you want support in that language.

  • issueType — (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.

  • attachmentSetId — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • caseId — (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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  attachmentId: 'STRING_VALUE' /* required */
};
support.describeAttachment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • attachmentId — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • attachment — (map)

      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.

      • fileName — (String)

        The name of the attachment file.

      • data — (Buffer, Typed Array, Blob, String)

        The content of the attachment file.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  afterTime: 'STRING_VALUE',
  beforeTime: 'STRING_VALUE',
  caseIdList: [
    'STRING_VALUE',
    /* more items */
  ],
  displayId: 'STRING_VALUE',
  includeCommunications: true || false,
  includeResolvedCases: true || false,
  language: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
support.describeCases(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • 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 Amazon Web Services 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 — (Boolean)

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

  • nextToken — (String)

    A resumption point for pagination.

  • maxResults — (Integer)

    The maximum number of results to return before paginating.

  • language — (String)

    The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1 code for the language parameter if you want support in that language.

  • includeCommunications — (Boolean)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • cases — (Array<map>)

      The details for the cases that match the request.

      • caseId — (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

      • displayId — (String)

        The ID displayed for the case in the Amazon Web Services Support Center. This is a numeric string.

      • subject — (String)

        The subject line for the case in the Amazon Web Services Support Center.

      • status — (String)

        The status of the case.

        Valid values:

        • all-open

        • customer-action-completed

        • opened

        • pending-customer-action

        • reopened

        • resolved

        • unassigned

        • work-in-progress

      • serviceCode — (String)

        The code for the Amazon Web Services service. You can get a list of codes and the corresponding service names by calling DescribeServices.

      • categoryCode — (String)

        The category of problem for the 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 created in the Amazon Web Services Support Center.

      • recentCommunications — (map)

        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.

        • communications — (Array<map>)

          The five most recent communications associated with the case.

          • caseId — (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

          • body — (String)

            The text of the communication between the customer and Amazon Web Services Support.

          • submittedBy — (String)

            The identity of the account that submitted, or responded to, the support case. Customer entries include the IAM role as well as the email address (for example, "AdminRole (Role) <janedoe@example.com>). Entries from the Amazon Web Services Support team display "Amazon Web Services," and don't show an email address.

          • timeCreated — (String)

            The time the communication was created.

          • attachmentSet — (Array<map>)

            Information about the attachments to the case communication.

            • 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 language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1 code for the language parameter if you want support in that language.

    • nextToken — (String)

      A resumption point for pagination.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  caseId: 'STRING_VALUE', /* required */
  afterTime: 'STRING_VALUE',
  beforeTime: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
support.describeCommunications(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • caseId — (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

  • 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 — (Integer)

    The maximum number of results to return before paginating.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • communications — (Array<map>)

      The communications for the case.

      • caseId — (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

      • body — (String)

        The text of the communication between the customer and Amazon Web Services Support.

      • submittedBy — (String)

        The identity of the account that submitted, or responded to, the support case. Customer entries include the IAM role as well as the email address (for example, "AdminRole (Role) <janedoe@example.com>). Entries from the Amazon Web Services Support team display "Amazon Web Services," and don't show an email address.

      • timeCreated — (String)

        The time the communication was created.

      • attachmentSet — (Array<map>)

        Information about the attachments to the case communication.

        • attachmentId — (String)

          The ID of the attachment.

        • fileName — (String)

          The file name of the attachment.

    • nextToken — (String)

      A resumption point for pagination.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  categoryCode: 'STRING_VALUE', /* required */
  issueType: 'STRING_VALUE', /* required */
  language: 'STRING_VALUE', /* required */
  serviceCode: 'STRING_VALUE' /* required */
};
support.describeCreateCaseOptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • issueType — (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.

  • serviceCode — (String)

    The code for the Amazon Web Services service. You can use the DescribeServices operation to get the possible serviceCode values.

  • language — (String)

    The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1 code for the language parameter if you want support in that language.

  • categoryCode — (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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • languageAvailability — (String)

      Language availability can be any of the following:

      • available

      • best_effort

      • unavailable

    • communicationTypes — (Array<map>)

      A JSON-formatted array that contains the available communication type options, along with the available support timeframes for the given inputs.

      • type — (String)

        A string value indicating the communication type. At the moment the type value can assume one of 3 values at the moment chat, web and call.

      • supportedHours — (Array<map>)

        A JSON-formatted list containing time ranges when support is available.

        • startTime — (String)

          Start Time. RFC 3339 format 'HH:mm:ss.SSS'.

        • endTime — (String)

          End Time. RFC 3339 format 'HH:mm:ss.SSS'.

      • datesWithoutSupport — (Array<map>)

        A JSON-formatted list containing date and time ranges for periods without support

        • startDateTime — (String)

          A JSON object containing start and date time (UTC). Date and time format is RFC 3339 : 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'.

        • endDateTime — (String)

          End Date Time (UTC). RFC 3339 format : 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  language: 'STRING_VALUE',
  serviceCodeList: [
    'STRING_VALUE',
    /* more items */
  ]
};
support.describeServices(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • serviceCodeList — (Array<String>)

    A JSON-formatted list of service codes available for Amazon Web Services services.

  • language — (String)

    The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1 code for the language parameter if you want support in that language.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • services — (Array<map>)

      A JSON-formatted list of Amazon Web Services services.

      • code — (String)

        The code for an Amazon Web Services service returned by the DescribeServices response. The name element contains the corresponding friendly name.

      • name — (String)

        The friendly name for an Amazon Web Services service. The code element contains the corresponding code.

      • categories — (Array<map>)

        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 — (String)

          The category code for the support case.

        • name — (String)

          The category name for the support case.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  language: 'STRING_VALUE'
};
support.describeSeverityLevels(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • language — (String)

    The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1 code for the language parameter if you want support in that language.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • severityLevels — (Array<map>)

      The available severity levels for the support case. Available severity levels are defined by your service level agreement with Amazon Web Services.

      • code — (String)

        The code for case severity level.

        Valid values: low | normal | high | urgent | critical

      • name — (String)

        The name of the severity level that corresponds to the severity level code.

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  categoryCode: 'STRING_VALUE', /* required */
  issueType: 'STRING_VALUE', /* required */
  serviceCode: 'STRING_VALUE' /* required */
};
support.describeSupportedLanguages(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • issueType — (String)

    The type of issue for the case. You can specify customer-service or technical.

  • serviceCode — (String)

    The code for the Amazon Web Services service. You can use the DescribeServices operation to get the possible serviceCode values.

  • categoryCode — (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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • supportedLanguages — (Array<map>)

      A JSON-formatted array that contains the available ISO 639-1 language codes.

      • code — (String)

        2 digit ISO 639-1 code. e.g. en

      • language — (String)

        Full language description e.g. ENGLISH

      • display — (String)

        Language display value e.g. ENGLISH

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  checkIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
support.describeTrustedAdvisorCheckRefreshStatuses(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • checkIds — (Array<String>)

    The IDs of the Trusted Advisor checks to get the status.

    Note: If you specify the check ID of a check that is automatically refreshed, you might see an InvalidParameterValue error.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • statuses — (Array<map>)

      The refresh status of the specified Trusted Advisor checks.

      • checkId — required — (String)

        The unique identifier for the Trusted Advisor check.

      • status — required — (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

      • millisUntilNextRefreshable — required — (Integer)

        The amount of time, in milliseconds, until the Trusted Advisor check is eligible for refresh.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  checkId: 'STRING_VALUE', /* required */
  language: 'STRING_VALUE'
};
support.describeTrustedAdvisorCheckResult(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • checkId — (String)

    The unique identifier for the Trusted Advisor check.

  • language — (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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • result — (map)

      The detailed results of the Trusted Advisor check.

      • checkId — required — (String)

        The unique identifier for the Trusted Advisor check.

      • timestamp — required — (String)

        The time of the last refresh of the check.

      • status — required — (String)

        The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".

      • resourcesSummary — required — (map)

        Details about Amazon Web Services resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries.

        • resourcesProcessed — required — (Integer)

          The number of Amazon Web Services resources that were analyzed by the Trusted Advisor check.

        • resourcesFlagged — required — (Integer)

          The number of Amazon Web Services resources that were flagged (listed) by the Trusted Advisor check.

        • resourcesIgnored — required — (Integer)

          The number of Amazon Web Services resources ignored by Trusted Advisor because information was unavailable.

        • resourcesSuppressed — required — (Integer)

          The number of Amazon Web Services resources ignored by Trusted Advisor because they were marked as suppressed by the user.

      • categorySpecificSummary — required — (map)

        Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.

        • costOptimizing — (map)

          The summary information about cost savings for a Trusted Advisor check that is in the Cost Optimizing category.

          • estimatedMonthlySavings — required — (Float)

            The estimated monthly savings that might be realized if the recommended operations are taken.

          • estimatedPercentMonthlySavings — required — (Float)

            The estimated percentage of savings that might be realized if the recommended operations are taken.

      • flaggedResources — required — (Array<map>)

        The details about each resource listed in the check result.

        • status — required — (String)

          The status code for the resource identified in the Trusted Advisor check.

        • region — (String)

          The Amazon Web Services Region in which the identified resource is located.

        • resourceId — required — (String)

          The unique identifier for the identified resource.

        • isSuppressed — (Boolean)

          Specifies whether the Amazon Web Services resource was ignored by Trusted Advisor because it was marked as suppressed by the user.

        • metadata — required — (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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  language: 'STRING_VALUE' /* required */
};
support.describeTrustedAdvisorChecks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • language — (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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • checks — (Array<map>)

      Information about all available Trusted Advisor checks.

      • id — required — (String)

        The unique identifier for the Trusted Advisor check.

      • name — required — (String)

        The display name for the Trusted Advisor check.

      • description — required — (String)

        The description of the Trusted Advisor check, which includes the alert criteria and recommended operations (contains HTML markup).

      • category — required — (String)

        The category of the Trusted Advisor check.

      • metadata — required — (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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  checkIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
support.describeTrustedAdvisorCheckSummaries(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • checkIds — (Array<String>)

    The IDs of the Trusted Advisor checks.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • summaries — (Array<map>)

      The summary information for the requested Trusted Advisor checks.

      • checkId — required — (String)

        The unique identifier for the Trusted Advisor check.

      • timestamp — required — (String)

        The time of the last refresh of the check.

      • status — required — (String)

        The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".

      • hasFlaggedResources — (Boolean)

        Specifies whether the Trusted Advisor check has flagged resources.

      • resourcesSummary — required — (map)

        Details about Amazon Web Services resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries.

        • resourcesProcessed — required — (Integer)

          The number of Amazon Web Services resources that were analyzed by the Trusted Advisor check.

        • resourcesFlagged — required — (Integer)

          The number of Amazon Web Services resources that were flagged (listed) by the Trusted Advisor check.

        • resourcesIgnored — required — (Integer)

          The number of Amazon Web Services resources ignored by Trusted Advisor because information was unavailable.

        • resourcesSuppressed — required — (Integer)

          The number of Amazon Web Services resources ignored by Trusted Advisor because they were marked as suppressed by the user.

      • categorySpecificSummary — required — (map)

        Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.

        • costOptimizing — (map)

          The summary information about cost savings for a Trusted Advisor check that is in the Cost Optimizing category.

          • estimatedMonthlySavings — required — (Float)

            The estimated monthly savings that might be realized if the recommended operations are taken.

          • estimatedPercentMonthlySavings — required — (Float)

            The estimated percentage of savings that might be realized if the recommended operations are taken.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  checkId: 'STRING_VALUE' /* required */
};
support.refreshTrustedAdvisorCheck(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • checkId — (String)

    The unique identifier for the Trusted Advisor check to refresh.

    Note: Specifying the check ID of a check that is automatically refreshed causes an InvalidParameterValue error.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • status — (map)

      The current refresh status for a check, including the amount of time until the check is eligible for refresh.

      • checkId — required — (String)

        The unique identifier for the Trusted Advisor check.

      • status — required — (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

      • millisUntilNextRefreshable — required — (Integer)

        The amount of time, in milliseconds, until the Trusted Advisor check is eligible for refresh.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  caseId: 'STRING_VALUE'
};
support.resolveCase(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • caseId — (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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.