You are viewing the documentation for an older major version of the AWS SDK for JavaScript.

The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.WellArchitected

Inherits:

AWS.Service

Object
AWS.Service
AWS.WellArchitected

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 AWS Well-Architected Tool API Reference. The AWS Well-Architected Tool API provides programmatic access to the AWS Well-Architected Tool in the AWS Management Console. For information about the AWS Well-Architected Tool, see the AWS 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

new AWS.WellArchitected(options = {}) ⇒ Object constructor
Constructs a service object.

Property Summary collapse

endpoint ⇒ AWS.Endpoint readwrite
An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

associateLenses(params = {}, callback) ⇒ AWS.Request
Associate a lens to a workload.

.
createMilestone(params = {}, callback) ⇒ AWS.Request
Create a milestone for an existing workload.

.
createWorkload(params = {}, callback) ⇒ AWS.Request
Create a new workload.

The owner of a workload can share the workload with other AWS accounts and IAM users in the same AWS Region.
createWorkloadShare(params = {}, callback) ⇒ AWS.Request
Create a workload share.

The owner of a workload can share it with other AWS accounts and IAM users in the same AWS Region.
deleteWorkload(params = {}, callback) ⇒ AWS.Request
Delete an existing workload.

.
deleteWorkloadShare(params = {}, callback) ⇒ AWS.Request
Delete a workload share.

.
disassociateLenses(params = {}, callback) ⇒ AWS.Request
Disassociate a lens from a workload.

Note: The AWS Well-Architected Framework lens (wellarchitected) cannot be removed from a workload.
getAnswer(params = {}, callback) ⇒ AWS.Request
Get the answer to a specific question in a workload review.

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

.
getLensReviewReport(params = {}, callback) ⇒ AWS.Request
Get lens review report.

.
getLensVersionDifference(params = {}, callback) ⇒ AWS.Request
Get lens version differences.

.
getMilestone(params = {}, callback) ⇒ AWS.Request
Get a milestone for an existing workload.

.
getWorkload(params = {}, callback) ⇒ AWS.Request
Get an existing workload.

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

.
listLenses(params = {}, callback) ⇒ AWS.Request
List the available lenses.

.
listLensReviewImprovements(params = {}, callback) ⇒ AWS.Request
List lens review improvements.

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

.
listMilestones(params = {}, callback) ⇒ AWS.Request
List all milestones for an existing workload.

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

.
listShareInvitations(params = {}, callback) ⇒ AWS.Request
List the workload invitations.

.
listTagsForResource(params = {}, callback) ⇒ AWS.Request
List the tags for a resource.

.
listWorkloads(params = {}, callback) ⇒ AWS.Request
List workloads.
listWorkloadShares(params = {}, callback) ⇒ AWS.Request
List the workload shares associated with the workload.

.
tagResource(params = {}, callback) ⇒ AWS.Request
Adds one or more tags to the specified resource.

.
untagResource(params = {}, callback) ⇒ AWS.Request
Deletes specified tags from a resource.

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

DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2
.
updateAnswer(params = {}, callback) ⇒ AWS.Request
Update the answer to a specific question in a workload review.

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

.
updateShareInvitation(params = {}, callback) ⇒ AWS.Request
Update a workload invitation.

.
updateWorkload(params = {}, callback) ⇒ AWS.Request
Update an existing workload.

.
updateWorkloadShare(params = {}, callback) ⇒ AWS.Request
Update a workload share.

.
upgradeLensReview(params = {}, callback) ⇒ AWS.Request
Upgrade lens review.

.

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

Property Details

