[ aws . wellarchitected ]

update-answer

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-answer
--workload-id <value>
--lens-alias <value>
--question-id <value>
[--selected-choices <value>]
[--choice-updates <value>]
[--notes <value>]
[--is-applicable | --no-is-applicable]
[--reason <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--workload-id (string)

The ID assigned to the workload. This ID is unique within an AWS Region.

--lens-alias (string)

The alias of the lens, for example, serverless .

Each lens is identified by its LensSummary$LensAlias .

--question-id (string)

The ID of the question.

--selected-choices (list)

List of selected choice IDs in a question answer.

The values entered replace the previously selected choices.

(string)

The ID of a choice.

Syntax:

"string" "string" ...

--choice-updates (map)

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

key -> (string)

The ID of a choice.

value -> (structure)

A list of choices to be updated.

Status -> (string)

The status of a choice.

Reason -> (string)

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

Notes -> (string)

The notes associated with a choice.

Shorthand Syntax:

KeyName1=Status=string,Reason=string,Notes=string,KeyName2=Status=string,Reason=string,Notes=string

JSON Syntax:

{"string": {
      "Status": "SELECTED"|"NOT_APPLICABLE"|"UNSELECTED",
      "Reason": "OUT_OF_SCOPE"|"BUSINESS_PRIORITIES"|"ARCHITECTURE_CONSTRAINTS"|"OTHER"|"NONE",
      "Notes": "string"
    }
  ...}

--notes (string)

The notes associated with the workload.

--is-applicable | --no-is-applicable (boolean)

Defines whether this question is applicable to a lens review.

--reason (string)

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

Possible values:

• OUT_OF_SCOPE

• BUSINESS_PRIORITIES

• ARCHITECTURE_CONSTRAINTS

• OTHER

• NONE

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

WorkloadId -> (string)

The ID assigned to the workload. This ID is unique within an AWS Region.

LensAlias -> (string)

The alias of the lens, for example, serverless .

Each lens is identified by its LensSummary$LensAlias .

Answer -> (structure)

An answer of the question.

QuestionId -> (string)

The ID of the question.

PillarId -> (string)

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

A pillar is identified by its PillarReviewSummary$PillarId .

QuestionTitle -> (string)

The title of the question.

QuestionDescription -> (string)

The description of the question.

ImprovementPlanUrl -> (string)

The improvement plan URL for a question.

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

HelpfulResourceUrl -> (string)

The helpful resource URL for a question.

Choices -> (list)

List of choices available for a question.

(structure)

A choice available to answer question.

ChoiceId -> (string)

The ID of a choice.

Title -> (string)

The title of a choice.

Description -> (string)

The description of a choice.

SelectedChoices -> (list)

List of selected choice IDs in a question answer.

The values entered replace the previously selected choices.

(string)

The ID of a choice.

ChoiceAnswers -> (list)

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

(structure)

A choice that has been answered on a question in your workload.

ChoiceId -> (string)

The ID of a choice.

Status -> (string)

The status of a choice.

Reason -> (string)

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

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.

Notes -> (string)

The notes associated with the workload.

Reason -> (string)

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