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

Inherits:
AWS.Service show all
Identifier:
wellarchitected
API Version:
2020-03-31
Defined in:
(unknown)

Overview

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

Service Description

This is the Well-Architected Tool API Reference. The WA Tool API provides programmatic access to the Well-Architected Tool in the Amazon Web Services Management Console. For information about the Well-Architected Tool, see the Well-Architected Tool User Guide.

Sending a Request Using WellArchitected

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

var wellarchitected = new AWS.WellArchitected({apiVersion: '2020-03-31'});

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

AWS.config.apiVersions = {
  wellarchitected: '2020-03-31',
  // other service API versions
};

var wellarchitected = new AWS.WellArchitected();

Version:

  • 2020-03-31

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.WellArchitected(options = {}) ⇒ Object

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

Examples:

Constructing a WellArchitected object

var wellarchitected = new AWS.WellArchitected({apiVersion: '2020-03-31'});

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

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

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

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

Associate a lens to a workload.

Up to 10 lenses can be associated with a workload in a single API operation. A maximum of 20 lenses can be associated with a workload.

Note: Disclaimer By accessing and/or applying custom lenses created by another Amazon Web Services user or account, you acknowledge that custom lenses created by other users and shared with you are Third Party Content as defined in the Amazon Web Services Customer Agreement.

Service Reference:

Examples:

Calling the associateLenses operation

var params = {
  LensAliases: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  WorkloadId: 'STRING_VALUE' /* required */
};
wellarchitected.associateLenses(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: {})
    • WorkloadId — (String)

      The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    • LensAliases — (Array<String>)

      List of lens aliases to associate or disassociate with a workload. Up to 10 lenses can be specified.

      Identify a lens using its LensSummary$LensAlias.

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.

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

Associate a profile with a workload.

Service Reference:

Examples:

Calling the associateProfiles operation

var params = {
  ProfileArns: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  WorkloadId: 'STRING_VALUE' /* required */
};
wellarchitected.associateProfiles(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: {})
    • WorkloadId — (String)

      The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    • ProfileArns — (Array<String>)

      The list of profile ARNs to associate with the workload.

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.

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

Create a lens share.

The owner of a lens can share it with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Lenses provided by Amazon Web Services (Amazon Web Services Official Content) cannot be shared.

Shared access to a lens is not removed until the lens invitation is deleted.

If you share a lens with an organization or OU, all accounts in the organization or OU are granted access to the lens.

For more information, see Sharing a custom lens in the Well-Architected Tool User Guide.

Note: Disclaimer By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account.

Service Reference:

Examples:

Calling the createLensShare operation

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  LensAlias: 'STRING_VALUE', /* required */
  SharedWith: 'STRING_VALUE' /* required */
};
wellarchitected.createLensShare(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: {})
    • LensAlias — (String)

      The alias of the lens.

      For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

      For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

      Each lens is identified by its LensSummary$LensAlias.

    • SharedWith — (String)

      The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared.

    • ClientRequestToken — (String)

      A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

      You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

      This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • ShareId — (String)

        The ID associated with the share.

Returns:

  • (AWS.Request)

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

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

Create a new lens version.

A lens can have up to 100 versions.

Use this operation to publish a new lens version after you have imported a lens. The LensAlias is used to identify the lens to be published. The owner of a lens can share the lens with other Amazon Web Services accounts and users in the same Amazon Web Services Region. Only the owner of a lens can delete it.

Service Reference:

Examples:

Calling the createLensVersion operation

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  LensAlias: 'STRING_VALUE', /* required */
  LensVersion: 'STRING_VALUE', /* required */
  IsMajorVersion: true || false
};
wellarchitected.createLensVersion(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: {})
    • LensAlias — (String)

      The alias of the lens.

      For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

      For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

      Each lens is identified by its LensSummary$LensAlias.

    • LensVersion — (String)

      The version of the lens being created.

    • IsMajorVersion — (Boolean)

      Set to true if this new major lens version.

    • ClientRequestToken — (String)

      A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

      You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

      This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • LensArn — (String)

        The ARN for the lens.

      • LensVersion — (String)

        The version of the lens.

Returns:

  • (AWS.Request)

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

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

Create a milestone for an existing workload.

Service Reference:

Examples:

Calling the createMilestone operation

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  MilestoneName: 'STRING_VALUE', /* required */
  WorkloadId: 'STRING_VALUE' /* required */
};
wellarchitected.createMilestone(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: {})
    • WorkloadId — (String)

      The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    • MilestoneName — (String)

      The name of the milestone in a workload.

      Milestone names must be unique within a workload.

    • ClientRequestToken — (String)

      A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

      You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

      This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • WorkloadId — (String)

        The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

      • MilestoneNumber — (Integer)

        The milestone number.

        A workload can have a maximum of 100 milestones.

Returns:

  • (AWS.Request)

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

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

Create a profile.

Service Reference:

Examples:

Calling the createProfile operation

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  ProfileDescription: 'STRING_VALUE', /* required */
  ProfileName: 'STRING_VALUE', /* required */
  ProfileQuestions: [ /* required */
    {
      QuestionId: 'STRING_VALUE',
      SelectedChoiceIds: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
wellarchitected.createProfile(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: {})
    • ProfileName — (String)

      Name of the profile.

    • ProfileDescription — (String)

      The profile description.

    • ProfileQuestions — (Array<map>)

      The profile questions.

      • QuestionId — (String)

        The ID of the question.

      • SelectedChoiceIds — (Array<String>)

        The selected choices.

    • ClientRequestToken — (String)

      A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

      You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

      This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Tags — (map<String>)

      The tags assigned to the profile.

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:

      • ProfileArn — (String)

        The profile ARN.

      • ProfileVersion — (String)

        Version of the profile.

Returns:

  • (AWS.Request)

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

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

Create a profile share.

Service Reference:

Examples:

Calling the createProfileShare operation

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  ProfileArn: 'STRING_VALUE', /* required */
  SharedWith: 'STRING_VALUE' /* required */
};
wellarchitected.createProfileShare(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: {})
    • ProfileArn — (String)

      The profile ARN.

    • SharedWith — (String)

      The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared.

    • ClientRequestToken — (String)

      A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

      You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

      This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • ShareId — (String)

        The ID associated with the share.

      • ProfileArn — (String)

        The profile ARN.

Returns:

  • (AWS.Request)

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

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

Create a review template.

Note: Disclaimer Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your review templates. If your review template or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.

Service Reference:

Examples:

Calling the createReviewTemplate operation

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE', /* required */
  Lenses: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  TemplateName: 'STRING_VALUE', /* required */
  Notes: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
wellarchitected.createReviewTemplate(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: {})
    • TemplateName — (String)

      Name of the review template.

    • Description — (String)

      The review template description.

    • Lenses — (Array<String>)

      Lenses applied to the review template.

    • Notes — (String)

      The notes associated with the workload.

      For a review template, these are the notes that will be associated with the workload when the template is applied.

    • Tags — (map<String>)

      The tags assigned to the review template.

    • ClientRequestToken — (String)

      A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

      You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

      This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • TemplateArn — (String)

        The review template ARN.

Returns:

  • (AWS.Request)

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

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

Create a review template share.

The owner of a review template can share it with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region.

Shared access to a review template is not removed until the review template share invitation is deleted.

If you share a review template with an organization or OU, all accounts in the organization or OU are granted access to the review template.

Note: Disclaimer By sharing your review template with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your review template available to those other accounts.

Service Reference:

Examples:

Calling the createTemplateShare operation

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  SharedWith: 'STRING_VALUE', /* required */
  TemplateArn: 'STRING_VALUE' /* required */
};
wellarchitected.createTemplateShare(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: {})
    • TemplateArn — (String)

      The review template ARN.

    • SharedWith — (String)

      The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared.

    • ClientRequestToken — (String)

      A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

      You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

      This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • TemplateArn — (String)

        The review template ARN.

      • ShareId — (String)

        The ID associated with the share.

Returns:

  • (AWS.Request)

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

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

Create a new workload.

The owner of a workload can share the workload with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Only the owner of a workload can delete it.

For more information, see Defining a Workload in the Well-Architected Tool User Guide.

Either AwsRegions, NonAwsRegions, or both must be specified when creating a workload.

You also must specify ReviewOwner, even though the parameter is listed as not being required in the following section.

When creating a workload using a review template, you must have the following IAM permissions:

  • wellarchitected:GetReviewTemplate

  • wellarchitected:GetReviewTemplateAnswer

  • wellarchitected:ListReviewTemplateAnswers

  • wellarchitected:GetReviewTemplateLensReview

Service Reference:

Examples:

Calling the createWorkload operation

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE', /* required */
  Environment: PRODUCTION | PREPRODUCTION, /* required */
  Lenses: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  WorkloadName: 'STRING_VALUE', /* required */
  AccountIds: [
    'STRING_VALUE',
    /* more items */
  ],
  Applications: [
    'STRING_VALUE',
    /* more items */
  ],
  ArchitecturalDesign: 'STRING_VALUE',
  AwsRegions: [
    'STRING_VALUE',
    /* more items */
  ],
  DiscoveryConfig: {
    TrustedAdvisorIntegrationStatus: ENABLED | DISABLED,
    WorkloadResourceDefinition: [
      WORKLOAD_METADATA | APP_REGISTRY,
      /* more items */
    ]
  },
  Industry: 'STRING_VALUE',
  IndustryType: 'STRING_VALUE',
  NonAwsRegions: [
    'STRING_VALUE',
    /* more items */
  ],
  Notes: 'STRING_VALUE',
  PillarPriorities: [
    'STRING_VALUE',
    /* more items */
  ],
  ProfileArns: [
    'STRING_VALUE',
    /* more items */
  ],
  ReviewOwner: 'STRING_VALUE',
  ReviewTemplateArns: [
    'STRING_VALUE',
    /* more items */
  ],
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
wellarchitected.createWorkload(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: {})
    • WorkloadName — (String)

      The name of the workload.

      The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.

    • Description — (String)

      The description for the workload.

    • Environment — (String)

      The environment for the workload.

      Possible values include:
      • "PRODUCTION"
      • "PREPRODUCTION"
    • AccountIds — (Array<String>)

      The list of Amazon Web Services account IDs associated with the workload.

    • AwsRegions — (Array<String>)

      The list of Amazon Web Services Regions associated with the workload, for example, us-east-2, or ca-central-1.

    • NonAwsRegions — (Array<String>)

      The list of non-Amazon Web Services Regions associated with the workload.

    • PillarPriorities — (Array<String>)

      The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId.

    • ArchitecturalDesign — (String)

      The URL of the architectural design for the workload.

    • ReviewOwner — (String)

      The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.

    • IndustryType — (String)

      The industry type for the workload.

      If specified, must be one of the following:

      • Agriculture

      • Automobile

      • Defense

      • Design and Engineering

      • Digital Advertising

      • Education

      • Environmental Protection

      • Financial Services

      • Gaming

      • General Public Services

      • Healthcare

      • Hospitality

      • InfoTech

      • Justice and Public Safety

      • Life Sciences

      • Manufacturing

      • Media & Entertainment

      • Mining & Resources

      • Oil & Gas

      • Power & Utilities

      • Professional Services

      • Real Estate & Construction

      • Retail & Wholesale

      • Social Protection

      • Telecommunications

      • Travel, Transportation & Logistics

      • Other

    • Industry — (String)

      The industry for the workload.

    • Lenses — (Array<String>)

      The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.

      If a review template that specifies lenses is applied to the workload, those lenses are applied to the workload in addition to these lenses.

    • Notes — (String)

      The notes associated with the workload.

      For a review template, these are the notes that will be associated with the workload when the template is applied.

    • ClientRequestToken — (String)

      A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

      You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

      This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Tags — (map<String>)

      The tags to be associated with the workload.

    • DiscoveryConfig — (map)

      Well-Architected discovery configuration settings associated to the workload.

      • TrustedAdvisorIntegrationStatus — (String)

        Discovery integration status in respect to Trusted Advisor for the workload.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • WorkloadResourceDefinition — (Array<String>)

        The mode to use for identifying resources associated with the workload.

        You can specify WORKLOAD_METADATA, APP_REGISTRY, or both.

    • Applications — (Array<String>)

      List of AppRegistry application ARNs associated to the workload.

    • ProfileArns — (Array<String>)

      The list of profile ARNs associated with the workload.

    • ReviewTemplateArns — (Array<String>)

      The list of review template ARNs to associate with the workload.

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:

      • WorkloadId — (String)

        The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

      • WorkloadArn — (String)

        The ARN for the workload.

Returns:

  • (AWS.Request)

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

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

Create a workload share.

The owner of a workload can share it with other Amazon Web Services accounts and users in the same Amazon Web Services Region. Shared access to a workload is not removed until the workload invitation is deleted.

If you share a workload with an organization or OU, all accounts in the organization or OU are granted access to the workload.

For more information, see Sharing a workload in the Well-Architected Tool User Guide.

Service Reference:

Examples:

Calling the createWorkloadShare operation

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  PermissionType: READONLY | CONTRIBUTOR, /* required */
  SharedWith: 'STRING_VALUE', /* required */
  WorkloadId: 'STRING_VALUE' /* required */
};
wellarchitected.createWorkloadShare(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: {})
    • WorkloadId — (String)

      The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    • SharedWith — (String)

      The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared.

    • PermissionType — (String)

      Permission granted on a share request.

      Possible values include:
      • "READONLY"
      • "CONTRIBUTOR"
    • ClientRequestToken — (String)

      A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

      You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

      This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • WorkloadId — (String)

        The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

      • ShareId — (String)

        The ID associated with the share.

Returns:

  • (AWS.Request)

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

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

Delete an existing lens.

Only the owner of a lens can delete it. After the lens is deleted, Amazon Web Services accounts and users that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads.

Note: Disclaimer By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account.

Service Reference:

Examples:

Calling the deleteLens operation

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  LensAlias: 'STRING_VALUE', /* required */
  LensStatus: ALL | DRAFT | PUBLISHED /* required */
};
wellarchitected.deleteLens(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: {})
    • LensAlias — (String)

      The alias of the lens.

      For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

      For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

      Each lens is identified by its LensSummary$LensAlias.

    • ClientRequestToken — (String)

      A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

      You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

      This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

      If a token is not provided, the SDK will use a version 4 UUID.
    • LensStatus — (String)

      The status of the lens to be deleted.

      Possible values include:
      • "ALL"
      • "DRAFT"
      • "PUBLISHED"

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.

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

Delete a lens share.

After the lens share is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads.

Note: Disclaimer By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account.

Service Reference:

Examples:

Calling the deleteLensShare operation

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  LensAlias: 'STRING_VALUE', /* required */
  ShareId: 'STRING_VALUE' /* required */
};
wellarchitected.deleteLensShare(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: {})
    • ShareId — (String)

      The ID associated with the share.

    • LensAlias — (String)

      The alias of the lens.

      For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

      For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

      Each lens is identified by its LensSummary$LensAlias.

    • ClientRequestToken — (String)

      A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

      You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

      This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

      If a token is not provided, the SDK will use a version 4 UUID.

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.

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

Delete a profile.

Note: Disclaimer By sharing your profile with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your profile available to those other accounts. Those other accounts may continue to access and use your shared profile even if you delete the profile from your own Amazon Web Services account or terminate your Amazon Web Services account.

Service Reference:

Examples:

Calling the deleteProfile operation

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  ProfileArn: 'STRING_VALUE' /* required */
};
wellarchitected.deleteProfile(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: {})
    • ProfileArn — (String)

      The profile ARN.

    • ClientRequestToken — (String)

      A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

      You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

      This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

      If a token is not provided, the SDK will use a version 4 UUID.

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.

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

Delete a profile share.

Service Reference:

