generate-data-set

Описание

Асинхронно публикует запрашиваемый набор данных в указатый бакет S3 и уведомляет указанную тему SNS, как только данные станут доступны. Возвращает уникальный идентификатор запроса, который может использоваться для сопоставления запросов с уведомлениями из темы SNS. Наборы данных будут опубликованы в формате CSV (значения, разделённые запятыми) с именем файла {тип_набора_данных}_ГГГГ-ММ-ДД.csv. Если файл с таким же именем уже существует (например, если тот же набор данных запрашивается дважды), оригинальный файл будет перезаписан новым. Требуется роль с прикреплённой политикой разрешений, предоставляющей разрешения на следующие действия: s3:PutObject, s3:GetBucketLocation, sns:GetTopicAttributes, sns:Publish, iam:GetRolePolicy.

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

Синтаксис

  generate-data-set
--data-set-type <value>
--data-set-publication-date <value>
--role-name-arn <value>
--destination-s3-bucket-name <value>
[--destination-s3-prefix <value>]
--sns-topic-arn <value>
[--customer-defined-values <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]

Параметры

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

--data-set-publication-date (отметка времени) Дата публикации набора данных. Для ежедневных наборов данных укажите дату с разрешением до дня для желаемого дня. Для ежемесячных наборов данных, кроме тех, у которых префикс disbursed_amount, укажите дату с разрешением до месяца для желаемого месяца (значение дня будет проигнорировано). Для наборов данных с префиксом disbursed_amount укажите дату с разрешением до дня для желаемого дня. Для этих наборов данных мы будем искать назад во времени в течение 31 дня до тех пор, пока не найдём первый набор данных (последний).

--role-name-arn (строка) Amazon Resource Name (ARN) роли с прикреплённой политикой разрешений для взаимодействия с предоставленными AWS-сервисами.

--destination-s3-bucket-name (строка) Имя (понятное имя, а не ARN) целевого ведра S3.

--destination-s3-prefix (строка) (Необязательно) Желаемый префикс S3 для опубликованного набора данных, аналогично пути к каталогу в стандартных файловых системах. Например, если задано имя ведра «mybucket» и префикс «myprefix/mydatasets», выходной файл «outputfile» будет опубликован в «s3://mybucket/myprefix/mydatasets/outputfile». Если структура каталогов префикса не существует, она будет создана. Если префикс не указан, набор данных будет опубликован в корневом каталоге S3-ведёр.

--sns-topic-arn (строка) Amazon Resource Name (ARN) темы SNS, которая будет уведомлена, когда набор данных будет опубликован или произойдёт ошибка.

--customer-defined-values (массив) (Необязательно) Пара ключей-значений, которые будут возвращены без изменений в сообщении уведомления Amazon SNS и файле метаданных набора данных. Эти пары ключей-значений могут быть использованы для сопоставления ответов с информацией о слежении из других систем.ключ -> (строка)

Сокращённый синтаксис:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "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
• текст
• таблица
• 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.

Вывод

dataSetRequestId -> (строка)