Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateDataset

Creates a new dataset resource asynchronously. Returns immediately with status CREATING. Poll GetDataset until status transitions to ACTIVE or CREATE_FAILED.

Request Syntax


POST /datasets HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "datasetName": "string",
   "description": "string",
   "kmsKeyArn": "string",
   "schemaType": "string",
   "source": { ... },
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

clientToken

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

Type: String

Length Constraints: Minimum length of 33. Maximum length of 256.

Pattern: [a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}

Required: No

datasetName

Human-readable name for the dataset. Must be unique within the account. Immutable after creation.

Type: String

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

Required: Yes

description

A description of the dataset.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 200.

Required: No

kmsKeyArn

Optional AWS KMS key ARN for server-side encryption on service Amazon S3 writes.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}

Required: No

schemaType

Versioned schema type governing the structure of examples. Immutable after creation.

Type: String

Valid Values: AGENTCORE_EVALUATION_PREDEFINED_V1 | AGENTCORE_EVALUATION_SIMULATED_V1

Required: Yes

source

Source of initial examples. Provide either inline examples or an S3 URI pointing to a JSONL file.

Type: DataSourceType object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

tags

A map of tag keys and values to assign to the dataset.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: [a-zA-Z0-9\s._:/=+@-]*

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: [a-zA-Z0-9\s._:/=+@-]*

Required: No

Response Syntax


HTTP/1.1 202
Content-type: application/json

{
   "createdAt": number,
   "datasetArn": "string",
   "datasetId": "string",
   "status": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

createdAt

The timestamp when the dataset was created.

Type: Timestamp

datasetArn

The Amazon Resource Name (ARN) of the created dataset.

Type: String

Pattern: arn:aws(-[a-z]+)*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:dataset/[a-zA-Z0-9_-]{1,110}

datasetId

The unique identifier of the created dataset.

Type: String

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

status

Always CREATING immediately after this call. Poll GetDataset until status transitions to ACTIVE or CREATE_FAILED.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

This exception is thrown when a request is denied per access permissions

HTTP Status Code: 403

ConflictException

This exception is thrown when there is a conflict performing an operation

HTTP Status Code: 409

InternalServerException

This exception is thrown if there was an unexpected error during processing of request

HTTP Status Code: 500

ServiceQuotaExceededException

This exception is thrown when a request is made beyond the service quota

HTTP Status Code: 402

ThrottlingException

This exception is thrown when the number of requests exceeds the limit

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by the service.

HTTP Status Code: 400