Examples:

Calling the deleteProfileShare operation

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  ProfileArn: 'STRING_VALUE', /* required */
  ShareId: 'STRING_VALUE' /* required */
};
wellarchitected.deleteProfileShare(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: {})
    • ShareId — (String)

      The ID associated with the share.

    • ProfileArn — (String)

      The profile ARN.

    • ClientRequestToken — (String)

      A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

      You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

      This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

      If a token is not provided, the SDK will use a version 4 UUID.

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.

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

Delete a review template.

Only the owner of a review template can delete it.

After the review template is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the review template with will no longer be able to apply it to new workloads.

Service Reference:

Examples:

Calling the deleteReviewTemplate operation

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  TemplateArn: 'STRING_VALUE' /* required */
};
wellarchitected.deleteReviewTemplate(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: {})
    • TemplateArn — (String)

      The review template ARN.

    • ClientRequestToken — (String)

      A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

      You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

      This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

      If a token is not provided, the SDK will use a version 4 UUID.

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.

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

Delete a review template share.

After the review template share is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the review template with will no longer be able to apply it to new workloads.

Service Reference:

Examples:

Calling the deleteTemplateShare operation

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  ShareId: 'STRING_VALUE', /* required */
  TemplateArn: 'STRING_VALUE' /* required */
};
wellarchitected.deleteTemplateShare(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: {})
    • ShareId — (String)

      The ID associated with the share.

    • TemplateArn — (String)

      The review template ARN.

    • ClientRequestToken — (String)

      A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

      You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

      This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

      If a token is not provided, the SDK will use a version 4 UUID.

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.

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

Delete an existing workload.

Service Reference:

Examples:

Calling the deleteWorkload operation

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  WorkloadId: 'STRING_VALUE' /* required */
};
wellarchitected.deleteWorkload(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: {})
    • WorkloadId — (String)

      The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    • ClientRequestToken — (String)

      A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

      You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

      This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

      If a token is not provided, the SDK will use a version 4 UUID.

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.

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

Delete a workload share.

Service Reference:

Examples:

Calling the deleteWorkloadShare operation

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  ShareId: 'STRING_VALUE', /* required */
  WorkloadId: 'STRING_VALUE' /* required */
};
wellarchitected.deleteWorkloadShare(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: {})
    • ShareId — (String)

      The ID associated with the share.

    • WorkloadId — (String)

      The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    • ClientRequestToken — (String)

      A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

      You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

      This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

      If a token is not provided, the SDK will use a version 4 UUID.

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.

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

Disassociate a lens from a workload.

Up to 10 lenses can be disassociated from a workload in a single API operation.

Note: The Amazon Web Services Well-Architected Framework lens (wellarchitected) cannot be removed from a workload.

Service Reference:

Examples:

Calling the disassociateLenses operation

var params = {
  LensAliases: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  WorkloadId: 'STRING_VALUE' /* required */
};
wellarchitected.disassociateLenses(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: {})
    • WorkloadId — (String)

      The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    • LensAliases — (Array<String>)

      List of lens aliases to associate or disassociate with a workload. Up to 10 lenses can be specified.

      Identify a lens using its LensSummary$LensAlias.

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.

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

Disassociate a profile from a workload.

Service Reference:

Examples:

Calling the disassociateProfiles operation

var params = {
  ProfileArns: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  WorkloadId: 'STRING_VALUE' /* required */
};
wellarchitected.disassociateProfiles(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: {})
    • WorkloadId — (String)

      The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    • ProfileArns — (Array<String>)

      The list of profile ARNs to disassociate from the workload.

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.

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

Export an existing lens.

Only the owner of a lens can export it. Lenses provided by Amazon Web Services (Amazon Web Services Official Content) cannot be exported.

Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide.

Note: Disclaimer Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your custom lenses. If your custom lens or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.

Service Reference:

Examples:

Calling the exportLens operation

var params = {
  LensAlias: 'STRING_VALUE', /* required */
  LensVersion: 'STRING_VALUE'
};
wellarchitected.exportLens(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: {})
    • LensAlias — (String)

      The alias of the lens.

      For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

      For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

      Each lens is identified by its LensSummary$LensAlias.

    • LensVersion — (String)

      The lens version to be exported.

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:

      • LensJSON — (String)

        The JSON representation of a lens.

Returns:

  • (AWS.Request)

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

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

Get the answer to a specific question in a workload review.

Service Reference:

Examples:

Calling the getAnswer operation

var params = {
  LensAlias: 'STRING_VALUE', /* required */
  QuestionId: 'STRING_VALUE', /* required */
  WorkloadId: 'STRING_VALUE', /* required */
  MilestoneNumber: 'NUMBER_VALUE'
};
wellarchitected.getAnswer(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: {})
    • WorkloadId — (String)

      The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    • LensAlias — (String)

      The alias of the lens.

      For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

      For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

      Each lens is identified by its LensSummary$LensAlias.

    • QuestionId — (String)

      The ID of the question.

    • MilestoneNumber — (Integer)

      The milestone number.

      A workload can have a maximum of 100 milestones.

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:

      • WorkloadId — (String)

        The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

      • MilestoneNumber — (Integer)

        The milestone number.

        A workload can have a maximum of 100 milestones.

      • LensAlias — (String)

        The alias of the lens.

        For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

        For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

        Each lens is identified by its LensSummary$LensAlias.

      • LensArn — (String)

        The ARN for the lens.

      • Answer — (map)

        An answer of the question.

        • QuestionId — (String)

          The ID of the question.

        • PillarId — (String)

          The ID used to identify a pillar, for example, security.

          A pillar is identified by its PillarReviewSummary$PillarId.

        • QuestionTitle — (String)

          The title of the question.

        • QuestionDescription — (String)

          The description of the question.

        • ImprovementPlanUrl — (String)

          The improvement plan URL for a question in an Amazon Web Services official lenses.

          This value is only available if the question has been answered.

          This value does not apply to custom lenses.

        • HelpfulResourceUrl — (String)

          The helpful resource URL.

          For Amazon Web Services official lenses, this is the helpful resource URL for a question or choice.

          For custom lenses, this is the helpful resource URL for a question and is only provided if HelpfulResourceDisplayText was specified for the question.

        • HelpfulResourceDisplayText — (String)

          The helpful resource text to be displayed for a custom lens.

          This field does not apply to Amazon Web Services official lenses.

        • Choices — (Array<map>)

          List of choices available for a question.

          • ChoiceId — (String)

            The ID of a choice.

          • Title — (String)

            The title of a choice.

          • Description — (String)

            The description of a choice.

          • HelpfulResource — (map)

            The helpful resource (both text and URL) for a particular choice.

            This field only applies to custom lenses. Each choice can have only one helpful resource.

            • DisplayText — (String)

              The display text for the choice content.

            • Url — (String)

              The URL for the choice content.

          • ImprovementPlan — (map)

            The improvement plan (both text and URL) for a particular choice.

            This field only applies to custom lenses. Each choice can have only one improvement plan.

            • DisplayText — (String)

              The display text for the choice content.

            • Url — (String)

              The URL for the choice content.

          • AdditionalResources — (Array<map>)

            The additional resources for a choice in a custom lens.

            A choice can have up to two additional resources: one of type HELPFUL_RESOURCE, one of type IMPROVEMENT_PLAN, or both.

            • Type — (String)

              Type of additional resource for a custom lens.

              Possible values include:
              • "HELPFUL_RESOURCE"
              • "IMPROVEMENT_PLAN"
            • Content — (Array<map>)

              The URLs for additional resources, either helpful resources or improvement plans, for a custom lens. Up to five additional URLs can be specified.

              • DisplayText — (String)

                The display text for the choice content.

              • Url — (String)

                The URL for the choice content.

        • SelectedChoices — (Array<String>)

          List of selected choice IDs in a question answer.

          The values entered replace the previously selected choices.

        • ChoiceAnswers — (Array<map>)

          A list of selected choices to a question in your workload.

          • ChoiceId — (String)

            The ID of a choice.

          • Status — (String)

            The status of a choice.

            Possible values include:
            • "SELECTED"
            • "NOT_APPLICABLE"
            • "UNSELECTED"
          • Reason — (String)

            The reason why a choice is non-applicable to a question in your workload.

            Possible values include:
            • "OUT_OF_SCOPE"
            • "BUSINESS_PRIORITIES"
            • "ARCHITECTURE_CONSTRAINTS"
            • "OTHER"
            • "NONE"
          • Notes — (String)

            The notes associated with a choice.

        • IsApplicable — (Boolean)

          Defines whether this question is applicable to a lens review.

        • Risk — (String)

          The risk for a given workload, lens review, pillar, or question.

          Possible values include:
          • "UNANSWERED"
          • "HIGH"
          • "MEDIUM"
          • "NONE"
          • "NOT_APPLICABLE"
        • Notes — (String)

          The notes associated with the workload.

          For a review template, these are the notes that will be associated with the workload when the template is applied.

        • Reason — (String)

          The reason why the question is not applicable to your workload.

          Possible values include:
          • "OUT_OF_SCOPE"
          • "BUSINESS_PRIORITIES"
          • "ARCHITECTURE_CONSTRAINTS"
          • "OTHER"
          • "NONE"

Returns:

  • (AWS.Request)

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

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

Get a consolidated report of your workloads.

You can optionally choose to include workloads that have been shared with you.

Service Reference:

Examples:

Calling the getConsolidatedReport operation

