Class: AWS.TrustedAdvisor

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

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

      • description — required — (String)

        A description for AWS Trusted Advisor recommendations

      • id — required — (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"
      • name — required — (String)

        The name of the AWS Trusted Advisor Recommendation

      • pillarSpecificAggregates — (map)

        The pillar aggregations for cost savings

        • costOptimizing — (map)

          Cost optimizing aggregates

          • estimatedMonthlySavings — required — (Float)

            The estimated monthly savings

          • estimatedPercentMonthlySavings — required — (Float)

            The estimated percently monthly savings

      • pillars — required — (Array<String>)

        The Pillars that the Recommendation is optimizing

      • resolvedAt — (Date)

        When the Recommendation was resolved

      • resourcesAggregates — required — (map)

        An aggregation of all resources

        • errorCount — required — (Integer)

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

        • okCount — required — (Integer)

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

        • warningCount — required — (Integer)

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

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

        The status of the Recommendation

        Possible values include:
        • "ok"
        • "warning"
        • "error"
      • type — required — (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.

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

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

      • description — required — (String)

        A description for AWS Trusted Advisor recommendations

      • id — required — (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"
      • name — required — (String)

        The name of the AWS Trusted Advisor Recommendation

      • pillarSpecificAggregates — (map)

        The pillar aggregations for cost savings

        • costOptimizing — (map)

          Cost optimizing aggregates

          • estimatedMonthlySavings — required — (Float)

            The estimated monthly savings

          • estimatedPercentMonthlySavings — required — (Float)

            The estimated percently monthly savings

      • pillars — required — (Array<String>)

        The Pillars that the Recommendation is optimizing

      • resolvedAt — (Date)

        When the Recommendation was resolved

      • resourcesAggregates — required — (map)

        An aggregation of all resources

        • errorCount — required — (Integer)

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

        • okCount — required — (Integer)

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

        • warningCount — required — (Integer)

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

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

        The status of the Recommendation

        Possible values include:
        • "ok"
        • "warning"
        • "error"
      • type — required — (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.

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

      • arn — required — (String)

        The ARN of the AWS Trusted Advisor Check

      • awsServices — required — (Array<String>)

        The AWS Services that the Check applies to

      • description — required — (String)

        A description of what the AWS Trusted Advisor Check is monitoring

      • id — required — (String)

        The unique identifier of the AWS Trusted Advisor Check

      • metadata — required — (map<String>)

        The column headings for the metadata returned in the resource

      • name — required — (String)

        The name of the AWS Trusted Advisor Check

      • pillars — required — (Array<String>)

        The Recommendation pillars that the AWS Trusted Advisor Check falls under

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

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.

var params = {
  organizationRecommendationIdentifier: 'STRING_VALUE', /* required */
  affectedAccountId: 'STRING_VALUE',
  exclusionStatus: excluded | included,
  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

  • exclusionStatus — (String)

    The exclusion status of the resource

    Possible values include:
    • "excluded"
    • "included"
  • 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

      • arn — required — (String)

        The ARN of the Recommendation Resource

      • awsResourceId — required — (String)

        The AWS resource identifier

      • exclusionStatus — (String)

        The exclusion status of the Recommendation Resource

        Possible values include:
        • "excluded"
        • "included"
      • id — required — (String)

        The ID of the Recommendation Resource

      • lastUpdatedAt — required — (Date)

        When the Recommendation Resource was last updated

      • metadata — required — (map<String>)

        Metadata associated with the Recommendation Resource

      • recommendationArn — required — (String)

        The Recommendation ARN

      • regionCode — required — (String)

        The AWS Region code that the Recommendation Resource is in

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

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

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

      • id — required — (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"
      • name — required — (String)

        The name of the AWS Trusted Advisor Recommendation

      • pillarSpecificAggregates — (map)

        The pillar aggregations for cost savings

        • costOptimizing — (map)

          Cost optimizing aggregates

          • estimatedMonthlySavings — required — (Float)

            The estimated monthly savings

          • estimatedPercentMonthlySavings — required — (Float)

            The estimated percently monthly savings

      • pillars — required — (Array<String>)

        The Pillars that the Recommendation is optimizing

      • resourcesAggregates — required — (map)

        An aggregation of all resources

        • errorCount — required — (Integer)

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

        • okCount — required — (Integer)

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

        • warningCount — required — (Integer)

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

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

        The status of the Recommendation

        Possible values include:
        • "ok"
        • "warning"
        • "error"
      • type — required — (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.

var params = {
  recommendationIdentifier: 'STRING_VALUE', /* required */
  exclusionStatus: excluded | included,
  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: {}) —
  • exclusionStatus — (String)

    The exclusion status of the resource

    Possible values include:
    • "excluded"
    • "included"
  • 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

      • arn — required — (String)

        The ARN of the Recommendation Resource

      • awsResourceId — required — (String)

        The AWS resource identifier

      • exclusionStatus — (String)

        The exclusion status of the Recommendation Resource

        Possible values include:
        • "excluded"
        • "included"
      • id — required — (String)

        The ID of the Recommendation Resource

      • lastUpdatedAt — required — (Date)

        When the Recommendation Resource was last updated

      • metadata — required — (map<String>)

        Metadata associated with the Recommendation Resource

      • recommendationArn — required — (String)

        The Recommendation ARN

      • regionCode — required — (String)

        The AWS Region code that the Recommendation Resource is in

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

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

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

      • id — required — (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"
      • name — required — (String)

        The name of the AWS Trusted Advisor Recommendation

      • pillarSpecificAggregates — (map)

        The pillar aggregations for cost savings

        • costOptimizing — (map)

          Cost optimizing aggregates

          • estimatedMonthlySavings — required — (Float)

            The estimated monthly savings

          • estimatedPercentMonthlySavings — required — (Float)

            The estimated percently monthly savings

      • pillars — required — (Array<String>)

        The Pillars that the Recommendation is optimizing

      • resourcesAggregates — required — (map)

        An aggregation of all resources

        • errorCount — required — (Integer)

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

        • okCount — required — (Integer)

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

        • warningCount — required — (Integer)

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

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

        The status of the Recommendation

        Possible values include:
        • "ok"
        • "warning"
        • "error"
      • type — required — (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.

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.

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.