описание-набора-данных

Описание

Описывает набор данных. Данная операция не поддерживает наборы данных, включающие загруженные файлы в качестве источника.

См. также: Документацию API AWS

Синтаксис

  describe-data-set
--aws-account-id <value>
--data-set-id <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 (строка)

Идентификатор учетной записи Amazon Web Services.

--data-set-id (строка)

Идентификатор набора данных, который вы хотите создать. Этот идентификатор уникален для каждой области Amazon Web Services и каждой учетной записи Amazon Web Services.

--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
table
yaml
yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Использовать указанную область. Переопределяет настройки конфигурации/среды.

--version (строка)

Показать версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

on
off
auto

--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 (логическое значение)

Отключить вывод страницы AWS CLI.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры входных данных CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запросы параметров входных данных CLI.

Вывод

Набор данных -> (структура)

Информация о наборе данных.

Arn -> (строка)

Amazon Resource Name (ARN) ресурса.

DataSetId -> (строка)

Идентификатор набора данных.

Name -> (строка)

Имя набора данных для отображения.

CreatedTime -> (отметка времени)

Время создания набора данных.

LastUpdatedTime -> (отметка времени)

Последнее время обновления набора данных.

PhysicalTableMap -> (карта)

Объявляет доступные физические таблицы в базовых источниках данных.

key -> (строка)

value -> (структура)

Представление источника данных, содержащее информацию о форме данных в базовом источнике. Это структура типа «вариант». Для валидности структуры только один из атрибутов может быть не пустым.

RelationalTable -> (структура)

Тип физической таблицы для реляционных источников данных.

DataSourceArn -> (строка)

Amazon Resource Name (ARN) для источника данных.

Catalog -> (строка)

Каталог, связанный со таблицей.

Schema -> (строка)

Имя схемы. Это имя применимо к определённым реляционным базам данных.

Name -> (строка)

Имя реляционной таблицы.

InputColumns -> (список)

Схема столбцов таблицы.

(структура)

Метаданные столбца, используемого в качестве входных данных для операции преобразования.

Name -> (строка)

Имя этого столбца в базовом источнике данных.

Type -> (строка)

Тип данных столбца.

SubType -> (строка)

Подтип данных столбца. Подтипы доступны только для десятичных столбцов, которые являются частью набора данных SPICE.

CustomSql -> (структура)

Физический тип таблицы, построенный из результатов запроса на пользовательском SQL.

DataSourceArn -> (строка)

Amazon Resource Name (ARN) источника данных.

Name -> (строка)

Имя результата запроса SQL для отображения.

SqlQuery -> (строка)

Запрос SQL.

Columns -> (список)

Схема столбцов из набора результатов запроса SQL.

(структура)

Метаданные столбца, используемого в качестве входных данных для операции преобразования.

Name -> (строка)

Имя этого столбца в базовом источнике данных.

Type -> (строка)

Тип данных столбца.

SubType -> (строка)

S3Source -> (структура)

Тип физической таблицы для источника данных S3.

DataSourceArn -> (строка)

Amazon Resource Name (ARN) для источника данных.

UploadSettings -> (структура)

Информация о формате файла или файлов источника S3.

Format -> (строка)

Формат файла.

StartFromRow -> (целое число)

Номер строки для начала чтения данных.

ContainsHeader -> (булево)

Содержит ли файл заголовок, или файлы имеют каждый свой заголовок.

TextQualifier -> (строка)

Разделитель текста.

Delimiter -> (строка)

Разделитель значений в файле.

InputColumns -> (список)

Тип физической таблицы для источника данных S3.

Примечание

Для файлов, не являющихся JSON, в столбцах входных данных поддерживаются только STRING типы данных.

(структура)

Метаданные столбца, используемого в качестве входных данных для операции преобразования.

Name -> (строка)

Имя этого столбца в базовом источнике данных.

Type -> (строка)

Тип данных столбца.

SubType -> (строка)

LogicalTableMap -> (карта)

Настраивает комбинирование и преобразование данных из физических таблиц.