endpoint ⇒ `AWS.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.

Service Reference:

AssociateLenses

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 AWS Region.
- LensAliases — (Array<String>)
  List of lens aliases to associate or disassociate with a workload.
  
  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.

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

Create a milestone for an existing workload.

Service Reference:

CreateMilestone

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 AWS 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 it 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 AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS 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 AWS 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.

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

Create a new workload.

The owner of a workload can share the workload with other AWS accounts and IAM users in the same AWS Region. Only the owner of a workload can delete it.

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

Service Reference:

CreateWorkload

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 */
  ],
  ReviewOwner: 'STRING_VALUE', /* required */
  WorkloadName: 'STRING_VALUE', /* required */
  AccountIds: [
    'STRING_VALUE',
    /* more items */
  ],
  ArchitecturalDesign: 'STRING_VALUE',
  AwsRegions: [
    'STRING_VALUE',
    /* more items */
  ],
  Industry: 'STRING_VALUE',
  IndustryType: 'STRING_VALUE',
  NonAwsRegions: [
    'STRING_VALUE',
    /* more items */
  ],
  Notes: 'STRING_VALUE',
  PillarPriorities: [
    '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 a 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 AWS account IDs associated with the workload.
- AwsRegions — (Array<String>)
  The list of AWS Regions associated with the workload, for example, us-east-2, or ca-central-1.
- NonAwsRegions — (Array<String>)
  The list of non-AWS 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.
- Notes — (String)
  The notes associated with the 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 it 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 AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS 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.

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 AWS 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 AWS accounts and IAM users in the same AWS Region. Shared access to a workload is not removed until the workload invitation is deleted.

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

Service Reference:

CreateWorkloadShare

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 AWS Region.
- SharedWith — (String)
  The AWS account ID or IAM role with which the workload is shared.
- PermissionType — (String)
  Permission granted on a workload share.
  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 it 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 AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS 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 AWS Region.
  - ShareId — (String)
    The ID associated with the workload share.

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:

DeleteWorkload

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 AWS 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 it 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 AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS 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:

DeleteWorkloadShare

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 workload share.
- WorkloadId — (String)
  The ID assigned to the workload. This ID is unique within an AWS 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 it 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 AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS 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.

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

Service Reference:

DisassociateLenses

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 AWS Region.
- LensAliases — (Array<String>)
  List of lens aliases to associate or disassociate with a workload.
  
  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.

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

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

Service Reference:

GetAnswer

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 AWS Region.
- LensAlias — (String)
  The alias of the lens, for example, serverless.
  
  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 AWS Region.
  - MilestoneNumber — (Integer)
    The milestone number.
    
    A workload can have a maximum of 100 milestones.
  - LensAlias — (String)
    The alias of the lens, for example, serverless.
    
    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.
    
    This value is only available if the question has been answered.
    
    HelpfulResourceUrl — (String)
    The helpful resource URL for a 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.
    
    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.
    
    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.

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

Get lens review.

Service Reference:

GetLensReview

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 AWS Region.
- LensAlias — (String)
  The alias of the lens, for example, serverless.
  
  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 AWS 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 example, serverless.
    
    Each lens is identified by its LensSummary$LensAlias.
    
    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"
    
    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.
    
    RiskCounts — (map<Integer>)
    A map from risk names to the count of how questions have that rating.
    
    UpdatedAt — (Date)
    The date and time recorded.
    
    Notes — (String)
    The notes associated with the workload.
    
    RiskCounts — (map<Integer>)
    A map from risk names to the count of how 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.

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

Get lens review report.

Service Reference:

GetLensReviewReport

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 AWS Region.
- LensAlias — (String)
  The alias of the lens, for example, serverless.
  
  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 AWS 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 example, serverless.
    
    Each lens is identified by its LensSummary$LensAlias.
    
    Base64String — (String)
    The Base64-encoded string representation of a lens review report.
    
    This data can be used to create a PDF file.

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:

GetLensVersionDifference

Examples:

Calling the getLensVersionDifference operation

var params = {
  BaseLensVersion: 'STRING_VALUE', /* required */
  LensAlias: 'STRING_VALUE' /* required */
};
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 example, serverless.
  
  Each lens is identified by its LensSummary$LensAlias.
- BaseLensVersion — (String)
  The base version 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:
  - LensAlias — (String)
    The alias of the lens, for example, serverless.
    
    Each lens is identified by its LensSummary$LensAlias.
  - BaseLensVersion — (String)
    The base version of 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.
    
    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:

GetMilestone

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 AWS 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 AWS 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 AWS Region.
    
    WorkloadArn — (String)
    The ARN for the workload.
    
    WorkloadName — (String)
    The name of the workload.
    
    The name must be unique within an account within a 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 AWS account IDs associated with the workload.
    
    AwsRegions — (Array<String>)
    The list of AWS Regions associated with the workload, for example, us-east-2, or ca-central-1.
    
    NonAwsRegions — (Array<String>)
    The list of non-AWS 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.
    
    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 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.
    
    Owner — (String)
    An AWS account ID.
    
    ShareInvitationId — (String)
    The ID assigned to the share invitation.
    
    Tags — (map<String>)
    The tags associated with the workload.

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:

GetWorkload

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 AWS 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 AWS Region.
    
    WorkloadArn — (String)
    The ARN for the workload.
    
    WorkloadName — (String)
    The name of the workload.
    
    The name must be unique within an account within a 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 AWS account IDs associated with the workload.
    
    AwsRegions — (Array<String>)
    The list of AWS Regions associated with the workload, for example, us-east-2, or ca-central-1.
    
    NonAwsRegions — (Array<String>)
    The list of non-AWS 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.
    
    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 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.
    
    Owner — (String)
    An AWS account ID.
    
    ShareInvitationId — (String)
    The ID assigned to the share invitation.
    
    Tags — (map<String>)
    The tags associated with the workload.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

List of answers.

Service Reference:

ListAnswers

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'
};
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 AWS Region.
- LensAlias — (String)
  The alias of the lens, for example, serverless.
  
  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.

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 AWS Region.
  - MilestoneNumber — (Integer)
    The milestone number.
    
    A workload can have a maximum of 100 milestones.
  - LensAlias — (String)
    The alias of the lens, for example, serverless.
    
    Each lens is identified by its LensSummary$LensAlias.
  - 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.
    
    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"
  - 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:

ListLenses

Examples:

Calling the listLenses operation

var params = {
  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.

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.
    
    LensAlias — (String)
    The alias of the lens, for example, serverless.
    
    Each lens is identified by its LensSummary$LensAlias.
    
    LensVersion — (String)
    The version of the lens.
    
    LensName — (String)
    The full name of the lens.
    
    Description — (String)
    The description of the lens.
  - 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:

ListLensReviewImprovements

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'
};
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 AWS Region.
- LensAlias — (String)
  The alias of the lens, for example, serverless.
  
  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.

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 AWS Region.
  - MilestoneNumber — (Integer)
    The milestone number.
    
    A workload can have a maximum of 100 milestones.
  - LensAlias — (String)
    The alias of the lens, for example, serverless.
    
    Each lens is identified by its LensSummary$LensAlias.
  - 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.
    
    This value is only available if the question has been answered.
  - 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.

Service Reference:

ListLensReviews

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 AWS 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 AWS 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 example, serverless.
    
    Each lens is identified by its LensSummary$LensAlias.
    
    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"
    
    UpdatedAt — (Date)
    The date and time recorded.
    
    RiskCounts — (map<Integer>)
    A map from risk names to the count of how 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.

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

List all milestones for an existing workload.

Service Reference:

ListMilestones

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 AWS 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 AWS 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 AWS Region.
    
    WorkloadArn — (String)
    The ARN for the workload.
    
    WorkloadName — (String)
    The name of the workload.
    
    The name must be unique within an account within a Region. Spaces and capitalization are ignored when checking for uniqueness.
    
    Owner — (String)
    An AWS 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.
    
    RiskCounts — (map<Integer>)
    A map from risk names to the count of how questions have that rating.
    
    ImprovementStatus — (String)
    The improvement status for a workload.
    Possible values include:
    
    "NOT_APPLICABLE"
    
    "NOT_STARTED"
    
    "IN_PROGRESS"
    
    "COMPLETE"
    
    "RISK_ACKNOWLEDGED"
  - 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:

ListNotifications

Examples:

Calling the listNotifications operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: '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 AWS 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>)
    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 AWS Region.
    
    WorkloadName — (String)
    The name of the workload.
    
    The name must be unique within an account within a Region. Spaces and capitalization are ignored when checking for uniqueness.
    
    LensAlias — (String)
    The alias of the lens, for example, serverless.
    
    Each lens is identified by its LensSummary$LensAlias.
    
    CurrentLensVersion — (String)
    The current version of the lens.
    
    LatestLensVersion — (String)
    The latest version of the lens.
  - 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 workload invitations.

Service Reference:

ListShareInvitations

Examples:

Calling the listShareInvitations operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: '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.
- 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:
  - ShareInvitationSummaries — (Array<map>)
    List of share invitation summaries in a workload.
    
    ShareInvitationId — (String)
    The ID assigned to the share invitation.
    
    SharedBy — (String)
    An AWS account ID.
    
    SharedWith — (String)
    The AWS account ID or IAM role with which the workload is shared.
    
    PermissionType — (String)
    Permission granted on a workload share.
    Possible values include:
    
    "READONLY"
    
    "CONTRIBUTOR"
    
    WorkloadName — (String)
    The name of the workload.
    
    The name must be unique within an account within a Region. Spaces and capitalization are ignored when checking for uniqueness.
    
    WorkloadId — (String)
    The ID assigned to the workload. This ID is unique within an AWS Region.
  - 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.

Service Reference:

ListTagsForResource

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.

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

List workloads. Paginated.

Service Reference:

ListWorkloads

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 AWS Region.
    
    WorkloadArn — (String)
    The ARN for the workload.
    
    WorkloadName — (String)
    The name of the workload.
    
    The name must be unique within an account within a Region. Spaces and capitalization are ignored when checking for uniqueness.
    
    Owner — (String)
    An AWS 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.
    
    RiskCounts — (map<Integer>)
    A map from risk names to the count of how questions have that rating.
    
    ImprovementStatus — (String)
    The improvement status for a workload.
    Possible values include:
    
    "NOT_APPLICABLE"
    
    "NOT_STARTED"
    
    "IN_PROGRESS"
    
    "COMPLETE"
    
    "RISK_ACKNOWLEDGED"
  - 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:

ListWorkloadShares

Examples:

Calling the listWorkloadShares operation

var params = {
  WorkloadId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SharedWithPrefix: 'STRING_VALUE'
};
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 AWS Region.
- SharedWithPrefix — (String)
  The AWS account ID or IAM role 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.

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 AWS Region.
  - WorkloadShareSummaries — (Array<map>)
    A list of workload share summaries.
    
    ShareId — (String)
    The ID associated with the workload share.
    
    SharedWith — (String)
    The AWS account ID or IAM role with which the workload is shared.
    
    PermissionType — (String)
    Permission granted on a workload share.
    Possible values include:
    
    "READONLY"
    
    "CONTRIBUTOR"
    
    Status — (String)
    The status of a workload share.
    Possible values include:
    
    "ACCEPTED"
    
    "REJECTED"
    
    "PENDING"
    
    "REVOKED"
    
    "EXPIRED"
  - 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.

Service Reference:

TagResource

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.

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

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

Service Reference:

UntagResource

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:

UpdateAnswer

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 AWS Region.
- LensAlias — (String)
  The alias of the lens, for example, serverless.
  
  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.
  - Status — required — (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.
- 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 AWS Region.
  - LensAlias — (String)
    The alias of the lens, for example, serverless.
    
    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.
    
    This value is only available if the question has been answered.
    
    HelpfulResourceUrl — (String)
    The helpful resource URL for a 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.
    
    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.
    
    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.

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

Update lens review.

Service Reference:

UpdateLensReview

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 AWS Region.
- LensAlias — (String)
  The alias of the lens, for example, serverless.
  
  Each lens is identified by its LensSummary$LensAlias.
- LensNotes — (String)
  The notes associated with the workload.
- PillarNotes — (map<String>)
  List of pillar notes of a lens review in a 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 AWS Region.
  - LensReview — (map)
    A lens review of a question.
    
    LensAlias — (String)
    The alias of the lens, for example, serverless.
    
    Each lens is identified by its LensSummary$LensAlias.
    
    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"
    
    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.
    
    RiskCounts — (map<Integer>)
    A map from risk names to the count of how questions have that rating.
    
    UpdatedAt — (Date)
    The date and time recorded.
    
    Notes — (String)
    The notes associated with the workload.
    
    RiskCounts — (map<Integer>)
    A map from risk names to the count of how 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.

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

Update a workload invitation.

Service Reference:

UpdateShareInvitation

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 share invitation.
    
    ShareInvitationId — (String)
    The ID assigned to the share invitation.
    
    WorkloadId — (String)
    The ID assigned to the workload. This ID is unique within an AWS Region.

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:

UpdateWorkload

Examples:

Calling the updateWorkload operation

var params = {
  WorkloadId: 'STRING_VALUE', /* required */
  AccountIds: [
    'STRING_VALUE',
    /* more items */
  ],
  ArchitecturalDesign: 'STRING_VALUE',
  AwsRegions: [
    'STRING_VALUE',
    /* more items */
  ],
  Description: 'STRING_VALUE',
  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 AWS Region.
- WorkloadName — (String)
  The name of the workload.
  
  The name must be unique within an account within a 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 AWS account IDs associated with the workload.
- AwsRegions — (Array<String>)
  The list of AWS Regions associated with the workload, for example, us-east-2, or ca-central-1.
- NonAwsRegions — (Array<String>)
  The list of non-AWS 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.
- ImprovementStatus — (String)
  The improvement status for a workload.
  Possible values include:
  - "NOT_APPLICABLE"
  - "NOT_STARTED"
  - "IN_PROGRESS"
  - "COMPLETE"
  - "RISK_ACKNOWLEDGED"

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 AWS Region.
    
    WorkloadArn — (String)
    The ARN for the workload.
    
    WorkloadName — (String)
    The name of the workload.
    
    The name must be unique within an account within a 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 AWS account IDs associated with the workload.
    
    AwsRegions — (Array<String>)
    The list of AWS Regions associated with the workload, for example, us-east-2, or ca-central-1.
    
    NonAwsRegions — (Array<String>)
    The list of non-AWS 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.
    
    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 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.
    
    Owner — (String)
    An AWS account ID.
    
    ShareInvitationId — (String)
    The ID assigned to the share invitation.
    
    Tags — (map<String>)
    The tags associated with the workload.

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:

UpdateWorkloadShare

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 workload share.
- WorkloadId — (String)
  The ID assigned to the workload. This ID is unique within an AWS Region.
- PermissionType — (String)
  Permission granted on a workload share.
  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 AWS Region.
  - WorkloadShare — (map)
    A workload share return object.
    
    ShareId — (String)
    The ID associated with the workload share.
    
    SharedBy — (String)
    An AWS account ID.
    
    SharedWith — (String)
    The AWS account ID or IAM role with which the workload is shared.
    
    PermissionType — (String)
    Permission granted on a workload share.
    Possible values include:
    
    "READONLY"
    
    "CONTRIBUTOR"
    
    Status — (String)
    The status of a workload share.
    Possible values include:
    
    "ACCEPTED"
    
    "REJECTED"
    
    "PENDING"
    
    "REVOKED"
    
    "EXPIRED"
    
    WorkloadName — (String)
    The name of the workload.
    
    The name must be unique within an account within a Region. Spaces and capitalization are ignored when checking for uniqueness.
    
    WorkloadId — (String)
    The ID assigned to the workload. This ID is unique within an AWS Region.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Upgrade lens review.

Service Reference:

UpgradeLensReview

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 AWS Region.
- LensAlias — (String)
  The alias of the lens, for example, serverless.
  
  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 it 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 AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS 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.

Class: AWS.WellArchitected

Overview

Service Description

Sending a Request Using WellArchitected

Locking the API Version

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

Method Summary collapse

Methods inherited from AWS.Service

Constructor Details

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

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Method Details

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

new AWS.WellArchitected(options = {}) ⇒ `Object`

endpoint ⇒ `AWS.Endpoint` (readwrite)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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