Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . quicksight ]

update-data-set

Description

Updates a dataset.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-data-set
--aws-account-id <value>
--data-set-id <value>
--name <value>
--physical-table-map <value>
[--logical-table-map <value>]
--import-mode <value>
[--column-groups <value>]
[--row-level-permission-data-set <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--aws-account-id (string)

The AWS account ID.

--data-set-id (string)

The ID for the dataset that you want to update. This ID is unique per AWS Region for each AWS account.

--name (string)

The display name for the dataset.

--physical-table-map (map)

Declares the physical tables that are available in the underlying data sources.

JSON Syntax:

{"string": {
      "RelationalTable": {
        "DataSourceArn": "string",
        "Schema": "string",
        "Name": "string",
        "InputColumns": [
          {
            "Name": "string",
            "Type": "STRING"|"INTEGER"|"DECIMAL"|"DATETIME"|"BIT"|"BOOLEAN"|"JSON"
          }
          ...
        ]
      },
      "CustomSql": {
        "DataSourceArn": "string",
        "Name": "string",
        "SqlQuery": "string",
        "Columns": [
          {
            "Name": "string",
            "Type": "STRING"|"INTEGER"|"DECIMAL"|"DATETIME"|"BIT"|"BOOLEAN"|"JSON"
          }
          ...
        ]
      },
      "S3Source": {
        "DataSourceArn": "string",
        "UploadSettings": {
          "Format": "CSV"|"TSV"|"CLF"|"ELF"|"XLSX"|"JSON",
          "StartFromRow": integer,
          "ContainsHeader": true|false,
          "TextQualifier": "DOUBLE_QUOTE"|"SINGLE_QUOTE",
          "Delimiter": "string"
        },
        "InputColumns": [
          {
            "Name": "string",
            "Type": "STRING"|"INTEGER"|"DECIMAL"|"DATETIME"|"BIT"|"BOOLEAN"|"JSON"
          }
          ...
        ]
      }
    }
  ...}

--logical-table-map (map)

Configures the combination and transformation of the data from the physical tables.

JSON Syntax:

{"string": {
      "Alias": "string",
      "DataTransforms": [
        {
          "ProjectOperation": {
            "ProjectedColumns": ["string", ...]
          },
          "FilterOperation": {
            "ConditionExpression": "string"
          },
          "CreateColumnsOperation": {
            "Columns": [
              {
                "ColumnName": "string",
                "ColumnId": "string",
                "Expression": "string"
              }
              ...
            ]
          },
          "RenameColumnOperation": {
            "ColumnName": "string",
            "NewColumnName": "string"
          },
          "CastColumnTypeOperation": {
            "ColumnName": "string",
            "NewColumnType": "STRING"|"INTEGER"|"DECIMAL"|"DATETIME",
            "Format": "string"
          },
          "TagColumnOperation": {
            "ColumnName": "string",
            "Tags": [
              {
                "ColumnGeographicRole": "COUNTRY"|"STATE"|"COUNTY"|"CITY"|"POSTCODE"|"LONGITUDE"|"LATITUDE"
              }
              ...
            ]
          }
        }
        ...
      ],
      "Source": {
        "JoinInstruction": {
          "LeftOperand": "string",
          "RightOperand": "string",
          "Type": "INNER"|"OUTER"|"LEFT"|"RIGHT",
          "OnClause": "string"
        },
        "PhysicalTableId": "string"
      }
    }
  ...}

--import-mode (string)

Indicates whether you want to import the data into SPICE.

Possible values:

  • SPICE
  • DIRECT_QUERY

--column-groups (list)

Groupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.

Shorthand Syntax:

GeoSpatialColumnGroup={Name=string,CountryCode=string,Columns=[string,string]} ...

JSON Syntax:

[
  {
    "GeoSpatialColumnGroup": {
      "Name": "string",
      "CountryCode": "US",
      "Columns": ["string", ...]
    }
  }
  ...
]

--row-level-permission-data-set (structure)

The row-level security configuration for the data you want to create.

Shorthand Syntax:

Arn=string,PermissionPolicy=string

JSON Syntax:

{
  "Arn": "string",
  "PermissionPolicy": "GRANT_ACCESS"|"DENY_ACCESS"
}

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

See 'aws help' for descriptions of global parameters.

Output

Arn -> (string)

The Amazon Resource Name (ARN) of the dataset.

DataSetId -> (string)

The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.

IngestionArn -> (string)

The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.

IngestionId -> (string)

The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.

RequestId -> (string)

The AWS request ID for this operation.

Status -> (integer)

The HTTP status of the request.