[ aws . quicksight ]
start-asset-bundle-export-job
Описание
Запускает задание экспорта пакета активов.
Задание экспорта пакета активов экспортирует указанные ресурсы Amazon QuickSight. Также можно выбрать экспорт всех зависимостей активов в рамках одного задания. Задания экспорта выполняются асинхронно и могут быть опрошены с помощью вызова DescribeAssetBundleExportJob API. При успешном завершении задания возвращается URL для скачивания экспортированных ресурсов. URL действителен в течение 5 минут и может быть обновлён с помощью вызова DescribeAssetBundleExportJob API. Каждый аккаунт Amazon QuickSight может запускать до 5 заданий экспорта одновременно.
Вызывающий API должен иметь необходимые разрешения в своей роли IAM для доступа к каждому ресурсу, прежде чем ресурсы смогут быть экспортированы.
См. также: AWS API Documentation
Синтаксис
start-asset-bundle-export-job
--aws-account-id <value>
--asset-bundle-export-job-id <value>
--resource-arns <value>
[--include-all-dependencies | --no-include-all-dependencies]
--export-format <value>
[--cloud-formation-override-property-configuration <value>]
[--include-permissions | --no-include-permissions]
[--include-tags | --no-include-tags]
[--validation-strategy <value>]
[--include-folder-memberships | --no-include-folder-memberships]
[--include-folder-members <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 (string)
--asset-bundle-export-job-id (string)
--resource-arns (list)
Массив ARN ресурсов для экспорта. Поддерживаются следующие ресурсы.
AnalysisDashboardDataSetDataSourceRefreshScheduleThemeVPCConnection
Вызывающий API должен иметь необходимые разрешения в своей роли IAM для доступа к каждому ресурсу, прежде чем эти ресурсы можно будет экспортировать.
(string)
Синтаксис:
"string" "string" ...
--include-all-dependencies | --no-include-all-dependencies (boolean)
ResourceArns. Если вы установили IncludeAllDependencies в TRUE, также экспортируется любой ресурс темы, набора данных и источника данных, который является зависимостью панели мониторинга.--export-format (string)
Формат данных экспорта.
Возможные значения:
CLOUDFORMATION_JSONQUICKSIGHT_JSON
--cloud-formation-override-property-configuration (structure)
Необязательная коллекция структур, которые генерируют параметры CloudFormation для переопределения существующих значений свойств ресурсов при экспорте ресурса в новый шаблон CloudFormation.
Используйте это поле, если поле ExportFormat вызова API StartAssetBundleExportJobRequest установлено в CLOUDFORMATION_JSON.
ResourceIdOverrideConfiguration -> (structure)
Необязательный список структур, управляющих параметризацией идентификаторов ресурсов в возвращаемом шаблоне CloudFormation.
PrefixForAllResources -> (boolean)
VPCConnections -> (list)
Необязательный список структур, управляющих параметризацией ресурсов VPCConnection в возвращаемом шаблоне CloudFormation.
(structure)
Управляет параметризацией определенного ресурса VPCConnection в выводимом шаблоне CloudFormation.
Arn -> (string)
VPCConnection, переопределяющие свойства которого настроены в этой структуре.Properties -> (list)
Список свойств ресурса VPCConnection для создания переменных в возвращаемом шаблоне CloudFormation.
(string)
RefreshSchedules -> (list)
Необязательный список структур, управляющих параметризацией ресурсов RefreshSchedule в возвращаемом шаблоне CloudFormation.
(structure)
Управляет параметризацией определенного ресурса RefreshSchedule в возвращаемом шаблоне CloudFormation.
Arn -> (string)
RefreshSchedule, переопределяющие свойства которого настроены в этой структуре.Properties -> (list)
Список свойств ресурса RefreshSchedule для создания переменных в возвращаемом шаблоне CloudFormation.
(string)
DataSources -> (list)
Необязательный список структур, управляющих параметризацией ресурсов DataSource в возвращаемом шаблоне CloudFormation.
(structure)
Управляет параметризацией определенного ресурса DataSource в возвращаемом шаблоне CloudFormation.
Arn -> (string)
DataSource, переопределяющие свойства которого настроены в этой структуре.Properties -> (list)
Список свойств ресурса DataSource для создания переменных в возвращаемом шаблоне CloudFormation.
(string)
DataSets -> (list)
Необязательный список структур, управляющих параметризацией ресурсов DataSet в возвращаемом шаблоне CloudFormation.
(structure)
Управляет параметризацией определенного ресурса DataSet в возвращаемом шаблоне CloudFormation.
Arn -> (string)
DataSet, переопределяющие свойства которого настроены в этой структуре.Properties -> (list)
Список свойств ресурса DataSet для создания переменных в возвращаемом шаблоне CloudFormation.
(string)
Themes -> (list)
Необязательный список структур, управляющих параметризацией ресурсов Theme в возвращаемом шаблоне CloudFormation.
(structure)
Управляет параметризацией определенного ресурса Theme в возвращаемом шаблоне CloudFormation.
Arn -> (string)
Theme, переопределяющие свойства которого настроены в этой структуре.Properties -> (list)
Список свойств ресурса Theme для создания переменных в возвращаемом шаблоне CloudFormation.
(string)
Analyses -> (list)
Необязательный список структур, управляющих параметризацией ресурсов Analysis в возвращаемом шаблоне CloudFormation.
(structure)
Управляет параметризацией определенного ресурса Analysis в возвращаемом шаблоне CloudFormation.
Arn -> (string)
Analysis, переопределяющие свойства которого настроены в этой структуре.Properties -> (list)
Список свойств ресурса Analysis для создания переменных в возвращаемом шаблоне CloudFormation.
(string)
Dashboards -> (list)
Необязательный список структур, управляющих параметризацией ресурсов Dashboard в возвращаемом шаблоне CloudFormation.
(structure)
Управляет параметризацией определенного ресурса Dashboard в возвращаемом шаблоне CloudFormation.
Arn -> (string)
Dashboard, переопределяющие свойства которого настроены в этой структуре.Properties -> (list)
Список свойств ресурса Dashboard для создания переменных в возвращаемом шаблоне CloudFormation.
(string)
Folders -> (list)
Необязательный список структур, управляющих параметризацией ресурсов Folder в возвращаемом шаблоне CloudFormation.
(structure)
Управляет параметризацией определенного ресурса Folder в возвращаемом шаблоне CloudFormation.
Arn -> (string)
Folder, переопределяющие свойства которого настроены в этой структуре.Properties -> (list)
Список свойств ресурса Folder для создания переменных в возвращаемом шаблоне CloudFormation.
(string)
Синтаксис JSON:
{
"ResourceIdOverrideConfiguration": {
"PrefixForAllResources": true|false
},
"VPCConnections": [
{
"Arn": "string",
"Properties": ["Name"|"DnsResolvers"|"RoleArn", ...]
}
...
],
"RefreshSchedules": [
{
"Arn": "string",
"Properties": ["StartAfterDateTime", ...]
}
...
],
"DataSources": [
{
"Arn": "string",
"Properties": ["Name"|"DisableSsl"|"SecretArn"|"Username"|"Password"|"Domain"|"WorkGroup"|"Host"|"Port"|"Database"|"DataSetName"|"Catalog"|"InstanceId"|"ClusterId"|"ManifestFileLocation"|"Warehouse"|"RoleArn"|"ProductType", ...]
}
...
],
"DataSets": [
{
"Arn": "string",
"Properties": ["Name"|"RefreshFailureEmailAlertStatus", ...]
}
...
],
"Themes": [
{
"Arn": "string",
"Properties": ["Name", ...]
}
...
],
"Analyses": [
{
"Arn": "string",
"Properties": ["Name", ...]
}
...
],
"Dashboards": [
{
"Arn": "string",
"Properties": ["Name", ...]
}
...
],
"Folders": [
{
"Arn": "string",
"Properties": ["Name"|"ParentFolderArn", ...]
}
...
]
}
--include-permissions | --no-include-permissions (boolean)
IncludePermissions в TRUE, все разрешения, связанные с каждым ресурсом, экспортируются.--include-tags | --no-include-tags (boolean)
IncludeTags в TRUE, все теги, связанные с каждым ресурсом, экспортируются.--validation-strategy (structure)
Необязательный параметр, который определяет, какую стратегию проверки использовать для задания экспорта. Если StrictModeForAllResources установлено в TRUE, обеспечивается строгая проверка каждой ошибки. Если установлено значение FALSE, проверка пропускается для определенных ошибок пользовательского интерфейса, которые отображаются в виде предупреждений. Значение по умолчанию для StrictModeForAllResources — FALSE.
StrictModeForAllResources -> (boolean)
Сокращенный синтаксис:
StrictModeForAllResources=boolean
Синтаксис JSON:
{
"StrictModeForAllResources": true|false
}
--include-folder-memberships | --no-include-folder-memberships (boolean)
--include-folder-members (string)
Параметр, указывающий, следует ли включать ресурсы папок. Вы также можете использовать этот параметр для рекурсивного включения всех подпапок экспортированной папки.
Возможные значения:
RECURSEONE_LEVELNONE
--cli-input-json | --cli-input-yaml (string) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения, используя значение, предоставленное в JSON, поскольку строка будет воспринята буквально. Это нельзя указывать вместе с --cli-input-yaml.
--generate-cli-skeleton (string) Выводит скелет JSON в стандартный вывод без отправки запроса API. Если не предоставлено значение или предоставлено значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено значение yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, он проверяет входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный скелет JSON не является стабильным между версиями AWS CLI, и в сгенерированном скелете JSON нет гарантий обратной совместимости.
Общие параметры
--debug (boolean)
Включить отладку логов.
--endpoint-url (string)
Переопределить стандартный URL команды указанным URL.
--no-verify-ssl (boolean)
По умолчанию AWS CLI использует SSL при общении с AWS сервисами. Для каждого SSL подключения AWS CLI проверяет SSL сертификаты. Этот параметр переопределяет стандартное поведение проверки SSL сертификатов.
--no-paginate (boolean)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один запрос для первой страницы результатов.
--output (string)
Стиль форматирования вывода команды.
- json
- text
- table
- yaml
- yaml-stream
--query (string)
Запрос JMESPath для фильтрации данных ответа.
--profile (string)
Использовать определённый профиль из файла учетных данных.
--region (string)
Использовать определённую область. Переопределяет настройки из конфигурации/среды.
--version (string)
Отобразить версию этого инструмента.
--color (string)
Включить/выключить цветной вывод.
- on
- off
- auto
--no-sign-request (boolean)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.
--ca-bundle (string)
Файл сертификатов CA для проверки SSL сертификатов. Переопределяет настройки из конфигурации/среды.
--cli-read-timeout (int)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию - 60 секунд.
--cli-connect-timeout (int)
Максимальное время соединения сокета в секундах. Если значение установлено в 0, соединение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию - 60 секунд.
--cli-binary-format (string)
Стиль форматирования, используемый для бинарных блоков. По умолчанию - base64. Формат base64 ожидает, что бинарные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI версии 1, и бинарные значения должны передаваться буквально. При предоставлении содержимого из файла, отображающего бинарный блок fileb:// всегда будет рассматриваться как бинарный и будет использовать содержимое файла напрямую независимо от cli-binary-format настройки. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (boolean)
Отключить пагинатор CLI для вывода.
--cli-auto-prompt (boolean)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (boolean)
Отключить автоматическое запросы параметров ввода CLI.
Вывод
Arn -> (string)
AssetBundleExportJobId -> (string)
RequestId -> (string)
Status -> (integer)
© Copyright 2025, Amazon Web Services. Created using Sphinx.