key -> (строка)

Идентификатор логической таблицы, определённой в наборе данных

value -> (структура)

Логическая таблица — это единица, объединяющая и подвергающая преобразованиям данные. У логической таблицы есть источник, который может быть либо физической таблицей, либо результатом объединения. Когда логическая таблица указывает на физическую таблицу, логическая таблица действует как изменяемая копия этой физической таблицы через операции преобразования.

Alias -> (строка)

Имя логической таблицы для отображения.

DataTransforms -> (список)

Операции преобразования, которые действуют на эту логическую таблицу. Для валидности этой структуры только один из атрибутов может быть не пустым.

(структура)

Преобразование данных в логической таблице. Это структура типа «вариант». Для валидности структуры только один из атрибутов может быть не пустым.

ProjectOperation -> (структура)

Операция, которая проектирует столбцы. Операции, которые следуют за проекцией, могут ссылаться только на спроектированные столбцы.

ProjectedColumns -> (список)

Спроектированные столбцы.

(строка)

FilterOperation -> (структура)

Операция, которая фильтрует строки на основе какого-либо условия.

ConditionExpression -> (строка)

Выражение, которое должно вычисляться в булево значение. Строки, для которых выражение вычисляет true, сохраняются в наборе данных.

CreateColumnsOperation -> (структура)

Операция, которая создаёт вычисляемые столбцы. Столбцы, созданные в такой операции, образуют лексическое окружение.

Columns -> (список)

Вычисляемые столбцы для создания.

(структура)

Вычисляемый столбец для набора данных.

ColumnName -> (строка)

Имя столбца.

ColumnId -> (строка)

Уникальный идентификатор для идентификации вычисляемого столбца. Во время обновления набора данных, если идентификатор столбца вычисляемого столбца совпадает с идентификатором существующего вычисляемого столбца, Amazon QuickSight сохраняет существующий вычисляемый столбец.

Expression -> (строка)

Выражение, определяющее вычисляемый столбец.

RenameColumnOperation -> (структура)

Операция, которая переименовывает столбец.

ColumnName -> (строка)

Имя столбца, который нужно переименовать.

NewColumnName -> (строка)

Новое имя столбца.

CastColumnTypeOperation -> (структура)

Операция преобразования, которая преобразует столбец в другой тип.

ColumnName -> (строка)

Имя столбца.

NewColumnType -> (строка)

Новый тип данных столбца.

SubType -> (строка)

Подтип данных нового столбца. Подтипы доступны только для десятичных столбцов, которые являются частью набора данных SPICE.

Format -> (строка)

При преобразовании столбца из строки в тип даты и времени, вы можете указать строку в формате, поддерживаемом Amazon QuickSight, чтобы обозначить формат исходных данных.

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 -> (булево)

Значение, которое указывает, что строка в таблице однозначно идентифицируется столбцами в ключе объединения. Используется Amazon QuickSight для оптимизации производительности запросов.

RightJoinKeyProperties -> (структура)

Свойства ключа объединения правого операнда.

UniqueKey -> (булево)

Type -> (строка)

Тип объединения.

OnClause -> (строка)

Инструкции объединения, заданные в ON-определении объединения.

PhysicalTableId -> (строка)

Идентификатор физической таблицы.

DataSetArn -> (строка)

Amazon Resource Number (ARN) родительского набора данных.

OutputColumns -> (список)

Список столбцов после всех преобразований. Эти столбцы доступны в шаблонах, анализах и панелях.

(структура)

Столбец вывода.

Name -> (строка)

Имя столбца для отображения.

Description -> (строка)

Описание столбца.

Type -> (строка)

Тип данных столбца.

SubType -> (строка)

Подтип данных столбца.

ImportMode -> (строка)

Значение, которое указывает, хотите ли вы импортировать данные в SPICE.

ConsumedSpiceCapacityInBytes -> (long)

Объём использованной SPICE-ёмкости этим набором данных. Значение 0 указывает, что набор данных не импортирован в SPICE.

