[ aws . bcm-data-exports ]
create-export
Описание
Создаёт экспорт данных и задаёт запрос к данным, предпочтения доставки и любые необязательные теги ресурсов.
A DataQuery состоит из QueryStatement и TableConfigurations.
QueryStatement — это SQL-запрос. Экспорт данных поддерживает только ограниченный подмножество SQL-синтаксиса. Для получения дополнительной информации о поддерживаемом SQL-синтаксисе см. раздел Запрос к данным. Чтобы просмотреть доступные таблицы и столбцы, см. словарь таблиц Экспорта данных.
TableConfigurations — это набор указанных TableProperties для таблицы, к которой осуществляется запрос в QueryStatement. TableProperties — это дополнительные настройки, которые вы можете предоставить, чтобы изменить данные и схему таблицы. У каждой таблицы могут быть разные TableProperties. Однако таблицы не обязаны иметь какие-либо TableProperties. У каждой свойства таблицы есть значение по умолчанию, которое оно принимает, если не указано иначе. Для получения дополнительной информации о настройках таблиц см. Запрос к данным. Чтобы просмотреть доступные свойства таблицы для каждой таблицы, см. словарь таблиц Экспорта данных или используйте API ListTables, чтобы получить ответ со всеми таблицами и их доступными свойствами.
См. также: Документацию API AWS
Синтаксис
create-export
--export <value>
[--resource-tags <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]
Параметры
--export (структура)
Подробности экспорта, включая запрос к данным, имя, описание и конфигурацию назначения.
DataQuery -> (структура)
Запрос к данным для этого конкретного экспорта данных.
QueryStatement -> (строка)
TableConfigurations -> (карта)
Настройка таблицы.
key -> (строка)
value -> (карта)
key -> (строка)
value -> (строка)
Description -> (строка)
DestinationConfigurations -> (структура)
Конфигурация назначения для этого конкретного экспорта данных.
S3Destination -> (структура)
Объект, описывающий место назначения файла экспорта данных.
S3Bucket -> (строка)
S3OutputConfigurations -> (структура)
Настройка вывода для экспорта данных.
Compression -> (строка)
Format -> (строка)
OutputType -> (строка)
Overwrite -> (строка)
S3Prefix -> (строка)
S3Region -> (строка)
ExportArn -> (строка)
Name -> (строка)
RefreshCadence -> (структура)
Интервал для обновления экспорта Amazon Web Services в вашем ведре S3.
Frequency -> (строка)
Синтаксис JSON:
{
"DataQuery": {
"QueryStatement": "string",
"TableConfigurations": {"string": {"string": "string"
...}
...}
},
"Description": "string",
"DestinationConfigurations": {
"S3Destination": {
"S3Bucket": "string",
"S3OutputConfigurations": {
"Compression": "GZIP"|"PARQUET",
"Format": "TEXT_OR_CSV"|"PARQUET",
"OutputType": "CUSTOM",
"Overwrite": "CREATE_NEW_REPORT"|"OVERWRITE_REPORT"
},
"S3Prefix": "string",
"S3Region": "string"
}
},
"ExportArn": "string",
"Name": "string",
"RefreshCadence": {
"Frequency": "SYNCHRONOUS"
}
}
--resource-tags (список)
Необязательный список тегов для ассоциации с указанным экспортом. Каждый тег состоит из ключа и значения, а каждый ключ должен быть уникальным для ресурса.
(структура)
Структура тега, содержащая ключ и значение тега.
Key -> (строка)
Value -> (строка)
Сокращённый синтаксис:
Key=string,Value=string ...
Синтаксис JSON:
[
{
"Key": "string",
"Value": "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
- 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 (булево)
Отключить кли-паджер для вывода.
--cli-auto-prompt (булево)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (булево)
Отключить автоматическое запросы параметров ввода CLI.
Вывод
ExportArn -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.