Class: AWS.WellArchitected

var params = {
  ProfileArns: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  WorkloadId: 'STRING_VALUE' /* required */
};
wellarchitected.associateProfiles(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • WorkloadId — (String)

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

  • ProfileArns — (Array<String>)

    The list of profile ARNs to associate with the workload.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

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

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  LensAlias: 'STRING_VALUE', /* required */
  SharedWith: 'STRING_VALUE' /* required */
};
wellarchitected.createLensShare(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • LensAlias — (String)

    The alias of the lens.

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

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

    Each lens is identified by its LensSummary$LensAlias.

  • SharedWith — (String)

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

  • ClientRequestToken — (String)

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

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

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

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ShareId — (String)

      The ID associated with the share.

Returns:

• (AWS.Request) —

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

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  LensAlias: 'STRING_VALUE', /* required */
  LensVersion: 'STRING_VALUE', /* required */
  IsMajorVersion: true || false
};
wellarchitected.createLensVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • LensAlias — (String)

    The alias of the lens.

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

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

    Each lens is identified by its LensSummary$LensAlias.

  • LensVersion — (String)

    The version of the lens being created.

  • IsMajorVersion — (Boolean)

    Set to true if this new major lens version.

  • ClientRequestToken — (String)

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

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

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

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • LensArn — (String)

      The ARN for the lens.

    • LensVersion — (String)

      The version of the lens.

Returns:

