We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.TrustedAdvisor

Inherits:
AWS.Service show all
Identifier:
trustedadvisor
API Version:
2022-09-15
Defined in:
(unknown)

Overview

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

Service Description

TrustedAdvisor Public API

Sending a Request Using TrustedAdvisor

var trustedadvisor = new AWS.TrustedAdvisor();
trustedadvisor.getOrganizationRecommendation(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 TrustedAdvisor object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var trustedadvisor = new AWS.TrustedAdvisor({apiVersion: '2022-09-15'});

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

AWS.config.apiVersions = {
  trustedadvisor: '2022-09-15',
  // other service API versions
};

var trustedadvisor = new AWS.TrustedAdvisor();

Version:

  • 2022-09-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.TrustedAdvisor(options = {}) ⇒ Object

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

Examples:

Constructing a TrustedAdvisor object

var trustedadvisor = new AWS.TrustedAdvisor({apiVersion: '2022-09-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|AWS.Endpoint)

    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' or an Endpoint object.

  • 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.TrustedAdvisor.region for more information.

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.TrustedAdvisor.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.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets 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 error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • 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.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

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

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

Get a specific recommendation within an AWS Organizations organization. This API supports only prioritized recommendations.

Service Reference:

Examples:

Calling the getOrganizationRecommendation operation

var params = {
  organizationRecommendationIdentifier: 'STRING_VALUE' /* required */
};
trustedadvisor.getOrganizationRecommendation(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: {})
    • organizationRecommendationIdentifier — (String)

      The Recommendation identifier

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:

      • organizationRecommendation — (map)

        The Recommendation

        • arnrequired — (String)

          The ARN of the Recommendation

        • awsServices — (Array<String>)

          The AWS Services that the Recommendation applies to

        • checkArn — (String)

          The AWS Trusted Advisor Check ARN that relates to the Recommendation

        • createdAt — (Date)

          When the Recommendation was created, if created by AWS Trusted Advisor Priority

        • createdBy — (String)

          The creator, if created by AWS Trusted Advisor Priority

        • descriptionrequired — (String)

          A description for AWS Trusted Advisor recommendations

        • idrequired — (String)

          The ID which identifies where the Recommendation was produced

        • lastUpdatedAt — (Date)

          When the Recommendation was last updated

        • lifecycleStage — (String)

          The lifecycle stage from AWS Trusted Advisor Priority

          Possible values include:
          • "in_progress"
          • "pending_response"
          • "dismissed"
          • "resolved"
        • namerequired — (String)

          The name of the AWS Trusted Advisor Recommendation

        • pillarSpecificAggregates — (map)

          The pillar aggregations for cost savings

          • costOptimizing — (map)

            Cost optimizing aggregates

            • estimatedMonthlySavingsrequired — (Float)

              The estimated monthly savings

            • estimatedPercentMonthlySavingsrequired — (Float)

              The estimated percently monthly savings

        • pillarsrequired — (Array<String>)

          The Pillars that the Recommendation is optimizing

        • resolvedAt — (Date)

          When the Recommendation was resolved

        • resourcesAggregatesrequired — (map)

          An aggregation of all resources

          • errorCountrequired — (Integer)

            The number of AWS resources that were flagged to have errors according to the Trusted Advisor check

          • okCountrequired — (Integer)

            The number of AWS resources that were flagged to be OK according to the Trusted Advisor check

          • warningCountrequired — (Integer)

            The number of AWS resources that were flagged to have warning according to the Trusted Advisor check

        • sourcerequired — (String)

          The source of the Recommendation

          Possible values include:
          • "aws_config"
          • "compute_optimizer"
          • "cost_explorer"
          • "lse"
          • "manual"
          • "pse"
          • "rds"
          • "resilience"
          • "resilience_hub"
          • "security_hub"
          • "stir"
          • "ta_check"
          • "well_architected"
        • statusrequired — (String)

          The status of the Recommendation

          Possible values include:
          • "ok"
          • "warning"
          • "error"
        • typerequired — (String)

          Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority

          Possible values include:
          • "standard"
          • "priority"
        • updateReason — (String)

          Reason for the lifecycle stage change

        • updateReasonCode — (String)

          Reason code for the lifecycle state change

          Possible values include:
          • "non_critical_account"
          • "temporary_account"
          • "valid_business_case"
          • "other_methods_available"
          • "low_priority"
          • "not_applicable"
          • "other"
        • updatedOnBehalfOf — (String)

          The person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority

        • updatedOnBehalfOfJobTitle — (String)

          The job title of the person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority

Returns:

  • (AWS.Request)

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

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

Get a specific Recommendation

Service Reference:

Examples:

Calling the getRecommendation operation

var params = {
  recommendationIdentifier: 'STRING_VALUE' /* required */
};
trustedadvisor.getRecommendation(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: {})
    • recommendationIdentifier — (String)

      The Recommendation identifier

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:

      • recommendation — (map)

        The Recommendation

        • arnrequired — (String)

          The ARN of the Recommendation

        • awsServices — (Array<String>)

          The AWS Services that the Recommendation applies to

        • checkArn — (String)

          The AWS Trusted Advisor Check ARN that relates to the Recommendation

        • createdAt — (Date)

          When the Recommendation was created, if created by AWS Trusted Advisor Priority

        • createdBy — (String)

          The creator, if created by AWS Trusted Advisor Priority

        • descriptionrequired — (String)

          A description for AWS Trusted Advisor recommendations

        • idrequired — (String)

          The ID which identifies where the Recommendation was produced

        • lastUpdatedAt — (Date)

          When the Recommendation was last updated

        • lifecycleStage — (String)

          The lifecycle stage from AWS Trusted Advisor Priority

          Possible values include:
          • "in_progress"
          • "pending_response"
          • "dismissed"
          • "resolved"
        • namerequired — (String)

          The name of the AWS Trusted Advisor Recommendation

        • pillarSpecificAggregates — (map)

          The pillar aggregations for cost savings

          • costOptimizing — (map)

            Cost optimizing aggregates

            • estimatedMonthlySavingsrequired — (Float)

              The estimated monthly savings

            • estimatedPercentMonthlySavingsrequired — (Float)

              The estimated percently monthly savings

        • pillarsrequired — (Array<String>)

          The Pillars that the Recommendation is optimizing

        • resolvedAt — (Date)

          When the Recommendation was resolved

        • resourcesAggregatesrequired — (map)

          An aggregation of all resources

          • errorCountrequired — (Integer)

            The number of AWS resources that were flagged to have errors according to the Trusted Advisor check

          • okCountrequired — (Integer)

            The number of AWS resources that were flagged to be OK according to the Trusted Advisor check

          • warningCountrequired — (Integer)

            The number of AWS resources that were flagged to have warning according to the Trusted Advisor check

        • sourcerequired — (String)

          The source of the Recommendation

          Possible values include:
          • "aws_config"
          • "compute_optimizer"
          • "cost_explorer"
          • "lse"
          • "manual"
          • "pse"
          • "rds"
          • "resilience"
          • "resilience_hub"
          • "security_hub"
          • "stir"
          • "ta_check"
          • "well_architected"
        • statusrequired — (String)

          The status of the Recommendation

          Possible values include:
          • "ok"
          • "warning"
          • "error"
        • typerequired — (String)

          Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority

          Possible values include:
          • "standard"
          • "priority"
        • updateReason — (String)

          Reason for the lifecycle stage change

        • updateReasonCode — (String)

          Reason code for the lifecycle state change

          Possible values include:
          • "non_critical_account"
          • "temporary_account"
          • "valid_business_case"
          • "other_methods_available"
          • "low_priority"
          • "not_applicable"
          • "other"
        • updatedOnBehalfOf — (String)

          The person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority

        • updatedOnBehalfOfJobTitle — (String)

          The job title of the person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority

Returns:

  • (AWS.Request)

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

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

List a filterable set of Checks

Service Reference:

Examples:

Calling the listChecks operation

var params = {
  awsService: 'STRING_VALUE',
  language: en | ja | zh | fr | de | ko | zh_TW | it | es | pt_BR | id,
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  pillar: cost_optimizing | performance | security | service_limits | fault_tolerance | operational_excellence,
  source: aws_config | compute_optimizer | cost_explorer | lse | manual | pse | rds | resilience | resilience_hub | security_hub | stir | ta_check | well_architected
};
trustedadvisor.listChecks(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: {})
    • awsService — (String)

      The aws service associated with the check

    • language — (String)

      The ISO 639-1 code for the language that you want your checks to appear in.

      Possible values include:
      • "en"
      • "ja"
      • "zh"
      • "fr"
      • "de"
      • "ko"
      • "zh_TW"
      • "it"
      • "es"
      • "pt_BR"
      • "id"
    • maxResults — (Integer)

      The maximum number of results to return per page.

    • nextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • pillar — (String)

      The pillar of the check

      Possible values include:
      • "cost_optimizing"
      • "performance"
      • "security"
      • "service_limits"
      • "fault_tolerance"
      • "operational_excellence"
    • source — (String)

      The source of the check

      Possible values include:
      • "aws_config"
      • "compute_optimizer"
      • "cost_explorer"
      • "lse"
      • "manual"
      • "pse"
      • "rds"
      • "resilience"
      • "resilience_hub"
      • "security_hub"
      • "stir"
      • "ta_check"
      • "well_architected"

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:

      • checkSummaries — (Array<map>)

        The list of Checks

        • arnrequired — (String)

          The ARN of the AWS Trusted Advisor Check

        • awsServicesrequired — (Array<String>)

          The AWS Services that the Check applies to

        • descriptionrequired — (String)

          A description of what the AWS Trusted Advisor Check is monitoring

        • idrequired — (String)

          The unique identifier of the AWS Trusted Advisor Check

        • metadatarequired — (map<String>)

          The column headings for the metadata returned in the resource

        • namerequired — (String)

          The name of the AWS Trusted Advisor Check

        • pillarsrequired — (Array<String>)

          The Recommendation pillars that the AWS Trusted Advisor Check falls under

        • sourcerequired — (String)

          The source of the Recommendation

          Possible values include:
          • "aws_config"
          • "compute_optimizer"
          • "cost_explorer"
          • "lse"
          • "manual"
          • "pse"
          • "rds"
          • "resilience"
          • "resilience_hub"
          • "security_hub"
          • "stir"
          • "ta_check"
          • "well_architected"
      • nextToken — (String)

        The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

  • (AWS.Request)

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

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

Lists the accounts that own the resources for an organization aggregate recommendation. This API only supports prioritized recommendations.

Examples:

Calling the listOrganizationRecommendationAccounts operation

var params = {
  organizationRecommendationIdentifier: 'STRING_VALUE', /* required */
  affectedAccountId: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
trustedadvisor.listOrganizationRecommendationAccounts(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: {})
    • affectedAccountId — (String)

      An account affected by this organization recommendation

    • maxResults — (Integer)

      The maximum number of results to return per page.

    • nextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • organizationRecommendationIdentifier — (String)

      The Recommendation identifier

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:

      • accountRecommendationLifecycleSummaries — (Array<map>)

        The account recommendations lifecycles that are applicable to the Recommendation

        • accountId — (String)

          The AWS account ID

        • accountRecommendationArn — (String)

          The Recommendation ARN

        • lastUpdatedAt — (Date)

          When the Recommendation was last updated

        • lifecycleStage — (String)

          The lifecycle stage from AWS Trusted Advisor Priority

          Possible values include:
          • "in_progress"
          • "pending_response"
          • "dismissed"
          • "resolved"
        • updateReason — (String)

          Reason for the lifecycle stage change

        • updateReasonCode — (String)

          Reason code for the lifecycle state change

          Possible values include:
          • "non_critical_account"
          • "temporary_account"
          • "valid_business_case"
          • "other_methods_available"
          • "low_priority"
          • "not_applicable"
          • "other"
        • updatedOnBehalfOf — (String)

          The person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority

        • updatedOnBehalfOfJobTitle — (String)

          The job title of the person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority

      • nextToken — (String)

        The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

  • (AWS.Request)

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

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

List Resources of a Recommendation within an Organization. This API only supports prioritized recommendations.

Examples:

Calling the listOrganizationRecommendationResources operation

var params = {
  organizationRecommendationIdentifier: 'STRING_VALUE', /* required */
  affectedAccountId: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  regionCode: 'STRING_VALUE',
  status: ok | warning | error
};
trustedadvisor.listOrganizationRecommendationResources(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: {})
    • affectedAccountId — (String)

      An account affected by this organization recommendation

    • maxResults — (Integer)

      The maximum number of results to return per page.

    • nextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • organizationRecommendationIdentifier — (String)

      The AWS Organization organization's Recommendation identifier

    • regionCode — (String)

      The AWS Region code of the resource

    • status — (String)

      The status of the resource

      Possible values include:
      • "ok"
      • "warning"
      • "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:

      • nextToken — (String)

        The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

      • organizationRecommendationResourceSummaries — (Array<map>)

        A list of Recommendation Resources

        • accountId — (String)

          The AWS account ID

        • arnrequired — (String)

          The ARN of the Recommendation Resource

        • awsResourceIdrequired — (String)

          The AWS resource identifier

        • idrequired — (String)

          The ID of the Recommendation Resource

        • lastUpdatedAtrequired — (Date)

          When the Recommendation Resource was last updated

        • metadatarequired — (map<String>)

          Metadata associated with the Recommendation Resource

        • recommendationArnrequired — (String)

          The Recommendation ARN

        • regionCoderequired — (String)

          The AWS Region code that the Recommendation Resource is in

        • statusrequired — (String)

          The current status of the Recommendation Resource

          Possible values include:
          • "ok"
          • "warning"
          • "error"

Returns:

  • (AWS.Request)

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

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

List a filterable set of Recommendations within an Organization. This API only supports prioritized recommendations.

Service Reference:

Examples:

Calling the listOrganizationRecommendations operation

var params = {
  afterLastUpdatedAt: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  awsService: 'STRING_VALUE',
  beforeLastUpdatedAt: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  checkIdentifier: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  pillar: cost_optimizing | performance | security | service_limits | fault_tolerance | operational_excellence,
  source: aws_config | compute_optimizer | cost_explorer | lse | manual | pse | rds | resilience | resilience_hub | security_hub | stir | ta_check | well_architected,
  status: ok | warning | error,
  type: standard | priority
};
trustedadvisor.listOrganizationRecommendations(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: {})
    • afterLastUpdatedAt — (Date)

      After the last update of the Recommendation

    • awsService — (String)

      The aws service associated with the Recommendation

    • beforeLastUpdatedAt — (Date)

      Before the last update of the Recommendation

    • checkIdentifier — (String)

      The check identifier of the Recommendation

    • maxResults — (Integer)

      The maximum number of results to return per page.

    • nextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • pillar — (String)

      The pillar of the Recommendation

      Possible values include:
      • "cost_optimizing"
      • "performance"
      • "security"
      • "service_limits"
      • "fault_tolerance"
      • "operational_excellence"
    • source — (String)

      The source of the Recommendation

      Possible values include:
      • "aws_config"
      • "compute_optimizer"
      • "cost_explorer"
      • "lse"
      • "manual"
      • "pse"
      • "rds"
      • "resilience"
      • "resilience_hub"
      • "security_hub"
      • "stir"
      • "ta_check"
      • "well_architected"
    • status — (String)

      The status of the Recommendation

      Possible values include:
      • "ok"
      • "warning"
      • "error"
    • type — (String)

      The type of the Recommendation

      Possible values include:
      • "standard"
      • "priority"

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:

      • nextToken — (String)

        The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

      • organizationRecommendationSummaries — (Array<map>)

        The list of Recommendations

        • arnrequired — (String)

          The ARN of the Recommendation

        • awsServices — (Array<String>)

          The AWS Services that the Recommendation applies to

        • checkArn — (String)

          The AWS Trusted Advisor Check ARN that relates to the Recommendation

        • createdAt — (Date)

          When the Recommendation was created, if created by AWS Trusted Advisor Priority

        • idrequired — (String)

          The ID which identifies where the Recommendation was produced

        • lastUpdatedAt — (Date)

          When the Recommendation was last updated

        • lifecycleStage — (String)

          The lifecycle stage from AWS Trusted Advisor Priority

          Possible values include:
          • "in_progress"
          • "pending_response"
          • "dismissed"
          • "resolved"
        • namerequired — (String)

          The name of the AWS Trusted Advisor Recommendation

        • pillarSpecificAggregates — (map)

          The pillar aggregations for cost savings

          • costOptimizing — (map)

            Cost optimizing aggregates

            • estimatedMonthlySavingsrequired — (Float)

              The estimated monthly savings

            • estimatedPercentMonthlySavingsrequired — (Float)

              The estimated percently monthly savings

        • pillarsrequired — (Array<String>)

          The Pillars that the Recommendation is optimizing

        • resourcesAggregatesrequired — (map)

          An aggregation of all resources

          • errorCountrequired — (Integer)

            The number of AWS resources that were flagged to have errors according to the Trusted Advisor check

          • okCountrequired — (Integer)

            The number of AWS resources that were flagged to be OK according to the Trusted Advisor check

          • warningCountrequired — (Integer)

            The number of AWS resources that were flagged to have warning according to the Trusted Advisor check

        • sourcerequired — (String)

          The source of the Recommendation

          Possible values include:
          • "aws_config"
          • "compute_optimizer"
          • "cost_explorer"
          • "lse"
          • "manual"
          • "pse"
          • "rds"
          • "resilience"
          • "resilience_hub"
          • "security_hub"
          • "stir"
          • "ta_check"
          • "well_architected"
        • statusrequired — (String)

          The status of the Recommendation

          Possible values include:
          • "ok"
          • "warning"
          • "error"
        • typerequired — (String)

          Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority

          Possible values include:
          • "standard"
          • "priority"

Returns:

  • (AWS.Request)

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

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

List Resources of a Recommendation

Service Reference:

Examples:

Calling the listRecommendationResources operation

var params = {
  recommendationIdentifier: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  regionCode: 'STRING_VALUE',
  status: ok | warning | error
};
trustedadvisor.listRecommendationResources(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: {})
    • maxResults — (Integer)

      The maximum number of results to return per page.

    • nextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • recommendationIdentifier — (String)

      The Recommendation identifier

    • regionCode — (String)

      The AWS Region code of the resource

    • status — (String)

      The status of the resource

      Possible values include:
      • "ok"
      • "warning"
      • "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:

      • nextToken — (String)

        The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

      • recommendationResourceSummaries — (Array<map>)

        A list of Recommendation Resources

        • arnrequired — (String)

          The ARN of the Recommendation Resource

        • awsResourceIdrequired — (String)

          The AWS resource identifier

        • idrequired — (String)

          The ID of the Recommendation Resource

        • lastUpdatedAtrequired — (Date)

          When the Recommendation Resource was last updated

        • metadatarequired — (map<String>)

          Metadata associated with the Recommendation Resource

        • recommendationArnrequired — (String)

          The Recommendation ARN

        • regionCoderequired — (String)

          The AWS Region code that the Recommendation Resource is in

        • statusrequired — (String)

          The current status of the Recommendation Resource

          Possible values include:
          • "ok"
          • "warning"
          • "error"

Returns:

  • (AWS.Request)

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

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

List a filterable set of Recommendations

Service Reference:

Examples:

Calling the listRecommendations operation

var params = {
  afterLastUpdatedAt: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  awsService: 'STRING_VALUE',
  beforeLastUpdatedAt: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  checkIdentifier: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  pillar: cost_optimizing | performance | security | service_limits | fault_tolerance | operational_excellence,
  source: aws_config | compute_optimizer | cost_explorer | lse | manual | pse | rds | resilience | resilience_hub | security_hub | stir | ta_check | well_architected,
  status: ok | warning | error,
  type: standard | priority
};
trustedadvisor.listRecommendations(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: {})
    • afterLastUpdatedAt — (Date)

      After the last update of the Recommendation

    • awsService — (String)

      The aws service associated with the Recommendation

    • beforeLastUpdatedAt — (Date)

      Before the last update of the Recommendation

    • checkIdentifier — (String)

      The check identifier of the Recommendation

    • maxResults — (Integer)

      The maximum number of results to return per page.

    • nextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • pillar — (String)

      The pillar of the Recommendation

      Possible values include:
      • "cost_optimizing"
      • "performance"
      • "security"
      • "service_limits"
      • "fault_tolerance"
      • "operational_excellence"
    • source — (String)

      The source of the Recommendation

      Possible values include:
      • "aws_config"
      • "compute_optimizer"
      • "cost_explorer"
      • "lse"
      • "manual"
      • "pse"
      • "rds"
      • "resilience"
      • "resilience_hub"
      • "security_hub"
      • "stir"
      • "ta_check"
      • "well_architected"
    • status — (String)

      The status of the Recommendation

      Possible values include:
      • "ok"
      • "warning"
      • "error"
    • type — (String)

      The type of the Recommendation

      Possible values include:
      • "standard"
      • "priority"

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:

      • nextToken — (String)

        The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

      • recommendationSummaries — (Array<map>)

        The list of Recommendations

        • arnrequired — (String)

          The ARN of the Recommendation

        • awsServices — (Array<String>)

          The AWS Services that the Recommendation applies to

        • checkArn — (String)

          The AWS Trusted Advisor Check ARN that relates to the Recommendation

        • createdAt — (Date)

          When the Recommendation was created, if created by AWS Trusted Advisor Priority

        • idrequired — (String)

          The ID which identifies where the Recommendation was produced

        • lastUpdatedAt — (Date)

          When the Recommendation was last updated

        • lifecycleStage — (String)

          The lifecycle stage from AWS Trusted Advisor Priority

          Possible values include:
          • "in_progress"
          • "pending_response"
          • "dismissed"
          • "resolved"
        • namerequired — (String)

          The name of the AWS Trusted Advisor Recommendation

        • pillarSpecificAggregates — (map)

          The pillar aggregations for cost savings

          • costOptimizing — (map)

            Cost optimizing aggregates

            • estimatedMonthlySavingsrequired — (Float)

              The estimated monthly savings

            • estimatedPercentMonthlySavingsrequired — (Float)

              The estimated percently monthly savings

        • pillarsrequired — (Array<String>)

          The Pillars that the Recommendation is optimizing

        • resourcesAggregatesrequired — (map)

          An aggregation of all resources

          • errorCountrequired — (Integer)

            The number of AWS resources that were flagged to have errors according to the Trusted Advisor check

          • okCountrequired — (Integer)

            The number of AWS resources that were flagged to be OK according to the Trusted Advisor check

          • warningCountrequired — (Integer)

            The number of AWS resources that were flagged to have warning according to the Trusted Advisor check

        • sourcerequired — (String)

          The source of the Recommendation

          Possible values include:
          • "aws_config"
          • "compute_optimizer"
          • "cost_explorer"
          • "lse"
          • "manual"
          • "pse"
          • "rds"
          • "resilience"
          • "resilience_hub"
          • "security_hub"
          • "stir"
          • "ta_check"
          • "well_architected"
        • statusrequired — (String)

          The status of the Recommendation

          Possible values include:
          • "ok"
          • "warning"
          • "error"
        • typerequired — (String)

          Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority

          Possible values include:
          • "standard"
          • "priority"

Returns:

  • (AWS.Request)

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

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

Update the lifecyle of a Recommendation within an Organization. This API only supports prioritized recommendations.

Examples:

Calling the updateOrganizationRecommendationLifecycle operation

var params = {
  lifecycleStage: pending_response | in_progress | dismissed | resolved, /* required */
  organizationRecommendationIdentifier: 'STRING_VALUE', /* required */
  updateReason: 'STRING_VALUE',
  updateReasonCode: non_critical_account | temporary_account | valid_business_case | other_methods_available | low_priority | not_applicable | other
};
trustedadvisor.updateOrganizationRecommendationLifecycle(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: {})
    • lifecycleStage — (String)

      The new lifecycle stage

      Possible values include:
      • "pending_response"
      • "in_progress"
      • "dismissed"
      • "resolved"
    • organizationRecommendationIdentifier — (String)

      The Recommendation identifier for AWS Trusted Advisor Priority recommendations

    • updateReason — (String)

      Reason for the lifecycle stage change

    • updateReasonCode — (String)

      Reason code for the lifecycle state change

      Possible values include:
      • "non_critical_account"
      • "temporary_account"
      • "valid_business_case"
      • "other_methods_available"
      • "low_priority"
      • "not_applicable"
      • "other"

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.

Returns:

  • (AWS.Request)

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

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

Update the lifecyle of a Recommendation. This API only supports prioritized recommendations.

Service Reference:

Examples:

Calling the updateRecommendationLifecycle operation

var params = {
  lifecycleStage: pending_response | in_progress | dismissed | resolved, /* required */
  recommendationIdentifier: 'STRING_VALUE', /* required */
  updateReason: 'STRING_VALUE',
  updateReasonCode: non_critical_account | temporary_account | valid_business_case | other_methods_available | low_priority | not_applicable | other
};
trustedadvisor.updateRecommendationLifecycle(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: {})
    • lifecycleStage — (String)

      The new lifecycle stage

      Possible values include:
      • "pending_response"
      • "in_progress"
      • "dismissed"
      • "resolved"
    • recommendationIdentifier — (String)

      The Recommendation identifier for AWS Trusted Advisor Priority recommendations

    • updateReason — (String)

      Reason for the lifecycle stage change

    • updateReasonCode — (String)

      Reason code for the lifecycle state change

      Possible values include:
      • "non_critical_account"
      • "temporary_account"
      • "valid_business_case"
      • "other_methods_available"
      • "low_priority"
      • "not_applicable"
      • "other"

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.

Returns:

  • (AWS.Request)

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