[ aws . quicksight ]
describe-dashboard-snapshot-job-result
Описание
Описывает результат завершённой задачи создания моментальной копии дашборда.
Завершённая задача создания моментальной копии вернёт состояние COMPLETED или FAILED, когда вы опросите задачу с помощью вызова API DescribeDashboardSnapshotJob.
Если задача ещё не завершена, этот оператор возвращает сообщение Dashboard Snapshot Job with id <SnapshotjobId> has not reached a terminal state..
См. также: Документацию API AWS
Синтаксис
describe-dashboard-snapshot-job-result
--aws-account-id <value>
--dashboard-id <value>
--snapshot-job-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 (строка)
--dashboard-id (строка)
--snapshot-job-id (строка)
StartDashboardSnapshotJob.--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-auto-prompt (логическое значение)
Автоматическое запрограммирование входных параметров CLI.
--no-cli-auto-prompt (логическое значение)
Отключение автоматического запрограммирования входных параметров CLI.
Вывод
Arn -> (строка)
StartDashboardSnapshotJob.JobStatus -> (строка)
COMPLETED или FAILED.CreatedTime -> (метка времени)
LastUpdatedTime -> (метка времени)
Result -> (структура)
Результат задачи создания моментальной копии. Задачи, успешно завершённые, вернут S3Uri, где они находятся. Задачи, завершившиеся ошибкой, вернут информацию об ошибке, которая привела к сбою задачи.
AnonymousUsers -> (список)
Список объектов AnonymousUserSnapshotJobResult, содержащих информацию об анонимных пользователях и их конфигурациях. Эти данные предоставляются вами при выполнении вызова API StartDashboardSnapshotJob.
(структура)
Структура, содержащая группы файлов, запрашиваемые для генерации артефактов в вызове API StartDashboardSnapshotJob.
FileGroups -> (список)
Список объектов SnapshotJobResultFileGroup, содержащих информацию о файлах, запрашиваемых во время вызова API StartDashboardSnapshotJob. Если задача выполнена успешно, эти объекты содержат местоположение, где хранятся артефакты моментальной копии. Если задача завершилась ошибкой, объекты содержат информацию об ошибке, которая привела к сбою задачи.
(структура)
Структура, содержащая информацию о сгенерированных группах файлов моментальной копии.
Files -> (список)
Список объектов SnapshotFile.
(структура)
Структура, содержащая информацию о моментальной копии, которую вы хотите сгенерировать. Эта информация предоставляется вами при запуске новой задачи создания моментальной копии.
SheetSelections -> (список)
Список объектов SnapshotFileSheetSelection, содержащих информацию о листе дашборда, который экспортируется. Эти объекты предоставляют информацию об артефактах моментальной копии, сгенерированных во время задачи. Данная структура может содержать максимум 5 конфигураций CSV, 5 конфигураций Excel или 1 конфигурацию для PDF.
(структура)
Структура, содержащая идентификаторы, определяющие моментальную копию, которую нужно сгенерировать.
SheetId -> (строка)
SelectionScope -> (строка)
Область выбора визуализаций на листе дашборда, для которого генерируется моментальная копия.
-
ALL_VISUALS- Выбирает все визуализации на листе. Это значение обязательно, если моментальная копия — PDF. -
SELECTED_VISUALS- Выбирает визуализацию, которую нужно добавить в моментальную копию. Это значение обязательно, если моментальная копия — CSV или Excel-рабочая книга.
VisualIds -> (список)
Структура, перечисляющая ID визуализаций на выбранном листе. Поддерживаемые типы визуализаций — таблицы, сводные таблицы. Это значение обязательно, если вы генерируете CSV или Excel-рабочую книгу. Это значение поддерживает максимум 1 ID визуализации для CSV и 5 ID визуализаций для до 5 выборов листа для Excel. Если вы генерируете Excel-рабочую книгу, порядок ID визуализаций в этой структуре определяет порядок листов в Excel-файле.
(строка)
FormatType -> (строка)
CSV , Excel или PDF.S3Results -> (список)
Список объектов SnapshotJobS3Result.
(структура)
Результат Amazon S3 из задачи создания моментальной копии. Результат включает DestinationConfiguration и Amazon S3 Uri. Если во время задачи произошла ошибка, результат возвращает информацию об ошибке.
S3DestinationConfiguration -> (структура)
Список конфигураций ведёр Amazon S3, предоставляемых при выполнении вызова API StartDashboardSnapshotJob.
BucketConfiguration -> (структура)
Структура, содержащая подробности о ведре Amazon S3, в котором сохраняется сгенерированная моментальная копия дашборда.
BucketName -> (строка)
BucketPrefix -> (строка)
BucketRegion -> (строка)
StartDashboardSnapshotJob.S3Uri -> (строка)
ErrorInfo -> (список)
Массив записей об ошибках, описывающих любые сбои, которые происходят во время выполнения задачи создания моментальной копии дашборда.
(структура)
Информация об ошибке, которая привела к сбою задачи создания моментальной копии.
ErrorMessage -> (строка)
ErrorType -> (строка)
ErrorInfo -> (структура)
Отображает информацию об ошибке, которая привела к сбою задачи.
ErrorMessage -> (строка)
ErrorType -> (строка)
RequestId -> (строка)
Status -> (целое число)
© Copyright 2025, Amazon Web Services. Created using Sphinx.