[ aws . quicksight ]
обновление-набора-данных
Описание
Обновляет набор данных. Данный оператор не поддерживает наборы данных, содержащие загруженные файлы в качестве источника. Частичные обновления не поддерживаются данным оператором.
См. также: Документацию API AWS
Синтаксис
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>]
[--field-folders <value>]
[--row-level-permission-data-set <value>]
[--row-level-permission-tag-configuration <value>]
[--column-level-permission-rules <value>]
[--data-set-usage-configuration <value>]
[--dataset-parameters <value>]
[--performance-configuration <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Параметры
--aws-account-id (строка)
--data-set-id (строка)
--name (строка)
--physical-table-map (словарь)
Определяет физические таблицы, доступные в исходных источниках данных.
ключ -> (строка)
значение -> (структура)
Вид источника данных, содержащий информацию о структуре данных в исходном источнике. Это структура переменного типа. Для того, чтобы структура была корректной, только один из атрибутов может быть не нулевым.
RelationalTable -> (структура)
Тип физической таблицы для реляционных источников данных.
DataSourceArn -> (строка)
Catalog -> (строка)
Schema -> (строка)
Name -> (строка)
InputColumns -> (список)
Схема столбцов таблицы.
(структура)
Метаданные столбца, используемого в качестве входных данных для операции преобразования.
Name -> (строка)
Type -> (строка)
SubType -> (строка)
CustomSql -> (структура)
Физический тип таблицы, созданный на основе результатов запроса пользовательского SQL.
DataSourceArn -> (строка)
Name -> (строка)
SqlQuery -> (строка)
Columns -> (список)
Схема столбцов из набора результатов запроса SQL.
(структура)
Метаданные столбца, используемого в качестве входных данных для операции преобразования.
Name -> (строка)
Type -> (строка)
SubType -> (строка)
S3Source -> (структура)
Тип физической таблицы для источника данных S3.
DataSourceArn -> (строка)
UploadSettings -> (структура)
Информация о формате файла или файлов источника S3.
Format -> (строка)
StartFromRow -> (целое число)
ContainsHeader -> (булево)
TextQualifier -> (строка)
Delimiter -> (строка)
InputColumns -> (список)
Тип физической таблицы для источника данных S3.
Примечание
Для файлов, которые не являются JSON, в столбцах входных данных поддерживаются толькоSTRING типы данных.(структура)
Метаданные столбца, используемого в качестве входных данных для операции преобразования.
Name -> (строка)
Type -> (строка)
SubType -> (строка)
Синтаксис JSON:
{"string": {
"RelationalTable": {
"DataSourceArn": "string",
"Catalog": "string",
"Schema": "string",
"Name": "string",
"InputColumns": [
{
"Name": "string",
"Type": "STRING"|"INTEGER"|"DECIMAL"|"DATETIME"|"BIT"|"BOOLEAN"|"JSON",
"SubType": "FLOAT"|"FIXED"
}
...
]
},
"CustomSql": {
"DataSourceArn": "string",
"Name": "string",
"SqlQuery": "string",
"Columns": [
{
"Name": "string",
"Type": "STRING"|"INTEGER"|"DECIMAL"|"DATETIME"|"BIT"|"BOOLEAN"|"JSON",
"SubType": "FLOAT"|"FIXED"
}
...
]
},
"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",
"SubType": "FLOAT"|"FIXED"
}
...
]
}
}
...}
--logical-table-map (словарь)
Настраивает комбинацию и преобразование данных из физических таблиц.
ключ -> (строка)
значение -> (структура)
Логическая таблица — это единица, к которой применяются операции объединения и преобразования данных. У логической таблицы есть источник, который может быть либо физической таблицей, либо результатом объединения. Когда логическая таблица указывает на физическую таблицу, она действует как измененная копия этой физической таблицы с помощью операций преобразования.
Alias -> (строка)
DataTransforms -> (список)
Операции преобразования, которые действуют на этой логической таблице. Для корректной структуры только один из атрибутов может быть не нулевым.
(структура)
Преобразование данных в логической таблице. Это структура переменного типа. Для корректной структуры только один из атрибутов может быть не нулевым.
ProjectOperation -> (структура)
Операция, которая проектирует столбцы. Операции, следующие за проекцией, могут ссылаться только на спроектированные столбцы.
ProjectedColumns -> (список)
Проектируемые столбцы.
(строка)
FilterOperation -> (структура)
Операция, которая фильтрует строки на основе определенного условия.
ConditionExpression -> (строка)
CreateColumnsOperation -> (структура)
Операция, которая создает вычисляемые столбцы. Столбцы, созданные в одной такой операции, образуют лексическое закрытие.
Columns -> (список)
Вычисляемые столбцы для создания.
(структура)
Вычисляемый столбец для набора данных.
ColumnName -> (строка)
ColumnId -> (строка)
Expression -> (строка)
RenameColumnOperation -> (структура)
Операция, которая переименовывает столбец.
ColumnName -> (строка)
NewColumnName -> (строка)
CastColumnTypeOperation -> (структура)
Операция преобразования, которая преобразует тип столбца.
ColumnName -> (строка)
NewColumnType -> (строка)
SubType -> (строка)
Format -> (строка)
TagColumnOperation -> (структура)
Операция, которая добавляет теги к столбцу с дополнительной информацией.
ColumnName -> (строка)
Tags -> (список)
Тег столбца набора данных, в настоящее время используется только для тегирования географических типов.
Примечание
Это не теги функции тегирования Amazon Web Services.(структура)
Тег столбца в структуре `` TagColumnOperation ``. Это структура переменного типа. Для корректной структуры только один из атрибутов может быть не нулевым.
ColumnGeographicRole -> (строка)
ColumnDescription -> (структура)
Описание столбца.
Text -> (строка)
UntagColumnOperation -> (структура)
Операция преобразования, которая удаляет теги, связанные со столбцом.
ColumnName -> (строка)
TagNames -> (список)
Теги столбцов, которые нужно удалить из этого столбца.
(строка)
OverrideDatasetParameterOperation -> (структура)
Операция преобразования, которая переопределяет значения параметров набора данных, определенные в другом наборе данных.
ParameterName -> (строка)
NewParameterName -> (строка)
NewDefaultValues -> (структура)
Новые значения параметров по умолчанию.
StringStaticValues -> (список)
Список статических значений по умолчанию для заданного строкового параметра.
(строка)
DecimalStaticValues -> (список)
Список статических значений по умолчанию для заданного десятичного параметра.
(двойное)
DateTimeStaticValues -> (список)
Список статических значений по умолчанию для заданного параметра даты и времени.
(метка времени)
IntegerStaticValues -> (список)
Список статических значений по умолчанию для заданного целочисленного параметра.
(длинное целое число)
Source -> (структура)
Источник этой логической таблицы.
JoinInstruction -> (структура)
Указывает результат объединения двух логических таблиц.
LeftOperand -> (строка)
RightOperand -> (строка)
LeftJoinKeyProperties -> (структура)
Свойства ключа объединения левого операнда.
UniqueKey -> (булево)
RightJoinKeyProperties -> (структура)
Свойства ключа объединения правого операнда.
UniqueKey -> (булево)
Type -> (строка)
OnClause -> (строка)
ON объединения.PhysicalTableId -> (строка)
DataSetArn -> (строка)
Синтаксис JSON:
{"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",
"SubType": "FLOAT"|"FIXED",
"Format": "string"
},
"TagColumnOperation": {
"ColumnName": "string",
"Tags": [
{
"ColumnGeographicRole": "COUNTRY"|"STATE"|"COUNTY"|"CITY"|"POSTCODE"|"LONGITUDE"|"LATITUDE",
"ColumnDescription": {
"Text": "string"
}
}
...
]
},
"UntagColumnOperation": {
"ColumnName": "string",
"TagNames": ["COLUMN_GEOGRAPHIC_ROLE"|"COLUMN_DESCRIPTION", ...]
},
"OverrideDatasetParameterOperation": {
"ParameterName": "string",
"NewParameterName": "string",
"NewDefaultValues": {
"StringStaticValues": ["string", ...],
"DecimalStaticValues": [double, ...],
"DateTimeStaticValues": [timestamp, ...],
"IntegerStaticValues": [long, ...]
}
}
}
...
],
"Source": {
"JoinInstruction": {
"LeftOperand": "string",
"RightOperand": "string",
"LeftJoinKeyProperties": {
"UniqueKey": true|false
},
"RightJoinKeyProperties": {
"UniqueKey": true|false
},
"Type": "INNER"|"OUTER"|"LEFT"|"RIGHT",
"OnClause": "string"
},
"PhysicalTableId": "string",
"DataSetArn": "string"
}
}
...}
--import-mode (строка)
Указывает, хотите ли вы импортировать данные в SPICE.
Возможные значения:
SPICEDIRECT_QUERY
--column-groups (список)
Группировки столбцов, которые работают вместе в определенных функциях Amazon QuickSight. В настоящее время поддерживается только геопространственная иерархия.
(структура)
Группировки столбцов, которые работают вместе в определенных функциях Amazon QuickSight. Это структура переменного типа. Для того, чтобы эта структура была допустимой, только один из атрибутов может быть не null.
GeoSpatialColumnGroup -> (структура)
Группа геопространственных столбцов, обозначающая иерархию.
Name -> (строка)
CountryCode -> (строка)
Columns -> (список)
Столбцы в этой иерархии.
(строка)
Краткая синтаксическая запись:
GeoSpatialColumnGroup={Name=string,CountryCode=string,Columns=[string,string]} ...
Синтаксис JSON:
[
{
"GeoSpatialColumnGroup": {
"Name": "string",
"CountryCode": "US",
"Columns": ["string", ...]
}
}
...
]
--field-folders (массив)
Папка, содержащая поля и вложенные подпапки для вашего набора данных.
ключ -> (строка)
значение -> (структура)
Элемент FieldFolder — это папка, которая содержит поля и вложенные подпапки.
описание -> (строка)
столбцы -> (список)
Папка содержит список столбцов. Столбец может находиться только в одной папке.
(строка)
Краткая синтаксическая запись:
KeyName1=description=string,columns=string,string,KeyName2=description=string,columns=string,string
Синтаксис JSON:
{"string": {
"description": "string",
"columns": ["string", ...]
}
...}
--row-level-permission-data-set (структура)
Настройка безопасности на уровне строк для данных, которые вы хотите создать.
Namespace -> (строка)
Arn -> (строка)
PermissionPolicy -> (строка)
DENY_ACCESS включен только для обратной совместимости.FormatVersion -> (строка)
Правила для пользователей или групп, связанные с набором данных, содержащим разрешения для RLS.
По умолчанию, FormatVersion является VERSION_1. Когда FormatVersion является VERSION_1, UserName и GroupName обязательны. Когда FormatVersion является VERSION_2, UserARN и GroupARN обязательны, и Namespace не должно существовать.
Status -> (строка)
ENABLED. Если отключено, статус — DISABLED.Краткая синтаксическая запись:
Namespace=string,Arn=string,PermissionPolicy=string,FormatVersion=string,Status=string
Синтаксис JSON:
{
"Namespace": "string",
"Arn": "string",
"PermissionPolicy": "GRANT_ACCESS"|"DENY_ACCESS",
"FormatVersion": "VERSION_1"|"VERSION_2",
"Status": "ENABLED"|"DISABLED"
}
--row-level-permission-tag-configuration (структура)
Настройка тегов набора данных для установки безопасности на уровне строк. Теги безопасности на уровне строк в настоящее время поддерживаются только для анонимной вставки.
Status -> (строка)
ENABLED. Если отключено, статус — DISABLED.TagRules -> (список)
Набор правил, связанных с безопасностью на уровне строк, таких как имена тегов и столбцы, которым они назначены.
(структура)
Набор правил, связанных с тегом.
TagKey -> (строка)
ColumnName -> (строка)
TagMultiValueDelimiter -> (строка)
MatchAllValue -> (строка)
TagRuleConfigurations -> (список)
Список правил конфигурации тегов для применения к набору данных. Все конфигурации тегов имеют условие ИЛИ. Теги в каждом блоке будут объединены (И). По крайней мере, одно правило в этой структуре должно иметь все значения тегов, назначенные ему, чтобы применить безопасность на уровне строк (RLS) к набору данных.
(список)
Краткая синтаксическая запись:
Status=string,TagRules=[{TagKey=string,ColumnName=string,TagMultiValueDelimiter=string,MatchAllValue=string},{TagKey=string,ColumnName=string,TagMultiValueDelimiter=string,MatchAllValue=string}],TagRuleConfigurations=[[string,string],[string,string]]
Синтаксис JSON:
{
"Status": "ENABLED"|"DISABLED",
"TagRules": [
{
"TagKey": "string",
"ColumnName": "string",
"TagMultiValueDelimiter": "string",
"MatchAllValue": "string"
}
...
],
"TagRuleConfigurations": [
["string", ...]
...
]
}
--column-level-permission-rules (список)
Набор одного или нескольких определений `` ColumnLevelPermissionRule ``.
(структура)
Правило, определенное для предоставления доступа к одному или нескольким ограниченным столбцам. Каждый набор данных может иметь несколько правил. Чтобы создать ограниченный столбец, добавьте его в одно или несколько правил. Каждое правило должно содержать как минимум один столбец и как минимум одного пользователя или группу. Чтобы видеть ограниченный столбец, пользователю или группе необходимо добавить его в правило для этого столбца.
Principals -> (список)
Массив Amazon Resource Names (ARN) пользователей или групп Amazon QuickSight.
(строка)
ColumnNames -> (список)
Массив имен столбцов.
(строка)
Краткая синтаксическая запись:
Principals=string,string,ColumnNames=string,string ...
Синтаксис JSON:
[
{
"Principals": ["string", ...],
"ColumnNames": ["string", ...]
}
...
]
--data-set-usage-configuration (структура)
Настройка использования для применения к дочерним наборам данных, которые ссылаются на этот набор данных в качестве источника.
DisableUseAsDirectQuerySource -> (булево)
DisableUseAsImportedSource -> (булево)
Краткая синтаксическая запись:
DisableUseAsDirectQuerySource=boolean,DisableUseAsImportedSource=boolean
Синтаксис JSON:
{
"DisableUseAsDirectQuerySource": true|false,
"DisableUseAsImportedSource": true|false
}
--dataset-parameters (список)
Объявления параметров набора данных.
(структура)
Параметр, созданный в наборе данных. Параметр может быть строковым, целочисленным, десятичным или временным типом данных.
StringDatasetParameter -> (структура)
Строковый параметр, созданный в наборе данных.
Id -> (строка)
Name -> (строка)
ValueType -> (строка)
single value или multi value.DefaultValues -> (структура)
Список значений по умолчанию для данного типа строкового параметра набора данных. Эта структура принимает только статические значения.
StaticValues -> (список)
Список статических значений по умолчанию для данного строкового параметра.
(строка)
DecimalDatasetParameter -> (структура)
Десятичный параметр, созданный в наборе данных.
Id -> (строка)
Name -> (строка)
ValueType -> (строка)
single value или multi value.DefaultValues -> (структура)
Список значений по умолчанию для данного десятичного параметра. Эта структура принимает только статические значения.
StaticValues -> (список)
Список статических значений по умолчанию для данного десятичного параметра.
(число с плавающей точкой)
IntegerDatasetParameter -> (структура)
Целочисленный параметр, созданный в наборе данных.
Id -> (строка)
Name -> (строка)
ValueType -> (строка)
single value или multi value.DefaultValues -> (структура)
Список значений по умолчанию для данного целочисленного параметра. Эта структура принимает только статические значения.
StaticValues -> (список)
Список статических значений по умолчанию для данного целочисленного параметра.
(целое число)
DateTimeDatasetParameter -> (структура)
Параметр даты и времени, созданный в наборе данных.
Id -> (строка)
Name -> (строка)
ValueType -> (строка)
single value или multi value.TimeGranularity -> (строка)
DefaultValues -> (структура)
Список значений по умолчанию для данного параметра даты и времени. Эта структура принимает только статические значения.
StaticValues -> (список)
Список статических значений по умолчанию для данного параметра даты и времени.
(временная метка)
Синтаксис JSON:
[
{
"StringDatasetParameter": {
"Id": "string",
"Name": "string",
"ValueType": "MULTI_VALUED"|"SINGLE_VALUED",
"DefaultValues": {
"StaticValues": ["string", ...]
}
},
"DecimalDatasetParameter": {
"Id": "string",
"Name": "string",
"ValueType": "MULTI_VALUED"|"SINGLE_VALUED",
"DefaultValues": {
"StaticValues": [double, ...]
}
},
"IntegerDatasetParameter": {
"Id": "string",
"Name": "string",
"ValueType": "MULTI_VALUED"|"SINGLE_VALUED",
"DefaultValues": {
"StaticValues": [long, ...]
}
},
"DateTimeDatasetParameter": {
"Id": "string",
"Name": "string",
"ValueType": "MULTI_VALUED"|"SINGLE_VALUED",
"TimeGranularity": "YEAR"|"QUARTER"|"MONTH"|"WEEK"|"DAY"|"HOUR"|"MINUTE"|"SECOND"|"MILLISECOND",
"DefaultValues": {
"StaticValues": [timestamp, ...]
}
}
}
...
]
--performance-configuration (структура)
Настройка оптимизации производительности набора данных, содержащего UniqueKey конфигурацию.
UniqueKeys -> (список)
UniqueKey конфигурация.
(структура)
UniqueKey конфигурация, которая ссылается на столбец набора данных.
ColumnNames -> (список)
Имя столбца, на который ссылается UniqueKey конфигурация.
(строка)
Синтаксис JSON:
{
"UniqueKeys": [
{
"ColumnNames": ["string", ...]
}
...
]
}
--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы указаны в командной строке, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного значения JSON, так как строка будет воспринята буквально. Это может не быть указано вместе с --cli-input-yaml.
--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если предоставлено без значения или со значением input, выводит JSON-пример входных данных, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, выведет пример входных данных YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, оно проверяет входные данные команды и возвращает JSON-пример выходных данных для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI и не гарантирует обратной совместимости в сгенерированном JSON-скелете.
Глобальные параметры
--debug (булево)
Включить отладочную запись журнала.
--endpoint-url (строка)
Переопределить URL по умолчанию команды заданным URL.
--no-verify-ssl (булево)
По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.
--no-paginate (булево)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (строка)
Стиль форматирования выходных данных команды.
- json
- text
- таблица
- yaml
- yaml-поток
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использовать определенный профиль из файла учетных данных.
--region (строка)
Регион для использования. Переопределяет настройки конфигурации/окружения.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включить/выключить цветной вывод.
- вкл
- выкл
- авто
--no-sign-request (булево)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.
--ca-bundle (строка)
Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/окружения.
--cli-read-timeout (целое число)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.
--cli-connect-timeout (целое число)
Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.
--cli-binary-format (строка)
Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде закодированной строки base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, отображающего двоичный блок, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от настроек cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (булево)
Отключить вывод пейджера CLI.
--cli-auto-prompt (булево)
Автоматически запросить параметры ввода CLI.
--no-cli-auto-prompt (булево)
Отключить автоматическое запрошение параметров ввода CLI.
Вывод
Arn -> (строка)
DataSetId -> (строка)
IngestionArn -> (строка)
IngestionId -> (строка)
RequestId -> (строка)
Status -> (целое число)
© Copyright 2025, Amazon Web Services. Created using Sphinx.