• (AWS.Request) —

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

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  MilestoneName: 'STRING_VALUE', /* required */
  WorkloadId: 'STRING_VALUE' /* required */
};
wellarchitected.createMilestone(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • WorkloadId — (String)

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

  • MilestoneName — (String)

    The name of the milestone in a workload.

    Milestone names must be unique within a workload.

  • ClientRequestToken — (String)

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

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

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

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • WorkloadId — (String)

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

    • MilestoneNumber — (Integer)

      The milestone number.

      A workload can have a maximum of 100 milestones.

Returns:

• (AWS.Request) —

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

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  ProfileDescription: 'STRING_VALUE', /* required */
  ProfileName: 'STRING_VALUE', /* required */
  ProfileQuestions: [ /* required */
    {
      QuestionId: 'STRING_VALUE',
      SelectedChoiceIds: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
wellarchitected.createProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ProfileName — (String)

    Name of the profile.

  • ProfileDescription — (String)

    The profile description.

  • ProfileQuestions — (Array<map>)

    The profile questions.

    • QuestionId — (String)

      The ID of the question.

    • SelectedChoiceIds — (Array<String>)

      The selected choices.

  • ClientRequestToken — (String)

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

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

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

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

    The tags assigned to the profile.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ProfileArn — (String)

      The profile ARN.

    • ProfileVersion — (String)

      Version of the profile.

Returns:

• (AWS.Request) —

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

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  ProfileArn: 'STRING_VALUE', /* required */
  SharedWith: 'STRING_VALUE' /* required */
};
wellarchitected.createProfileShare(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ProfileArn — (String)

    The profile ARN.

  • SharedWith — (String)

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

  • ClientRequestToken — (String)

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

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

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

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ShareId — (String)

      The ID associated with the share.

    • ProfileArn — (String)

      The profile ARN.

Returns:

• (AWS.Request) —

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

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE', /* required */
  Lenses: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  TemplateName: 'STRING_VALUE', /* required */
  Notes: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
wellarchitected.createReviewTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • TemplateName — (String)

    Name of the review template.

  • Description — (String)

    The review template description.

  • Lenses — (Array<String>)

    Lenses applied to the review template.

  • Notes — (String)

    The notes associated with the workload.

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

  • Tags — (map<String>)

    The tags assigned to the review template.

  • ClientRequestToken — (String)

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

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

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

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • TemplateArn — (String)

      The review template ARN.

Returns:

• (AWS.Request) —

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

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  SharedWith: 'STRING_VALUE', /* required */
  TemplateArn: 'STRING_VALUE' /* required */
};
wellarchitected.createTemplateShare(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • TemplateArn — (String)

    The review template ARN.

  • SharedWith — (String)

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

  • ClientRequestToken — (String)

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

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

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

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • TemplateArn — (String)

      The review template ARN.

    • ShareId — (String)

      The ID associated with the share.

Returns:

• (AWS.Request) —

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

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE', /* required */
  Environment: PRODUCTION | PREPRODUCTION, /* required */
  Lenses: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  WorkloadName: 'STRING_VALUE', /* required */
  AccountIds: [
    'STRING_VALUE',
    /* more items */
  ],
  Applications: [
    'STRING_VALUE',
    /* more items */
  ],
  ArchitecturalDesign: 'STRING_VALUE',
  AwsRegions: [
    'STRING_VALUE',
    /* more items */
  ],
  DiscoveryConfig: {
    TrustedAdvisorIntegrationStatus: ENABLED | DISABLED,
    WorkloadResourceDefinition: [
      WORKLOAD_METADATA | APP_REGISTRY,
      /* more items */
    ]
  },
  Industry: 'STRING_VALUE',
  IndustryType: 'STRING_VALUE',
  JiraConfiguration: {
    IssueManagementStatus: ENABLED | DISABLED | INHERIT,
    IssueManagementType: AUTO | MANUAL,
    JiraProjectKey: 'STRING_VALUE'
  },
  NonAwsRegions: [
    'STRING_VALUE',
    /* more items */
  ],
  Notes: 'STRING_VALUE',
  PillarPriorities: [
    'STRING_VALUE',
    /* more items */
  ],
  ProfileArns: [
    'STRING_VALUE',
    /* more items */
  ],
  ReviewOwner: 'STRING_VALUE',
  ReviewTemplateArns: [
    'STRING_VALUE',
    /* more items */
  ],
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
wellarchitected.createWorkload(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • WorkloadName — (String)

    The name of the workload.

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

  • Description — (String)

    The description for the workload.

  • Environment — (String)

    The environment for the workload.

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

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

  • AwsRegions — (Array<String>)

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

  • NonAwsRegions — (Array<String>)

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

  • PillarPriorities — (Array<String>)

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

  • ArchitecturalDesign — (String)

    The URL of the architectural design for the workload.

  • ReviewOwner — (String)

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

  • IndustryType — (String)

    The industry type for the workload.

    If specified, must be one of the following:

    • Agriculture

    • Automobile

    • Defense

    • Design and Engineering

    • Digital Advertising

    • Education

    • Environmental Protection

    • Financial Services

    • Gaming

    • General Public Services

    • Healthcare

    • Hospitality

    • InfoTech

    • Justice and Public Safety

    • Life Sciences

    • Manufacturing

    • Media & Entertainment

    • Mining & Resources

    • Oil & Gas

    • Power & Utilities

    • Professional Services

    • Real Estate & Construction

    • Retail & Wholesale

    • Social Protection

    • Telecommunications

    • Travel, Transportation & Logistics

    • Other

  • Industry — (String)

    The industry for the workload.

  • Lenses — (Array<String>)

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

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

  • Notes — (String)

    The notes associated with the workload.

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

  • ClientRequestToken — (String)

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

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

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

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

    The tags to be associated with the workload.

  • DiscoveryConfig — (map)

    Well-Architected discovery configuration settings associated to the workload.

    • TrustedAdvisorIntegrationStatus — (String)

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

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

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

      You can specify WORKLOAD_METADATA, APP_REGISTRY, or both.

  • Applications — (Array<String>)

    List of AppRegistry application ARNs associated to the workload.

  • ProfileArns — (Array<String>)

    The list of profile ARNs associated with the workload.

  • ReviewTemplateArns — (Array<String>)

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

  • JiraConfiguration — (map)

    Jira configuration settings when creating a workload.

    • IssueManagementStatus — (String)

      Workload-level: Jira issue management status.

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

      Workload-level: Jira issue management type.

      Possible values include:
      • "AUTO"
      • "MANUAL"
    • JiraProjectKey — (String)

      Workload-level: Jira project key to sync workloads to.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • WorkloadId — (String)

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

    • WorkloadArn — (String)

      The ARN for the workload.

Returns:

• (AWS.Request) —

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

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  PermissionType: READONLY | CONTRIBUTOR, /* required */
  SharedWith: 'STRING_VALUE', /* required */
  WorkloadId: 'STRING_VALUE' /* required */
};
wellarchitected.createWorkloadShare(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • WorkloadId — (String)

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

  • SharedWith — (String)

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

  • PermissionType — (String)

    Permission granted on a share request.

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

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

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

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

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • WorkloadId — (String)

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

    • ShareId — (String)

      The ID associated with the share.

Returns:

• (AWS.Request) —

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

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  LensAlias: 'STRING_VALUE', /* required */
  LensStatus: ALL | DRAFT | PUBLISHED /* required */
};
wellarchitected.deleteLens(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • LensAlias — (String)

    The alias of the lens.

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

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

    Each lens is identified by its LensSummary$LensAlias.

  • ClientRequestToken — (String)

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

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

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

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

    The status of the lens to be deleted.

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

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

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  LensAlias: 'STRING_VALUE', /* required */
  ShareId: 'STRING_VALUE' /* required */
};
wellarchitected.deleteLensShare(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ShareId — (String)

    The ID associated with the share.

  • LensAlias — (String)

    The alias of the lens.

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

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

    Each lens is identified by its LensSummary$LensAlias.

  • ClientRequestToken — (String)

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

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

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

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

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

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  ProfileArn: 'STRING_VALUE' /* required */
};
wellarchitected.deleteProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ProfileArn — (String)

    The profile ARN.

  • ClientRequestToken — (String)

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

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

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

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

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

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  ProfileArn: 'STRING_VALUE', /* required */
  ShareId: 'STRING_VALUE' /* required */
};
wellarchitected.deleteProfileShare(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ShareId — (String)

    The ID associated with the share.

  • ProfileArn — (String)

    The profile ARN.

  • ClientRequestToken — (String)

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

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

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

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

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

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  TemplateArn: 'STRING_VALUE' /* required */
};
wellarchitected.deleteReviewTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • TemplateArn — (String)

    The review template ARN.

  • ClientRequestToken — (String)

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

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

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

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

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

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  ShareId: 'STRING_VALUE', /* required */
  TemplateArn: 'STRING_VALUE' /* required */
};
wellarchitected.deleteTemplateShare(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ShareId — (String)

    The ID associated with the share.

  • TemplateArn — (String)

    The review template ARN.

  • ClientRequestToken — (String)

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

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

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

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

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

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  WorkloadId: 'STRING_VALUE' /* required */
};
wellarchitected.deleteWorkload(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • WorkloadId — (String)

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

  • ClientRequestToken — (String)

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

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

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

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

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

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  ShareId: 'STRING_VALUE', /* required */
  WorkloadId: 'STRING_VALUE' /* required */
};
wellarchitected.deleteWorkloadShare(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ShareId — (String)

    The ID associated with the share.

  • WorkloadId — (String)

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

  • ClientRequestToken — (String)

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

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

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

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

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

var params = {
  LensAliases: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  WorkloadId: 'STRING_VALUE' /* required */
};
wellarchitected.disassociateLenses(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • WorkloadId — (String)

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

  • LensAliases — (Array<String>)

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

    Identify a lens using its LensSummary$LensAlias.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

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

var params = {
  ProfileArns: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  WorkloadId: 'STRING_VALUE' /* required */
};
wellarchitected.disassociateProfiles(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • WorkloadId — (String)

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

  • ProfileArns — (Array<String>)

    The list of profile ARNs to disassociate from the workload.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

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

var params = {
  LensAlias: 'STRING_VALUE', /* required */
  LensVersion: 'STRING_VALUE'
};
wellarchitected.exportLens(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • LensAlias — (String)

    The alias of the lens.

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

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

    Each lens is identified by its LensSummary$LensAlias.

  • LensVersion — (String)

    The lens version to be exported.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • LensJSON — (String)

      The JSON representation of a lens.

Returns:

• (AWS.Request) —

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

var params = {
  LensAlias: 'STRING_VALUE', /* required */
  QuestionId: 'STRING_VALUE', /* required */
  WorkloadId: 'STRING_VALUE', /* required */
  MilestoneNumber: 'NUMBER_VALUE'
};
wellarchitected.getAnswer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • WorkloadId — (String)

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

  • LensAlias — (String)

    The alias of the lens.

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

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

    Each lens is identified by its LensSummary$LensAlias.

  • QuestionId — (String)

    The ID of the question.

  • MilestoneNumber — (Integer)

    The milestone number.

    A workload can have a maximum of 100 milestones.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • WorkloadId — (String)

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

    • MilestoneNumber — (Integer)

      The milestone number.

      A workload can have a maximum of 100 milestones.

    • LensAlias — (String)

      The alias of the lens.

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

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

      Each lens is identified by its LensSummary$LensAlias.

    • LensArn — (String)

      The ARN for the lens.

    • Answer — (map)

      An answer of the question.

      • QuestionId — (String)

        The ID of the question.

      • PillarId — (String)

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

        A pillar is identified by its PillarReviewSummary$PillarId.

      • QuestionTitle — (String)

        The title of the question.

      • QuestionDescription — (String)

        The description of the question.

      • ImprovementPlanUrl — (String)

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

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

        This value does not apply to custom lenses.

      • HelpfulResourceUrl — (String)

        The helpful resource URL.

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

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

      • HelpfulResourceDisplayText — (String)

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

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

      • Choices — (Array<map>)

        List of choices available for a question.

        • ChoiceId — (String)

          The ID of a choice.

        • Title — (String)

          The title of a choice.

        • Description — (String)

          The description of a choice.

        • HelpfulResource — (map)

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

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

          • DisplayText — (String)

            The display text for the choice content.

          • Url — (String)

            The URL for the choice content.

        • ImprovementPlan — (map)

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

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

          • DisplayText — (String)

            The display text for the choice content.

          • Url — (String)

            The URL for the choice content.

        • AdditionalResources — (Array<map>)

          The additional resources for a choice in a custom lens.

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

          • Type — (String)

            Type of additional resource for a custom lens.

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

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

            • DisplayText — (String)

              The display text for the choice content.

            • Url — (String)

              The URL for the choice content.

      • SelectedChoices — (Array<String>)

        List of selected choice IDs in a question answer.

        The values entered replace the previously selected choices.

      • ChoiceAnswers — (Array<map>)

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

        • ChoiceId — (String)

          The ID of a choice.

        • Status — (String)

          The status of a choice.

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

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

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

          The notes associated with a choice.

      • IsApplicable — (Boolean)

        Defines whether this question is applicable to a lens review.

      • Risk — (String)

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

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

        The notes associated with the workload.

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

      • Reason — (String)

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

        Possible values include:
        • "OUT_OF_SCOPE"
        • "BUSINESS_PRIORITIES"
        • "ARCHITECTURE_CONSTRAINTS"
        • "OTHER"
        • "NONE"
      • JiraConfiguration — (map)

        Configuration of the Jira integration.

        • JiraIssueUrl — (String)

          The URL of the associated Jira issue.

        • LastSyncedTime — (Date)

          The date and time recorded.

Returns:

• (AWS.Request) —

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

var params = {
  Format: PDF | JSON, /* required */
  IncludeSharedResources: true || false,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
wellarchitected.getConsolidatedReport(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Format — (String)

    The format of the consolidated report.

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

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

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

  • NextToken — (String)

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

  • MaxResults — (Integer)

    The maximum number of results to return for this request.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Metrics — (Array<map>)

      The metrics that make up the consolidated report.

      Only returned when JSON format is requested.

      • MetricType — (String)

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

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

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

      • WorkloadId — (String)

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

      • WorkloadName — (String)

        The name of the workload.

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

      • WorkloadArn — (String)

        The ARN for the workload.

      • UpdatedAt — (Date)

        The date and time recorded.

      • Lenses — (Array<map>)

        The metrics for the lenses in the workload.

        • LensArn — (String)

          The lens ARN.

        • Pillars — (Array<map>)

          The metrics for the pillars in a lens.

          • PillarId — (String)

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

            A pillar is identified by its PillarReviewSummary$PillarId.

          • RiskCounts — (map<Integer>)

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

          • Questions — (Array<map>)

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

            • QuestionId — (String)

              The ID of the question.

            • Risk — (String)

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

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

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

              • ChoiceId — (String)

                The ID of a choice.

              • ChoiceTitle — (String)

                The title of a choice.

        • RiskCounts — (map<Integer>)

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

      • LensesAppliedCount — (Integer)

        The total number of lenses applied to the workload.

    • NextToken — (String)

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

    • Base64String — (String)

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

      This data can be used to create a PDF file.

      Only returned by GetConsolidatedReport when PDF format is requested.

Returns:

• (AWS.Request) —

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

wellarchitected.getGlobalSettings(function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {})

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • OrganizationSharingStatus — (String)

      Amazon Web Services Organizations sharing status.

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

      Discovery integration status.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
    • JiraConfiguration — (map)

      Jira configuration status.

      • IntegrationStatus — (String)

        Account-level: Configuration status of the Jira integration.

        Possible values include:
        • "CONFIGURED"
        • "NOT_CONFIGURED"
      • IssueManagementStatus — (String)

        Account-level: Jira issue management status.

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

        Account-level: Jira issue management type.

        Possible values include:
        • "AUTO"
        • "MANUAL"
      • Subdomain — (String)

        Account-level: Jira subdomain URL.

      • JiraProjectKey — (String)

        Account-level: Jira project key to sync workloads to.

      • StatusMessage — (String)

        Account-level: Status message on configuration of the Jira integration.

Returns:

• (AWS.Request) —

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

var params = {
  LensAlias: 'STRING_VALUE', /* required */
  LensVersion: 'STRING_VALUE'
};
wellarchitected.getLens(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • LensAlias — (String)

    The alias of the lens.

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

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

    Each lens is identified by its LensSummary$LensAlias.

  • LensVersion — (String)

    The lens version to be retrieved.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Lens — (map)

      A lens return object.

      • LensArn — (String)

        The ARN of a lens.

      • LensVersion — (String)

        The version of a lens.

      • Name — (String)

        The full name of the lens.

      • Description — (String)

        The description of the lens.

      • Owner — (String)

        The Amazon Web Services account ID that owns the lens.

      • ShareInvitationId — (String)

        The ID assigned to the share invitation.

      • Tags — (map<String>)

        The tags assigned to the lens.

Returns:

• (AWS.Request) —

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

var params = {
  LensAlias: 'STRING_VALUE', /* required */
  WorkloadId: 'STRING_VALUE', /* required */
  MilestoneNumber: 'NUMBER_VALUE'
};
wellarchitected.getLensReview(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • WorkloadId — (String)

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

  • LensAlias — (String)

    The alias of the lens.

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

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

    Each lens is identified by its LensSummary$LensAlias.

  • MilestoneNumber — (Integer)

    The milestone number.

    A workload can have a maximum of 100 milestones.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • WorkloadId — (String)

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

    • MilestoneNumber — (Integer)

      The milestone number.

      A workload can have a maximum of 100 milestones.

    • LensReview — (map)

      A lens review of a question.

      • LensAlias — (String)

        The alias of the lens.

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

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

        Each lens is identified by its LensSummary$LensAlias.

      • LensArn — (String)

        The ARN for the lens.

      • LensVersion — (String)

        The version of the lens.

      • LensName — (String)

        The full name of the lens.

      • LensStatus — (String)

        The status of the lens.

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

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

        • PillarId — (String)

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

          A pillar is identified by its PillarReviewSummary$PillarId.

        • PillarName — (String)

          The name of the pillar.

        • Notes — (String)

          The notes associated with the workload.

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

        • RiskCounts — (map<Integer>)

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

        • PrioritizedRiskCounts — (map<Integer>)

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

      • JiraConfiguration — (map)

        Jira configuration status of the Lens review.

        • SelectedPillars — (Array<map>)

          Selected pillars in the workload.

          • PillarId — (String)

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

            A pillar is identified by its PillarReviewSummary$PillarId.

          • SelectedQuestionIds — (Array<String>)

            Selected question IDs in the selected pillar.

      • UpdatedAt — (Date)

        The date and time recorded.

      • Notes — (String)

        The notes associated with the workload.

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

      • RiskCounts — (map<Integer>)

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

      • NextToken — (String)

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

      • Profiles — (Array<map>)

        The profiles associated with the workload.

        • ProfileArn — (String)

          The profile ARN.

        • ProfileVersion — (String)

          The profile version.

      • PrioritizedRiskCounts — (map<Integer>)

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

Returns:

• (AWS.Request) —

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

var params = {
  LensAlias: 'STRING_VALUE', /* required */
  WorkloadId: 'STRING_VALUE', /* required */
  MilestoneNumber: 'NUMBER_VALUE'
};
wellarchitected.getLensReviewReport(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • WorkloadId — (String)

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

  • LensAlias — (String)

    The alias of the lens.

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

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

    Each lens is identified by its LensSummary$LensAlias.

  • MilestoneNumber — (Integer)

    The milestone number.

    A workload can have a maximum of 100 milestones.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • WorkloadId — (String)

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

    • MilestoneNumber — (Integer)

      The milestone number.

      A workload can have a maximum of 100 milestones.

    • LensReviewReport — (map)

      A report of a lens review.

      • LensAlias — (String)

        The alias of the lens.

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

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

        Each lens is identified by its LensSummary$LensAlias.

      • LensArn — (String)

        The ARN for the lens.

      • Base64String — (String)

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

        This data can be used to create a PDF file.

        Only returned by GetConsolidatedReport when PDF format is requested.

Returns:

• (AWS.Request) —

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

var params = {
  LensAlias: 'STRING_VALUE', /* required */
  BaseLensVersion: 'STRING_VALUE',
  TargetLensVersion: 'STRING_VALUE'
};
wellarchitected.getLensVersionDifference(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • LensAlias — (String)

    The alias of the lens.

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

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

    Each lens is identified by its LensSummary$LensAlias.

  • BaseLensVersion — (String)

    The base version of the lens.

  • TargetLensVersion — (String)

    The lens version to target a difference for.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • LensAlias — (String)

      The alias of the lens.

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

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

      Each lens is identified by its LensSummary$LensAlias.

    • LensArn — (String)

      The ARN for the lens.

    • BaseLensVersion — (String)

      The base version of the lens.

    • TargetLensVersion — (String)

      The target lens version for the lens.

    • LatestLensVersion — (String)

      The latest version of the lens.

    • VersionDifferences — (map)

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

      • PillarDifferences — (Array<map>)

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

        • PillarId — (String)

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

          A pillar is identified by its PillarReviewSummary$PillarId.

        • PillarName — (String)

          The name of the pillar.

        • DifferenceStatus — (String)

          Indicates the type of change to the pillar.

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

          List of question differences.

          • QuestionId — (String)

            The ID of the question.

          • QuestionTitle — (String)

            The title of the question.

          • DifferenceStatus — (String)

            Indicates the type of change to the question.

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

Returns:

• (AWS.Request) —

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

var params = {
  MilestoneNumber: 'NUMBER_VALUE', /* required */
  WorkloadId: 'STRING_VALUE' /* required */
};
wellarchitected.getMilestone(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • WorkloadId — (String)

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

  • MilestoneNumber — (Integer)

    The milestone number.

    A workload can have a maximum of 100 milestones.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • WorkloadId — (String)

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

    • Milestone — (map)

      A milestone return object.

      • MilestoneNumber — (Integer)

        The milestone number.

        A workload can have a maximum of 100 milestones.

      • MilestoneName — (String)

        The name of the milestone in a workload.

        Milestone names must be unique within a workload.

      • RecordedAt — (Date)

        The date and time recorded.

      • Workload — (map)

        A workload return object.

        • WorkloadId — (String)

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

        • WorkloadArn — (String)

          The ARN for the workload.

        • WorkloadName — (String)

          The name of the workload.

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

        • Description — (String)

          The description for the workload.

        • Environment — (String)

          The environment for the workload.

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

          The date and time recorded.

        • AccountIds — (Array<String>)

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

        • AwsRegions — (Array<String>)

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

        • NonAwsRegions — (Array<String>)

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

        • ArchitecturalDesign — (String)

          The URL of the architectural design for the workload.

        • ReviewOwner — (String)

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

        • ReviewRestrictionDate — (Date)

          The date and time recorded.

        • IsReviewOwnerUpdateAcknowledged — (Boolean)

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

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

        • IndustryType — (String)

          The industry type for the workload.

          If specified, must be one of the following:

          • Agriculture

          • Automobile

          • Defense

          • Design and Engineering

          • Digital Advertising

          • Education

          • Environmental Protection

          • Financial Services

          • Gaming

          • General Public Services

          • Healthcare

          • Hospitality

          • InfoTech

          • Justice and Public Safety

          • Life Sciences

          • Manufacturing

          • Media & Entertainment

          • Mining & Resources

          • Oil & Gas

          • Power & Utilities

          • Professional Services

          • Real Estate & Construction

          • Retail & Wholesale

          • Social Protection

          • Telecommunications

          • Travel, Transportation & Logistics

          • Other

        • Industry — (String)

          The industry for the workload.

        • Notes — (String)

          The notes associated with the workload.

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

        • ImprovementStatus — (String)

          The improvement status for a workload.

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

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

        • PillarPriorities — (Array<String>)

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

        • Lenses — (Array<String>)

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

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

        • Owner — (String)

          An Amazon Web Services account ID.

        • ShareInvitationId — (String)

          The ID assigned to the share invitation.

        • Tags — (map<String>)

          The tags associated with the workload.

        • DiscoveryConfig — (map)

          Discovery configuration associated to the workload.

          • TrustedAdvisorIntegrationStatus — (String)

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

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

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

            You can specify WORKLOAD_METADATA, APP_REGISTRY, or both.

        • Applications — (Array<String>)

          List of AppRegistry application ARNs associated to the workload.

        • Profiles — (Array<map>)

          Profile associated with a workload.

          • ProfileArn — (String)

            The profile ARN.

          • ProfileVersion — (String)

            The profile version.

        • PrioritizedRiskCounts — (map<Integer>)

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

        • JiraConfiguration — (map)

          Jira configuration for a specific workload.

          • IssueManagementStatus — (String)

            Workload-level: Jira issue management status.

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

            Workload-level: Jira issue management type.

            Possible values include:
            • "AUTO"
            • "MANUAL"
          • JiraProjectKey — (String)

            Workload-level: Jira project key to sync workloads to.

          • StatusMessage — (String)

            Workload-level: Status message on configuration of the Jira integration.

Returns:

• (AWS.Request) —

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

var params = {
  ProfileArn: 'STRING_VALUE', /* required */
  ProfileVersion: 'STRING_VALUE'
};
wellarchitected.getProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ProfileArn — (String)

    The profile ARN.

  • ProfileVersion — (String)

    The profile version.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Profile — (map)

      The profile.

      • ProfileArn — (String)

        The profile ARN.

      • ProfileVersion — (String)

        The profile version.

      • ProfileName — (String)

        The profile name.

      • ProfileDescription — (String)

        The profile description.

      • ProfileQuestions — (Array<map>)

        Profile questions.

        • QuestionId — (String)

          The ID of the question.

        • QuestionTitle — (String)

          The title of the question.

        • QuestionDescription — (String)

          The description of the question.

        • QuestionChoices — (Array<map>)

          The question choices.

          • ChoiceId — (String)

            The ID of a choice.

          • ChoiceTitle — (String)

            The title of a choice.

          • ChoiceDescription — (String)

            The description of a choice.

        • SelectedChoiceIds — (Array<String>)

          The selected choices.

        • MinSelectedChoices — (Integer)

          The minimum number of selected choices.

        • MaxSelectedChoices — (Integer)

          The maximum number of selected choices.

      • Owner — (String)

        An Amazon Web Services account ID.

      • CreatedAt — (Date)

        The date and time recorded.

      • UpdatedAt — (Date)

        The date and time recorded.

      • ShareInvitationId — (String)

        The ID assigned to the share invitation.

      • Tags — (map<String>)

        The tags assigned to the profile.

Returns:

• (AWS.Request) —

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

var params = {
};
wellarchitected.getProfileTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {})

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ProfileTemplate — (map)

      The profile template.

      • TemplateName — (String)

        The name of the profile template.

      • TemplateQuestions — (Array<map>)

        Profile template questions.

        • QuestionId — (String)

          The ID of the question.

        • QuestionTitle — (String)

          The title of the question.

        • QuestionDescription — (String)

          The description of the question.

        • QuestionChoices — (Array<map>)

          The question choices.

          • ChoiceId — (String)

            The ID of a choice.

          • ChoiceTitle — (String)

            The title of a choice.

          • ChoiceDescription — (String)

            The description of a choice.

        • MinSelectedChoices — (Integer)

          The minimum number of choices selected.

        • MaxSelectedChoices — (Integer)

          The maximum number of choices selected.

      • CreatedAt — (Date)

        The date and time recorded.

      • UpdatedAt — (Date)

        The date and time recorded.

Returns:

• (AWS.Request) —

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

var params = {
  TemplateArn: 'STRING_VALUE' /* required */
};
wellarchitected.getReviewTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • TemplateArn — (String)

    The review template ARN.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ReviewTemplate — (map)

      The review template.

      • Description — (String)

        The review template description.

      • Lenses — (Array<String>)

        The lenses applied to the review template.

      • Notes — (String)

        The notes associated with the workload.

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

      • QuestionCounts — (map<Integer>)

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

      • Owner — (String)

        An Amazon Web Services account ID.

      • UpdatedAt — (Date)

        The date and time recorded.

      • TemplateArn — (String)

        The review template ARN.

      • TemplateName — (String)

        The name of the review template.

      • Tags — (map<String>)

        The tags assigned to the review template.

      • UpdateStatus — (String)

        The latest status of a review template.

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

        The ID assigned to the template share invitation.

Returns:

• (AWS.Request) —

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

var params = {
  LensAlias: 'STRING_VALUE', /* required */
  QuestionId: 'STRING_VALUE', /* required */
  TemplateArn: 'STRING_VALUE' /* required */
};
wellarchitected.getReviewTemplateAnswer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • TemplateArn — (String)

    The review template ARN.

  • LensAlias — (String)

    The alias of the lens.

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

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

    Each lens is identified by its LensSummary$LensAlias.

  • QuestionId — (String)

    The ID of the question.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • TemplateArn — (String)

      The review template ARN.

    • LensAlias — (String)

      The alias of the lens.

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

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

      Each lens is identified by its LensSummary$LensAlias.

    • Answer — (map)

      An answer of the question.

      • QuestionId — (String)

        The ID of the question.

      • PillarId — (String)

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

        A pillar is identified by its PillarReviewSummary$PillarId.

      • QuestionTitle — (String)

        The title of the question.

      • QuestionDescription — (String)

        The description of the question.

      • ImprovementPlanUrl — (String)

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

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

        This value does not apply to custom lenses.

      • HelpfulResourceUrl — (String)

        The helpful resource URL.

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

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

      • HelpfulResourceDisplayText — (String)

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

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

        List of choices available for a question.

        • ChoiceId — (String)

          The ID of a choice.

        • Title — (String)

          The title of a choice.

        • Description — (String)

          The description of a choice.

        • HelpfulResource — (map)

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

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

          • DisplayText — (String)

            The display text for the choice content.

          • Url — (String)

            The URL for the choice content.

        • ImprovementPlan — (map)

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

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

          • DisplayText — (String)

            The display text for the choice content.

          • Url — (String)

            The URL for the choice content.

        • AdditionalResources — (Array<map>)

          The additional resources for a choice in a custom lens.

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

          • Type — (String)

            Type of additional resource for a custom lens.

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

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

            • DisplayText — (String)

              The display text for the choice content.

            • Url — (String)

              The URL for the choice content.

      • SelectedChoices — (Array<String>)

        List of selected choice IDs in a question answer.

        The values entered replace the previously selected choices.

      • ChoiceAnswers — (Array<map>)

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

        • ChoiceId — (String)

          The ID of a choice.

        • Status — (String)

          The status of a choice.

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

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

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

          The notes associated with a choice.

      • IsApplicable — (Boolean)

        Defines whether this question is applicable to a lens review.

      • AnswerStatus — (String)

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

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

        The notes associated with the workload.

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

      • Reason — (String)

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

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

Returns:

• (AWS.Request) —

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

var params = {
  LensAlias: 'STRING_VALUE', /* required */
  TemplateArn: 'STRING_VALUE' /* required */
};
wellarchitected.getReviewTemplateLensReview(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • TemplateArn — (String)

    The review template ARN.

  • LensAlias — (String)

    The alias of the lens.

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

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

    Each lens is identified by its LensSummary$LensAlias.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • TemplateArn — (String)

      The review template ARN.

    • LensReview — (map)

      A lens review of a question.

      • LensAlias — (String)

        The alias of the lens.

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

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

        Each lens is identified by its LensSummary$LensAlias.

      • LensArn — (String)

        The lens ARN.

      • LensVersion — (String)

        The version of the lens.

      • LensName — (String)

        The full name of the lens.

      • LensStatus — (String)

        The status of the lens.

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

        Pillar review summaries of a lens review.

        • PillarId — (String)

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

          A pillar is identified by its PillarReviewSummary$PillarId.

        • PillarName — (String)

          The name of the pillar.

        • Notes — (String)

          The notes associated with the workload.

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

        • QuestionCounts — (map<Integer>)

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

      • UpdatedAt — (Date)

        The date and time recorded.

      • Notes — (String)

        The notes associated with the workload.

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

      • QuestionCounts — (map<Integer>)

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

      • NextToken — (String)

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

Returns:

• (AWS.Request) —

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

var params = {
  WorkloadId: 'STRING_VALUE' /* required */
};
wellarchitected.getWorkload(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • WorkloadId — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Workload — (map)

      A workload return object.

      • WorkloadId — (String)

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

      • WorkloadArn — (String)

        The ARN for the workload.

      • WorkloadName — (String)

        The name of the workload.

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

      • Description — (String)

        The description for the workload.

      • Environment — (String)

        The environment for the workload.

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

        The date and time recorded.

      • AccountIds — (Array<String>)

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

      • AwsRegions — (Array<String>)

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

      • NonAwsRegions — (Array<String>)

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

      • ArchitecturalDesign — (String)

        The URL of the architectural design for the workload.

      • ReviewOwner — (String)

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

      • ReviewRestrictionDate — (Date)

        The date and time recorded.

      • IsReviewOwnerUpdateAcknowledged — (Boolean)

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

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

      • IndustryType — (String)

        The industry type for the workload.

        If specified, must be one of the following:

        • Agriculture

        • Automobile

        • Defense

        • Design and Engineering

        • Digital Advertising

        • Education

        • Environmental Protection

        • Financial Services

        • Gaming

        • General Public Services

        • Healthcare

        • Hospitality

        • InfoTech

        • Justice and Public Safety

        • Life Sciences

        • Manufacturing

        • Media & Entertainment

        • Mining & Resources

        • Oil & Gas

        • Power & Utilities

        • Professional Services

        • Real Estate & Construction

        • Retail & Wholesale

        • Social Protection

        • Telecommunications

        • Travel, Transportation & Logistics

        • Other

      • Industry — (String)

        The industry for the workload.

      • Notes — (String)

        The notes associated with the workload.

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

      • ImprovementStatus — (String)

        The improvement status for a workload.

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

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

      • PillarPriorities — (Array<String>)

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

      • Lenses — (Array<String>)

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

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

      • Owner — (String)

        An Amazon Web Services account ID.

      • ShareInvitationId — (String)

        The ID assigned to the share invitation.

      • Tags — (map<String>)

        The tags associated with the workload.

      • DiscoveryConfig — (map)

        Discovery configuration associated to the workload.

        • TrustedAdvisorIntegrationStatus — (String)

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

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

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

          You can specify WORKLOAD_METADATA, APP_REGISTRY, or both.

      • Applications — (Array<String>)

        List of AppRegistry application ARNs associated to the workload.

      • Profiles — (Array<map>)

        Profile associated with a workload.

        • ProfileArn — (String)

          The profile ARN.

        • ProfileVersion — (String)

          The profile version.

      • PrioritizedRiskCounts — (map<Integer>)

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

      • JiraConfiguration — (map)

        Jira configuration for a specific workload.

        • IssueManagementStatus — (String)

          Workload-level: Jira issue management status.

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

          Workload-level: Jira issue management type.

          Possible values include:
          • "AUTO"
          • "MANUAL"
        • JiraProjectKey — (String)

          Workload-level: Jira project key to sync workloads to.

        • StatusMessage — (String)

          Workload-level: Status message on configuration of the Jira integration.

Returns:

• (AWS.Request) —

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

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  JSONString: 'STRING_VALUE', /* required */
  LensAlias: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
wellarchitected.importLens(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • LensAlias — (String)

    The alias of the lens.

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

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

    Each lens is identified by its LensSummary$LensAlias.

  • JSONString — (String)

    The JSON representation of a lens.

  • ClientRequestToken — (String)

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

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

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

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

    Tags to associate to a lens.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • LensArn — (String)

      The ARN for the lens that was created or updated.

    • Status — (String)

      The status of the imported lens.

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

Returns:

• (AWS.Request) —

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

var params = {
  LensAlias: 'STRING_VALUE', /* required */
  WorkloadId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  MilestoneNumber: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  PillarId: 'STRING_VALUE',
  QuestionPriority: PRIORITIZED | NONE
};
wellarchitected.listAnswers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • WorkloadId — (String)

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

  • LensAlias — (String)

    The alias of the lens.

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

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

    Each lens is identified by its LensSummary$LensAlias.

  • PillarId — (String)

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

    A pillar is identified by its PillarReviewSummary$PillarId.

  • MilestoneNumber — (Integer)

    The milestone number.

    A workload can have a maximum of 100 milestones.

  • NextToken — (String)

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

  • MaxResults — (Integer)

    The maximum number of results to return for this request.

  • QuestionPriority — (String)

    The priority of the question.

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • WorkloadId — (String)

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

    • MilestoneNumber — (Integer)

      The milestone number.

      A workload can have a maximum of 100 milestones.

    • LensAlias — (String)

      The alias of the lens.

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

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

      Each lens is identified by its LensSummary$LensAlias.

    • LensArn — (String)

      The ARN for the lens.

    • AnswerSummaries — (Array<map>)

      List of answer summaries of lens review in a workload.

      • QuestionId — (String)

        The ID of the question.

      • PillarId — (String)

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

        A pillar is identified by its PillarReviewSummary$PillarId.

      • QuestionTitle — (String)

        The title of the question.

      • Choices — (Array<map>)

        List of choices available for a question.

        • ChoiceId — (String)

          The ID of a choice.

        • Title — (String)

          The title of a choice.

        • Description — (String)

          The description of a choice.

        • HelpfulResource — (map)

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

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

          • DisplayText — (String)

            The display text for the choice content.

          • Url — (String)

            The URL for the choice content.

        • ImprovementPlan — (map)

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

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

          • DisplayText — (String)

            The display text for the choice content.

          • Url — (String)

            The URL for the choice content.

        • AdditionalResources — (Array<map>)

          The additional resources for a choice in a custom lens.

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

          • Type — (String)

            Type of additional resource for a custom lens.

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

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

            • DisplayText — (String)

              The display text for the choice content.

            • Url — (String)

              The URL for the choice content.

      • SelectedChoices — (Array<String>)

        List of selected choice IDs in a question answer.

        The values entered replace the previously selected choices.

      • ChoiceAnswerSummaries — (Array<map>)

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

        • ChoiceId — (String)

          The ID of a choice.

        • Status — (String)

          The status of a choice.

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

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

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

        Defines whether this question is applicable to a lens review.

      • Risk — (String)

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

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

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

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

        The type of the question.

        Possible values include:
        • "PRIORITIZED"
        • "NON_PRIORITIZED"
      • JiraConfiguration — (map)

        Configuration of the Jira integration.

        • JiraIssueUrl — (String)

          The URL of the associated Jira issue.

        • LastSyncedTime — (Date)

          The date and time recorded.

    • NextToken — (String)

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

Returns:

• (AWS.Request) —

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

var params = {
  ChoiceId: 'STRING_VALUE', /* required */
  LensArn: 'STRING_VALUE', /* required */
  PillarId: 'STRING_VALUE', /* required */
  QuestionId: 'STRING_VALUE', /* required */
  WorkloadId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
wellarchitected.listCheckDetails(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • WorkloadId — (String)

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

  • NextToken — (String)

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

  • MaxResults — (Integer)

    The maximum number of results to return for this request.

  • LensArn — (String)

    Well-Architected Lens ARN.

  • PillarId — (String)

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

    A pillar is identified by its PillarReviewSummary$PillarId.

  • QuestionId — (String)

    The ID of the question.

  • ChoiceId — (String)

    The ID of a choice.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • CheckDetails — (Array<map>)

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

      • Id — (String)

        Trusted Advisor check ID.

      • Name — (String)

        Trusted Advisor check name.

      • Description — (String)

        Trusted Advisor check description.

      • Provider — (String)

        Provider of the check related to the best practice.

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

        Well-Architected Lens ARN associated to the check.

      • PillarId — (String)

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

        A pillar is identified by its PillarReviewSummary$PillarId.

      • QuestionId — (String)

        The ID of the question.

      • ChoiceId — (String)

        The ID of a choice.

      • Status — (String)

        Status associated to the check.

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

        An Amazon Web Services account ID.

      • FlaggedResources — (Integer)

        Count of flagged resources associated to the check.

      • Reason — (String)

        Reason associated to the check.

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

        The date and time recorded.

    • NextToken — (String)

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

Returns:

• (AWS.Request) —

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

var params = {
  ChoiceId: 'STRING_VALUE', /* required */
  LensArn: 'STRING_VALUE', /* required */
  PillarId: 'STRING_VALUE', /* required */
  QuestionId: 'STRING_VALUE', /* required */
  WorkloadId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
wellarchitected.listCheckSummaries(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • WorkloadId — (String)

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

  • NextToken — (String)

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

  • MaxResults — (Integer)

    The maximum number of results to return for this request.

  • LensArn — (String)

    Well-Architected Lens ARN.

  • PillarId — (String)

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

    A pillar is identified by its PillarReviewSummary$PillarId.

  • QuestionId — (String)

    The ID of the question.

  • ChoiceId — (String)

    The ID of a choice.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • CheckSummaries — (Array<map>)

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

      • Id — (String)

        Trusted Advisor check ID.

      • Name — (String)

        Trusted Advisor check name.

      • Provider — (String)

        Provider of the check related to the best practice.

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

        Trusted Advisor check description.

      • UpdatedAt — (Date)

        The date and time recorded.

      • LensArn — (String)

        Well-Architected Lens ARN associated to the check.

      • PillarId — (String)

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

        A pillar is identified by its PillarReviewSummary$PillarId.

      • QuestionId — (String)

        The ID of the question.

      • ChoiceId — (String)

        The ID of a choice.

      • Status — (String)

        Status associated to the check.

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

        Account summary associated to the check.

    • NextToken — (String)

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

Returns:

• (AWS.Request) —

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

var params = {
  LensName: 'STRING_VALUE',
  LensStatus: ALL | DRAFT | PUBLISHED,
  LensType: AWS_OFFICIAL | CUSTOM_SHARED | CUSTOM_SELF,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
wellarchitected.listLenses(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • NextToken — (String)

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

  • MaxResults — (Integer)

    The maximum number of results to return for this request.

  • LensType — (String)

    The type of lenses to be returned.

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

    The status of lenses to be returned.

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

    The full name of the lens.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • LensSummaries — (Array<map>)

      List of lens summaries of available lenses.

      • LensArn — (String)

        The ARN of the lens.

      • LensAlias — (String)

        The alias of the lens.

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

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

        Each lens is identified by its LensSummary$LensAlias.

      • LensName — (String)

        The full name of the lens.

      • LensType — (String)

        The type of the lens.

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

        The description of the lens.

      • CreatedAt — (Date)

        The date and time recorded.

      • UpdatedAt — (Date)

        The date and time recorded.

      • LensVersion — (String)

        The version of the lens.

      • Owner — (String)

        An Amazon Web Services account ID.

      • LensStatus — (String)

        The status of the lens.

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

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