var params = {
  Format: PDF | JSON, /* required */
  IncludeSharedResources: true || false,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
wellarchitected.getConsolidatedReport(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: {})
    • Format — (String)

      The format of the consolidated report.

      For PDF, Base64String is returned. For JSON, Metrics is returned.

      Possible values include:
      • "PDF"
      • "JSON"
    • IncludeSharedResources — (Boolean)

      Set to true to have shared resources included in the report.

    • NextToken — (String)

      The token to use to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return for this request.

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:

      • Metrics — (Array<map>)

        The metrics that make up the consolidated report.

        Only returned when JSON format is requested.

        • MetricType — (String)

          The metric type of a metric in the consolidated report. Currently only WORKLOAD metric types are supported.

          Possible values include:
          • "WORKLOAD"
        • RiskCounts — (map<Integer>)

          A map from risk names to the count of how many questions have that rating.

        • WorkloadId — (String)

          The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

        • WorkloadName — (String)

          The name of the workload.

          The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.

        • WorkloadArn — (String)

          The ARN for the workload.

        • UpdatedAt — (Date)

          The date and time recorded.

        • Lenses — (Array<map>)

          The metrics for the lenses in the workload.

          • LensArn — (String)

            The lens ARN.

          • Pillars — (Array<map>)

            The metrics for the pillars in a lens.

            • PillarId — (String)

              The ID used to identify a pillar, for example, security.

              A pillar is identified by its PillarReviewSummary$PillarId.

            • RiskCounts — (map<Integer>)

              A map from risk names to the count of how many questions have that rating.

            • Questions — (Array<map>)

              The questions that have been identified as risks in the pillar.

              • QuestionId — (String)

                The ID of the question.

              • Risk — (String)

                The risk for a given workload, lens review, pillar, or question.

                Possible values include:
                • "UNANSWERED"
                • "HIGH"
                • "MEDIUM"
                • "NONE"
                • "NOT_APPLICABLE"
              • BestPractices — (Array<map>)

                The best practices, or choices, that have been identified as contributing to risk in a question.

                • ChoiceId — (String)

                  The ID of a choice.

                • ChoiceTitle — (String)

                  The title of a choice.

          • RiskCounts — (map<Integer>)

            A map from risk names to the count of how many questions have that rating.

        • LensesAppliedCount — (Integer)

          The total number of lenses applied to the workload.

      • NextToken — (String)

        The token to use to retrieve the next set of results.

      • Base64String — (String)

        The Base64-encoded string representation of a lens review report.

        This data can be used to create a PDF file.

        Only returned by GetConsolidatedReport when PDF format is requested.

Returns:

  • (AWS.Request)

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

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

Get an existing lens.

Service Reference:

Examples:

Calling the getLens operation

var params = {
  LensAlias: 'STRING_VALUE', /* required */
  LensVersion: 'STRING_VALUE'
};
wellarchitected.getLens(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: {})
    • LensAlias — (String)

      The alias of the lens.

      For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

      For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

      Each lens is identified by its LensSummary$LensAlias.

    • LensVersion — (String)

      The lens version to be retrieved.

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:

      • Lens — (map)

        A lens return object.

        • LensArn — (String)

          The ARN of a lens.

        • LensVersion — (String)

          The version of a lens.

        • Name — (String)

          The full name of the lens.

        • Description — (String)

          The description of the lens.

        • Owner — (String)

          The Amazon Web Services account ID that owns the lens.

        • ShareInvitationId — (String)

          The ID assigned to the share invitation.

        • Tags — (map<String>)

          The tags assigned to the lens.

Returns:

  • (AWS.Request)

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

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

Get lens review.

Service Reference:

Examples:

Calling the getLensReview operation

var params = {
  LensAlias: 'STRING_VALUE', /* required */
  WorkloadId: 'STRING_VALUE', /* required */
  MilestoneNumber: 'NUMBER_VALUE'
};
wellarchitected.getLensReview(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: {})
    • WorkloadId — (String)

      The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    • LensAlias — (String)

      The alias of the lens.

      For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

      For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

      Each lens is identified by its LensSummary$LensAlias.

    • MilestoneNumber — (Integer)

      The milestone number.

      A workload can have a maximum of 100 milestones.

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:

      • WorkloadId — (String)

        The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

      • MilestoneNumber — (Integer)

        The milestone number.

        A workload can have a maximum of 100 milestones.

      • LensReview — (map)

        A lens review of a question.

        • LensAlias — (String)

          The alias of the lens.

          For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

          For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

          Each lens is identified by its LensSummary$LensAlias.

        • LensArn — (String)

          The ARN for the lens.

        • LensVersion — (String)

          The version of the lens.

        • LensName — (String)

          The full name of the lens.

        • LensStatus — (String)

          The status of the lens.

          Possible values include:
          • "CURRENT"
          • "NOT_CURRENT"
          • "DEPRECATED"
          • "DELETED"
          • "UNSHARED"
        • PillarReviewSummaries — (Array<map>)

          List of pillar review summaries of lens review in a workload.

          • PillarId — (String)

            The ID used to identify a pillar, for example, security.

            A pillar is identified by its PillarReviewSummary$PillarId.

          • PillarName — (String)

            The name of the pillar.

          • Notes — (String)

            The notes associated with the workload.

            For a review template, these are the notes that will be associated with the workload when the template is applied.

          • RiskCounts — (map<Integer>)

            A map from risk names to the count of how many questions have that rating.

          • PrioritizedRiskCounts — (map<Integer>)

            A map from risk names to the count of how many questions have that rating.

        • UpdatedAt — (Date)

          The date and time recorded.

        • Notes — (String)

          The notes associated with the workload.

          For a review template, these are the notes that will be associated with the workload when the template is applied.

        • RiskCounts — (map<Integer>)

          A map from risk names to the count of how many questions have that rating.

        • NextToken — (String)

          The token to use to retrieve the next set of results.

        • Profiles — (Array<map>)

          The profiles associated with the workload.

          • ProfileArn — (String)

            The profile ARN.

          • ProfileVersion — (String)

            The profile version.

        • PrioritizedRiskCounts — (map<Integer>)

          A map from risk names to the count of how many questions have that rating.

Returns:

  • (AWS.Request)

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

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

Get lens review report.

Service Reference:

Examples:

Calling the getLensReviewReport operation

var params = {
  LensAlias: 'STRING_VALUE', /* required */
  WorkloadId: 'STRING_VALUE', /* required */
  MilestoneNumber: 'NUMBER_VALUE'
};
wellarchitected.getLensReviewReport(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: {})
    • WorkloadId — (String)

      The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    • LensAlias — (String)

      The alias of the lens.

      For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

      For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

      Each lens is identified by its LensSummary$LensAlias.

    • MilestoneNumber — (Integer)

      The milestone number.

      A workload can have a maximum of 100 milestones.

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:

      • WorkloadId — (String)

        The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

      • MilestoneNumber — (Integer)

        The milestone number.

        A workload can have a maximum of 100 milestones.

      • LensReviewReport — (map)

        A report of a lens review.

        • LensAlias — (String)

          The alias of the lens.

          For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

          For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

          Each lens is identified by its LensSummary$LensAlias.

        • LensArn — (String)

          The ARN for the lens.

        • Base64String — (String)

          The Base64-encoded string representation of a lens review report.

          This data can be used to create a PDF file.

          Only returned by GetConsolidatedReport when PDF format is requested.

Returns:

  • (AWS.Request)

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

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

Get lens version differences.

Service Reference:

Examples:

Calling the getLensVersionDifference operation

var params = {
  LensAlias: 'STRING_VALUE', /* required */
  BaseLensVersion: 'STRING_VALUE',
  TargetLensVersion: 'STRING_VALUE'
};
wellarchitected.getLensVersionDifference(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: {})
    • LensAlias — (String)

      The alias of the lens.

      For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

      For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

      Each lens is identified by its LensSummary$LensAlias.

    • BaseLensVersion — (String)

      The base version of the lens.

    • TargetLensVersion — (String)

      The lens version to target a difference for.

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:

      • LensAlias — (String)

        The alias of the lens.

        For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

        For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

        Each lens is identified by its LensSummary$LensAlias.

      • LensArn — (String)

        The ARN for the lens.

      • BaseLensVersion — (String)

        The base version of the lens.

      • TargetLensVersion — (String)

        The target lens version for the lens.

      • LatestLensVersion — (String)

        The latest version of the lens.

      • VersionDifferences — (map)

        The differences between the base and latest versions of the lens.

        • PillarDifferences — (Array<map>)

          The differences between the base and latest versions of the lens.

          • PillarId — (String)

            The ID used to identify a pillar, for example, security.

            A pillar is identified by its PillarReviewSummary$PillarId.

          • PillarName — (String)

            The name of the pillar.

          • DifferenceStatus — (String)

            Indicates the type of change to the pillar.

            Possible values include:
            • "UPDATED"
            • "NEW"
            • "DELETED"
          • QuestionDifferences — (Array<map>)

            List of question differences.

            • QuestionId — (String)

              The ID of the question.

            • QuestionTitle — (String)

              The title of the question.

            • DifferenceStatus — (String)

              Indicates the type of change to the question.

              Possible values include:
              • "UPDATED"
              • "NEW"
              • "DELETED"

Returns:

  • (AWS.Request)

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

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

Get a milestone for an existing workload.

Service Reference:

Examples:

Calling the getMilestone operation

var params = {
  MilestoneNumber: 'NUMBER_VALUE', /* required */
  WorkloadId: 'STRING_VALUE' /* required */
};
wellarchitected.getMilestone(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: {})
    • WorkloadId — (String)

      The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    • MilestoneNumber — (Integer)

      The milestone number.

      A workload can have a maximum of 100 milestones.

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:

      • WorkloadId — (String)

        The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

      • Milestone — (map)

        A milestone return object.

        • MilestoneNumber — (Integer)

          The milestone number.

          A workload can have a maximum of 100 milestones.

        • MilestoneName — (String)

          The name of the milestone in a workload.

          Milestone names must be unique within a workload.

        • RecordedAt — (Date)

          The date and time recorded.

        • Workload — (map)

          A workload return object.

          • WorkloadId — (String)

            The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

          • WorkloadArn — (String)

            The ARN for the workload.

          • WorkloadName — (String)

            The name of the workload.

            The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.

          • Description — (String)

            The description for the workload.

          • Environment — (String)

            The environment for the workload.

            Possible values include:
            • "PRODUCTION"
            • "PREPRODUCTION"
          • UpdatedAt — (Date)

            The date and time recorded.

          • AccountIds — (Array<String>)

            The list of Amazon Web Services account IDs associated with the workload.

          • AwsRegions — (Array<String>)

            The list of Amazon Web Services Regions associated with the workload, for example, us-east-2, or ca-central-1.

          • NonAwsRegions — (Array<String>)

            The list of non-Amazon Web Services Regions associated with the workload.

          • ArchitecturalDesign — (String)

            The URL of the architectural design for the workload.

          • ReviewOwner — (String)

            The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.

          • ReviewRestrictionDate — (Date)

            The date and time recorded.

          • IsReviewOwnerUpdateAcknowledged — (Boolean)

            Flag indicating whether the workload owner has acknowledged that the Review owner field is required.

            If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.

          • IndustryType — (String)

            The industry type for the workload.

            If specified, must be one of the following:

            • Agriculture

            • Automobile

            • Defense

            • Design and Engineering

            • Digital Advertising

            • Education

            • Environmental Protection

            • Financial Services

            • Gaming

            • General Public Services

            • Healthcare

            • Hospitality

            • InfoTech

            • Justice and Public Safety

            • Life Sciences

            • Manufacturing

            • Media & Entertainment

            • Mining & Resources

            • Oil & Gas

            • Power & Utilities

            • Professional Services

            • Real Estate & Construction

            • Retail & Wholesale

            • Social Protection

            • Telecommunications

            • Travel, Transportation & Logistics

            • Other

          • Industry — (String)

            The industry for the workload.

          • Notes — (String)

            The notes associated with the workload.

            For a review template, these are the notes that will be associated with the workload when the template is applied.

          • ImprovementStatus — (String)

            The improvement status for a workload.

            Possible values include:
            • "NOT_APPLICABLE"
            • "NOT_STARTED"
            • "IN_PROGRESS"
            • "COMPLETE"
            • "RISK_ACKNOWLEDGED"
          • RiskCounts — (map<Integer>)

            A map from risk names to the count of how many questions have that rating.

          • PillarPriorities — (Array<String>)

            The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId.

          • Lenses — (Array<String>)

            The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.

            If a review template that specifies lenses is applied to the workload, those lenses are applied to the workload in addition to these lenses.

          • Owner — (String)

            An Amazon Web Services account ID.

          • ShareInvitationId — (String)

            The ID assigned to the share invitation.

          • Tags — (map<String>)

            The tags associated with the workload.

          • DiscoveryConfig — (map)

            Discovery configuration associated to the workload.

            • TrustedAdvisorIntegrationStatus — (String)

              Discovery integration status in respect to Trusted Advisor for the workload.

              Possible values include:
              • "ENABLED"
              • "DISABLED"
            • WorkloadResourceDefinition — (Array<String>)

              The mode to use for identifying resources associated with the workload.

              You can specify WORKLOAD_METADATA, APP_REGISTRY, or both.

          • Applications — (Array<String>)

            List of AppRegistry application ARNs associated to the workload.

          • Profiles — (Array<map>)

            Profile associated with a workload.

            • ProfileArn — (String)

              The profile ARN.

            • ProfileVersion — (String)

              The profile version.

          • PrioritizedRiskCounts — (map<Integer>)

            A map from risk names to the count of how many questions have that rating.

Returns:

  • (AWS.Request)

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

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

Get profile information.

Service Reference:

Examples:

Calling the getProfile operation

var params = {
  ProfileArn: 'STRING_VALUE', /* required */
  ProfileVersion: 'STRING_VALUE'
};
wellarchitected.getProfile(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: {})
    • ProfileArn — (String)

      The profile ARN.

    • ProfileVersion — (String)

      The profile version.

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:

      • Profile — (map)

        The profile.

        • ProfileArn — (String)

          The profile ARN.

        • ProfileVersion — (String)

          The profile version.

        • ProfileName — (String)

          The profile name.

        • ProfileDescription — (String)

          The profile description.

        • ProfileQuestions — (Array<map>)

          Profile questions.

          • QuestionId — (String)

            The ID of the question.

          • QuestionTitle — (String)

            The title of the question.

          • QuestionDescription — (String)

            The description of the question.

          • QuestionChoices — (Array<map>)

            The question choices.

            • ChoiceId — (String)

              The ID of a choice.

            • ChoiceTitle — (String)

              The title of a choice.

            • ChoiceDescription — (String)

              The description of a choice.

          • SelectedChoiceIds — (Array<String>)

            The selected choices.

          • MinSelectedChoices — (Integer)

            The minimum number of selected choices.

          • MaxSelectedChoices — (Integer)

            The maximum number of selected choices.

        • Owner — (String)

          An Amazon Web Services account ID.

        • CreatedAt — (Date)

          The date and time recorded.

        • UpdatedAt — (Date)

          The date and time recorded.

        • ShareInvitationId — (String)

          The ID assigned to the share invitation.

        • Tags — (map<String>)

          The tags assigned to the profile.

Returns:

  • (AWS.Request)

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

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

Get profile template.

Service Reference:

Examples:

Calling the getProfileTemplate operation

var params = {
};
wellarchitected.getProfileTemplate(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: {})

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:

      • ProfileTemplate — (map)

        The profile template.

        • TemplateName — (String)

          The name of the profile template.

        • TemplateQuestions — (Array<map>)

          Profile template questions.

          • QuestionId — (String)

            The ID of the question.

          • QuestionTitle — (String)

            The title of the question.

          • QuestionDescription — (String)

            The description of the question.

          • QuestionChoices — (Array<map>)

            The question choices.

            • ChoiceId — (String)

              The ID of a choice.

            • ChoiceTitle — (String)

              The title of a choice.

            • ChoiceDescription — (String)

              The description of a choice.

          • MinSelectedChoices — (Integer)

            The minimum number of choices selected.

          • MaxSelectedChoices — (Integer)

            The maximum number of choices selected.

        • CreatedAt — (Date)

          The date and time recorded.

        • UpdatedAt — (Date)

          The date and time recorded.

Returns:

  • (AWS.Request)

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

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

Get review template.

Service Reference:

Examples:

Calling the getReviewTemplate operation

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

      The review template ARN.

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:

      • ReviewTemplate — (map)

        The review template.

        • Description — (String)

          The review template description.

        • Lenses — (Array<String>)

          The lenses applied to the review template.

        • Notes — (String)

          The notes associated with the workload.

          For a review template, these are the notes that will be associated with the workload when the template is applied.

        • QuestionCounts — (map<Integer>)

          A count of how many total questions are answered and unanswered in the review template.

        • Owner — (String)

          An Amazon Web Services account ID.

        • UpdatedAt — (Date)

          The date and time recorded.

        • TemplateArn — (String)

          The review template ARN.

        • TemplateName — (String)

          The name of the review template.

        • Tags — (map<String>)

          The tags assigned to the review template.

        • UpdateStatus — (String)

          The latest status of a review template.

          Possible values include:
          • "CURRENT"
          • "LENS_NOT_CURRENT"
        • ShareInvitationId — (String)

          The ID assigned to the template share invitation.

Returns:

  • (AWS.Request)

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

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

Get review template answer.

Service Reference:

Examples:

Calling the getReviewTemplateAnswer operation

var params = {
  LensAlias: 'STRING_VALUE', /* required */
  QuestionId: 'STRING_VALUE', /* required */
  TemplateArn: 'STRING_VALUE' /* required */
};
wellarchitected.getReviewTemplateAnswer(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: {})
    • TemplateArn — (String)

      The review template ARN.

    • LensAlias — (String)

      The alias of the lens.

      For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

      For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

      Each lens is identified by its LensSummary$LensAlias.

    • QuestionId — (String)

      The ID of the question.

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:

      • TemplateArn — (String)

        The review template ARN.

      • LensAlias — (String)

        The alias of the lens.

        For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

        For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

        Each lens is identified by its LensSummary$LensAlias.

      • Answer — (map)

        An answer of the question.

        • QuestionId — (String)

          The ID of the question.

        • PillarId — (String)

          The ID used to identify a pillar, for example, security.

          A pillar is identified by its PillarReviewSummary$PillarId.

        • QuestionTitle — (String)

          The title of the question.

        • QuestionDescription — (String)

          The description of the question.

        • ImprovementPlanUrl — (String)

          The improvement plan URL for a question in an Amazon Web Services official lenses.

          This value is only available if the question has been answered.

          This value does not apply to custom lenses.

        • HelpfulResourceUrl — (String)

          The helpful resource URL.

          For Amazon Web Services official lenses, this is the helpful resource URL for a question or choice.

          For custom lenses, this is the helpful resource URL for a question and is only provided if HelpfulResourceDisplayText was specified for the question.

        • HelpfulResourceDisplayText — (String)

          The helpful resource text to be displayed for a custom lens.

          Note: This field does not apply to Amazon Web Services official lenses.
        • Choices — (Array<map>)

          List of choices available for a question.

          • ChoiceId — (String)

            The ID of a choice.

          • Title — (String)

            The title of a choice.

          • Description — (String)

            The description of a choice.

          • HelpfulResource — (map)

            The helpful resource (both text and URL) for a particular choice.

            This field only applies to custom lenses. Each choice can have only one helpful resource.

            • DisplayText — (String)

              The display text for the choice content.

            • Url — (String)

              The URL for the choice content.

          • ImprovementPlan — (map)

            The improvement plan (both text and URL) for a particular choice.

            This field only applies to custom lenses. Each choice can have only one improvement plan.

            • DisplayText — (String)

              The display text for the choice content.

            • Url — (String)

              The URL for the choice content.

          • AdditionalResources — (Array<map>)

            The additional resources for a choice in a custom lens.

            A choice can have up to two additional resources: one of type HELPFUL_RESOURCE, one of type IMPROVEMENT_PLAN, or both.

            • Type — (String)

              Type of additional resource for a custom lens.

              Possible values include:
              • "HELPFUL_RESOURCE"
              • "IMPROVEMENT_PLAN"
            • Content — (Array<map>)

              The URLs for additional resources, either helpful resources or improvement plans, for a custom lens. Up to five additional URLs can be specified.

              • DisplayText — (String)

                The display text for the choice content.

              • Url — (String)

                The URL for the choice content.

        • SelectedChoices — (Array<String>)

          List of selected choice IDs in a question answer.

          The values entered replace the previously selected choices.

        • ChoiceAnswers — (Array<map>)

          A list of selected choices to a question in your review template.

          • ChoiceId — (String)

            The ID of a choice.

          • Status — (String)

            The status of a choice.

            Possible values include:
            • "SELECTED"
            • "NOT_APPLICABLE"
            • "UNSELECTED"
          • Reason — (String)

            The reason why a choice is non-applicable to a question in your workload.

            Possible values include:
            • "OUT_OF_SCOPE"
            • "BUSINESS_PRIORITIES"
            • "ARCHITECTURE_CONSTRAINTS"
            • "OTHER"
            • "NONE"
          • Notes — (String)

            The notes associated with a choice.

        • IsApplicable — (Boolean)

          Defines whether this question is applicable to a lens review.

        • AnswerStatus — (String)

          The status of whether or not this question has been answered.

          Possible values include:
          • "UNANSWERED"
          • "ANSWERED"
        • Notes — (String)

          The notes associated with the workload.

          For a review template, these are the notes that will be associated with the workload when the template is applied.

        • Reason — (String)

          The reason why the question is not applicable to your review template.

          Possible values include:
          • "OUT_OF_SCOPE"
          • "BUSINESS_PRIORITIES"
          • "ARCHITECTURE_CONSTRAINTS"
          • "OTHER"
          • "NONE"

Returns:

  • (AWS.Request)

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

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

Get a lens review associated with a review template.

Service Reference:

Examples:

Calling the getReviewTemplateLensReview operation

var params = {
  LensAlias: 'STRING_VALUE', /* required */
  TemplateArn: 'STRING_VALUE' /* required */
};
wellarchitected.getReviewTemplateLensReview(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: {})
    • TemplateArn — (String)

      The review template ARN.

    • LensAlias — (String)

      The alias of the lens.

      For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

      For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

      Each lens is identified by its LensSummary$LensAlias.

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:

      • TemplateArn — (String)

        The review template ARN.

      • LensReview — (map)

        A lens review of a question.

        • LensAlias — (String)

          The alias of the lens.

          For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

          For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

          Each lens is identified by its LensSummary$LensAlias.

        • LensArn — (String)

          The lens ARN.

        • LensVersion — (String)

          The version of the lens.

        • LensName — (String)

          The full name of the lens.

        • LensStatus — (String)

          The status of the lens.

          Possible values include:
          • "CURRENT"
          • "NOT_CURRENT"
          • "DEPRECATED"
          • "DELETED"
          • "UNSHARED"
        • PillarReviewSummaries — (Array<map>)

          Pillar review summaries of a lens review.

          • PillarId — (String)

            The ID used to identify a pillar, for example, security.

            A pillar is identified by its PillarReviewSummary$PillarId.

          • PillarName — (String)

            The name of the pillar.

          • Notes — (String)

            The notes associated with the workload.

            For a review template, these are the notes that will be associated with the workload when the template is applied.

          • QuestionCounts — (map<Integer>)

            A count of how many questions are answered and unanswered in the requested pillar of the lens review.

        • UpdatedAt — (Date)

          The date and time recorded.

        • Notes — (String)

          The notes associated with the workload.

          For a review template, these are the notes that will be associated with the workload when the template is applied.

        • QuestionCounts — (map<Integer>)

          A count of how many questions are answered and unanswered in the lens review.

        • NextToken — (String)

          The token to use to retrieve the next set of results.

Returns:

  • (AWS.Request)

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

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

Get an existing workload.

Service Reference:

Examples:

Calling the getWorkload operation

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

      The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

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:

      • Workload — (map)

        A workload return object.

        • WorkloadId — (String)

          The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

        • WorkloadArn — (String)

          The ARN for the workload.

        • WorkloadName — (String)

          The name of the workload.

          The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.

        • Description — (String)

          The description for the workload.

        • Environment — (String)

          The environment for the workload.

          Possible values include:
          • "PRODUCTION"
          • "PREPRODUCTION"
        • UpdatedAt — (Date)

          The date and time recorded.

        • AccountIds — (Array<String>)

          The list of Amazon Web Services account IDs associated with the workload.

        • AwsRegions — (Array<String>)

          The list of Amazon Web Services Regions associated with the workload, for example, us-east-2, or ca-central-1.

        • NonAwsRegions — (Array<String>)

          The list of non-Amazon Web Services Regions associated with the workload.

        • ArchitecturalDesign — (String)

          The URL of the architectural design for the workload.

        • ReviewOwner — (String)

          The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.

        • ReviewRestrictionDate — (Date)

          The date and time recorded.

        • IsReviewOwnerUpdateAcknowledged — (Boolean)

          Flag indicating whether the workload owner has acknowledged that the Review owner field is required.

          If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.

        • IndustryType — (String)

          The industry type for the workload.

          If specified, must be one of the following:

          • Agriculture

          • Automobile

          • Defense

          • Design and Engineering

          • Digital Advertising

          • Education

          • Environmental Protection

          • Financial Services

          • Gaming

          • General Public Services

          • Healthcare

          • Hospitality

          • InfoTech

          • Justice and Public Safety

          • Life Sciences

          • Manufacturing

          • Media & Entertainment

          • Mining & Resources

          • Oil & Gas

          • Power & Utilities

          • Professional Services

          • Real Estate & Construction

          • Retail & Wholesale

          • Social Protection

          • Telecommunications

          • Travel, Transportation & Logistics

          • Other

        • Industry — (String)

          The industry for the workload.

        • Notes — (String)

          The notes associated with the workload.

          For a review template, these are the notes that will be associated with the workload when the template is applied.

        • ImprovementStatus — (String)

          The improvement status for a workload.

          Possible values include:
          • "NOT_APPLICABLE"
          • "NOT_STARTED"
          • "IN_PROGRESS"
          • "COMPLETE"
          • "RISK_ACKNOWLEDGED"
        • RiskCounts — (map<Integer>)

          A map from risk names to the count of how many questions have that rating.

        • PillarPriorities — (Array<String>)

          The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId.

        • Lenses — (Array<String>)

          The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.

          If a review template that specifies lenses is applied to the workload, those lenses are applied to the workload in addition to these lenses.

        • Owner — (String)

          An Amazon Web Services account ID.

        • ShareInvitationId — (String)

          The ID assigned to the share invitation.

        • Tags — (map<String>)

          The tags associated with the workload.

        • DiscoveryConfig — (map)

          Discovery configuration associated to the workload.

          • TrustedAdvisorIntegrationStatus — (String)

            Discovery integration status in respect to Trusted Advisor for the workload.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
          • WorkloadResourceDefinition — (Array<String>)

            The mode to use for identifying resources associated with the workload.

            You can specify WORKLOAD_METADATA, APP_REGISTRY, or both.

        • Applications — (Array<String>)

          List of AppRegistry application ARNs associated to the workload.

        • Profiles — (Array<map>)

          Profile associated with a workload.

          • ProfileArn — (String)

            The profile ARN.

          • ProfileVersion — (String)

            The profile version.

        • PrioritizedRiskCounts — (map<Integer>)

          A map from risk names to the count of how many questions have that rating.

Returns:

  • (AWS.Request)

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

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

Import a new custom lens or update an existing custom lens.

To update an existing custom lens, specify its ARN as the LensAlias. If no ARN is specified, a new custom lens is created.

The new or updated lens will have a status of DRAFT. The lens cannot be applied to workloads or shared with other Amazon Web Services accounts until it's published with CreateLensVersion.

Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide.

A custom lens cannot exceed 500 KB in size.

Note: Disclaimer Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your custom lenses. If your custom lens or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.

Service Reference:

Examples:

Calling the importLens operation

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  JSONString: 'STRING_VALUE', /* required */
  LensAlias: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
wellarchitected.importLens(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: {})
    • LensAlias — (String)

      The alias of the lens.

      For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

      For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

      Each lens is identified by its LensSummary$LensAlias.

    • JSONString — (String)

      The JSON representation of a lens.

    • ClientRequestToken — (String)

      A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

      You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

      This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Tags — (map<String>)

      Tags to associate to a lens.

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:

      • LensArn — (String)

        The ARN for the lens that was created or updated.

      • Status — (String)

        The status of the imported lens.

        Possible values include:
        • "IN_PROGRESS"
        • "COMPLETE"
        • "ERROR"

Returns:

  • (AWS.Request)

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

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

List of answers for a particular workload and lens.

Service Reference:

Examples:

Calling the listAnswers operation

var params = {
  LensAlias: 'STRING_VALUE', /* required */
  WorkloadId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  MilestoneNumber: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  PillarId: 'STRING_VALUE',
  QuestionPriority: PRIORITIZED | NONE
};
wellarchitected.listAnswers(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: {})
    • WorkloadId — (String)

      The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    • LensAlias — (String)

      The alias of the lens.

      For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

      For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

      Each lens is identified by its LensSummary$LensAlias.

    • PillarId — (String)

      The ID used to identify a pillar, for example, security.

      A pillar is identified by its PillarReviewSummary$PillarId.

    • MilestoneNumber — (Integer)

      The milestone number.

      A workload can have a maximum of 100 milestones.

    • NextToken — (String)

      The token to use to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return for this request.

    • QuestionPriority — (String)

      The priority of the question.

      Possible values include:
      • "PRIORITIZED"
      • "NONE"

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:

      • WorkloadId — (String)

        The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

      • MilestoneNumber — (Integer)

        The milestone number.

        A workload can have a maximum of 100 milestones.

      • LensAlias — (String)

        The alias of the lens.

        For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

        For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

        Each lens is identified by its LensSummary$LensAlias.

      • LensArn — (String)

        The ARN for the lens.

      • AnswerSummaries — (Array<map>)

        List of answer summaries of lens review in a workload.

        • QuestionId — (String)

          The ID of the question.

        • PillarId — (String)

          The ID used to identify a pillar, for example, security.

          A pillar is identified by its PillarReviewSummary$PillarId.

        • QuestionTitle — (String)

          The title of the question.

        • Choices — (Array<map>)

          List of choices available for a question.

          • ChoiceId — (String)

            The ID of a choice.

          • Title — (String)

            The title of a choice.

          • Description — (String)

            The description of a choice.

          • HelpfulResource — (map)

            The helpful resource (both text and URL) for a particular choice.

            This field only applies to custom lenses. Each choice can have only one helpful resource.

            • DisplayText — (String)

              The display text for the choice content.

            • Url — (String)

              The URL for the choice content.

          • ImprovementPlan — (map)

            The improvement plan (both text and URL) for a particular choice.

            This field only applies to custom lenses. Each choice can have only one improvement plan.

            • DisplayText — (String)

              The display text for the choice content.

            • Url — (String)

              The URL for the choice content.

          • AdditionalResources — (Array<map>)

            The additional resources for a choice in a custom lens.

            A choice can have up to two additional resources: one of type HELPFUL_RESOURCE, one of type IMPROVEMENT_PLAN, or both.

            • Type — (String)

              Type of additional resource for a custom lens.

              Possible values include:
              • "HELPFUL_RESOURCE"
              • "IMPROVEMENT_PLAN"
            • Content — (Array<map>)

              The URLs for additional resources, either helpful resources or improvement plans, for a custom lens. Up to five additional URLs can be specified.

              • DisplayText — (String)

                The display text for the choice content.

              • Url — (String)

                The URL for the choice content.

        • SelectedChoices — (Array<String>)

          List of selected choice IDs in a question answer.

          The values entered replace the previously selected choices.

        • ChoiceAnswerSummaries — (Array<map>)

          A list of selected choices to a question in your workload.

          • ChoiceId — (String)

            The ID of a choice.

          • Status — (String)

            The status of a choice.

            Possible values include:
            • "SELECTED"
            • "NOT_APPLICABLE"
            • "UNSELECTED"
          • Reason — (String)

            The reason why a choice is non-applicable to a question in your workload.

            Possible values include:
            • "OUT_OF_SCOPE"
            • "BUSINESS_PRIORITIES"
            • "ARCHITECTURE_CONSTRAINTS"
            • "OTHER"
            • "NONE"
        • IsApplicable — (Boolean)

          Defines whether this question is applicable to a lens review.

        • Risk — (String)

          The risk for a given workload, lens review, pillar, or question.

          Possible values include:
          • "UNANSWERED"
          • "HIGH"
          • "MEDIUM"
          • "NONE"
          • "NOT_APPLICABLE"
        • Reason — (String)

          The reason why a choice is non-applicable to a question in your workload.

          Possible values include:
          • "OUT_OF_SCOPE"
          • "BUSINESS_PRIORITIES"
          • "ARCHITECTURE_CONSTRAINTS"
          • "OTHER"
          • "NONE"
        • QuestionType — (String)

          The type of the question.

          Possible values include:
          • "PRIORITIZED"
          • "NON_PRIORITIZED"
      • NextToken — (String)

        The token to use to retrieve the next set of results.

Returns:

  • (AWS.Request)

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

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

List of Trusted Advisor check details by account related to the workload.

Service Reference:

Examples:

Calling the listCheckDetails operation

var params = {
  ChoiceId: 'STRING_VALUE', /* required */
  LensArn: 'STRING_VALUE', /* required */
  PillarId: 'STRING_VALUE', /* required */
  QuestionId: 'STRING_VALUE', /* required */
  WorkloadId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
wellarchitected.listCheckDetails(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: {})
    • WorkloadId — (String)

      The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    • NextToken — (String)

      The token to use to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return for this request.

    • LensArn — (String)

      Well-Architected Lens ARN.

    • PillarId — (String)

      The ID used to identify a pillar, for example, security.

      A pillar is identified by its PillarReviewSummary$PillarId.

    • QuestionId — (String)

      The ID of the question.

    • ChoiceId — (String)

      The ID of a choice.

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:

      • CheckDetails — (Array<map>)

        The details about the Trusted Advisor checks related to the Well-Architected best practice.

        • Id — (String)

          Trusted Advisor check ID.

        • Name — (String)

          Trusted Advisor check name.

        • Description — (String)

          Trusted Advisor check description.

        • Provider — (String)

          Provider of the check related to the best practice.

          Possible values include:
          • "TRUSTED_ADVISOR"
        • LensArn — (String)

          Well-Architected Lens ARN associated to the check.

        • PillarId — (String)

          The ID used to identify a pillar, for example, security.

          A pillar is identified by its PillarReviewSummary$PillarId.

        • QuestionId — (String)

          The ID of the question.

        • ChoiceId — (String)

          The ID of a choice.

        • Status — (String)

          Status associated to the check.

          Possible values include:
          • "OKAY"
          • "WARNING"
          • "ERROR"
          • "NOT_AVAILABLE"
          • "FETCH_FAILED"
        • AccountId — (String)

          An Amazon Web Services account ID.

        • FlaggedResources — (Integer)

          Count of flagged resources associated to the check.

        • Reason — (String)

          Reason associated to the check.

          Possible values include:
          • "ASSUME_ROLE_ERROR"
          • "ACCESS_DENIED"
          • "UNKNOWN_ERROR"
          • "PREMIUM_SUPPORT_REQUIRED"
        • UpdatedAt — (Date)

          The date and time recorded.

      • NextToken — (String)

        The token to use to retrieve the next set of results.

Returns:

  • (AWS.Request)

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

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

List of Trusted Advisor checks summarized for all accounts related to the workload.

Service Reference:

Examples:

Calling the listCheckSummaries operation

var params = {
  ChoiceId: 'STRING_VALUE', /* required */
  LensArn: 'STRING_VALUE', /* required */
  PillarId: 'STRING_VALUE', /* required */
  QuestionId: 'STRING_VALUE', /* required */
  WorkloadId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
wellarchitected.listCheckSummaries(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: {})
    • WorkloadId — (String)

      The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    • NextToken — (String)

      The token to use to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return for this request.

    • LensArn — (String)

      Well-Architected Lens ARN.

    • PillarId — (String)

      The ID used to identify a pillar, for example, security.

      A pillar is identified by its PillarReviewSummary$PillarId.

    • QuestionId — (String)

      The ID of the question.

    • ChoiceId — (String)

      The ID of a choice.

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

        List of Trusted Advisor summaries related to the Well-Architected best practice.

        • Id — (String)

          Trusted Advisor check ID.

        • Name — (String)

          Trusted Advisor check name.

        • Provider — (String)

          Provider of the check related to the best practice.

          Possible values include:
          • "TRUSTED_ADVISOR"
        • Description — (String)

          Trusted Advisor check description.

        • UpdatedAt — (Date)

          The date and time recorded.

        • LensArn — (String)

          Well-Architected Lens ARN associated to the check.

        • PillarId — (String)

          The ID used to identify a pillar, for example, security.

          A pillar is identified by its PillarReviewSummary$PillarId.

        • QuestionId — (String)

          The ID of the question.

        • ChoiceId — (String)

          The ID of a choice.

        • Status — (String)

          Status associated to the check.

          Possible values include:
          • "OKAY"
          • "WARNING"
          • "ERROR"
          • "NOT_AVAILABLE"
          • "FETCH_FAILED"
        • AccountSummary — (map<Integer>)

          Account summary associated to the check.

      • NextToken — (String)

        The token to use to retrieve the next set of results.

Returns:

  • (AWS.Request)

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

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

List the available lenses.

Service Reference:

Examples:

Calling the listLenses operation

var params = {
  LensName: 'STRING_VALUE',
  LensStatus: ALL | DRAFT | PUBLISHED,
  LensType: AWS_OFFICIAL | CUSTOM_SHARED | CUSTOM_SELF,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
wellarchitected.listLenses(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: {})
    • NextToken — (String)

      The token to use to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return for this request.

    • LensType — (String)

      The type of lenses to be returned.

      Possible values include:
      • "AWS_OFFICIAL"
      • "CUSTOM_SHARED"
      • "CUSTOM_SELF"
    • LensStatus — (String)

      The status of lenses to be returned.

      Possible values include:
      • "ALL"
      • "DRAFT"
      • "PUBLISHED"
    • LensName — (String)

      The full name of the lens.

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:

      • LensSummaries — (Array<map>)

        List of lens summaries of available lenses.

        • LensArn — (String)

          The ARN of the lens.

        • LensAlias — (String)

          The alias of the lens.

          For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

          For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

          Each lens is identified by its LensSummary$LensAlias.

        • LensName — (String)

          The full name of the lens.

        • LensType — (String)

          The type of the lens.

          Possible values include:
          • "AWS_OFFICIAL"
          • "CUSTOM_SHARED"
          • "CUSTOM_SELF"
        • Description — (String)

          The description of the lens.

        • CreatedAt — (Date)

          The date and time recorded.

        • UpdatedAt — (Date)

          The date and time recorded.

        • LensVersion — (String)

          The version of the lens.

        • Owner — (String)

          An Amazon Web Services account ID.

        • LensStatus — (String)

          The status of the lens.

          Possible values include:
          • "CURRENT"
          • "NOT_CURRENT"
          • "DEPRECATED"
          • "DELETED"
          • "UNSHARED"
      • NextToken — (String)

        The token to use to retrieve the next set of results.

Returns:

  • (AWS.Request)

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

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

List lens review improvements.

Service Reference:

Examples:

Calling the listLensReviewImprovements operation

var params = {
  LensAlias: 'STRING_VALUE', /* required */
  WorkloadId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  MilestoneNumber: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  PillarId: 'STRING_VALUE',
  QuestionPriority: PRIORITIZED | NONE
};
wellarchitected.listLensReviewImprovements(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: {})
    • WorkloadId — (String)

      The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    • LensAlias — (String)

      The alias of the lens.

      For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

      For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

      Each lens is identified by its LensSummary$LensAlias.

    • PillarId — (String)

      The ID used to identify a pillar, for example, security.

      A pillar is identified by its PillarReviewSummary$PillarId.

    • MilestoneNumber — (Integer)

      The milestone number.

      A workload can have a maximum of 100 milestones.

    • NextToken — (String)

      The token to use to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return for this request.

    • QuestionPriority — (String)

      The priority of the question.

      Possible values include:
      • "PRIORITIZED"
      • "NONE"

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:

      • WorkloadId — (String)

        The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

      • MilestoneNumber — (Integer)

        The milestone number.

        A workload can have a maximum of 100 milestones.

      • LensAlias — (String)

        The alias of the lens.

        For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

        For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

        Each lens is identified by its LensSummary$LensAlias.

      • LensArn — (String)

        The ARN for the lens.

      • ImprovementSummaries — (Array<map>)

        List of improvement summaries of lens review in a workload.

        • QuestionId — (String)

          The ID of the question.

        • PillarId — (String)

          The ID used to identify a pillar, for example, security.

          A pillar is identified by its PillarReviewSummary$PillarId.

        • QuestionTitle — (String)

          The title of the question.

        • Risk — (String)

          The risk for a given workload, lens review, pillar, or question.

          Possible values include:
          • "UNANSWERED"
          • "HIGH"
          • "MEDIUM"
          • "NONE"
          • "NOT_APPLICABLE"
        • ImprovementPlanUrl — (String)

          The improvement plan URL for a question in an Amazon Web Services official lenses.

          This value is only available if the question has been answered.

          This value does not apply to custom lenses.

        • ImprovementPlans — (Array<map>)

          The improvement plan details.

          • ChoiceId — (String)

            The ID of a choice.

          • DisplayText — (String)

            The display text for the improvement plan.

          • ImprovementPlanUrl — (String)

            The improvement plan URL for a question in an Amazon Web Services official lenses.

            This value is only available if the question has been answered.

            This value does not apply to custom lenses.

      • NextToken — (String)

        The token to use to retrieve the next set of results.

Returns:

  • (AWS.Request)

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

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

List lens reviews for a particular workload.

Service Reference:

Examples:

Calling the listLensReviews operation

var params = {
  WorkloadId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  MilestoneNumber: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
wellarchitected.listLensReviews(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: {})
    • WorkloadId — (String)

      The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    • MilestoneNumber — (Integer)

      The milestone number.

      A workload can have a maximum of 100 milestones.

    • NextToken — (String)

      The token to use to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return for this request.

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:

      • WorkloadId — (String)

        The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

      • MilestoneNumber — (Integer)

        The milestone number.

        A workload can have a maximum of 100 milestones.

      • LensReviewSummaries — (Array<map>)

        List of lens summaries of lens reviews of a workload.

        • LensAlias — (String)

          The alias of the lens.

          For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

          For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

          Each lens is identified by its LensSummary$LensAlias.

        • LensArn — (String)

          The ARN for the lens.

        • LensVersion — (String)

          The version of the lens.

        • LensName — (String)

          The full name of the lens.

        • LensStatus — (String)

          The status of the lens.

          Possible values include:
          • "CURRENT"
          • "NOT_CURRENT"
          • "DEPRECATED"
          • "DELETED"
          • "UNSHARED"
        • UpdatedAt — (Date)

          The date and time recorded.

        • RiskCounts — (map<Integer>)

          A map from risk names to the count of how many questions have that rating.

        • Profiles — (Array<map>)

          The profiles associated with the workload.

          • ProfileArn — (String)

            The profile ARN.

          • ProfileVersion — (String)

            The profile version.

        • PrioritizedRiskCounts — (map<Integer>)

          A map from risk names to the count of how many questions have that rating.

      • NextToken — (String)

        The token to use to retrieve the next set of results.

Returns:

  • (AWS.Request)

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

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

List the lens shares associated with the lens.

Service Reference:

Examples:

Calling the listLensShares operation

var params = {
  LensAlias: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SharedWithPrefix: 'STRING_VALUE',
  Status: ACCEPTED | REJECTED | PENDING | REVOKED | EXPIRED | ASSOCIATING | ASSOCIATED | FAILED
};
wellarchitected.listLensShares(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: {})
    • LensAlias — (String)

      The alias of the lens.

      For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

      For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

      Each lens is identified by its LensSummary$LensAlias.

    • SharedWithPrefix — (String)

      The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the lens is shared.

    • NextToken — (String)

      The token to use to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return for this request.

    • Status — (String)

      The status of the share request.

      Possible values include:
      • "ACCEPTED"
      • "REJECTED"
      • "PENDING"
      • "REVOKED"
      • "EXPIRED"
      • "ASSOCIATING"
      • "ASSOCIATED"
      • "FAILED"

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:

      • LensShareSummaries — (Array<map>)

        A list of lens share summaries.

        • ShareId — (String)

          The ID associated with the share.

        • SharedWith — (String)

          The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared.

        • Status — (String)

          The status of the share request.

          Possible values include:
          • "ACCEPTED"
          • "REJECTED"
          • "PENDING"
          • "REVOKED"
          • "EXPIRED"
          • "ASSOCIATING"
          • "ASSOCIATED"
          • "FAILED"
        • StatusMessage — (String)

          Optional message to compliment the Status field.

      • NextToken — (String)

        The token to use to retrieve the next set of results.

Returns:

  • (AWS.Request)

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

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

List all milestones for an existing workload.

Service Reference:

Examples:

Calling the listMilestones operation

var params = {
  WorkloadId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
wellarchitected.listMilestones(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: {})
    • WorkloadId — (String)

      The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    • NextToken — (String)

      The token to use to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return for this request.

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:

      • WorkloadId — (String)

        The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

      • MilestoneSummaries — (Array<map>)

        A list of milestone summaries.

        • MilestoneNumber — (Integer)

          The milestone number.

          A workload can have a maximum of 100 milestones.

        • MilestoneName — (String)

          The name of the milestone in a workload.

          Milestone names must be unique within a workload.

        • RecordedAt — (Date)

          The date and time recorded.

        • WorkloadSummary — (map)

          A workload summary return object.

          • WorkloadId — (String)

            The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

          • WorkloadArn — (String)

            The ARN for the workload.

          • WorkloadName — (String)

            The name of the workload.

            The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.

          • Owner — (String)

            An Amazon Web Services account ID.

          • UpdatedAt — (Date)

            The date and time recorded.

          • Lenses — (Array<String>)

            The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.

            If a review template that specifies lenses is applied to the workload, those lenses are applied to the workload in addition to these lenses.

          • RiskCounts — (map<Integer>)

            A map from risk names to the count of how many questions have that rating.

          • ImprovementStatus — (String)

            The improvement status for a workload.

            Possible values include:
            • "NOT_APPLICABLE"
            • "NOT_STARTED"
            • "IN_PROGRESS"
            • "COMPLETE"
            • "RISK_ACKNOWLEDGED"
          • Profiles — (Array<map>)

            Profile associated with a workload.

            • ProfileArn — (String)

              The profile ARN.

            • ProfileVersion — (String)

              The profile version.

          • PrioritizedRiskCounts — (map<Integer>)

            A map from risk names to the count of how many questions have that rating.

      • NextToken — (String)

        The token to use to retrieve the next set of results.

Returns:

  • (AWS.Request)

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

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

List lens notifications.

Service Reference:

Examples:

Calling the listNotifications operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ResourceArn: 'STRING_VALUE',
  WorkloadId: 'STRING_VALUE'
};
wellarchitected.listNotifications(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: {})
    • WorkloadId — (String)

      The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    • NextToken — (String)

      The token to use to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return for this request.

    • ResourceArn — (String)

      The ARN for the related resource for the notification.

      Note: Only one of WorkloadID or ResourceARN should be specified.

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:

      • NotificationSummaries — (Array<map>)

        List of lens notification summaries in a workload.

        • Type — (String)

          The type of notification.

          Possible values include:
          • "LENS_VERSION_UPGRADED"
          • "LENS_VERSION_DEPRECATED"
        • LensUpgradeSummary — (map)

          Summary of lens upgrade.

          • WorkloadId — (String)

            The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

          • WorkloadName — (String)

            The name of the workload.

            The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.

          • LensAlias — (String)

            The alias of the lens.

            For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

            For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

            Each lens is identified by its LensSummary$LensAlias.

          • LensArn — (String)

            The ARN for the lens.

          • CurrentLensVersion — (String)

            The current version of the lens.

          • LatestLensVersion — (String)

            The latest version of the lens.

          • ResourceArn — (String)

            ResourceArn of the lens being upgraded

          • ResourceName — (String)

            The name of the workload.

            The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.

      • NextToken — (String)

        The token to use to retrieve the next set of results.

Returns:

  • (AWS.Request)

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

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

List profile notifications.

Service Reference:

Examples:

Calling the listProfileNotifications operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  WorkloadId: 'STRING_VALUE'
};
wellarchitected.listProfileNotifications(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: {})
    • WorkloadId — (String)

      The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    • NextToken — (String)

      The token to use to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return for this request.

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:

      • NotificationSummaries — (Array<map>)

        Notification summaries.

        • CurrentProfileVersion — (String)

          The current profile version.

        • LatestProfileVersion — (String)

          The latest profile version.

        • Type — (String)

          Type of notification.

          Possible values include:
          • "PROFILE_ANSWERS_UPDATED"
          • "PROFILE_DELETED"
        • ProfileArn — (String)

          The profile ARN.

        • ProfileName — (String)

          The profile name.

        • WorkloadId — (String)

          The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

        • WorkloadName — (String)

          The name of the workload.

          The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.

      • NextToken — (String)

        The token to use to retrieve the next set of results.

Returns:

  • (AWS.Request)

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

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

List profiles.

Service Reference:

Examples:

Calling the listProfiles operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ProfileNamePrefix: 'STRING_VALUE',
  ProfileOwnerType: SELF | SHARED
};
wellarchitected.listProfiles(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: {})
    • ProfileNamePrefix — (String)

      An optional string added to the beginning of each profile name returned in the results.

    • ProfileOwnerType — (String)

      Profile owner type.

      Possible values include:
      • "SELF"
      • "SHARED"
    • NextToken — (String)

      The token to use to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return for this request.

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:

      • ProfileSummaries — (Array<map>)

        Profile summaries.

        • ProfileArn — (String)

          The profile ARN.

        • ProfileVersion — (String)

          The profile version.

        • ProfileName — (String)

          The profile name.

        • ProfileDescription — (String)

          The profile description.

        • Owner — (String)

          An Amazon Web Services account ID.

        • CreatedAt — (Date)

          The date and time recorded.

        • UpdatedAt — (Date)

          The date and time recorded.

      • NextToken — (String)

        The token to use to retrieve the next set of results.

Returns:

  • (AWS.Request)

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

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

List profile shares.

Service Reference:

Examples:

Calling the listProfileShares operation

var params = {
  ProfileArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SharedWithPrefix: 'STRING_VALUE',
  Status: ACCEPTED | REJECTED | PENDING | REVOKED | EXPIRED | ASSOCIATING | ASSOCIATED | FAILED
};
wellarchitected.listProfileShares(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: {})
    • ProfileArn — (String)

      The profile ARN.

    • SharedWithPrefix — (String)

      The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the profile is shared.

    • NextToken — (String)

      The token to use to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return for this request.

    • Status — (String)

      The status of the share request.

      Possible values include:
      • "ACCEPTED"
      • "REJECTED"
      • "PENDING"
      • "REVOKED"
      • "EXPIRED"
      • "ASSOCIATING"
      • "ASSOCIATED"
      • "FAILED"

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:

      • ProfileShareSummaries — (Array<map>)

        Profile share summaries.

        • ShareId — (String)

          The ID associated with the share.

        • SharedWith — (String)

          The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared.

        • Status — (String)

          The status of the share request.

          Possible values include:
          • "ACCEPTED"
          • "REJECTED"
          • "PENDING"
          • "REVOKED"
          • "EXPIRED"
          • "ASSOCIATING"
          • "ASSOCIATED"
          • "FAILED"
        • StatusMessage — (String)

          Profile share invitation status message.

      • NextToken — (String)

        The token to use to retrieve the next set of results.

Returns:

  • (AWS.Request)

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

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

List the answers of a review template.

Service Reference:

Examples:

Calling the listReviewTemplateAnswers operation

var params = {
  LensAlias: 'STRING_VALUE', /* required */
  TemplateArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  PillarId: 'STRING_VALUE'
};
wellarchitected.listReviewTemplateAnswers(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: {})
    • TemplateArn — (String)

      The ARN of the review template.

    • LensAlias — (String)

      The alias of the lens.

      For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

      For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

      Each lens is identified by its LensSummary$LensAlias.

    • PillarId — (String)

      The ID used to identify a pillar, for example, security.

      A pillar is identified by its PillarReviewSummary$PillarId.

    • NextToken — (String)

      The token to use to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return for this request.

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:

      • TemplateArn — (String)

        The ARN of the review template.

      • LensAlias — (String)

        The alias of the lens.

        For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

        For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

        Each lens is identified by its LensSummary$LensAlias.

      • AnswerSummaries — (Array<map>)

        List of answer summaries of a lens review in a review template.

        • QuestionId — (String)

          The ID of the question.

        • PillarId — (String)

          The ID used to identify a pillar, for example, security.

          A pillar is identified by its PillarReviewSummary$PillarId.

        • QuestionTitle — (String)

          The title of the question.

        • Choices — (Array<map>)

          List of choices available for a question.

          • ChoiceId — (String)

            The ID of a choice.

          • Title — (String)

            The title of a choice.

          • Description — (String)

            The description of a choice.

          • HelpfulResource — (map)

            The helpful resource (both text and URL) for a particular choice.

            This field only applies to custom lenses. Each choice can have only one helpful resource.

            • DisplayText — (String)

              The display text for the choice content.

            • Url — (String)

              The URL for the choice content.

          • ImprovementPlan — (map)

            The improvement plan (both text and URL) for a particular choice.

            This field only applies to custom lenses. Each choice can have only one improvement plan.

            • DisplayText — (String)

              The display text for the choice content.

            • Url — (String)

              The URL for the choice content.

          • AdditionalResources — (Array<map>)

            The additional resources for a choice in a custom lens.

            A choice can have up to two additional resources: one of type HELPFUL_RESOURCE, one of type IMPROVEMENT_PLAN, or both.

            • Type — (String)

              Type of additional resource for a custom lens.

              Possible values include:
              • "HELPFUL_RESOURCE"
              • "IMPROVEMENT_PLAN"
            • Content — (Array<map>)

              The URLs for additional resources, either helpful resources or improvement plans, for a custom lens. Up to five additional URLs can be specified.

              • DisplayText — (String)

                The display text for the choice content.

              • Url — (String)

                The URL for the choice content.

        • SelectedChoices — (Array<String>)

          List of selected choice IDs in a question answer.

          The values entered replace the previously selected choices.

        • ChoiceAnswerSummaries — (Array<map>)

          A list of selected choices to a question in the review template.

          • ChoiceId — (String)

            The ID of a choice.

          • Status — (String)

            The status of a choice.

            Possible values include:
            • "SELECTED"
            • "NOT_APPLICABLE"
            • "UNSELECTED"
          • Reason — (String)

            The reason why a choice is non-applicable to a question in your workload.

            Possible values include:
            • "OUT_OF_SCOPE"
            • "BUSINESS_PRIORITIES"
            • "ARCHITECTURE_CONSTRAINTS"
            • "OTHER"
            • "NONE"
        • IsApplicable — (Boolean)

          Defines whether this question is applicable to a lens review.

        • AnswerStatus — (String)

          The status of whether or not this question has been answered.

          Possible values include:
          • "UNANSWERED"
          • "ANSWERED"
        • Reason — (String)

          The reason why a choice is not-applicable to a question in the review template.

          Possible values include:
          • "OUT_OF_SCOPE"
          • "BUSINESS_PRIORITIES"
          • "ARCHITECTURE_CONSTRAINTS"
          • "OTHER"
          • "NONE"
        • QuestionType — (String)

          The type of question.

          Possible values include:
          • "PRIORITIZED"
          • "NON_PRIORITIZED"
      • NextToken — (String)

        The token to use to retrieve the next set of results.

Returns:

  • (AWS.Request)

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

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

List review templates.

Service Reference:

Examples:

Calling the listReviewTemplates operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
wellarchitected.listReviewTemplates(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: {})
    • NextToken — (String)

      The token to use to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return for this request.

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:

      • ReviewTemplates — (Array<map>)

        List of review templates.

        • Description — (String)

          Description of the review template.

        • Lenses — (Array<String>)

          Lenses associated with the review template.

        • Owner — (String)

          An Amazon Web Services account ID.

        • UpdatedAt — (Date)

          The date and time recorded.

        • TemplateArn — (String)

          The review template ARN.

        • TemplateName — (String)

          The name of the review template.

        • UpdateStatus — (String)

          The latest status of a review template.

          Possible values include:
          • "CURRENT"
          • "LENS_NOT_CURRENT"
      • NextToken — (String)

        The token to use to retrieve the next set of results.

Returns:

  • (AWS.Request)

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

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

List the share invitations.

WorkloadNamePrefix, LensNamePrefix, ProfileNamePrefix, and TemplateNamePrefix are mutually exclusive. Use the parameter that matches your ShareResourceType.

Service Reference:

Examples:

Calling the listShareInvitations operation

var params = {
  LensNamePrefix: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ProfileNamePrefix: 'STRING_VALUE',
  ShareResourceType: WORKLOAD | LENS | PROFILE | TEMPLATE,
  TemplateNamePrefix: 'STRING_VALUE',
  WorkloadNamePrefix: 'STRING_VALUE'
};
wellarchitected.listShareInvitations(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: {})
    • WorkloadNamePrefix — (String)

      An optional string added to the beginning of each workload name returned in the results.

    • LensNamePrefix — (String)

      An optional string added to the beginning of each lens name returned in the results.

    • ShareResourceType — (String)

      The type of share invitations to be returned.

      Possible values include:
      • "WORKLOAD"
      • "LENS"
      • "PROFILE"
      • "TEMPLATE"
    • NextToken — (String)

      The token to use to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return for this request.

    • ProfileNamePrefix — (String)

      An optional string added to the beginning of each profile name returned in the results.

    • TemplateNamePrefix — (String)

      An optional string added to the beginning of each review template name returned in the results.

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:

      • ShareInvitationSummaries — (Array<map>)

        List of share invitation summaries in a workload.

        • ShareInvitationId — (String)

          The ID assigned to the share invitation.

        • SharedBy — (String)

          An Amazon Web Services account ID.

        • SharedWith — (String)

          The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared.

        • PermissionType — (String)

          Permission granted on a share request.

          Possible values include:
          • "READONLY"
          • "CONTRIBUTOR"
        • ShareResourceType — (String)

          The resource type of the share invitation.

          Possible values include:
          • "WORKLOAD"
          • "LENS"
          • "PROFILE"
          • "TEMPLATE"
        • WorkloadName — (String)

          The name of the workload.

          The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.

        • WorkloadId — (String)

          The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

        • LensName — (String)

          The full name of the lens.

        • LensArn — (String)

          The ARN for the lens.

        • ProfileName — (String)

          The profile name.

        • ProfileArn — (String)

          The profile ARN.

        • TemplateName — (String)

          The name of the review template.

        • TemplateArn — (String)

          The review template ARN.

      • NextToken — (String)

        The token to use to retrieve the next set of results.

Returns:

  • (AWS.Request)

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

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

List the tags for a resource.

Note: The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.

Service Reference:

Examples:

Calling the listTagsForResource operation

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

      The ARN for the workload.

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:

      • Tags — (map<String>)

        The tags for the resource.

Returns:

  • (AWS.Request)

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

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

List review template shares.

Service Reference:

Examples:

Calling the listTemplateShares operation

var params = {
  TemplateArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SharedWithPrefix: 'STRING_VALUE',
  Status: ACCEPTED | REJECTED | PENDING | REVOKED | EXPIRED | ASSOCIATING | ASSOCIATED | FAILED
};
wellarchitected.listTemplateShares(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: {})
    • TemplateArn — (String)

      The review template ARN.

    • SharedWithPrefix — (String)

      The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the profile is shared.

    • NextToken — (String)

      The token to use to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return for this request.

    • Status — (String)

      The status of the share request.

      Possible values include:
      • "ACCEPTED"
      • "REJECTED"
      • "PENDING"
      • "REVOKED"
      • "EXPIRED"
      • "ASSOCIATING"
      • "ASSOCIATED"
      • "FAILED"

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:

      • TemplateArn — (String)

        The review template ARN.

      • TemplateShareSummaries — (Array<map>)

        A review template share summary return object.

        • ShareId — (String)

          The ID associated with the share.

        • SharedWith — (String)

          The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared.

        • Status — (String)

          The status of the share request.

          Possible values include:
          • "ACCEPTED"
          • "REJECTED"
          • "PENDING"
          • "REVOKED"
          • "EXPIRED"
          • "ASSOCIATING"
          • "ASSOCIATED"
          • "FAILED"
        • StatusMessage — (String)

          Review template share invitation status message.

      • NextToken — (String)

        The token to use to retrieve the next set of results.

Returns:

  • (AWS.Request)

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

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

Paginated list of workloads.

Service Reference:

Examples:

Calling the listWorkloads operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  WorkloadNamePrefix: 'STRING_VALUE'
};
wellarchitected.listWorkloads(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: {})
    • WorkloadNamePrefix — (String)

      An optional string added to the beginning of each workload name returned in the results.

    • NextToken — (String)

      The token to use to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return for this request.

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:

      • WorkloadSummaries — (Array<map>)

        A list of workload summaries.

        • WorkloadId — (String)

          The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

        • WorkloadArn — (String)

          The ARN for the workload.

        • WorkloadName — (String)

          The name of the workload.

          The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.

        • Owner — (String)

          An Amazon Web Services account ID.

        • UpdatedAt — (Date)

          The date and time recorded.

        • Lenses — (Array<String>)

          The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.

          If a review template that specifies lenses is applied to the workload, those lenses are applied to the workload in addition to these lenses.

        • RiskCounts — (map<Integer>)

          A map from risk names to the count of how many questions have that rating.

        • ImprovementStatus — (String)

          The improvement status for a workload.

          Possible values include:
          • "NOT_APPLICABLE"
          • "NOT_STARTED"
          • "IN_PROGRESS"
          • "COMPLETE"
          • "RISK_ACKNOWLEDGED"
        • Profiles — (Array<map>)

          Profile associated with a workload.

          • ProfileArn — (String)

            The profile ARN.

          • ProfileVersion — (String)

            The profile version.

        • PrioritizedRiskCounts — (map<Integer>)

          A map from risk names to the count of how many questions have that rating.

      • NextToken — (String)

        The token to use to retrieve the next set of results.

Returns:

  • (AWS.Request)

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

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

List the workload shares associated with the workload.

Service Reference:

Examples:

Calling the listWorkloadShares operation

var params = {
  WorkloadId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SharedWithPrefix: 'STRING_VALUE',
  Status: ACCEPTED | REJECTED | PENDING | REVOKED | EXPIRED | ASSOCIATING | ASSOCIATED | FAILED
};
wellarchitected.listWorkloadShares(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: {})
    • WorkloadId — (String)

      The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    • SharedWithPrefix — (String)

      The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload is shared.

    • NextToken — (String)

      The token to use to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return for this request.

    • Status — (String)

      The status of the share request.

      Possible values include:
      • "ACCEPTED"
      • "REJECTED"
      • "PENDING"
      • "REVOKED"
      • "EXPIRED"
      • "ASSOCIATING"
      • "ASSOCIATED"
      • "FAILED"

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:

      • WorkloadId — (String)

        The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

      • WorkloadShareSummaries — (Array<map>)

        A list of workload share summaries.

        • ShareId — (String)

          The ID associated with the share.

        • SharedWith — (String)

          The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared.

        • PermissionType — (String)

          Permission granted on a share request.

          Possible values include:
          • "READONLY"
          • "CONTRIBUTOR"
        • Status — (String)

          The status of the share request.

          Possible values include:
          • "ACCEPTED"
          • "REJECTED"
          • "PENDING"
          • "REVOKED"
          • "EXPIRED"
          • "ASSOCIATING"
          • "ASSOCIATED"
          • "FAILED"
        • StatusMessage — (String)

          Optional message to compliment the Status field.

      • NextToken — (String)

        The token to use to retrieve the next set of results.

Returns:

  • (AWS.Request)

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

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

Adds one or more tags to the specified resource.

Note: The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  Tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  WorkloadArn: 'STRING_VALUE' /* required */
};
wellarchitected.tagResource(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: {})
    • WorkloadArn — (String)

      The ARN for the workload.

    • Tags — (map<String>)

      The tags for the resource.

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.

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

Deletes specified tags from a resource.

Note: The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.

To specify multiple tags, use separate tagKeys parameters, for example:

DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  WorkloadArn: 'STRING_VALUE' /* required */
};
wellarchitected.untagResource(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: {})
    • WorkloadArn — (String)

      The ARN for the workload.

    • TagKeys — (Array<String>)

      A list of tag keys. Existing tags of the resource whose keys are members of this list are removed from the resource.

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.

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