ColumnGroups -> (list)

Группировки столбцов, работающих вместе в определённых функциях Amazon QuickSight. В настоящее время поддерживается только геопространственная иерархия.

(structure)

Группировки столбцов, работающих вместе в определённых функциях Amazon QuickSight. Это структура типа вариант. Для корректной структуры только один из атрибутов может быть не нулевым.

GeoSpatialColumnGroup -> (structure)

Группа геопространственных столбцов, обозначающая иерархию.

Name -> (string)

Имя отображения иерархии.

CountryCode -> (string)

Код страны.

Columns -> (list)

Столбцы в этой иерархии.

(string)

FieldFolders -> (map)

Папка, содержащая поля и вложенные подпапки для вашего набора данных.

key -> (string)

value -> (structure)

Элемент FieldFolder — это папка, содержащая поля и вложенные подпапки.

description -> (string)

Описание папки с полями.

columns -> (list)

Папка содержит список столбцов. Столбец может находиться только в одной папке.

(string)

RowLevelPermissionDataSet -> (structure)

Настройка защиты на уровне строк для набора данных.

Namespace -> (string)

Пространство имён, связанное с набором данных, содержащим разрешения для защиты на уровне строк.

Arn -> (string)

Amazon Resource Name (ARN) набора данных, содержащего разрешения для защиты на уровне строк.

PermissionPolicy -> (string)

Тип разрешений для использования при интерпретации разрешений для защиты на уровне строк. DENY_ACCESS включен только для обратной совместимости.

FormatVersion -> (string)

Правила, связанные с пользователем или группой, связанные с набором данных, содержащим разрешения для защиты на уровне строк.

По умолчанию, FormatVersion является VERSION_1. Когда FormatVersion является VERSION_1, UserName и GroupName являются обязательными. Когда FormatVersion является VERSION_2, UserARN и GroupARN являются обязательными, и Namespace не должно существовать.

Status -> (string)

Статус набора данных с разрешениями защиты на уровне строк. Если включено, статус — ENABLED. Если отключено, статус — DISABLED.

RowLevelPermissionTagConfiguration -> (structure)

Элемент, который можно использовать для определения тегов для защиты на уровне строк.

Status -> (string)

Статус тегов защиты на уровне строк. Если включено, статус — ENABLED. Если отключено, статус — DISABLED.

TagRules -> (list)

Набор правил, связанных с защитой на уровне строк, таких как имена тегов и столбцы, которым они назначены.

(structure)

Набор правил, связанных с тегом.

TagKey -> (string)

Уникальный ключ тега.

ColumnName -> (string)

Имя столбца, которому назначен ключ тега.

TagMultiValueDelimiter -> (string)

Строка, используемая для разграничения значений при передаче значений во время выполнения. Например, можно разделить значения запятыми.

MatchAllValue -> (string)

Строка, используемая для фильтрации по всем значениям в столбце в наборе данных, а не для перечисления значений по одному. Например, можно использовать звёздочку в качестве значения "совпадение со всем".

TagRuleConfigurations -> (list)

Список правил конфигурации тегов, которые необходимо применить к набору данных. Все конфигурации тегов имеют условие ИЛИ. Теги в каждой плитке будут объединены (И). Для применения защиты на уровне строк (RLS) к набору данных по крайней мере одно правило в этой структуре должно иметь все назначенные значения тегов.

(list)

(string)

ColumnLevelPermissionRules -> (list)

Набор одного или нескольких определений правила `` ColumnLevelPermissionRule ``.

(structure)

Правило, определённое для предоставления доступа к одному или нескольким ограниченным столбцам. Каждый набор данных может иметь несколько правил. Чтобы создать ограниченный столбец, добавьте его к одному или нескольким правилам. Каждое правило должно содержать по крайней мере один столбец и по крайней мере одного пользователя или группу. Чтобы увидеть ограниченный столбец, пользователь или группа должны быть добавлены в правило для этого столбца.

Principals -> (list)

Массив Amazon Resource Names (ARN) для пользователей или групп Amazon QuickSight.

