Spec-Zone.ru › AWS CLI v2

[ aws . databrew ]

list-datasets

Описание

Отображает все наборы данных DataBrew.

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

list-datasets — это операция с постраничной обработкой. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничную обработку, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной обработкой, аргумент --query должен извлекать данные из результатов следующих выражений запроса: Datasets

Синтаксис

  list-datasets
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, заданному --generate-cli-skeleton. Если другие аргументы указаны в командной строке, эти значения переопределят значения, предоставленные через JSON. Невозможно передавать произвольные двоичные данные с помощью предоставленного значения JSON, так как строка будет воспринята буквально. Этот параметр не может быть указан вместе с --cli-input-yaml.

--starting-token (строка)

Маркер для указания начала постраничной обработки. Это NextToken из ранее усечённого ответа.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя по AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения данных в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить таймаут вызовов AWS-сервиса.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя по AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничной обработки укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя по AWS Command Line Interface.

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

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

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

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

Вывод

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

Список определённых наборов данных.

(структура)

Представляет набор данных, который может быть обработан DataBrew.

AccountId -> (строка)

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

CreatedBy -> (строка)

Amazon Resource Name (ARN) пользователя, который создал набор данных.

CreateDate -> (временная метка)

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

Name -> (строка)

Уникальное имя набора данных.

Format -> (строка)

Формат файла набора данных, созданного из файла или папки Amazon S3.

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

Набор параметров, определяющих, как DataBrew интерпретирует данные в наборе данных.

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

Параметры, определяющие, как DataBrew интерпретирует входные данные JSON.

MultiLine -> (булево)

Значение, указывающее, содержит ли входной JSON вложенные символы новой строки.

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

Параметры, определяющие, как DataBrew интерпретирует входные данные Excel.

SheetNames -> (список)

Одно или несколько именованных листов в файле Excel, которые будут включены в набор данных.

(строка)

SheetIndexes -> (список)

Один или несколько номеров листов в файле Excel, которые будут включены в набор данных.

(целое число)

HeaderRow -> (булево)

Переменная, указывающая, является ли первая строка файла заголовком. Если значение ложно, имена столбцов генерируются автоматически.

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

Параметры, определяющие, как DataBrew интерпретирует входные данные CSV.

Delimiter -> (строка)

Один символ, определяющий разделитель, используемый в файле CSV.

HeaderRow -> (булево)

Переменная, указывающая, является ли первая строка файла заголовком. Если значение ложно, имена столбцов генерируются автоматически.

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

Информация о том, как DataBrew может найти набор данных в каталоге Glue Data Catalog или Amazon S3.

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

Расположение данных в Amazon S3.

Bucket -> (строка)

Имя ведра Amazon S3.

Key -> (строка)

Уникальное имя объекта в ведре.

BucketOwner -> (строка)

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

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

Параметры Glue Data Catalog для данных.

CatalogId -> (строка)

Уникальный идентификатор учётной записи Amazon Web Services, которая владеет каталогом Data Catalog, хранящим данные.

DatabaseName -> (строка)

Имя базы данных в каталоге Data Catalog.

TableName -> (строка)

Имя таблицы базы данных в каталоге Data Catalog. Эта таблица соответствует набору данных DataBrew.

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

Представляет расположение Amazon, где DataBrew может хранить промежуточные результаты.

Bucket -> (строка)

Имя ведра Amazon S3.

Key -> (строка)

Уникальное имя объекта в ведре.

BucketOwner -> (строка)

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

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

Информация для подключения к файлам входных данных набора данных, хранящимся в базе данных.

GlueConnectionName -> (строка)

Glue Connection, хранящий информацию о подключении к целевой базе данных.

DatabaseTableName -> (строка)

Таблица в целевой базе данных.

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

Представляет расположение Amazon S3 (имя ведра, владелец ведра и ключ объекта), где DataBrew может читать входные данные или записывать выходные данные из задания.

Bucket -> (строка)

Имя ведра Amazon S3.

Key -> (строка)

Уникальное имя объекта в ведре.

BucketOwner -> (строка)

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

QueryString -> (строка)

