Class: AWS.Support

Inherits:
AWS.Service show all
Identifier:
support
API Version:
2013-04-15
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Sending a Request Using Support

var support = new AWS.Support();
support.addAttachmentsToSet(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Support object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var support = new AWS.Support({apiVersion: '2013-04-15'});

You can also set the API version globally in AWS.config.apiVersions using the support service identifier:

AWS.config.apiVersions = {
  support: '2013-04-15',
  // other service API versions
};

var support = new AWS.Support();

Version:

  • 2013-04-15

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.Support(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a Support object

var support = new AWS.Support({apiVersion: '2013-04-15'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.Support.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.Support.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.Support.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

addAttachmentsToSet(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the addAttachmentsToSet operation

var params = {
  attachments: [ /* required */
    {
      data: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
      fileName: 'STRING_VALUE'
    },
    /* more items */
  ],
  attachmentSetId: 'STRING_VALUE'
};
support.addAttachmentsToSet(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: {})
    • 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<map>)

      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.

      • fileName — (String)

        The name of the attachment file.

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

        The content of the attachment file.

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:

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

Returns:

  • (AWS.Request)

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

addCommunicationToCase(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the addCommunicationToCase operation

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

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:

Returns:

  • (AWS.Request)

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

createCase(params = {}, callback) ⇒ AWS.Request

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.

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

Service Reference:

Examples:

Calling the createCase operation

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

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

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

  • (AWS.Request)

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

describeAttachment(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the describeAttachment operation

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)

        The attachment content and file name.

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

describeCases(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the describeCases operation

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: 0,
  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 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 — (Boolean)

      Specifies whether resolved support cases should be included in the DescribeCases results. The default is false.

    • nextToken — (String)

      A resumption point for pagination.

    • maxResults — (Integer)

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

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

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

          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<map>)

            The five most recent communications associated with the case.

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

Returns:

  • (AWS.Request)

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

describeCommunications(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the describeCommunications operation

var params = {
  caseId: 'STRING_VALUE', /* required */
  afterTime: 'STRING_VALUE',
  beforeTime: 'STRING_VALUE',
  maxResults: 0,
  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 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 — (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 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<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.

describeServices(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the describeServices operation

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

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 AWS services.

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

describeSeverityLevels(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the describeSeverityLevels operation

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

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

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

Returns:

  • (AWS.Request)

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

describeTrustedAdvisorCheckRefreshStatuses(params = {}, callback) ⇒ AWS.Request

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

Note: Some checks are refreshed automatically, and their refresh statuses cannot be retrieved by using this operation. Use of the DescribeTrustedAdvisorCheckRefreshStatuses operation for these checks causes an InvalidParameterValue error.

Examples:

Calling the describeTrustedAdvisorCheckRefreshStatuses operation

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

      • statuses — (Array<map>)

        The refresh status of the specified Trusted Advisor checks.

        • checkIdrequired — (String)

          The unique identifier for the Trusted Advisor check.

        • statusrequired — (String)

          The status of the Trusted Advisor check for which a refresh has been requested: "none", "enqueued", "processing", "success", or "abandoned".

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

describeTrustedAdvisorCheckResult(params = {}, callback) ⇒ AWS.Request

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:

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:

Calling the describeTrustedAdvisorCheckResult operation

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

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.

        • checkIdrequired — (String)

          The unique identifier for the Trusted Advisor check.

        • timestamprequired — (String)

          The time of the last refresh of the check.

        • statusrequired — (String)

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

        • resourcesSummaryrequired — (map)

          Details about AWS resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries.

          • resourcesProcessedrequired — (Integer)

            The number of AWS resources that were analyzed by the Trusted Advisor check.

          • resourcesFlaggedrequired — (Integer)

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

          • resourcesIgnoredrequired — (Integer)

            The number of AWS resources ignored by Trusted Advisor because information was unavailable.

          • resourcesSuppressedrequired — (Integer)

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

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

            • estimatedMonthlySavingsrequired — (Float)

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

            • estimatedPercentMonthlySavingsrequired — (Float)

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

        • flaggedResourcesrequired — (Array<map>)

          The details about each resource listed in the check result.

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

          • resourceIdrequired — (String)

            The unique identifier for the identified resource.

          • isSuppressed — (Boolean)

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

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

describeTrustedAdvisorChecks(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the describeTrustedAdvisorChecks operation

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

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.

        • idrequired — (String)

          The unique identifier for the Trusted Advisor check.

        • namerequired — (String)

          The display name for the Trusted Advisor check.

        • descriptionrequired — (String)

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

        • categoryrequired — (String)

          The category of the Trusted Advisor check.

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

describeTrustedAdvisorCheckSummaries(params = {}, callback) ⇒ AWS.Request

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:

Calling the describeTrustedAdvisorCheckSummaries operation

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.

        • checkIdrequired — (String)

          The unique identifier for the Trusted Advisor check.

        • timestamprequired — (String)

          The time of the last refresh of the check.

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

        • resourcesSummaryrequired — (map)

          Details about AWS resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries.

          • resourcesProcessedrequired — (Integer)

            The number of AWS resources that were analyzed by the Trusted Advisor check.

          • resourcesFlaggedrequired — (Integer)

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

          • resourcesIgnoredrequired — (Integer)

            The number of AWS resources ignored by Trusted Advisor because information was unavailable.

          • resourcesSuppressedrequired — (Integer)

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

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

            • estimatedMonthlySavingsrequired — (Float)

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

            • estimatedPercentMonthlySavingsrequired — (Float)

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

Returns:

  • (AWS.Request)

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

refreshTrustedAdvisorCheck(params = {}, callback) ⇒ AWS.Request

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

Note: Some checks are refreshed automatically, and they cannot be refreshed by using this operation. Use of the RefreshTrustedAdvisorCheck operation for these checks causes an InvalidParameterValue error.

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.

Service Reference:

Examples:

Calling the refreshTrustedAdvisorCheck operation

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.

        • checkIdrequired — (String)

          The unique identifier for the Trusted Advisor check.

        • statusrequired — (String)

          The status of the Trusted Advisor check for which a refresh has been requested: "none", "enqueued", "processing", "success", or "abandoned".

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

resolveCase(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the resolveCase operation

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

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.