Update the answer to a specific question in a workload review.

Service Reference:

Examples:

Calling the updateAnswer operation

var params = {
  LensAlias: 'STRING_VALUE', /* required */
  QuestionId: 'STRING_VALUE', /* required */
  WorkloadId: 'STRING_VALUE', /* required */
  ChoiceUpdates: {
    '<ChoiceId>': {
      Status: SELECTED | NOT_APPLICABLE | UNSELECTED, /* required */
      Notes: 'STRING_VALUE',
      Reason: OUT_OF_SCOPE | BUSINESS_PRIORITIES | ARCHITECTURE_CONSTRAINTS | OTHER | NONE
    },
    /* '<ChoiceId>': ... */
  },
  IsApplicable: true || false,
  Notes: 'STRING_VALUE',
  Reason: OUT_OF_SCOPE | BUSINESS_PRIORITIES | ARCHITECTURE_CONSTRAINTS | OTHER | NONE,
  SelectedChoices: [
    'STRING_VALUE',
    /* more items */
  ]
};
wellarchitected.updateAnswer(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: {})
    • WorkloadId — (String)

      The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    • LensAlias — (String)

      The alias of the lens.

      For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

      For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

      Each lens is identified by its LensSummary$LensAlias.

    • QuestionId — (String)

      The ID of the question.

    • SelectedChoices — (Array<String>)

      List of selected choice IDs in a question answer.

      The values entered replace the previously selected choices.

    • ChoiceUpdates — (map<map>)

      A list of choices to update on a question in your workload. The String key corresponds to the choice ID to be updated.

      • Statusrequired — (String)

        The status of a choice.

        Possible values include:
        • "SELECTED"
        • "NOT_APPLICABLE"
        • "UNSELECTED"
      • Reason — (String)

        The reason why a choice is non-applicable to a question in your workload.

        Possible values include:
        • "OUT_OF_SCOPE"
        • "BUSINESS_PRIORITIES"
        • "ARCHITECTURE_CONSTRAINTS"
        • "OTHER"
        • "NONE"
      • Notes — (String)

        The notes associated with a choice.

    • Notes — (String)

      The notes associated with the workload.

      For a review template, these are the notes that will be associated with the workload when the template is applied.

    • IsApplicable — (Boolean)

      Defines whether this question is applicable to a lens review.

    • Reason — (String)

      The reason why a question is not applicable to your workload.

      Possible values include:
      • "OUT_OF_SCOPE"
      • "BUSINESS_PRIORITIES"
      • "ARCHITECTURE_CONSTRAINTS"
      • "OTHER"
      • "NONE"

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:

      • WorkloadId — (String)

        The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

      • LensAlias — (String)

        The alias of the lens.

        For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

        For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

        Each lens is identified by its LensSummary$LensAlias.

      • LensArn — (String)

        The ARN for the lens.

      • Answer — (map)

        An answer of the question.

        • QuestionId — (String)

          The ID of the question.

        • PillarId — (String)

          The ID used to identify a pillar, for example, security.

          A pillar is identified by its PillarReviewSummary$PillarId.

        • QuestionTitle — (String)

          The title of the question.

        • QuestionDescription — (String)

          The description of the question.

        • ImprovementPlanUrl — (String)

          The improvement plan URL for a question in an Amazon Web Services official lenses.

          This value is only available if the question has been answered.

          This value does not apply to custom lenses.

        • HelpfulResourceUrl — (String)

          The helpful resource URL.

          For Amazon Web Services official lenses, this is the helpful resource URL for a question or choice.

          For custom lenses, this is the helpful resource URL for a question and is only provided if HelpfulResourceDisplayText was specified for the question.

        • HelpfulResourceDisplayText — (String)

          The helpful resource text to be displayed for a custom lens.

          This field does not apply to Amazon Web Services official lenses.

        • Choices — (Array<map>)

          List of choices available for a question.

          • ChoiceId — (String)

            The ID of a choice.

          • Title — (String)

            The title of a choice.

          • Description — (String)

            The description of a choice.

          • HelpfulResource — (map)

            The helpful resource (both text and URL) for a particular choice.

            This field only applies to custom lenses. Each choice can have only one helpful resource.

            • DisplayText — (String)

              The display text for the choice content.

            • Url — (String)

              The URL for the choice content.

          • ImprovementPlan — (map)

            The improvement plan (both text and URL) for a particular choice.

            This field only applies to custom lenses. Each choice can have only one improvement plan.

            • DisplayText — (String)

              The display text for the choice content.

            • Url — (String)

              The URL for the choice content.

          • AdditionalResources — (Array<map>)

            The additional resources for a choice in a custom lens.

            A choice can have up to two additional resources: one of type HELPFUL_RESOURCE, one of type IMPROVEMENT_PLAN, or both.

            • Type — (String)

              Type of additional resource for a custom lens.

              Possible values include:
              • "HELPFUL_RESOURCE"
              • "IMPROVEMENT_PLAN"
            • Content — (Array<map>)

              The URLs for additional resources, either helpful resources or improvement plans, for a custom lens. Up to five additional URLs can be specified.

              • DisplayText — (String)

                The display text for the choice content.

              • Url — (String)

                The URL for the choice content.

        • SelectedChoices — (Array<String>)

          List of selected choice IDs in a question answer.

          The values entered replace the previously selected choices.

        • ChoiceAnswers — (Array<map>)

          A list of selected choices to a question in your workload.

          • ChoiceId — (String)

            The ID of a choice.

          • Status — (String)

            The status of a choice.

            Possible values include:
            • "SELECTED"
            • "NOT_APPLICABLE"
            • "UNSELECTED"
          • Reason — (String)

            The reason why a choice is non-applicable to a question in your workload.

            Possible values include:
            • "OUT_OF_SCOPE"
            • "BUSINESS_PRIORITIES"
            • "ARCHITECTURE_CONSTRAINTS"
            • "OTHER"
            • "NONE"
          • Notes — (String)

            The notes associated with a choice.

        • IsApplicable — (Boolean)

          Defines whether this question is applicable to a lens review.

        • Risk — (String)

          The risk for a given workload, lens review, pillar, or question.

          Possible values include:
          • "UNANSWERED"
          • "HIGH"
          • "MEDIUM"
          • "NONE"
          • "NOT_APPLICABLE"
        • Notes — (String)

          The notes associated with the workload.

          For a review template, these are the notes that will be associated with the workload when the template is applied.

        • Reason — (String)

          The reason why the question is not applicable to your workload.

          Possible values include:
          • "OUT_OF_SCOPE"
          • "BUSINESS_PRIORITIES"
          • "ARCHITECTURE_CONSTRAINTS"
          • "OTHER"
          • "NONE"