Пользовательский SQL-запрос, выполняемый над предоставленным соединением Glue. Этот SQL будет использоваться в проектах и заданиях DataBrew.

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

Содержит дополнительную информацию о ресурсах, необходимую для конкретных наборов данных.

SourceArn -> (строка)

Amazon Resource Name (ARN), связанный с набором данных. В настоящее время DataBrew поддерживает только ARN из Amazon AppFlow.

LastModifiedDate -> (временная метка)

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

LastModifiedBy -> (строка)

Amazon Resource Name (ARN) пользователя, который последний раз изменил набор данных.

Source -> (строка)

Расположение данных для набора данных, либо Amazon S3, либо Glue Data Catalog.

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

Набор параметров, определяющих, как DataBrew интерпретирует путь к набору данных в Amazon S3.

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

Если предоставлена, эта структура определяет диапазон дат для сопоставления объектов Amazon S3 на основе атрибута LastModifiedDate в Amazon S3.

Expression -> (строка)

Выражение, включающее имена условий, за которыми следуют переменные подстановки, возможно, сгруппированные и объединённые с другими условиями. Например, “(starts_with :prefix1 or starts_with :prefix2) and (ends_with :suffix1 or ends_with :suffix2)”. Переменные подстановки должны начинаться с символа ‘:’.

ValuesMap -> (карта)

Карта имён переменных подстановки и их значений, используемых в этом выражении фильтра.

key -> (строка)

value -> (строка)

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

Если предоставлена, эта структура накладывает ограничение на количество файлов, которые должны быть выбраны.

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

Количество файлов Amazon S3 для выбора.

OrderedBy -> (строка)

Критерий для сортировки файлов Amazon S3 перед их выбором. По умолчанию используется LAST_MODIFIED_DATE в качестве критерия сортировки. В настоящее время это единственное допустимое значение.

Order -> (строка)

Критерий для сортировки файлов Amazon S3 перед их выбором. По умолчанию используется DESCENDING порядок, т.е. файлы с самой поздней датой модификации выбираются первыми. Другое возможное значение - ASCENDING.

Parameters -> (карта)

Структура, отображающая имена параметров, используемых в пути Amazon S3 набора данных, и их определения.

key -> (строка)

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

Представляет параметр набора данных, определяющий тип и условия для параметра в пути Amazon S3 набора данных.

Name -> (строка)

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

Type -> (строка)

Тип параметра набора данных, может быть одним из ‘String’, ‘Number’ или ‘Datetime’.

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

Дополнительные параметры, такие как формат и часовой пояс. Требуется для параметров типа datetime.

Format -> (строка)

Обязательный параметр, определяющий формат даты и времени, используемый для параметра даты в пути Amazon S3. Должен использовать только поддерживаемые спецификаторы даты и времени и разделители, все литеры a-z или A-Z должны быть экранированы одинарной кавычкой. Например, “MM.dd.yyyy-‘at’-HH:mm”.

TimezoneOffset -> (строка)

Необязательное значение смещения часового пояса значения параметра даты и времени в пути Amazon S3. Не должно использоваться, если формат для этого параметра включает поля часового пояса. Если смещение не указано, предполагается UTC.

LocaleCode -> (строка)

Необязательное значение кода локали (не US), необходимое для правильной интерпретации некоторых форматов дат.

CreateColumn -> (булево)

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

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

Необязательная структура выражения фильтра для применения дополнительных критериев соответствия к параметру.

Expression -> (строка)

Выражение, включающее имена условий, за которыми следуют переменные подстановки, возможно, сгруппированные и объединённые с другими условиями. Например, “(starts_with :prefix1 or starts_with :prefix2) and (ends_with :suffix1 or ends_with :suffix2)”. Переменные подстановки должны начинаться с символа ‘:’.

ValuesMap -> (карта)

Карта имён переменных подстановки и их значений, используемых в этом выражении фильтра.

key -> (строка)

value -> (строка)

Tags -> (карта)

Метки метаданных, применённые к набору данных.

key -> (строка)

value -> (строка)

ResourceArn -> (строка)

Уникальный Amazon Resource Name (ARN) для набора данных.

NextToken -> (строка)

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

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

Spec-Zone.ru

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