create_dataset¶
Operation¶
async
¶
create_dataset(input: CreateDatasetInput, plugins: list[Plugin] | None = None) -> CreateDatasetOutput
Creates a new dataset resource asynchronously. Returns immediately with
status CREATING. Poll GetDataset until status transitions to ACTIVE or
CREATE_FAILED.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateDatasetInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
CreateDatasetOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for CreateDatasetInput structure.
Attributes¶
class-attribute
instance-attribute
¶
client_token: str | None = None
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.
class-attribute
instance-attribute
¶
dataset_name: str | None = None
Human-readable name for the dataset. Must be unique within the account. Immutable after creation.
class-attribute
instance-attribute
¶
description: str | None = None
A description of the dataset.
class-attribute
instance-attribute
¶
kms_key_arn: str | None = None
Optional KMS key ARN for server-side encryption on service Amazon S3 writes.
class-attribute
instance-attribute
¶
schema_type: DatasetSchemaType | None = None
Versioned schema type governing the structure of examples. Immutable after creation.
class-attribute
instance-attribute
¶
source: DataSourceType | None = None
Source of initial examples. Provide either inline examples or an S3 URI pointing to a JSONL file.
class-attribute
instance-attribute
¶
tags: dict[str, str] | None = None
A map of tag keys and values to assign to the dataset.
Output¶
dataclass
¶
Dataclass for CreateDatasetOutput structure.
Attributes¶
instance-attribute
¶
dataset_arn: str
The Amazon Resource Name (ARN) of the created dataset.
instance-attribute
¶
status: DatasetStatus
Always CREATING immediately after this call. Poll GetDataset until
status transitions to ACTIVE or CREATE_FAILED.