Returns:

  • (AWS.Request)

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

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

Updates whether the Amazon Web Services account is opted into organization sharing and discovery integration features.

Service Reference:

Examples:

Calling the updateGlobalSettings operation

var params = {
  DiscoveryIntegrationStatus: ENABLED | DISABLED,
  OrganizationSharingStatus: ENABLED | DISABLED
};
wellarchitected.updateGlobalSettings(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: {})
    • OrganizationSharingStatus — (String)

      The status of organization sharing settings.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
    • DiscoveryIntegrationStatus — (String)

      The status of discovery support settings.

      Possible values include:
      • "ENABLED"
      • "DISABLED"

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.

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

Update lens review for a particular workload.

Service Reference:

Examples:

Calling the updateLensReview operation

var params = {
  LensAlias: 'STRING_VALUE', /* required */
  WorkloadId: 'STRING_VALUE', /* required */
  LensNotes: 'STRING_VALUE',
  PillarNotes: {
    '<PillarId>': 'STRING_VALUE',
    /* '<PillarId>': ... */
  }
};
wellarchitected.updateLensReview(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: {})
    • WorkloadId — (String)

      The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    • LensAlias — (String)

      The alias of the lens.

      For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

      For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

      Each lens is identified by its LensSummary$LensAlias.

    • LensNotes — (String)

      The notes associated with the workload.

      For a review template, these are the notes that will be associated with the workload when the template is applied.

    • PillarNotes — (map<String>)

      List of pillar notes of a lens review in a workload.

      For a review template, these are the notes that will be associated with the workload when the template is applied.

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:

      • WorkloadId — (String)

        The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

      • LensReview — (map)

        A lens review of a question.

        • LensAlias — (String)

          The alias of the lens.

          For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

          For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

          Each lens is identified by its LensSummary$LensAlias.

        • LensArn — (String)

          The ARN for the lens.

        • LensVersion — (String)

          The version of the lens.

        • LensName — (String)

          The full name of the lens.

        • LensStatus — (String)

          The status of the lens.

          Possible values include:
          • "CURRENT"
          • "NOT_CURRENT"
          • "DEPRECATED"
          • "DELETED"
          • "UNSHARED"
        • PillarReviewSummaries — (Array<map>)

          List of pillar review summaries of lens review in a workload.

          • PillarId — (String)

            The ID used to identify a pillar, for example, security.

            A pillar is identified by its PillarReviewSummary$PillarId.

          • PillarName — (String)

            The name of the pillar.

          • Notes — (String)

            The notes associated with the workload.

            For a review template, these are the notes that will be associated with the workload when the template is applied.

          • RiskCounts — (map<Integer>)

            A map from risk names to the count of how many questions have that rating.

          • PrioritizedRiskCounts — (map<Integer>)

            A map from risk names to the count of how many questions have that rating.

        • UpdatedAt — (Date)

          The date and time recorded.

        • Notes — (String)

          The notes associated with the workload.

          For a review template, these are the notes that will be associated with the workload when the template is applied.

        • RiskCounts — (map<Integer>)

          A map from risk names to the count of how many questions have that rating.

        • NextToken — (String)

          The token to use to retrieve the next set of results.

        • Profiles — (Array<map>)

          The profiles associated with the workload.

          • ProfileArn — (String)

            The profile ARN.

          • ProfileVersion — (String)

            The profile version.

        • PrioritizedRiskCounts — (map<Integer>)

          A map from risk names to the count of how many questions have that rating.

