[ aws . quicksight ]
describe-topic
Описание
Описывает тему.
См. также: Документацию API AWS
Синтаксис
describe-topic
--aws-account-id <value>
--topic-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 (строка)
--topic-id (строка)
--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
- текст
- таблица
- 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 -> (строка)
TopicId -> (строка)
Тема -> (структура)
Определение темы.
Имя -> (строка)
Описание -> (строка)
Версия пользовательского интерфейса -> (строка)
Наборы данных -> (список)
Наборы данных, с которыми связана тема.
(структура)
Структура, представляющая набор данных.
DatasetArn -> (строка)
Название набора данных -> (строка)
Описание набора данных -> (строка)
Агрегация данных -> (структура)
Определение агрегации данных.
Гранularity даты строки набора данных -> (строка)
DateTime значений.Имя столбца даты по умолчанию -> (строка)
Фильтры -> (список)
Список определений фильтров.
(структура)
Структура, представляющая фильтр, используемый для выбора элементов для темы.
Описание фильтра -> (строка)
Класс фильтра -> (строка)
ENFORCED_VALUE_FILTER , CONDITIONAL_VALUE_FILTER и NAMED_VALUE_FILTER .Имя фильтра -> (строка)
Синонимы фильтра -> (список)
Другие имена или псевдонимы фильтра.
(строка)
Имя поля операнда -> (строка)
Тип фильтра -> (строка)
CATEGORY_FILTER , NUMERIC_EQUALITY_FILTER , NUMERIC_RANGE_FILTER , DATE_RANGE_FILTER и RELATIVE_DATE_FILTER .Фильтр категории -> (структура)
Фильтр категории, связанный с этим фильтром.
Функция фильтра категории -> (строка)
EXACT и CONTAINS .Тип фильтра категории -> (строка)
Константа -> (структура)
Константа, используемая в фильтре категории.
Тип константы -> (строка)
SINGULAR и COLLECTIVE .Единичная константа -> (строка)
Совокупная константа -> (структура)
Совокупная константа, используемая в фильтре категории. Этот элемент используется для указания списка значений для константы.
Список значений -> (список)
Список значений для совокупной константы.
(строка)
Обратный -> (булево)
Фильтр равенства чисел -> (структура)
Фильтр равенства чисел.
Константа -> (структура)
Константа, используемая в фильтре равенства чисел.
Тип константы -> (строка)
SINGULAR .Единичная константа -> (строка)
Агрегация -> (строка)
NO_AGGREGATION , SUM , AVERAGE , COUNT , DISTINCT_COUNT , MAX , MEDIAN , MIN , STDEV , STDEVP , VAR и VARP .Фильтр диапазона чисел -> (структура)
Фильтр диапазона чисел.
Включительно -> (булево)
Константа -> (структура)
Константа, используемая в фильтре диапазона чисел.
Тип константы -> (строка)
RANGE .Константа диапазона -> (структура)
Значение константы, используемой для указания конечных точек фильтра диапазона.
Минимум -> (строка)
Максимум -> (строка)
Агрегация -> (строка)
NO_AGGREGATION , SUM , AVERAGE , COUNT , DISTINCT_COUNT , MAX , MEDIAN , MIN , STDEV , STDEVP , VAR и VARP .Фильтр диапазона дат -> (структура)
Фильтр диапазона дат.
Включительно -> (булево)
Константа -> (структура)
Константа, используемая в фильтре диапазона дат.
Тип константы -> (строка)
RANGE .Константа диапазона -> (структура)
Значение константы, используемой для указания конечных точек фильтра диапазона.
Минимум -> (строка)
Максимум -> (строка)
Фильтр относительной даты -> (структура)
Фильтр относительной даты.
Гранularity времени -> (строка)
DateTime значений.Функция фильтра относительной даты -> (строка)
BEFORE , AFTER и BETWEEN .Константа -> (структура)
Константа, используемая в фильтре относительной даты.
Тип константы -> (строка)
SINGULAR .Единичная константа -> (строка)
Столбцы -> (список)
Список определений столбцов.
(структура)
Представляет столбец в наборе данных.
ColumnName -> (строка)
ColumnFriendlyName -> (строка)
ColumnDescription -> (строка)
ColumnSynonyms -> (список)
Другие имена или псевдонимы столбца.
(строка)
ColumnDataRole -> (строка)
DIMENSION и MEASURE .Aggregation -> (строка)
IsIncludedInTopic -> (булево)
DisableIndexing -> (булево)
ComparativeOrder -> (структура)
Порядок отображения данных для столбца при использовании в сравнительном контексте.
UseOrdering -> (строка)
GREATER_IS_BETTER , LESSER_IS_BETTER и SPECIFIED .SpecifedOrder -> (список)
Список столбцов, используемых в сортировке.
(строка)
TreatUndefinedSpecifiedValues -> (строка)
LEAST и MOST .SemanticType -> (структура)
Семантический тип данных в столбце.
TypeName -> (строка)
SubTypeName -> (строка)
TypeParameters -> (карта)
Параметры семантического типа.
ключ -> (строка)
значение -> (строка)
TruthyCellValue -> (строка)
TruthyCellValueSynonyms -> (список)
Другие имена или псевдонимы значения ячейки истинности.
(строка)
FalseyCellValue -> (строка)
FalseyCellValueSynonyms -> (список)
Другие имена или псевдонимы значения ячейки ложности.
(строка)
TimeGranularity -> (строка)
DateTime .AllowedAggregations -> (список)
Список разрешенных типов агрегации для столбца. Допустимые значения для этой структуры - COUNT , DISTINCT_COUNT , MIN , MAX , MEDIAN , SUM , AVERAGE , STDEV , STDEVP , VAR , VARP и PERCENTILE .
(строка)
NotAllowedAggregations -> (список)
Список запрещенных типов агрегации для столбца. Допустимые значения для этой структуры - COUNT , DISTINCT_COUNT , MIN , MAX , MEDIAN , SUM , AVERAGE , STDEV , STDEVP , VAR , VARP и PERCENTILE .
(строка)
DefaultFormatting -> (структура)
Форматирование по умолчанию для значений в столбце.
DisplayFormat -> (строка)
AUTO , PERCENT , CURRENCY , NUMBER , DATE и STRING .DisplayFormatOptions -> (структура)
Дополнительные параметры форматирования отображения.
UseBlankCellFormat -> (булево)
BlankCellFormat -> (строка)
DateFormat -> (строка)
DateTime .DecimalSeparator -> (строка)
GroupingSeparator -> (строка)
UseGrouping -> (булево)
FractionDigits -> (целое число)
Prefix -> (строка)
Suffix -> (строка)
UnitScaler -> (строка)
NONE , AUTO , THOUSANDS , MILLIONS , BILLIONS и TRILLIONS .NegativeFormat -> (структура)
Формат отрицательных значений.
Prefix -> (строка)
Suffix -> (строка)
CurrencySymbol -> (строка)
USD .NeverAggregateInFilter -> (булево)
CellValueSynonyms -> (список)
Другие имена или псевдонимы значения ячейки столбца.
(структура)
Структура, представляющая синоним значения ячейки.
CellValue -> (строка)
Synonyms -> (список)
Другие имена или псевдонимы значения ячейки.
(строка)
NonAdditive -> (булево)
CalculatedFields -> (список)
Список определений вычисленных полей.
(структура)
Структура, представляющая вычисленное поле.
CalculatedFieldName -> (строка)
CalculatedFieldDescription -> (строка)
Expression -> (строка)
CalculatedFieldSynonyms -> (список)
Другие имена или псевдонимы вычисленного поля.
(строка)
IsIncludedInTopic -> (булево)
DisableIndexing -> (булево)
ColumnDataRole -> (строка)
DIMENSION и MEASURE.TimeGranularity -> (строка)
DateTime.DefaultFormatting -> (структура)
Определение формата по умолчанию.
DisplayFormat -> (строка)
AUTO, PERCENT, CURRENCY, NUMBER, DATE и STRING.DisplayFormatOptions -> (структура)
Дополнительные параметры для форматирования отображения.
UseBlankCellFormat -> (булево)
BlankCellFormat -> (строка)
DateFormat -> (строка)
DateTime.DecimalSeparator -> (строка)
GroupingSeparator -> (строка)
UseGrouping -> (булево)
FractionDigits -> (целое)
Prefix -> (строка)
Suffix -> (строка)
UnitScaler -> (строка)
NONE, AUTO, THOUSANDS, MILLIONS, BILLIONS и TRILLIONS.NegativeFormat -> (структура)
Формат отрицательных значений.
Prefix -> (строка)
Suffix -> (строка)
CurrencySymbol -> (строка)
USD.Aggregation -> (строка)
SUM, MAX, MIN, COUNT, DISTINCT_COUNT и AVERAGE.ComparativeOrder -> (структура)
Порядок отображения данных для вычисленного поля при использовании в контексте сравнения.
UseOrdering -> (строка)
GREATER_IS_BETTER, LESSER_IS_BETTER и SPECIFIED.SpecifedOrder -> (список)
Список столбцов, используемых в сортировке.
(строка)
TreatUndefinedSpecifiedValues -> (строка)
LEAST и MOST.SemanticType -> (структура)
Семантический тип.
TypeName -> (строка)
SubTypeName -> (строка)
TypeParameters -> (массив)
Параметры семантического типа.
ключ -> (строка)
значение -> (строка)
TruthyCellValue -> (строка)
TruthyCellValueSynonyms -> (список)
Другие имена или псевдонимы значения ячейки «истина».
(строка)
FalseyCellValue -> (строка)
FalseyCellValueSynonyms -> (список)
Другие имена или псевдонимы значения ячейки «ложь».
(строка)
AllowedAggregations -> (список)
Список типов агрегаций, разрешенных для вычисленного поля. Допустимые значения — COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP и PERCENTILE.
(строка)
NotAllowedAggregations -> (список)
Список типов агрегаций, запрещенных для вычисленного поля. Допустимые значения — COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP и PERCENTILE.
(строка)
NeverAggregateInFilter -> (булево)
CellValueSynonyms -> (список)
Другие имена или псевдонимы значения ячейки вычисленного поля.
(структура)
Структура, представляющая синоним значения ячейки.
CellValue -> (строка)
Synonyms -> (список)
Другие имена или псевдонимы значения ячейки.
(строка)
NonAdditive -> (булево)
NamedEntities -> (список)
Список определений именованных сущностей.
(структура)
Структура, представляющая именованную сущность.
EntityName -> (строка)
EntityDescription -> (строка)
EntitySynonyms -> (список)
Другие имена или псевдонимы именованной сущности.
(строка)
SemanticEntityType -> (структура)
Тип именованной сущности, который представляет тема.
TypeName -> (строка)
SubTypeName -> (строка)
TypeParameters -> (массив)
Параметры типа семантической сущности.
ключ -> (строка)
значение -> (строка)
Definition -> (список)
Определение именованной сущности.
(структура)
Структура, представляющая именованную сущность.
FieldName -> (строка)
PropertyName -> (строка)
PropertyRole -> (строка)
PRIMARY и ID.PropertyUsage -> (строка)
INHERIT, DIMENSION и MEASURE.Metric -> (структура)
Определение метрики.
Aggregation -> (строка)
SUM, MIN, MAX, COUNT, AVERAGE, DISTINCT_COUNT, STDEV, STDEVP, VAR, VARP, PERCENTILE, MEDIAN и CUSTOM.AggregationFunctionParameters -> (массив)
Дополнительные параметры функции агрегации.
ключ -> (строка)
значение -> (строка)
ConfigOptions -> (структура)
Параметры конфигурации для Topic.
QBusinessInsightsEnabled -> (булево)
Topic.RequestId -> (строка)
Status -> (целое)
© Copyright 2025, Amazon Web Services. Created using Sphinx.