BedrockAgentCoreControl / Client / create_dataset
create_dataset¶
- BedrockAgentCoreControl.Client.create_dataset(**kwargs)¶
Creates a new Dataset resource asynchronously.
Returns immediately with status CREATING. Poll GetDataset until status transitions to ACTIVE or CREATE_FAILED (with failureReason).
See also: AWS API Documentation
Request Syntax
response = client.create_dataset( clientToken='string', datasetName='string', description='string', source={ 'inlineExamples': { 'examples': [ {...}|[...]|123|123.4|'string'|True|None, ] }, 's3Source': { 's3Uri': 'string' } }, schemaType='AGENTCORE_EVALUATION_PREDEFINED_V1'|'AGENTCORE_EVALUATION_SIMULATED_V1', kmsKeyArn='string', tags={ 'string': 'string' } )
- Parameters:
clientToken (string) –
Optional idempotency token.
This field is autopopulated if not provided.
datasetName (string) –
[REQUIRED]
Human-readable name for the dataset. Unique within the account (case-insensitive). Immutable after creation.
description (string) – A description of the dataset.
source (dict) –
[REQUIRED]
Source of initial examples. Provide either inline examples or an S3 URI pointing to a JSONL file.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:
inlineExamples,s3Source.inlineExamples (dict) –
Inline examples provided directly in the request body.
examples (list) – [REQUIRED]
Examples to add. Each example is assigned an auto-generated UUID.
(document) –
s3Source (dict) –
S3 URI pointing to a JSONL file in the customer’s bucket. The service reads this file using the caller’s FAS credentials.
s3Uri (string) – [REQUIRED]
S3 URI of the JSONL file (e.g. s3://my-bucket/path/to/examples.jsonl).
schemaType (string) –
[REQUIRED]
Versioned schema type governing the structure of examples. Immutable after creation.
kmsKeyArn (string) – Optional AWS KMS key ARN for SSE-KMS on service S3 writes.
tags (dict) –
A map of tag keys and values to assign to the dataset.
(string) –
(string) –
- Return type:
dict
- Returns:
Response Syntax
{ 'datasetArn': 'string', 'datasetId': 'string', 'status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED', 'createdAt': datetime(2015, 1, 1) }
Response Structure
(dict) –
datasetArn (string) –
The Amazon Resource Name (ARN) of the created dataset.
datasetId (string) –
The unique identifier of the created dataset.
status (string) –
Always CREATING immediately after this call. Poll GetDataset until status == ACTIVE (draftStatus=MODIFIED) or CREATE_FAILED.
createdAt (datetime) –
The timestamp when the dataset was created.
Exceptions
BedrockAgentCoreControl.Client.exceptions.ServiceQuotaExceededExceptionBedrockAgentCoreControl.Client.exceptions.ValidationExceptionBedrockAgentCoreControl.Client.exceptions.ConflictExceptionBedrockAgentCoreControl.Client.exceptions.AccessDeniedExceptionBedrockAgentCoreControl.Client.exceptions.ThrottlingExceptionBedrockAgentCoreControl.Client.exceptions.InternalServerException