Skip to content

update_dataset

Operation

update_dataset

update_dataset(request: UpdateDatasetInput | UpdateDatasetInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateDatasetInputDict]) -> UpdateDatasetOutput

Updates a dataset's metadata. Synchronous operation. Only provided fields are updated; omitted fields remain unchanged. To modify dataset content, use AddDatasetExamples, UpdateDatasetExamples, or DeleteDatasetExamples.

Parameters:

Name Type Description Default
request UpdateDatasetInput | UpdateDatasetInputDict | 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[UpdateDatasetInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateDatasetOutput

An instance of UpdateDatasetOutput.

update_dataset async

update_dataset(request: UpdateDatasetInput | UpdateDatasetInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateDatasetInputDict]) -> UpdateDatasetOutput

Updates a dataset's metadata. Synchronous operation. Only provided fields are updated; omitted fields remain unchanged. To modify dataset content, use AddDatasetExamples, UpdateDatasetExamples, or DeleteDatasetExamples.

Parameters:

Name Type Description Default
request UpdateDatasetInput | UpdateDatasetInputDict | 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[UpdateDatasetInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateDatasetOutput

An instance of UpdateDatasetOutput.

Input

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

UpdateDatasetInputDict

Bases: TypedDict

Dictionary form of UpdateDatasetInput.

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

description instance-attribute
description: str | None

The updated description for the dataset.

UpdateDatasetInput dataclass

Bases: _SerdeShape

Dataclass for UpdateDatasetInput 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 update.

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

The updated description for the dataset.

Output

UpdateDatasetOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateDatasetOutput structure.

Attributes

dataset_arn instance-attribute
dataset_arn: str

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

dataset_id instance-attribute
dataset_id: str

The unique identifier of the updated dataset.

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.

updated_at instance-attribute
updated_at: datetime

The timestamp when the dataset was updated.