Returns:

  • (AWS.Request)

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

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

Update a profile.

Service Reference:

Examples:

Calling the updateProfile operation

var params = {
  ProfileArn: 'STRING_VALUE', /* required */
  ProfileDescription: 'STRING_VALUE',
  ProfileQuestions: [
    {
      QuestionId: 'STRING_VALUE',
      SelectedChoiceIds: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ]
};
wellarchitected.updateProfile(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: {})
    • ProfileArn — (String)

      The profile ARN.

    • ProfileDescription — (String)

      The profile description.

    • ProfileQuestions — (Array<map>)

      Profile questions.

      • QuestionId — (String)

        The ID of the question.

      • SelectedChoiceIds — (Array<String>)

        The selected choices.

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:

      • Profile — (map)

        The profile.

        • ProfileArn — (String)

          The profile ARN.

        • ProfileVersion — (String)

          The profile version.

        • ProfileName — (String)

          The profile name.

        • ProfileDescription — (String)

          The profile description.

        • ProfileQuestions — (Array<map>)

          Profile questions.

          • QuestionId — (String)

            The ID of the question.

          • QuestionTitle — (String)

            The title of the question.

          • QuestionDescription — (String)

            The description of the question.

          • QuestionChoices — (Array<map>)

            The question choices.

            • ChoiceId — (String)

              The ID of a choice.

            • ChoiceTitle — (String)

              The title of a choice.

            • ChoiceDescription — (String)

              The description of a choice.

          • SelectedChoiceIds — (Array<String>)

            The selected choices.

          • MinSelectedChoices — (Integer)

            The minimum number of selected choices.

          • MaxSelectedChoices — (Integer)

            The maximum number of selected choices.

        • Owner — (String)

          An Amazon Web Services account ID.

        • CreatedAt — (Date)

          The date and time recorded.

        • UpdatedAt — (Date)

          The date and time recorded.

        • ShareInvitationId — (String)

          The ID assigned to the share invitation.

        • Tags — (map<String>)

          The tags assigned to the profile.

Returns:

  • (AWS.Request)

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

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

Update a review template.

Service Reference:

Examples:

Calling the updateReviewTemplate operation

var params = {
  TemplateArn: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  LensesToAssociate: [
    'STRING_VALUE',
    /* more items */
  ],
  LensesToDisassociate: [
    'STRING_VALUE',
    /* more items */
  ],
  Notes: 'STRING_VALUE',
  TemplateName: 'STRING_VALUE'
};
wellarchitected.updateReviewTemplate(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: {})
    • TemplateArn — (String)

      The review template ARN.

    • TemplateName — (String)

      The review template name.

    • Description — (String)

      The review template description.

    • Notes — (String)

      The notes associated with the workload.

      For a review template, these are the notes that will be associated with the workload when the template is applied.

    • LensesToAssociate — (Array<String>)

      A list of lens aliases or ARNs to apply to the review template.

    • LensesToDisassociate — (Array<String>)

      A list of lens aliases or ARNs to unapply to the review template. The wellarchitected lens cannot be unapplied.

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:

      • ReviewTemplate — (map)

        A review template.

        • Description — (String)

          The review template description.

        • Lenses — (Array<String>)

          The lenses applied to the review template.

        • Notes — (String)

          The notes associated with the workload.

          For a review template, these are the notes that will be associated with the workload when the template is applied.

        • QuestionCounts — (map<Integer>)

          A count of how many total questions are answered and unanswered in the review template.

        • Owner — (String)

          An Amazon Web Services account ID.

        • UpdatedAt — (Date)

          The date and time recorded.

        • TemplateArn — (String)

          The review template ARN.

        • TemplateName — (String)

          The name of the review template.

        • Tags — (map<String>)

          The tags assigned to the review template.

        • UpdateStatus — (String)

          The latest status of a review template.

          Possible values include:
          • "CURRENT"
          • "LENS_NOT_CURRENT"
        • ShareInvitationId — (String)

          The ID assigned to the template share invitation.

Returns:

  • (AWS.Request)

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

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

Update a review template answer.

Service Reference:

Examples:

Calling the updateReviewTemplateAnswer operation

var params = {
  LensAlias: 'STRING_VALUE', /* required */
  QuestionId: 'STRING_VALUE', /* required */
  TemplateArn: 'STRING_VALUE', /* required */
  ChoiceUpdates: {
    '<ChoiceId>': {
      Status: SELECTED | NOT_APPLICABLE | UNSELECTED, /* required */
      Notes: 'STRING_VALUE',
      Reason: OUT_OF_SCOPE | BUSINESS_PRIORITIES | ARCHITECTURE_CONSTRAINTS | OTHER | NONE
    },
    /* '<ChoiceId>': ... */
  },
  IsApplicable: true || false,
  Notes: 'STRING_VALUE',
  Reason: OUT_OF_SCOPE | BUSINESS_PRIORITIES | ARCHITECTURE_CONSTRAINTS | OTHER | NONE,
  SelectedChoices: [
    'STRING_VALUE',
    /* more items */
  ]
};
wellarchitected.updateReviewTemplateAnswer(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: {})
    • TemplateArn — (String)

      The review template ARN.

    • LensAlias — (String)

      The alias of the lens.

      For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

      For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

      Each lens is identified by its LensSummary$LensAlias.

    • QuestionId — (String)

      The ID of the question.

    • SelectedChoices — (Array<String>)

      List of selected choice IDs in a question answer.

      The values entered replace the previously selected choices.

    • ChoiceUpdates — (map<map>)

      A list of choices to be updated.

      • Statusrequired — (String)

        The status of a choice.

        Possible values include:
        • "SELECTED"
        • "NOT_APPLICABLE"
        • "UNSELECTED"
      • Reason — (String)

        The reason why a choice is non-applicable to a question in your workload.

        Possible values include:
        • "OUT_OF_SCOPE"
        • "BUSINESS_PRIORITIES"
        • "ARCHITECTURE_CONSTRAINTS"
        • "OTHER"
        • "NONE"
      • Notes — (String)

        The notes associated with a choice.

    • Notes — (String)

      The notes associated with the workload.

      For a review template, these are the notes that will be associated with the workload when the template is applied.

    • IsApplicable — (Boolean)

      Defines whether this question is applicable to a lens review.

    • Reason — (String)

      The update reason.

      Possible values include:
      • "OUT_OF_SCOPE"
      • "BUSINESS_PRIORITIES"
      • "ARCHITECTURE_CONSTRAINTS"
      • "OTHER"
      • "NONE"

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:

      • TemplateArn — (String)

        The review template ARN.

      • LensAlias — (String)

        The alias of the lens.

        For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

        For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

        Each lens is identified by its LensSummary$LensAlias.

      • Answer — (map)

        An answer of the question.

        • QuestionId — (String)

          The ID of the question.

        • PillarId — (String)

          The ID used to identify a pillar, for example, security.

          A pillar is identified by its PillarReviewSummary$PillarId.

        • QuestionTitle — (String)

          The title of the question.

        • QuestionDescription — (String)

          The description of the question.

        • ImprovementPlanUrl — (String)

          The improvement plan URL for a question in an Amazon Web Services official lenses.

          This value is only available if the question has been answered.

          This value does not apply to custom lenses.

        • HelpfulResourceUrl — (String)

          The helpful resource URL.

          For Amazon Web Services official lenses, this is the helpful resource URL for a question or choice.

          For custom lenses, this is the helpful resource URL for a question and is only provided if HelpfulResourceDisplayText was specified for the question.

        • HelpfulResourceDisplayText — (String)

          The helpful resource text to be displayed for a custom lens.

          Note: This field does not apply to Amazon Web Services official lenses.
        • Choices — (Array<map>)

          List of choices available for a question.

          • ChoiceId — (String)

            The ID of a choice.

          • Title — (String)

            The title of a choice.

          • Description — (String)

            The description of a choice.

          • HelpfulResource — (map)

            The helpful resource (both text and URL) for a particular choice.

            This field only applies to custom lenses. Each choice can have only one helpful resource.

            • DisplayText — (String)

              The display text for the choice content.

            • Url — (String)

              The URL for the choice content.

          • ImprovementPlan — (map)

            The improvement plan (both text and URL) for a particular choice.

            This field only applies to custom lenses. Each choice can have only one improvement plan.

            • DisplayText — (String)

              The display text for the choice content.

            • Url — (String)

              The URL for the choice content.

          • AdditionalResources — (Array<map>)

            The additional resources for a choice in a custom lens.

            A choice can have up to two additional resources: one of type HELPFUL_RESOURCE, one of type IMPROVEMENT_PLAN, or both.

            • Type — (String)

              Type of additional resource for a custom lens.

              Possible values include:
              • "HELPFUL_RESOURCE"
              • "IMPROVEMENT_PLAN"
            • Content — (Array<map>)

              The URLs for additional resources, either helpful resources or improvement plans, for a custom lens. Up to five additional URLs can be specified.

              • DisplayText — (String)

                The display text for the choice content.

              • Url — (String)

                The URL for the choice content.

        • SelectedChoices — (Array<String>)

          List of selected choice IDs in a question answer.

          The values entered replace the previously selected choices.

        • ChoiceAnswers — (Array<map>)

          A list of selected choices to a question in your review template.

          • ChoiceId — (String)

            The ID of a choice.

          • Status — (String)

            The status of a choice.

            Possible values include:
            • "SELECTED"
            • "NOT_APPLICABLE"
            • "UNSELECTED"
          • Reason — (String)

            The reason why a choice is non-applicable to a question in your workload.

            Possible values include:
            • "OUT_OF_SCOPE"
            • "BUSINESS_PRIORITIES"
            • "ARCHITECTURE_CONSTRAINTS"
            • "OTHER"
            • "NONE"
          • Notes — (String)

            The notes associated with a choice.

        • IsApplicable — (Boolean)

          Defines whether this question is applicable to a lens review.

        • AnswerStatus — (String)

          The status of whether or not this question has been answered.

          Possible values include:
          • "UNANSWERED"
          • "ANSWERED"
        • Notes — (String)

          The notes associated with the workload.

          For a review template, these are the notes that will be associated with the workload when the template is applied.

        • Reason — (String)

          The reason why the question is not applicable to your review template.

          Possible values include:
          • "OUT_OF_SCOPE"
          • "BUSINESS_PRIORITIES"
          • "ARCHITECTURE_CONSTRAINTS"
          • "OTHER"
          • "NONE"

Returns:

  • (AWS.Request)

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

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

Update a lens review associated with a review template.

Service Reference:

Examples:

Calling the updateReviewTemplateLensReview operation

var params = {
  LensAlias: 'STRING_VALUE', /* required */
  TemplateArn: 'STRING_VALUE', /* required */
  LensNotes: 'STRING_VALUE',
  PillarNotes: {
    '<PillarId>': 'STRING_VALUE',
    /* '<PillarId>': ... */
  }
};
wellarchitected.updateReviewTemplateLensReview(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: {})
    • TemplateArn — (String)

      The review template ARN.

    • LensAlias — (String)

      The alias of the lens.

      For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

      For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

      Each lens is identified by its LensSummary$LensAlias.

    • LensNotes — (String)

      The notes associated with the workload.

      For a review template, these are the notes that will be associated with the workload when the template is applied.

    • PillarNotes — (map<String>)

      List of pillar notes of a lens review in a workload.

      For a review template, these are the notes that will be associated with the workload when the template is applied.

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:

      • TemplateArn — (String)

        The review template ARN.

      • LensReview — (map)

        A lens review of a question.

        • LensAlias — (String)

          The alias of the lens.

          For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

          For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

          Each lens is identified by its LensSummary$LensAlias.

        • LensArn — (String)

          The lens ARN.

        • LensVersion — (String)

          The version of the lens.

        • LensName — (String)

          The full name of the lens.

        • LensStatus — (String)

          The status of the lens.

          Possible values include:
          • "CURRENT"
          • "NOT_CURRENT"
          • "DEPRECATED"
          • "DELETED"
          • "UNSHARED"
        • PillarReviewSummaries — (Array<map>)

          Pillar review summaries of a lens review.

          • PillarId — (String)

            The ID used to identify a pillar, for example, security.

            A pillar is identified by its PillarReviewSummary$PillarId.

          • PillarName — (String)

            The name of the pillar.

          • Notes — (String)

            The notes associated with the workload.

            For a review template, these are the notes that will be associated with the workload when the template is applied.

          • QuestionCounts — (map<Integer>)

            A count of how many questions are answered and unanswered in the requested pillar of the lens review.

        • UpdatedAt — (Date)

          The date and time recorded.

        • Notes — (String)

          The notes associated with the workload.

          For a review template, these are the notes that will be associated with the workload when the template is applied.

        • QuestionCounts — (map<Integer>)

          A count of how many questions are answered and unanswered in the lens review.

        • NextToken — (String)

          The token to use to retrieve the next set of results.

Returns:

  • (AWS.Request)

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

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

Update a workload or custom lens share invitation.

Note: This API operation can be called independently of any resource. Previous documentation implied that a workload ARN must be specified.

Service Reference:

Examples:

Calling the updateShareInvitation operation

var params = {
  ShareInvitationAction: ACCEPT | REJECT, /* required */
  ShareInvitationId: 'STRING_VALUE' /* required */
};
wellarchitected.updateShareInvitation(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: {})
    • ShareInvitationId — (String)

      The ID assigned to the share invitation.

    • ShareInvitationAction — (String)

      Share invitation action taken by contributor.

      Possible values include:
      • "ACCEPT"
      • "REJECT"

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:

      • ShareInvitation — (map)

        The updated workload or custom lens share invitation.

        • ShareInvitationId — (String)

          The ID assigned to the share invitation.

        • ShareResourceType — (String)

          The resource type of the share invitation.

          Possible values include:
          • "WORKLOAD"
          • "LENS"
          • "PROFILE"
          • "TEMPLATE"
        • WorkloadId — (String)

          The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

        • LensAlias — (String)

          The alias of the lens.

          For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

          For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

          Each lens is identified by its LensSummary$LensAlias.

        • LensArn — (String)

          The ARN for the lens.

        • ProfileArn — (String)

          The profile ARN.

        • TemplateArn — (String)

          The review template ARN.

Returns:

  • (AWS.Request)

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

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

Update an existing workload.

Service Reference:

Examples:

Calling the updateWorkload operation

var params = {
  WorkloadId: 'STRING_VALUE', /* required */
  AccountIds: [
    'STRING_VALUE',
    /* more items */
  ],
  Applications: [
    'STRING_VALUE',
    /* more items */
  ],
  ArchitecturalDesign: 'STRING_VALUE',
  AwsRegions: [
    'STRING_VALUE',
    /* more items */
  ],
  Description: 'STRING_VALUE',
  DiscoveryConfig: {
    TrustedAdvisorIntegrationStatus: ENABLED | DISABLED,
    WorkloadResourceDefinition: [
      WORKLOAD_METADATA | APP_REGISTRY,
      /* more items */
    ]
  },
  Environment: PRODUCTION | PREPRODUCTION,
  ImprovementStatus: NOT_APPLICABLE | NOT_STARTED | IN_PROGRESS | COMPLETE | RISK_ACKNOWLEDGED,
  Industry: 'STRING_VALUE',
  IndustryType: 'STRING_VALUE',
  IsReviewOwnerUpdateAcknowledged: true || false,
  NonAwsRegions: [
    'STRING_VALUE',
    /* more items */
  ],
  Notes: 'STRING_VALUE',
  PillarPriorities: [
    'STRING_VALUE',
    /* more items */
  ],
  ReviewOwner: 'STRING_VALUE',
  WorkloadName: 'STRING_VALUE'
};
wellarchitected.updateWorkload(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: {})
    • WorkloadId — (String)

      The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    • WorkloadName — (String)

      The name of the workload.

      The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.

    • Description — (String)

      The description for the workload.

    • Environment — (String)

      The environment for the workload.

      Possible values include:
      • "PRODUCTION"
      • "PREPRODUCTION"
    • AccountIds — (Array<String>)

      The list of Amazon Web Services account IDs associated with the workload.

    • AwsRegions — (Array<String>)

      The list of Amazon Web Services Regions associated with the workload, for example, us-east-2, or ca-central-1.

    • NonAwsRegions — (Array<String>)

      The list of non-Amazon Web Services Regions associated with the workload.

    • PillarPriorities — (Array<String>)

      The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId.

    • ArchitecturalDesign — (String)

      The URL of the architectural design for the workload.

    • ReviewOwner — (String)

      The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.

    • IsReviewOwnerUpdateAcknowledged — (Boolean)

      Flag indicating whether the workload owner has acknowledged that the Review owner field is required.

      If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.

    • IndustryType — (String)

      The industry type for the workload.

      If specified, must be one of the following:

      • Agriculture

      • Automobile

      • Defense

      • Design and Engineering

      • Digital Advertising

      • Education

      • Environmental Protection

      • Financial Services

      • Gaming

      • General Public Services

      • Healthcare

      • Hospitality

      • InfoTech

      • Justice and Public Safety

      • Life Sciences

      • Manufacturing

      • Media & Entertainment

      • Mining & Resources

      • Oil & Gas

      • Power & Utilities

      • Professional Services

      • Real Estate & Construction

      • Retail & Wholesale

      • Social Protection

      • Telecommunications

      • Travel, Transportation & Logistics

      • Other

    • Industry — (String)

      The industry for the workload.

    • Notes — (String)

      The notes associated with the workload.

      For a review template, these are the notes that will be associated with the workload when the template is applied.

    • ImprovementStatus — (String)

      The improvement status for a workload.

      Possible values include:
      • "NOT_APPLICABLE"
      • "NOT_STARTED"
      • "IN_PROGRESS"
      • "COMPLETE"
      • "RISK_ACKNOWLEDGED"
    • DiscoveryConfig — (map)

      Well-Architected discovery configuration settings to associate to the workload.

      • TrustedAdvisorIntegrationStatus — (String)

        Discovery integration status in respect to Trusted Advisor for the workload.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • WorkloadResourceDefinition — (Array<String>)

        The mode to use for identifying resources associated with the workload.

        You can specify WORKLOAD_METADATA, APP_REGISTRY, or both.

    • Applications — (Array<String>)

      List of AppRegistry application ARNs to associate to the workload.

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:

      • Workload — (map)

        A workload return object.

        • WorkloadId — (String)

          The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

        • WorkloadArn — (String)

          The ARN for the workload.

        • WorkloadName — (String)

          The name of the workload.

          The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.

        • Description — (String)

          The description for the workload.

        • Environment — (String)

          The environment for the workload.

          Possible values include:
          • "PRODUCTION"
          • "PREPRODUCTION"
        • UpdatedAt — (Date)

          The date and time recorded.

        • AccountIds — (Array<String>)

          The list of Amazon Web Services account IDs associated with the workload.

        • AwsRegions — (Array<String>)

          The list of Amazon Web Services Regions associated with the workload, for example, us-east-2, or ca-central-1.

        • NonAwsRegions — (Array<String>)

          The list of non-Amazon Web Services Regions associated with the workload.

        • ArchitecturalDesign — (String)

          The URL of the architectural design for the workload.

        • ReviewOwner — (String)

          The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.

        • ReviewRestrictionDate — (Date)

          The date and time recorded.

        • IsReviewOwnerUpdateAcknowledged — (Boolean)

          Flag indicating whether the workload owner has acknowledged that the Review owner field is required.

          If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.

        • IndustryType — (String)

          The industry type for the workload.

          If specified, must be one of the following:

          • Agriculture

          • Automobile

          • Defense

          • Design and Engineering

          • Digital Advertising

          • Education

          • Environmental Protection

          • Financial Services

          • Gaming

          • General Public Services

          • Healthcare

          • Hospitality

          • InfoTech

          • Justice and Public Safety

          • Life Sciences

          • Manufacturing

          • Media & Entertainment

          • Mining & Resources

          • Oil & Gas

          • Power & Utilities

          • Professional Services

          • Real Estate & Construction

          • Retail & Wholesale

          • Social Protection

          • Telecommunications

          • Travel, Transportation & Logistics

          • Other

        • Industry — (String)

          The industry for the workload.

        • Notes — (String)

          The notes associated with the workload.

          For a review template, these are the notes that will be associated with the workload when the template is applied.

        • ImprovementStatus — (String)

          The improvement status for a workload.

          Possible values include:
          • "NOT_APPLICABLE"
          • "NOT_STARTED"
          • "IN_PROGRESS"
          • "COMPLETE"
          • "RISK_ACKNOWLEDGED"
        • RiskCounts — (map<Integer>)

          A map from risk names to the count of how many questions have that rating.

        • PillarPriorities — (Array<String>)

          The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId.

        • Lenses — (Array<String>)

          The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.

          If a review template that specifies lenses is applied to the workload, those lenses are applied to the workload in addition to these lenses.

        • Owner — (String)

          An Amazon Web Services account ID.

        • ShareInvitationId — (String)

          The ID assigned to the share invitation.

        • Tags — (map<String>)

          The tags associated with the workload.

        • DiscoveryConfig — (map)

          Discovery configuration associated to the workload.

          • TrustedAdvisorIntegrationStatus — (String)

            Discovery integration status in respect to Trusted Advisor for the workload.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
          • WorkloadResourceDefinition — (Array<String>)

            The mode to use for identifying resources associated with the workload.

            You can specify WORKLOAD_METADATA, APP_REGISTRY, or both.

        • Applications — (Array<String>)

          List of AppRegistry application ARNs associated to the workload.

        • Profiles — (Array<map>)

          Profile associated with a workload.

          • ProfileArn — (String)

            The profile ARN.

          • ProfileVersion — (String)

            The profile version.

        • PrioritizedRiskCounts — (map<Integer>)

          A map from risk names to the count of how many questions have that rating.

Returns:

  • (AWS.Request)

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

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

Update a workload share.

Service Reference:

Examples:

Calling the updateWorkloadShare operation

var params = {
  PermissionType: READONLY | CONTRIBUTOR, /* required */
  ShareId: 'STRING_VALUE', /* required */
  WorkloadId: 'STRING_VALUE' /* required */
};
wellarchitected.updateWorkloadShare(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: {})
    • ShareId — (String)

      The ID associated with the share.

    • WorkloadId — (String)

      The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    • PermissionType — (String)

      Permission granted on a share request.

      Possible values include:
      • "READONLY"
      • "CONTRIBUTOR"

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:

      • WorkloadId — (String)

        The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

      • WorkloadShare — (map)

        A workload share return object.

        • ShareId — (String)

          The ID associated with the share.

        • SharedBy — (String)

          An Amazon Web Services account ID.

        • SharedWith — (String)

          The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared.

        • PermissionType — (String)

          Permission granted on a share request.

          Possible values include:
          • "READONLY"
          • "CONTRIBUTOR"
        • Status — (String)

          The status of the share request.

          Possible values include:
          • "ACCEPTED"
          • "REJECTED"
          • "PENDING"
          • "REVOKED"
          • "EXPIRED"
          • "ASSOCIATING"
          • "ASSOCIATED"
          • "FAILED"
        • WorkloadName — (String)

          The name of the workload.

          The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.

        • WorkloadId — (String)

          The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

Returns:

  • (AWS.Request)

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

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

Upgrade lens review for a particular workload.

Service Reference:

Examples:

Calling the upgradeLensReview operation

var params = {
  LensAlias: 'STRING_VALUE', /* required */
  MilestoneName: 'STRING_VALUE', /* required */
  WorkloadId: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE'
};
wellarchitected.upgradeLensReview(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: {})
    • WorkloadId — (String)

      The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    • LensAlias — (String)

      The alias of the lens.

      For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

      For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

      Each lens is identified by its LensSummary$LensAlias.

    • MilestoneName — (String)

      The name of the milestone in a workload.

      Milestone names must be unique within a workload.

    • ClientRequestToken — (String)

      A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

      You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

      This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

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.

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

Upgrade a profile.

Service Reference:

Examples:

Calling the upgradeProfileVersion operation

var params = {
  ProfileArn: 'STRING_VALUE', /* required */
  WorkloadId: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE',
  MilestoneName: 'STRING_VALUE'
};
wellarchitected.upgradeProfileVersion(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: {})
    • WorkloadId — (String)

      The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    • ProfileArn — (String)

      The profile ARN.

    • MilestoneName — (String)

      The name of the milestone in a workload.

      Milestone names must be unique within a workload.

    • ClientRequestToken — (String)

      A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

      You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

      This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

      If a token is not provided, the SDK will use a version 4 UUID.

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.

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

Upgrade the lens review of a review template.

Service Reference:

Examples:

Calling the upgradeReviewTemplateLensReview operation

var params = {
  LensAlias: 'STRING_VALUE', /* required */
  TemplateArn: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE'
};
wellarchitected.upgradeReviewTemplateLensReview(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: {})
    • TemplateArn — (String)

      The ARN of the review template.

    • LensAlias — (String)

      The alias of the lens.

      For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

      For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

      Each lens is identified by its LensSummary$LensAlias.

    • ClientRequestToken — (String)

      A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

      You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

      This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

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.