Skip to content

create_dataset

create_dataset(
    dataset_title: DatasetTitle,
    kind: DatasetKind,
    permission_group_params: PermissionGroupParams,
    *,
    config_overrides: Optional[finspacedataClientConfig] = None,
    client_token: Optional[ClientToken] = None,
    dataset_description: Optional[DatasetDescription] = None,
    owner_info: Optional[DatasetOwnerInfo] = None,
    alias: Optional[AliasString] = None,
    schema_definition: Optional[SchemaUnion] = None,
) -> CreateDatasetResponse

Creates a new FinSpace Dataset.

Parameters:

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

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

  • dataset_title (DatasetTitle) –

    Display title for a FinSpace Dataset.

  • kind (DatasetKind) –

    The format in which 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 ) –

    Description of a Dataset.

  • owner_info (Optional[DatasetOwnerInfo], default: None ) –

    Contact information for a Dataset owner.

  • permission_group_params (PermissionGroupParams) –

    Permission group parameters for Dataset permissions.

  • 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/finspacedata.py
def create_dataset(
    self,
    dataset_title: "capo_finspace_data.types.dataset_title.DatasetTitle",
    kind: "capo_finspace_data.types.dataset_kind.DatasetKind",
    permission_group_params: "capo_finspace_data.types.permission_group_params.PermissionGroupParams",
    *,
    config_overrides: Optional[finspacedataClientConfig] = None,
    client_token: Optional[
        "capo_finspace_data.types.client_token.ClientToken"
    ] = None,
    dataset_description: Optional[
        "capo_finspace_data.types.dataset_description.DatasetDescription"
    ] = None,
    owner_info: Optional[
        "capo_finspace_data.types.dataset_owner_info.DatasetOwnerInfo"
    ] = 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.create_dataset_response.CreateDatasetResponse":
    """<p>Creates a new FinSpace Dataset.</p>

    Args:
        client_token: <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
        dataset_title: <p>Display title for a FinSpace Dataset.</p>
        kind: <p>The format in which 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>Description of a Dataset.</p>
        owner_info: <p>Contact information for a Dataset owner.</p>
        permission_group_params: <p>Permission group parameters for Dataset permissions.</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.limit_exceeded_exception.LimitExceededException: <p>A limit has exceeded.</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.
    """

    def _handler(
        req: "OperationRequest[capo_finspace_data.types.create_dataset_request.CreateDatasetRequest]",
    ) -> OperationResponse[
        "capo_finspace_data.types.create_dataset_response.CreateDatasetResponse"
    ]:
        import capo_finspace_data._operations.aws_habanero_public_api.create_dataset

        output, http_response = (
            capo_finspace_data._operations.aws_habanero_public_api.create_dataset.create_dataset(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_finspace_data.types.create_dataset_request.CreateDatasetRequest",
    ) -> dict[str, Any]:
        import capo_finspace_data.types.create_dataset_request

        return capo_finspace_data.types.create_dataset_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("CreateDataset", redact_input=_redact_input),
    )
    input_: capo_finspace_data.types.create_dataset_request.CreateDatasetRequest = {
        "dataset_title": dataset_title,
        "kind": kind,
        "permission_group_params": permission_group_params,
    }
    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 owner_info is not None:
        input_["owner_info"] = owner_info
    if alias is not None:
        input_["alias"] = alias
    if schema_definition is not None:
        input_["schema_definition"] = schema_definition

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output