Spec-Zone.ru › AWS CLI v2

[ 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 (строка)

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

--topic-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
  • текст
  • таблица
  • 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 -> (строка)

Идентификатор ресурса Amazon (ARN) темы.

TopicId -> (строка)

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

Тема -> (структура)

Определение темы.

Имя -> (строка)

Имя темы.

Описание -> (строка)

Описание темы.

Версия пользовательского интерфейса -> (строка)

Версия пользовательского интерфейса темы.

Наборы данных -> (список)

Наборы данных, с которыми связана тема.

(структура)

Структура, представляющая набор данных.

DatasetArn -> (строка)

Идентификатор ресурса Amazon (ARN) набора данных.

Название набора данных -> (строка)

Название набора данных.

Описание набора данных -> (строка)

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

Агрегация данных -> (структура)

Определение агрегации данных.

Гран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 .

Фильтр диапазона чисел -> (структура)

Фильтр диапазона чисел.

Включительно -> (булево)

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

Константа -> (структура)

Константа, используемая в фильтре диапазона чисел.

Тип константы -> (строка)

Тип данных значения константы, используемой в фильтре диапазона. Допустимые значения для этой структуры — RANGE .

Константа диапазона -> (структура)

Значение константы, используемой для указания конечных точек фильтра диапазона.

Минимум -> (строка)

Минимальное значение для константы диапазона.

Максимум -> (строка)

Максимальное значение для константы диапазона.

Агрегация -> (строка)

Функция агрегации, указывающая, как вычислять значение числового поля для темы. Допустимые значения для этой структуры — NO_AGGREGATION , SUM , AVERAGE , COUNT , DISTINCT_COUNT , MAX , MEDIAN , MIN , STDEV , STDEVP , VAR и VARP .

Фильтр диапазона дат -> (структура)

Фильтр диапазона дат.

Включительно -> (булево)

Булево значение, указывающее, должны ли значения границ диапазона дат включаться в фильтр. Если значение true, фильтр включает начальную и конечную даты. Если значение false, фильтр их исключает.

Константа -> (структура)

Константа, используемая в фильтре диапазона дат.

Тип константы -> (строка)

Тип данных значения константы, используемой в фильтре диапазона. Допустимые значения для этой структуры — 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 -> (булево)

Включает Amazon Q Business Insights для Topic.

RequestId -> (строка)

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

Status -> (целое)

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

© Copyright 2025, Amazon Web Services. Created using Sphinx.

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API