Skip to content

create_dataset_version

Operation

create_dataset_version

create_dataset_version(request: CreateDatasetVersionInput | CreateDatasetVersionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateDatasetVersionInputDict]) -> CreateDatasetVersionOutput

Publishes the current DRAFT as a new numbered version. The DRAFT is preserved and remains editable after publishing. Returns immediately with status UPDATING. Poll GetDataset until status transitions to ACTIVE or UPDATE_FAILED.

Parameters:

Name Type Description Default
request CreateDatasetVersionInput | CreateDatasetVersionInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[CreateDatasetVersionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateDatasetVersionOutput

An instance of CreateDatasetVersionOutput.

create_dataset_version async

create_dataset_version(request: CreateDatasetVersionInput | CreateDatasetVersionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateDatasetVersionInputDict]) -> CreateDatasetVersionOutput

Publishes the current DRAFT as a new numbered version. The DRAFT is preserved and remains editable after publishing. Returns immediately with status UPDATING. Poll GetDataset until status transitions to ACTIVE or UPDATE_FAILED.

Parameters:

Name Type Description Default
request CreateDatasetVersionInput | CreateDatasetVersionInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[CreateDatasetVersionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateDatasetVersionOutput

An instance of CreateDatasetVersionOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

CreateDatasetVersionInputDict

Bases: TypedDict

Dictionary form of CreateDatasetVersionInput.

Attributes

client_token instance-attribute
client_token: str | 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.

This field is autopopulated if not provided.

dataset_id instance-attribute
dataset_id: Required[str]

The unique identifier of the dataset to publish a version for.

CreateDatasetVersionInput dataclass

Bases: _SerdeShape

Dataclass for CreateDatasetVersionInput structure.

Attributes

client_token class-attribute instance-attribute
client_token: str | 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.

This field is autopopulated if not provided.

dataset_id class-attribute instance-attribute
dataset_id: str | None = ...

The unique identifier of the dataset to publish a version for.

Output

CreateDatasetVersionOutput dataclass

Bases: _SerdeShape

Dataclass for CreateDatasetVersionOutput structure.

Attributes

created_at instance-attribute
created_at: datetime

The timestamp when the version creation was initiated.

dataset_arn instance-attribute
dataset_arn: str

The Amazon Resource Name (ARN) of the dataset.

dataset_id instance-attribute
dataset_id: str

The unique identifier of the dataset.

dataset_version instance-attribute
dataset_version: str

The version number being created.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

status instance-attribute
status: str

Always UPDATING immediately after this call. Poll GetDataset until status transitions to ACTIVE or UPDATE_FAILED.