(string)

ColumnNames -> (list)

Массив имён столбцов.

(string)

DataSetUsageConfiguration -> (structure)

Конфигурация использования, применяемая к дочерним наборам данных, ссылающимся на этот набор данных в качестве источника.

DisableUseAsDirectQuerySource -> (boolean)

Параметр, определяющий, может ли дочерний набор данных прямого запроса использовать этот набор данных в качестве источника.

DisableUseAsImportedSource -> (boolean)

Параметр, определяющий, может ли дочерний набор данных, хранящийся в QuickSight, использовать этот набор данных в качестве источника.

DatasetParameters -> (list)

Параметры, объявленные в наборе данных.

(structure)

Параметр, созданный в наборе данных. Параметр может быть строковым, целочисленным, десятичным или временным типом данных.

StringDatasetParameter -> (structure)

Строковый параметр, созданный в наборе данных.

Id -> (string)

Идентификатор строкового параметра, созданного в наборе данных.

Name -> (string)

Имя строкового параметра, созданного в наборе данных.

ValueType -> (string)

Тип значения параметра набора данных. Допустимые значения — single value или multi value.

DefaultValues -> (structure)

Список значений по умолчанию для данного типа строкового параметра набора данных. Эта структура принимает только статические значения.

StaticValues -> (list)

Список статических значений по умолчанию для данного строкового параметра.

(string)

Значение по умолчанию для строкового параметра.

DecimalDatasetParameter -> (structure)

Десятичный параметр, созданный в наборе данных.

Id -> (string)

Идентификатор десятичного параметра, созданного в наборе данных.

Name -> (string)

Имя десятичного параметра, созданного в наборе данных.

ValueType -> (string)

Тип значения параметра набора данных. Допустимые значения — single value или multi value.

DefaultValues -> (structure)

Список значений по умолчанию для данного десятичного параметра. Эта структура принимает только статические значения.

StaticValues -> (list)

Список статических значений по умолчанию для данного десятичного параметра.

(double)

Значение по умолчанию для десятичного параметра.

IntegerDatasetParameter -> (structure)

Целочисленный параметр, созданный в наборе данных.

Id -> (string)

Идентификатор целочисленного параметра, созданного в наборе данных.

Name -> (string)

Имя целочисленного параметра, созданного в наборе данных.

ValueType -> (string)

Тип значения параметра набора данных. Допустимые значения — single value или multi value.

DefaultValues -> (structure)

Список значений по умолчанию для данного целочисленного параметра. Эта структура принимает только статические значения.

StaticValues -> (list)

Список статических значений по умолчанию для данного целочисленного параметра.

(long)

Значение по умолчанию для целочисленного параметра.

DateTimeDatasetParameter -> (structure)

Параметр даты и времени, созданный в наборе данных.

Id -> (string)

Идентификатор параметра, созданного в наборе данных.

Name -> (string)

Имя параметра даты и времени, созданного в наборе данных.

ValueType -> (string)

Тип значения параметра набора данных. Допустимые значения — single value или multi value.

TimeGranularity -> (string)

Гранularity времени параметра даты и времени.

DefaultValues -> (structure)

Список значений по умолчанию для данного параметра даты и времени. Эта структура принимает только статические значения.

StaticValues -> (list)

Список статических значений по умолчанию для данного параметра даты и времени.

(timestamp)

Значение по умолчанию для параметра даты и времени.

PerformanceConfiguration -> (structure)

Конфигурация оптимизации производительности набора данных.

UniqueKeys -> (list)

Конфигурация UniqueKey.

(structure)

Конфигурация UniqueKey, ссылающаяся на столбец набора данных.

ColumnNames -> (list)

Имя столбца, на который ссылается конфигурация UniqueKey.

(string)

UseAs -> (string)

Использование набора данных.

RequestId -> (string)

Идентификатор запроса Amazon Web Services для этой операции.

Status -> (integer)

HTTP-статус запроса.

END_OF_DOCUMENT_MARKER