[ aws . elementalinference ]

update-question-set

Description

Updates the DRAFT version of the specified question set. UpdateQuestionSet doesn’t create a version and doesn’t change published versions. To publish the updated DRAFT as a new version, use CreateQuestionSetVersion.

UpdateQuestionSet replaces questions one type at a time. For each of yesNo, yesNoPerOption, and chooseOne: if you omit the array, DRAFT keeps its questions of that type. If you include the array, it replaces all the questions of that type in DRAFT. If you include an empty array, DRAFT no longer has questions of that type. The updated DRAFT must follow the same rules as in CreateQuestionSet, and Elemental Inference applies those rules to the questions that DRAFT keeps as well as to the questions in the request.

Feeds that reference the DRAFT version use the updated questions. To make sure that the questions for a feed don’t change, reference a published version instead.

See also: AWS API Documentation

Synopsis

  update-question-set
--id <value>
[--yes-no <value>]
[--yes-no-per-option <value>]
[--choose-one <value>]
[--name <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]

Options

--id (string) [required]

The ID of the question set to update.

Constraints:

  • pattern: [a-z0-9]{19}

--yes-no (list)

An array of questions that Elemental Inference answers with yes or no, to replace all the yesNo questions in DRAFT. You can specify up to 50 yesNo questions. If not specified, the yesNo questions are not changed. To remove all the yesNo questions, specify an empty array.

Constraints:

  • min: 0
  • max: 50

(structure)

A question that you ask Elemental Inference, which answers with yes or no. You specify it in the yesNo array of a question set.

name -> (string) [required]

A name for the question. The name must be unique among all the questions in the version, across all question types. The name can be up to 64 characters. It must start with a letter or an underscore, and can contain only the letters A-Z and a-z, the digits 0-9, and underscores.

Constraints:

  • pattern: [A-Za-z_][A-Za-z0-9_]{0,63}

question -> (string) [required]

The text of the question. The text can be up to 256 bytes, encoded in UTF-8. It can contain letters in any language, combining marks, digits, spaces, and the following characters: . , ? ! ' " ( ) - : ; / & % , plus the curly apostrophe and quotation marks (U+2019, U+201C, and U+201D).

