Skip to content

update_dataset async

update_dataset(
    dataset_id: DatasetId,
    dataset_title: DatasetTitle,
    kind: DatasetKind,
    *,
    config_overrides: Optional[AsyncfinspacedataClientConfig] = None,
    client_token: Optional[ClientToken] = None,
    dataset_description: Optional[DatasetDescription] = None,
    alias: Optional[AliasString] = None,
    schema_definition: Optional[SchemaUnion] = None,
) -> UpdateDatasetResponse

Updates a FinSpace Dataset.

Parameters:

  • client_token (Optional[ClientToken], default: None ) –

    A token that ensures idempotency. This token expires in 10 minutes.

  • dataset_id (DatasetId) –

    The unique identifier for the Dataset to update.

  • dataset_title (DatasetTitle) –

    A display title for the Dataset.

  • kind (DatasetKind) –

    The format in which the Dataset data is structured.

    • TABULAR – Data is structured in a tabular format.

    • NON_TABULAR – Data is structured in a non-tabular format.

  • dataset_description (Optional[DatasetDescription], default: None ) –

    A description for the Dataset.

  • alias (Optional[AliasString], default: None ) –

    The unique resource identifier for a Dataset.

  • schema_definition (Optional[SchemaUnion], default: None ) –

    Definition for a schema on a tabular Dataset.

Raises:

Source code in docs_src/capo_finspace_data/_services/async_finspacedata.py
async def update_dataset(
    self,
    dataset_id: "capo_finspace_data.types.dataset_id.DatasetId",
    dataset_title: "capo_finspace_data.types.dataset_title.DatasetTitle",
    kind: "capo_finspace_data.types.dataset_kind.DatasetKind",
    *,
    config_overrides: Optional[AsyncfinspacedataClientConfig] = None,
    client_token: Optional[
        "capo_finspace_data.types.client_token.ClientToken"
    ] = None,
    dataset_description: Optional[
        "capo_finspace_data.types.dataset_description.DatasetDescription"
    ] = None,
    alias: Optional["capo_finspace_data.types.alias_string.AliasString"] = None,
    schema_definition: Optional[
        "capo_finspace_data.types.schema_union.SchemaUnion"
    ] = None,
) -> "capo_finspace_data.types.update_dataset_response.UpdateDatasetResponse":
    """<p>Updates a FinSpace Dataset.</p>

    Args:
        client_token: <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
        dataset_id: <p>The unique identifier for the Dataset to update.</p>
        dataset_title: <p>A display title for the Dataset.</p>
        kind: <p>The format in which the Dataset data is structured.</p> <ul> <li> <p> <code>TABULAR</code> – Data is structured in a tabular format.</p> </li> <li> <p> <code>NON_TABULAR</code> – Data is structured in a non-tabular format.</p> </li> </ul>
        dataset_description: <p>A description for the Dataset.</p>
        alias: <p>The unique resource identifier for a Dataset.</p>
        schema_definition: <p>Definition for a schema on a tabular Dataset.</p>

    Raises:
        capo_finspace_data.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_finspace_data.errors.conflict_exception.ConflictException: <p>The request conflicts with an existing resource.</p>
        capo_finspace_data.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_finspace_data.errors.resource_not_found_exception.ResourceNotFoundException: <p>One or more resources can't be found.</p>
        capo_finspace_data.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_finspace_data.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an AWS service.</p>
        capo_finspace_data.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_finspace_data.types.update_dataset_request.UpdateDatasetRequest]",
    ) -> AsyncOperationResponse[
        "capo_finspace_data.types.update_dataset_response.UpdateDatasetResponse"
    ]:
        import capo_finspace_data._operations.aws_habanero_public_api.update_dataset

        (
            output,
            http_response,
        ) = await capo_finspace_data._operations.aws_habanero_public_api.update_dataset.async_update_dataset(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateDataset")
    )
    input_: capo_finspace_data.types.update_dataset_request.UpdateDatasetRequest = {
        "dataset_id": dataset_id,
        "dataset_title": dataset_title,
        "kind": kind,
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if dataset_description is not None:
        input_["dataset_description"] = dataset_description
    if alias is not None:
        input_["alias"] = alias
    if schema_definition is not None:
        input_["schema_definition"] = schema_definition

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output