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:
-
dataset_id
(DatasetId)
–
The unique identifier of the dataset to update.
-
client_token
(Optional[ClientToken], default:
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.
-
description
(Optional[str], default:
None
)
–
The updated description for the dataset.
Raises:
Source code in docs_src/capo_bedrock_agentcore_control/_services/bedrock_agent_core_control.py
| def update_dataset(
self,
dataset_id: "capo_bedrock_agentcore_control.types.dataset_id.DatasetId",
*,
config_overrides: Optional[BedrockAgentCoreControlClientConfig] = None,
client_token: Optional[
"capo_bedrock_agentcore_control.types.client_token.ClientToken"
] = None,
description: Optional[str] = None,
) -> "capo_bedrock_agentcore_control.types.update_dataset_response.UpdateDatasetResponse":
"""<p> Updates a dataset's metadata. Synchronous operation. Only provided fields are updated; omitted fields remain unchanged. To modify dataset content, use <code>AddDatasetExamples</code>, <code>UpdateDatasetExamples</code>, or <code>DeleteDatasetExamples</code>. </p>
Args:
dataset_id: <p> The unique identifier of the dataset to update. </p>
client_token: <p>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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
description: <p> The updated description for the dataset. </p>
Raises:
capo_bedrock_agentcore_control.errors.access_denied_exception.AccessDeniedException: <p>This exception is thrown when a request is denied per access permissions</p>
capo_bedrock_agentcore_control.errors.conflict_exception.ConflictException: <p>This exception is thrown when there is a conflict performing an operation</p>
capo_bedrock_agentcore_control.errors.internal_server_exception.InternalServerException: <p>This exception is thrown if there was an unexpected error during processing of request</p>
capo_bedrock_agentcore_control.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception is thrown when a resource referenced by the operation does not exist</p>
capo_bedrock_agentcore_control.errors.throttling_exception.ThrottlingException: <p>This exception is thrown when the number of requests exceeds the limit</p>
capo_bedrock_agentcore_control.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the service.</p>
capo_bedrock_agentcore_control.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_bedrock_agentcore_control.types.update_dataset_request.UpdateDatasetRequest]",
) -> OperationResponse[
"capo_bedrock_agentcore_control.types.update_dataset_response.UpdateDatasetResponse"
]:
import capo_bedrock_agentcore_control._operations.amazon_bedrock_agent_core_control.update_dataset
output, http_response = (
capo_bedrock_agentcore_control._operations.amazon_bedrock_agent_core_control.update_dataset.update_dataset(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("UpdateDataset")
)
input_: capo_bedrock_agentcore_control.types.update_dataset_request.UpdateDatasetRequest = {
"dataset_id": dataset_id
}
if client_token is None:
client_token = str(uuid.uuid4())
input_["client_token"] = client_token
if description is not None:
input_["description"] = description
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|