[ aws . quicksight ]
describe-dashboard-snapshot-job
Описание
Описывает существующую задачу создания моментальной копии.
Опрашивайте описания задач после начала выполнения, чтобы узнать статус задачи. Доступные коды статуса см. в JobStatus .
См. также: Документацию API AWS
Синтаксис
describe-dashboard-snapshot-job
--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
- 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.
Вывод
AwsAccountId -> (строка)
DashboardId -> (строка)
SnapshotJobId -> (строка)
StartDashboardSnapshotJob API.UserConfiguration -> (структура)
Настройка пользователя для задачи создания снимка. Эта информация предоставляется при выполнении вызова StartDashboardSnapshotJob API.
AnonymousUsers -> (список)
Массив записей, описывающих анонимных пользователей, для которых генерируется снимок дашборда. Конфиденциальная информация о пользователях исключена.
(структура)
Используйте эту структуру, чтобы скрыть чувствительную информацию, предоставленную вами об анонимном пользователе, из снимка.
RowLevelPermissionTagKeys -> (список)
Ключи тегов для RowLevelPermissionTags.
(строка)
SnapshotConfiguration -> (структура)
Настройка создания снимка для задачи. Эта информация предоставляется при выполнении вызова StartDashboardSnapshotJob API.
FileGroups -> (список)
Список объектов SnapshotJobResultFileGroup, содержащих информацию о создаваемом снимке. Этот список может содержать максимум 6 конфигураций FileGroup.
(структура)
Структура, содержащая информацию о файлах снимка.
Files -> (список)
Список объектов SnapshotFile, содержащих информацию о файлах снимка, которые необходимо сгенерировать. Эта структура может содержать 1 конфигурацию за раз.
(структура)
Структура, содержащая информацию о снимке, который вы хотите сгенерировать. Эта информация предоставляется вами при запуске новой задачи создания снимка.
SheetSelections -> (список)
Список объектов SnapshotFileSheetSelection, содержащих информацию о листе дашборда, который экспортируется. Эти объекты предоставляют информацию о результатах создания снимка во время выполнения задачи. Эта структура может содержать максимум 5 конфигураций CSV, 5 конфигураций Excel или 1 конфигурацию для PDF.
(структура)
Структура, содержащая информацию, идентифицирующую снимок, который необходимо сгенерировать.
SheetId -> (строка)
SelectionScope -> (строка)
Область выбора визуализаций на листе дашборда, для которого вы создаёте снимок. Вы можете выбрать один из следующих вариантов.
-
ALL_VISUALS- Выбирает все визуализации на листе. Это значение требуется, если снимок в формате PDF. -
SELECTED_VISUALS- Выберите визуализацию, которую вы хотите добавить в снимок. Это значение требуется, если снимок в формате CSV или Excel.
VisualIds -> (список)
Структура, перечисляющая идентификаторы визуализаций на выбранном листе. Поддерживаемые типы визуализаций: таблица, сводная таблица. Это значение требуется, если вы генерируете файл CSV или Excel. Это значение поддерживает максимум 1 идентификатор визуализации для CSV и 5 идентификаторов визуализаций для до 5 выборов листов для Excel. Если вы генерируете файл Excel, порядок идентификаторов визуализаций в этой структуре определяет порядок листов в файле Excel.
(строка)
FormatType -> (строка)
CSV, Excel или PDF.DestinationConfiguration -> (структура)
Структура, содержащая информацию об Amazon S3 ведре, в котором хранится созданный снимок.
S3Destinations -> (список)
Список объектов SnapshotS3DestinationConfiguration, содержащих конфигурации назначения Amazon S3. Эта структура может содержать максимум 1 S3DestinationConfiguration.
(структура)
Структура, описывающая параметры Amazon S3 для сохранения сгенерированного снимка дашборда.
BucketConfiguration -> (структура)
Структура, содержащая подробности о ведре Amazon S3, в котором сохраняется сгенерированный снимок дашборда.
BucketName -> (строка)
BucketPrefix -> (строка)
BucketRegion -> (строка)
StartDashboardSnapshotJob.Parameters -> (структура)
Список параметров Amazon QuickSight и переопределённые значения списка.
StringParameters -> (список)
Параметры, у которых тип данных — строка.
(структура)
Строковый параметр.
Name -> (строка)
Values -> (список)
Значения строкового параметра.
(строка)
IntegerParameters -> (список)
Параметры, у которых тип данных — целое число.
(структура)
Целочисленный параметр.
Name -> (строка)
Values -> (список)
Значения целочисленного параметра.
(long)
DecimalParameters -> (список)
Параметры, у которых тип данных — десятичное число.
(структура)
Десятичный параметр.
Name -> (строка)
Values -> (список)
Значения десятичного параметра.
(double)
DateTimeParameters -> (список)
Параметры, у которых тип данных — дата и время.
(структура)
Параметр даты и времени.
Name -> (строка)
Values -> (список)
Значения параметра даты и времени.
(timestamp)
Arn -> (строка)
StartDashboardSnapshotJob API.JobStatus -> (строка)
Указывает состояние задачи. Состояние обновляется по мере выполнения задачи. Показывается одно из следующих значений.
-
COMPLETED- Задача выполнена успешно. -
FAILED- Задача не выполнена. -
QUEUED- Задача находится в очереди и ещё не началась. -
RUNNING- Задача всё ещё выполняется.
CreatedTime -> (timestamp)
LastUpdatedTime -> (timestamp)
RequestId -> (строка)
Status -> (целое число)
© Copyright 2025, Amazon Web Services. Created using Sphinx.