Constraints:

  • min: 1
  • max: 256
  • pattern: [\p{L}\p{M}\p{N} .,?!'"’“”()\-:;/&%]*

Shorthand Syntax:

name=string,question=string ...

JSON Syntax:

[
  {
    "name": "string",
    "question": "string"
  }
  ...
]

--yes-no-per-option (list)

An array of questions that you ask about each of their options, to replace all the yesNoPerOption questions in DRAFT. You can specify up to 10 yesNoPerOption questions. If not specified, the yesNoPerOption questions are not changed. To remove all the yesNoPerOption questions, specify an empty array.

Constraints:

  • min: 0
  • max: 10

(structure)

A question that you ask Elemental Inference separately about each of its options. Elemental Inference answers yes or no for each option. Word the question so that it fits any of the options. For example, ask Is this overlay visible? with one option for each overlay. You specify it in the yesNoPerOption array of a question set.

name -> (string) [required]

A name for the question. The name must be unique among all the questions in the version, across all question types. The name can be up to 64 characters. It must start with a letter or an underscore, and can contain only the letters A-Z and a-z, the digits 0-9, and underscores.

Constraints:

  • pattern: [A-Za-z_][A-Za-z0-9_]{0,63}

question -> (string) [required]

The text of the question. The text can be up to 256 bytes, encoded in UTF-8. It can contain letters in any language, combining marks, digits, spaces, and the following characters: . , ? ! ' " ( ) - : ; / & % , plus the curly apostrophe and quotation marks (U+2019, U+201C, and U+201D).

Constraints:

  • min: 1
  • max: 256
  • pattern: [\p{L}\p{M}\p{N} .,?!'"’“”()\-:;/&%]*

options -> (list) [required]

The options that you ask the question about. You can specify from 1 to 50 options. Each option counts as one item toward the limit of 100 scored items in a version.

Constraints:

  • min: 1
  • max: 50

(structure)

An option in a yesNoPerOption question or a chooseOne question.

name -> (string) [required]

A name for the option. The name must be unique among the options of the question. The name can be up to 64 characters. It must start with a letter or an underscore, and can contain only the letters A-Z and a-z, the digits 0-9, and underscores.

Constraints:

  • pattern: [A-Za-z_][A-Za-z0-9_]{0,63}

text -> (string) [required]

The text of the option. The text must be unique among the options of the question, ignoring case. The text can be up to 16 bytes, encoded in UTF-8. It can contain the same characters as the text of a question.

Constraints:

  • min: 1
  • max: 16
  • pattern: [\p{L}\p{M}\p{N} .,?!'"’“”()\-:;/&%]*

Shorthand Syntax:

name=string,question=string,options=[{name=string,text=string},{name=string,text=string}] ...

JSON Syntax:

[
  {
    "name": "string",
    "question": "string",
    "options": [
      {
        "name": "string",
        "text": "string"
      }
      ...
    ]
  }
  ...
]

--choose-one (list)

An array of questions that Elemental Inference answers by choosing one of their options, to replace all the chooseOne questions in DRAFT. You can specify up to 10 chooseOne questions. If not specified, the chooseOne questions are not changed. To remove all the chooseOne questions, specify an empty array.

Constraints:

  • min: 0
  • max: 10

(structure)

A question that you ask Elemental Inference, which answers by choosing one of its options. You specify it in the chooseOne array of a question set.

name -> (string) [required]

A name for the question. The name must be unique among all the questions in the version, across all question types. The name can be up to 64 characters. It must start with a letter or an underscore, and can contain only the letters A-Z and a-z, the digits 0-9, and underscores.

Constraints:

  • pattern: [A-Za-z_][A-Za-z0-9_]{0,63}

question -> (string) [required]

The text of the question. The text can be up to 256 bytes, encoded in UTF-8. It can contain letters in any language, combining marks, digits, spaces, and the following characters: . , ? ! ' " ( ) - : ; / & % , plus the curly apostrophe and quotation marks (U+2019, U+201C, and U+201D).

Constraints:

  • min: 1
  • max: 256
  • pattern: [\p{L}\p{M}\p{N} .,?!'"’“”()\-:;/&%]*

options -> (list) [required]

The options that Elemental Inference chooses from. You can specify from 2 to 26 options. The question counts as one item toward the limit of 100 scored items in a version, regardless of how many options it has.

Constraints:

  • min: 2
  • max: 26

(structure)

An option in a yesNoPerOption question or a chooseOne question.

name -> (string) [required]

A name for the option. The name must be unique among the options of the question. The name can be up to 64 characters. It must start with a letter or an underscore, and can contain only the letters A-Z and a-z, the digits 0-9, and underscores.

Constraints:

  • pattern: [A-Za-z_][A-Za-z0-9_]{0,63}

text -> (string) [required]

The text of the option. The text must be unique among the options of the question, ignoring case. The text can be up to 16 bytes, encoded in UTF-8. It can contain the same characters as the text of a question.

Constraints:

  • min: 1
  • max: 16
  • pattern: [\p{L}\p{M}\p{N} .,?!'"’“”()\-:;/&%]*

Shorthand Syntax:

name=string,question=string,options=[{name=string,text=string},{name=string,text=string}] ...

JSON Syntax:

[
  {
    "name": "string",
    "question": "string",
    "options": [
      {
        "name": "string",
        "text": "string"
      }
      ...
    ]
  }
  ...
]

--name (string)

A new name for the question set. If not specified, the name is not changed.

Constraints:

  • pattern: [a-zA-Z0-9]([a-zA-Z0-9-_]{0,126}[a-zA-Z0-9])?

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

--help (boolean)

Display help for the command/subcommand.

Output

yesNo -> (list)

The yesNo questions in this version. Elemental Inference doesn’t return this property if the version has no yesNo questions.

Constraints:

  • min: 0
  • max: 50

(structure)

A question that you ask Elemental Inference, which answers with yes or no. You specify it in the yesNo array of a question set.

name -> (string) [required]

A name for the question. The name must be unique among all the questions in the version, across all question types. The name can be up to 64 characters. It must start with a letter or an underscore, and can contain only the letters A-Z and a-z, the digits 0-9, and underscores.

Constraints:

  • pattern: [A-Za-z_][A-Za-z0-9_]{0,63}

question -> (string) [required]

The text of the question. The text can be up to 256 bytes, encoded in UTF-8. It can contain letters in any language, combining marks, digits, spaces, and the following characters: . , ? ! ' " ( ) - : ; / & % , plus the curly apostrophe and quotation marks (U+2019, U+201C, and U+201D).

Constraints:

  • min: 1
  • max: 256
  • pattern: [\p{L}\p{M}\p{N} .,?!'"’“”()\-:;/&%]*

yesNoPerOption -> (list)

The yesNoPerOption questions in this version. Elemental Inference doesn’t return this property if the version has no yesNoPerOption questions.

Constraints:

  • min: 0
  • max: 10

(structure)

A question that you ask Elemental Inference separately about each of its options. Elemental Inference answers yes or no for each option. Word the question so that it fits any of the options. For example, ask Is this overlay visible? with one option for each overlay. You specify it in the yesNoPerOption array of a question set.

name -> (string) [required]

A name for the question. The name must be unique among all the questions in the version, across all question types. The name can be up to 64 characters. It must start with a letter or an underscore, and can contain only the letters A-Z and a-z, the digits 0-9, and underscores.

Constraints:

  • pattern: [A-Za-z_][A-Za-z0-9_]{0,63}

question -> (string) [required]

The text of the question. The text can be up to 256 bytes, encoded in UTF-8. It can contain letters in any language, combining marks, digits, spaces, and the following characters: . , ? ! ' " ( ) - : ; / & % , plus the curly apostrophe and quotation marks (U+2019, U+201C, and U+201D).

Constraints:

  • min: 1
  • max: 256
  • pattern: [\p{L}\p{M}\p{N} .,?!'"’“”()\-:;/&%]*

options -> (list) [required]

The options that you ask the question about. You can specify from 1 to 50 options. Each option counts as one item toward the limit of 100 scored items in a version.

Constraints:

  • min: 1
  • max: 50

(structure)

An option in a yesNoPerOption question or a chooseOne question.

name -> (string) [required]

A name for the option. The name must be unique among the options of the question. The name can be up to 64 characters. It must start with a letter or an underscore, and can contain only the letters A-Z and a-z, the digits 0-9, and underscores.

Constraints:

  • pattern: [A-Za-z_][A-Za-z0-9_]{0,63}

text -> (string) [required]

The text of the option. The text must be unique among the options of the question, ignoring case. The text can be up to 16 bytes, encoded in UTF-8. It can contain the same characters as the text of a question.

Constraints:

  • min: 1
  • max: 16
  • pattern: [\p{L}\p{M}\p{N} .,?!'"’“”()\-:;/&%]*

chooseOne -> (list)

The chooseOne questions in this version. Elemental Inference doesn’t return this property if the version has no chooseOne questions.

Constraints:

  • min: 0
  • max: 10

(structure)

A question that you ask Elemental Inference, which answers by choosing one of its options. You specify it in the chooseOne array of a question set.

name -> (string) [required]

A name for the question. The name must be unique among all the questions in the version, across all question types. The name can be up to 64 characters. It must start with a letter or an underscore, and can contain only the letters A-Z and a-z, the digits 0-9, and underscores.

Constraints:

  • pattern: [A-Za-z_][A-Za-z0-9_]{0,63}

question -> (string) [required]

The text of the question. The text can be up to 256 bytes, encoded in UTF-8. It can contain letters in any language, combining marks, digits, spaces, and the following characters: . , ? ! ' " ( ) - : ; / & % , plus the curly apostrophe and quotation marks (U+2019, U+201C, and U+201D).

Constraints:

  • min: 1
  • max: 256
  • pattern: [\p{L}\p{M}\p{N} .,?!'"’“”()\-:;/&%]*

options -> (list) [required]

The options that Elemental Inference chooses from. You can specify from 2 to 26 options. The question counts as one item toward the limit of 100 scored items in a version, regardless of how many options it has.

Constraints:

  • min: 2
  • max: 26

(structure)

An option in a yesNoPerOption question or a chooseOne question.

name -> (string) [required]

A name for the option. The name must be unique among the options of the question. The name can be up to 64 characters. It must start with a letter or an underscore, and can contain only the letters A-Z and a-z, the digits 0-9, and underscores.

Constraints:

  • pattern: [A-Za-z_][A-Za-z0-9_]{0,63}

text -> (string) [required]

The text of the option. The text must be unique among the options of the question, ignoring case. The text can be up to 16 bytes, encoded in UTF-8. It can contain the same characters as the text of a question.

Constraints:

  • min: 1
  • max: 16
  • pattern: [\p{L}\p{M}\p{N} .,?!'"’“”()\-:;/&%]*

arn -> (string)

The ARN of the question set.

id -> (string)

The ID of the question set.

Constraints:

  • pattern: [a-z0-9]{19}

name -> (string)

The updated or original name of the question set.

Constraints:

  • pattern: [a-zA-Z0-9]([a-zA-Z0-9-_]{0,126}[a-zA-Z0-9])?

version -> (string)

The version that this response describes. For UpdateQuestionSet, the version is always DRAFT.

Constraints:

  • min: 1
  • max: 10
  • pattern: (DRAFT|[1-9][0-9]*)

description -> (string)

The description of the version. Elemental Inference doesn’t return this property for UpdateQuestionSet, because the DRAFT version has no description.

Constraints:

  • min: 1
  • max: 256
  • pattern: [\w \-\.',@:;]*

latestVersion -> (string)

The number of the highest version that you have published for this question set, even if you have since deleted that version. Elemental Inference doesn’t return this property if you haven’t published a version.

Constraints:

  • min: 1
  • max: 10
  • pattern: (DRAFT|[1-9][0-9]*)

sha256 -> (string)

The SHA-256 hash of the DRAFT version after the update, as 64 lowercase hexadecimal characters. The hash covers the name of the question set and its questions, so it changes when you rename the question set. You can specify this value in a CreateQuestionSetVersion request, so that Elemental Inference publishes DRAFT only if it hasn’t changed since this update.

Constraints:

  • pattern: [a-f0-9]{64}

references -> (list)

A list of feed IDs that reference the DRAFT version of the question set.

(string)

Constraints:

  • pattern: [a-z0-9]{19}

tags -> (map)

Any tags associated with the question set.

key -> (string)

Constraints:

  • min: 1
  • max: 128

value -> (string)

Constraints:

  • min: 0
  • max: 256