[ aws . bedrock-agentcore ]

start-dataset-generation

Description

Starts a dataset generation, which creates examples for an existing dataset from your agent’s traces. The dataset must be ACTIVE . Each generation produces one scenario type, set by scenarioType . When the generation finishes, AgentCore adds the examples to the dataset’s draft. Examples that duplicate each other, or that duplicate examples already in the draft, are left out.

A dataset can have only one generation in progress at a time. While it runs, requests that change the dataset’s draft or publish a version are rejected with a ConflictException .

AgentCore reads the traces with your credentials, so you need read access to the trace log groups, and to the dataset’s KMS key if the dataset uses a customer managed key. The draft can hold at most 1,000 examples, including the examples this generation can add (maxScenarios ).

The operation returns immediately. To track progress, call GetDatasetGeneration .

See also: AWS API Documentation

Synopsis

  start-dataset-generation
--dataset-id <value>
--name <value>
[--description <value>]
[--scenario-type <value>]
--source <value>
[--client-token <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

--dataset-id (string) [required]

The unique identifier of the dataset to add the generated examples to. The dataset must be ACTIVE .

Constraints:

  • pattern: [a-zA-Z0-9_-]{1,110}

--name (string) [required]

The name of the dataset generation. The generation ID starts with this name.

Constraints:

  • pattern: [a-zA-Z][a-zA-Z0-9_-]{0,47}

--description (string)

A description of the dataset generation.

Constraints:

  • min: 0
  • max: 200

--scenario-type (string)

The type of scenario to generate. If you don’t specify a value, the generation produces DYNAMIC scenarios.

Possible values:

  • FIXED
  • DYNAMIC

--source (tagged union structure) [required]

Where the generation reads sessions from, and how it selects, samples, labels and redacts them.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: traceGeneration.

traceGeneration -> (structure)

Generates examples from your agent’s traces.

sourceConfig -> (tagged union structure) [required]

Where to read the sessions from.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: cloudWatchLogs, onlineEvaluation, batchEvaluation.

cloudWatchLogs -> (structure)

Reads sessions from CloudWatch Logs log groups.

logGroupNames -> (list)

The names of the log groups to read, from 1 to 5. You can’t specify this together with logGroupNamePrefixes .

Constraints:

  • min: 1
  • max: 5

(string)

Constraints:

  • pattern: [.\-_/#A-Za-z0-9]+

logGroupNamePrefixes -> (list)

Prefixes of the names of the log groups to read, from 1 to 5. You can’t specify this together with logGroupNames .

Constraints:

  • min: 1
  • max: 5

(string)

Prefix of a CloudWatch Logs log group name.

Constraints:

  • min: 1
  • max: 512
  • pattern: [.\-_/#A-Za-z0-9]+

serviceNames -> (list) [required]

The service name of the agent, which matches the service.name resource attribute in its traces. Specify exactly one.

Constraints:

  • min: 1
  • max: 1

(string)

Constraints:

  • min: 1
  • max: 256
  • pattern: [a-zA-Z0-9._-]+

startTime -> (timestamp)

The start of the time window to read sessions from. The default is 7 days before endTime .

endTime -> (timestamp)

The end of the time window to read sessions from. The default is the time the generation starts.

onlineEvaluation -> (structure)

Reads sessions, with their evaluation results, from an online evaluation configuration.

onlineEvaluationConfigArn -> (string) [required]

The Amazon Resource Name (ARN) of the online evaluation configuration.

Constraints:

  • pattern: arn:aws[a-zA-Z-]*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:online-evaluation-config\/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}

startTime -> (timestamp)

The start of the time window to read sessions from. The default is 7 days before endTime .

endTime -> (timestamp)

The end of the time window to read sessions from. The default is the time the generation starts.

batchEvaluation -> (structure)

Reads sessions, with their evaluation results, from a batch evaluation.

batchEvaluationArn -> (string) [required]

The Amazon Resource Name (ARN) of the batch evaluation.

selection -> (tagged union structure)

How to choose sessions from the source. If you don’t specify a selection, the generation uses every session in the source and time window that has at most 100 turns.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: filters, identifiers.

filters -> (structure)

Conditions that a session must meet to be selected.

attributeFilters -> (list)

Attribute conditions, up to 5. A session must meet all of them. An attribute on a span matches when any span in the session meets the condition.

Constraints:

  • min: 0
  • max: 5

(structure)

A condition on a session attribute.

key -> (string) [required]

The attribute key.

Constraints:

  • min: 1
  • max: 256
  • pattern: [a-zA-Z0-9._-]+

operator -> (string) [required]

How to compare the attribute with value .

Possible values:

  • Equals
  • NotEquals
  • GreaterThan
  • LessThan
  • GreaterThanOrEqual
  • LessThanOrEqual
  • Contains
  • NotContains

value -> (tagged union structure) [required]

The value to compare the attribute with.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: stringValue, doubleValue, booleanValue.

stringValue -> (string)

A string value.

Constraints:

  • min: 0
  • max: 1024

doubleValue -> (double)

A numeric value.

booleanValue -> (boolean)

A Boolean value.

turnCount -> (structure)

The range of turns a session can have. For example, set max to 1 for single-turn sessions only, or min to 2 for multi-turn sessions only. Sessions with more than 100 turns are never selected.

min -> (integer)

The minimum number of turns.

Constraints:

  • min: 1
  • max: 100

max -> (integer)

The maximum number of turns. The default is 100.

Constraints:

  • min: 1
  • max: 100

evaluatorFilters -> (list)

Conditions on evaluation results, up to 10. A session must meet all of them. You can use these only with an onlineEvaluation or batchEvaluation source. A cloudWatchLogs source has no evaluation results.

Constraints:

  • min: 0
  • max: 10

(structure)

A condition on a session’s evaluation result.

evaluatorId -> (string) [required]

The unique identifier of the evaluator whose result to compare.

Constraints:

  • min: 1
  • max: 111
  • pattern: (Builtin\.[a-zA-Z0-9._-]+|ThirdParty\.[a-zA-Z0-9_-]+\.[a-zA-Z0-9_-]+|[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10})

evaluationDimensionName -> (string)

The dimension of the evaluator’s result to compare. Required for an evaluator that scores more than one dimension. Don’t specify it for any other evaluator.

Constraints:

  • pattern: [a-zA-Z][a-zA-Z0-9_]{0,47}

operator -> (string) [required]

How to compare the evaluation result with value .

Possible values:

  • Equals
  • NotEquals
  • GreaterThan
  • LessThan
  • GreaterThanOrEqual
  • LessThanOrEqual
  • Contains
  • NotContains

value -> (tagged union structure) [required]

The value to compare the evaluation result with. Use doubleValue for a score and stringValue for a label. booleanValue isn’t supported.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: stringValue, doubleValue, booleanValue.

stringValue -> (string)

A string value.

Constraints:

  • min: 0
  • max: 1024

doubleValue -> (double)

A numeric value.

booleanValue -> (boolean)

A Boolean value.

aggregation -> (string)

How to combine the evaluator’s per-trace or per-span results into one result for the session. Required for an evaluator that scores traces or spans. Don’t specify it for an evaluator that scores sessions.

Possible values:

  • Min
  • Max
  • Mean
  • AllMatch
  • AnyMatch

identifiers -> (structure)

The sessions and traces to use.

sessionIds -> (list)

The IDs of the sessions to use, up to 25.

Constraints:

  • min: 0
  • max: 25

(string)

Constraints:

  • min: 1
  • max: 100
  • pattern: [a-zA-Z0-9][a-zA-Z0-9-_]*

traceIds -> (list)

The IDs of the traces to use, up to 25.

Constraints:

  • min: 0
  • max: 25

(string)

Constraints:

  • min: 32
  • max: 32

sampling -> (structure)

How many scenarios to generate from the selected sessions.

maxScenarios -> (integer)

The maximum number of scenarios to generate, from 1 to 1,000. The default is 100. The generation produces at most one scenario for each selected session. The dataset’s draft examples plus this value can’t be more than 1,000.

Constraints:

  • min: 1
  • max: 1000

groundTruth -> (structure)

Reference fields to copy from the sessions into the examples. If you don’t specify this, the examples have no reference fields.

fields -> (list) [required]

The reference fields to copy. Values are copied from the session as observed, not generated.

Constraints:

  • min: 1
  • max: 2

(string)

A reference field in a dataset example.

Possible values:

  • expected_response
  • expected_trajectory

qualityFilters -> (list)

Evaluator conditions that a selected session must also meet to have reference fields copied. If you don’t specify these, the generation uses the evaluator filters from selection . If the selection names sessions and traces by ID, every selected session gets reference fields. Specify an empty list to give every selected session reference fields. You can’t specify quality filters with a cloudWatchLogs source.

Constraints:

  • min: 0
  • max: 10

(structure)

A condition on a session’s evaluation result.

evaluatorId -> (string) [required]

The unique identifier of the evaluator whose result to compare.

Constraints:

  • min: 1
  • max: 111
  • pattern: (Builtin\.[a-zA-Z0-9._-]+|ThirdParty\.[a-zA-Z0-9_-]+\.[a-zA-Z0-9_-]+|[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10})

evaluationDimensionName -> (string)

The dimension of the evaluator’s result to compare. Required for an evaluator that scores more than one dimension. Don’t specify it for any other evaluator.

Constraints:

  • pattern: [a-zA-Z][a-zA-Z0-9_]{0,47}

operator -> (string) [required]

How to compare the evaluation result with value .

Possible values:

  • Equals
  • NotEquals
  • GreaterThan
  • LessThan
  • GreaterThanOrEqual
  • LessThanOrEqual
  • Contains
  • NotContains

value -> (tagged union structure) [required]

The value to compare the evaluation result with. Use doubleValue for a score and stringValue for a label. booleanValue isn’t supported.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: stringValue, doubleValue, booleanValue.

stringValue -> (string)

A string value.

Constraints:

  • min: 0
  • max: 1024

doubleValue -> (double)

A numeric value.

booleanValue -> (boolean)

A Boolean value.

aggregation -> (string)

How to combine the evaluator’s per-trace or per-span results into one result for the session. Required for an evaluator that scores traces or spans. Don’t specify it for an evaluator that scores sessions.

Possible values:

  • Min
  • Max
  • Mean
  • AllMatch
  • AnyMatch

redactionConfiguration -> (structure)

Sensitive data to mask in the examples. If you don’t specify this, nothing is redacted.

identifiers -> (list)

The managed data identifiers to apply. These match the CloudWatch Logs managed data identifiers.

Constraints:

  • min: 0
  • max: 100

(string)

A managed data identifier. The values match the CloudWatch Logs managed data identifiers.

Possible values:

  • ADDRESS
  • AWS_SECRET_KEY
  • BANK_ACCOUNT_NUMBER_DE
  • BANK_ACCOUNT_NUMBER_ES
  • BANK_ACCOUNT_NUMBER_FR
  • BANK_ACCOUNT_NUMBER_GB
  • BANK_ACCOUNT_NUMBER_IT
  • BANK_ACCOUNT_NUMBER_US
  • CEP_CODE_BR
  • CNPJ_BR
  • CPF_CODE_BR
  • CREDIT_CARD_EXPIRATION
  • CREDIT_CARD_MAGNETIC_STRIPE
  • CREDIT_CARD_NUMBER
  • CREDIT_CARD_SECURITY_CODE
  • DATE_OF_BIRTH
  • DRIVERS_LICENSE_AT
  • DRIVERS_LICENSE_AU
  • DRIVERS_LICENSE_BE
  • DRIVERS_LICENSE_BG
  • DRIVERS_LICENSE_CA
  • DRIVERS_LICENSE_CY
  • DRIVERS_LICENSE_CZ
  • DRIVERS_LICENSE_DE
  • DRIVERS_LICENSE_DK
  • DRIVERS_LICENSE_EE
  • DRIVERS_LICENSE_ES
  • DRIVERS_LICENSE_FI
  • DRIVERS_LICENSE_FR
  • DRIVERS_LICENSE_GB
  • DRIVERS_LICENSE_GR
  • DRIVERS_LICENSE_HR
  • DRIVERS_LICENSE_HU
  • DRIVERS_LICENSE_IE
  • DRIVERS_LICENSE_IT
  • DRIVERS_LICENSE_LT
  • DRIVERS_LICENSE_LU
  • DRIVERS_LICENSE_LV
  • DRIVERS_LICENSE_MT
  • DRIVERS_LICENSE_NL
  • DRIVERS_LICENSE_PL
  • DRIVERS_LICENSE_PT
  • DRIVERS_LICENSE_RO
  • DRIVERS_LICENSE_SE
  • DRIVERS_LICENSE_SI
  • DRIVERS_LICENSE_SK
  • DRIVERS_LICENSE_US
  • DRUG_ENFORCEMENT_AGENCY_NUMBER_US
  • ELECTORAL_ROLL_NUMBER_GB
  • EMAIL_ADDRESS
  • HEALTH_INSURANCE_CARD_NUMBER_EU
  • HEALTH_INSURANCE_CLAIM_NUMBER_US
  • HEALTH_INSURANCE_NUMBER_FR
  • HEALTHCARE_PROCEDURE_CODE_US
  • INDIVIDUAL_TAX_IDENTIFICATION_NUMBER_US
  • INSEE_CODE_FR
  • IP_ADDRESS
  • LAT_LONG
  • MEDICARE_BENEFICIARY_NUMBER_US
  • NAME
  • NATIONAL_DRUG_CODE_US
  • NATIONAL_IDENTIFICATION_NUMBER_DE
  • NATIONAL_IDENTIFICATION_NUMBER_ES
  • NATIONAL_IDENTIFICATION_NUMBER_IT
  • NATIONAL_INSURANCE_NUMBER_GB
  • NATIONAL_PROVIDER_ID_US
  • NHS_NUMBER_GB
  • NIE_NUMBER_ES
  • NIF_NUMBER_ES
  • OPEN_SSH_PRIVATE_KEY
  • PASSPORT_NUMBER_CA
  • PASSPORT_NUMBER_DE
  • PASSPORT_NUMBER_ES
  • PASSPORT_NUMBER_FR
  • PASSPORT_NUMBER_GB
  • PASSPORT_NUMBER_IT
  • PASSPORT_NUMBER_US
  • PERMANENT_RESIDENCE_NUMBER_CA
  • PERSONAL_HEALTH_NUMBER_CA
  • PGP_PRIVATE_KEY
  • PHONE_NUMBER_BR
  • PHONE_NUMBER_DE
  • PHONE_NUMBER_ES
  • PHONE_NUMBER_FR
  • PHONE_NUMBER_GB
  • PHONE_NUMBER_IT
  • PHONE_NUMBER_US
  • PKCS_PRIVATE_KEY
  • POSTAL_CODE_CA
  • PUTTY_PRIVATE_KEY
  • RG_NUMBER_BR
  • SOCIAL_INSURANCE_NUMBER_CA
  • SSN_ES
  • SSN_US
  • TAX_ID_DE
  • TAX_ID_ES
  • TAX_ID_FR
  • TAX_ID_GB
  • VEHICLE_IDENTIFICATION_NUMBER
  • ZIP_CODE_US

customDataIdentifiers -> (list)

Custom data identifiers to apply, up to 10. You can use custom identifiers without any managed identifiers.

Constraints:

  • min: 0
  • max: 10

(structure)

A custom data identifier, defined by a regular expression.

name -> (string) [required]

The name of the custom data identifier. It can’t be the same as the name of a managed data identifier.

Constraints:

  • min: 1
  • max: 128
  • pattern: [A-Za-z0-9_-]+

regex -> (string) [required]

The regular expression that matches the data to mask. Lookahead and lookbehind aren’t supported.

Constraints:

  • min: 1
  • max: 200

JSON Syntax:

{
  "traceGeneration": {
    "sourceConfig": {
      "cloudWatchLogs": {
        "logGroupNames": ["string", ...],
        "logGroupNamePrefixes": ["string", ...],
        "serviceNames": ["string", ...],
        "startTime": timestamp,
        "endTime": timestamp
      },
      "onlineEvaluation": {
        "onlineEvaluationConfigArn": "string",
        "startTime": timestamp,
        "endTime": timestamp
      },
      "batchEvaluation": {
        "batchEvaluationArn": "string"
      }
    },
    "selection": {
      "filters": {
        "attributeFilters": [
          {
            "key": "string",
            "operator": "Equals"|"NotEquals"|"GreaterThan"|"LessThan"|"GreaterThanOrEqual"|"LessThanOrEqual"|"Contains"|"NotContains",
            "value": {
              "stringValue": "string",
              "doubleValue": double,
              "booleanValue": true|false
            }
          }
          ...
        ],
        "turnCount": {
          "min": integer,
          "max": integer
        },
        "evaluatorFilters": [
          {
            "evaluatorId": "string",
            "evaluationDimensionName": "string",
            "operator": "Equals"|"NotEquals"|"GreaterThan"|"LessThan"|"GreaterThanOrEqual"|"LessThanOrEqual"|"Contains"|"NotContains",
            "value": {
              "stringValue": "string",
              "doubleValue": double,
              "booleanValue": true|false
            },
            "aggregation": "Min"|"Max"|"Mean"|"AllMatch"|"AnyMatch"
          }
          ...
        ]
      },
      "identifiers": {
        "sessionIds": ["string", ...],
        "traceIds": ["string", ...]
      }
    },
    "sampling": {
      "maxScenarios": integer
    },
    "groundTruth": {
      "fields": ["expected_response"|"expected_trajectory", ...],
      "qualityFilters": [
        {
          "evaluatorId": "string",
          "evaluationDimensionName": "string",
          "operator": "Equals"|"NotEquals"|"GreaterThan"|"LessThan"|"GreaterThanOrEqual"|"LessThanOrEqual"|"Contains"|"NotContains",
          "value": {
            "stringValue": "string",
            "doubleValue": double,
            "booleanValue": true|false
          },
          "aggregation": "Min"|"Max"|"Mean"|"AllMatch"|"AnyMatch"
        }
        ...
      ]
    },
    "redactionConfiguration": {
      "identifiers": ["ADDRESS"|"AWS_SECRET_KEY"|"BANK_ACCOUNT_NUMBER_DE"|"BANK_ACCOUNT_NUMBER_ES"|"BANK_ACCOUNT_NUMBER_FR"|"BANK_ACCOUNT_NUMBER_GB"|"BANK_ACCOUNT_NUMBER_IT"|"BANK_ACCOUNT_NUMBER_US"|"CEP_CODE_BR"|"CNPJ_BR"|"CPF_CODE_BR"|"CREDIT_CARD_EXPIRATION"|"CREDIT_CARD_MAGNETIC_STRIPE"|"CREDIT_CARD_NUMBER"|"CREDIT_CARD_SECURITY_CODE"|"DATE_OF_BIRTH"|"DRIVERS_LICENSE_AT"|"DRIVERS_LICENSE_AU"|"DRIVERS_LICENSE_BE"|"DRIVERS_LICENSE_BG"|"DRIVERS_LICENSE_CA"|"DRIVERS_LICENSE_CY"|"DRIVERS_LICENSE_CZ"|"DRIVERS_LICENSE_DE"|"DRIVERS_LICENSE_DK"|"DRIVERS_LICENSE_EE"|"DRIVERS_LICENSE_ES"|"DRIVERS_LICENSE_FI"|"DRIVERS_LICENSE_FR"|"DRIVERS_LICENSE_GB"|"DRIVERS_LICENSE_GR"|"DRIVERS_LICENSE_HR"|"DRIVERS_LICENSE_HU"|"DRIVERS_LICENSE_IE"|"DRIVERS_LICENSE_IT"|"DRIVERS_LICENSE_LT"|"DRIVERS_LICENSE_LU"|"DRIVERS_LICENSE_LV"|"DRIVERS_LICENSE_MT"|"DRIVERS_LICENSE_NL"|"DRIVERS_LICENSE_PL"|"DRIVERS_LICENSE_PT"|"DRIVERS_LICENSE_RO"|"DRIVERS_LICENSE_SE"|"DRIVERS_LICENSE_SI"|"DRIVERS_LICENSE_SK"|"DRIVERS_LICENSE_US"|"DRUG_ENFORCEMENT_AGENCY_NUMBER_US"|"ELECTORAL_ROLL_NUMBER_GB"|"EMAIL_ADDRESS"|"HEALTH_INSURANCE_CARD_NUMBER_EU"|"HEALTH_INSURANCE_CLAIM_NUMBER_US"|"HEALTH_INSURANCE_NUMBER_FR"|"HEALTHCARE_PROCEDURE_CODE_US"|"INDIVIDUAL_TAX_IDENTIFICATION_NUMBER_US"|"INSEE_CODE_FR"|"IP_ADDRESS"|"LAT_LONG"|"MEDICARE_BENEFICIARY_NUMBER_US"|"NAME"|"NATIONAL_DRUG_CODE_US"|"NATIONAL_IDENTIFICATION_NUMBER_DE"|"NATIONAL_IDENTIFICATION_NUMBER_ES"|"NATIONAL_IDENTIFICATION_NUMBER_IT"|"NATIONAL_INSURANCE_NUMBER_GB"|"NATIONAL_PROVIDER_ID_US"|"NHS_NUMBER_GB"|"NIE_NUMBER_ES"|"NIF_NUMBER_ES"|"OPEN_SSH_PRIVATE_KEY"|"PASSPORT_NUMBER_CA"|"PASSPORT_NUMBER_DE"|"PASSPORT_NUMBER_ES"|"PASSPORT_NUMBER_FR"|"PASSPORT_NUMBER_GB"|"PASSPORT_NUMBER_IT"|"PASSPORT_NUMBER_US"|"PERMANENT_RESIDENCE_NUMBER_CA"|"PERSONAL_HEALTH_NUMBER_CA"|"PGP_PRIVATE_KEY"|"PHONE_NUMBER_BR"|"PHONE_NUMBER_DE"|"PHONE_NUMBER_ES"|"PHONE_NUMBER_FR"|"PHONE_NUMBER_GB"|"PHONE_NUMBER_IT"|"PHONE_NUMBER_US"|"PKCS_PRIVATE_KEY"|"POSTAL_CODE_CA"|"PUTTY_PRIVATE_KEY"|"RG_NUMBER_BR"|"SOCIAL_INSURANCE_NUMBER_CA"|"SSN_ES"|"SSN_US"|"TAX_ID_DE"|"TAX_ID_ES"|"TAX_ID_FR"|"TAX_ID_GB"|"VEHICLE_IDENTIFICATION_NUMBER"|"ZIP_CODE_US", ...],
      "customDataIdentifiers": [
        {
          "name": "string",
          "regex": "string"
        }
        ...
      ]
    }
  }
}

--client-token (string)

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.

Constraints:

  • min: 33
  • max: 256
  • pattern: [a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}

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

generationId -> (string)

The unique identifier of the dataset generation.

Constraints:

  • pattern: [a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}

name -> (string)

The name of the dataset generation.

Constraints:

  • pattern: [a-zA-Z][a-zA-Z0-9_-]{0,47}

datasetId -> (string)

The unique identifier of the dataset.

Constraints:

  • pattern: [a-zA-Z0-9_-]{1,110}

status -> (string)

The status of the dataset generation.

Possible values:

  • IN_PROGRESS
  • COMPLETED
  • COMPLETED_WITH_ERRORS
  • FAILED
  • DELETING

createdAt -> (timestamp)

The time at which the dataset generation started.