AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . finspace-data ]

create-dataset

Description

Creates a new FinSpace Dataset.

See also: AWS API Documentation

Synopsis

  create-dataset
[--client-token <value>]
--dataset-title <value>
--kind <value>
[--dataset-description <value>]
[--owner-info <value>]
--permission-group-params <value>
[--alias <value>]
[--schema-definition <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--client-token (string)

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

--dataset-title (string)

Display title for a FinSpace Dataset.

--kind (string)

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.

Possible values:

  • TABULAR
  • NON_TABULAR

--dataset-description (string)

Description of a Dataset.

--owner-info (structure)

Contact information for a Dataset owner.

name -> (string)

The name of the Dataset owner.

phoneNumber -> (string)

Phone number for the Dataset owner.

email -> (string)

Email address for the Dataset owner.

Shorthand Syntax:

name=string,phoneNumber=string,email=string

JSON Syntax:

{
  "name": "string",
  "phoneNumber": "string",
  "email": "string"
}

--permission-group-params (structure)

Permission group parameters for Dataset permissions.

permissionGroupId -> (string)

The unique identifier for the PermissionGroup .

datasetPermissions -> (list)

List of resource permissions.

(structure)

Resource permission for a dataset. When you create a dataset, all the other members of the same user group inherit access to the dataset. You can only create a dataset if your user group has application permission for Create Datasets.

The following is a list of valid dataset permissions that you can apply:

  • ViewDatasetDetails
  • ReadDatasetDetails
  • AddDatasetData
  • CreateDataView
  • EditDatasetMetadata
  • DeleteDataset

For more information on the dataset permissions, see Supported Dataset Permissions in the FinSpace User Guide.

permission -> (string)

Permission for a resource.

Shorthand Syntax:

permissionGroupId=string,datasetPermissions=[{permission=string},{permission=string}]

JSON Syntax:

{
  "permissionGroupId": "string",
  "datasetPermissions": [
    {
      "permission": "string"
    }
    ...
  ]
}

--alias (string)

The unique resource identifier for a Dataset.

--schema-definition (structure)

Definition for a schema on a tabular Dataset.

tabularSchemaConfig -> (structure)

The configuration for a schema on a tabular Dataset.

columns -> (list)

List of column definitions.

(structure)

The definition of a column in a tabular Dataset.

dataType -> (string)

Data type of a column.

  • STRING – A String data type. CHAR – A char data type. INTEGER – An integer data type. TINYINT – A tinyint data type. SMALLINT – A smallint data type. BIGINT – A bigint data type. FLOAT – A float data type. DOUBLE – A double data type. DATE – A date data type. DATETIME – A datetime data type. BOOLEAN – A boolean data type. BINARY – A binary data type.

columnName -> (string)

The name of a column.

columnDescription -> (string)

Description for a column.

primaryKeyColumns -> (list)

List of column names used for primary key.

(string)

Column Name

JSON Syntax:

{
  "tabularSchemaConfig": {
    "columns": [
      {
        "dataType": "STRING"|"CHAR"|"INTEGER"|"TINYINT"|"SMALLINT"|"BIGINT"|"FLOAT"|"DOUBLE"|"DATE"|"DATETIME"|"BOOLEAN"|"BINARY",
        "columnName": "string",
        "columnDescription": "string"
      }
      ...
    ],
    "primaryKeyColumns": ["string", ...]
  }
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

datasetId -> (string)

The unique identifier for the created Dataset.