start-dashboard-snapshot-job

Описание

Запускает асинхронную задачу, генерирующую моментальный снимок вывода панели инструментов. Вы можете запросить одну или несколько из следующих конфигураций формата в каждом вызове API.

• 1 PDF-файл с постраничной разбивкой
• 1 рабочая книга Excel, содержащая до 5 визуальных элементов таблиц или сводных таблиц
• 5 CSV-файлов из визуальных элементов таблиц или сводных таблиц

Статус отправленной задачи можно проверить с помощью API DescribeDashboardSnapshotJob. При вызове API DescribeDashboardSnapshotJob, проверьте поле JobStatus в ответе. После того, как задача достигнет статуса COMPLETED или FAILED, используйте API DescribeDashboardSnapshotJobResult для получения URL-адресов сгенерированных файлов. В случае сбоя задачи API DescribeDashboardSnapshotJobResult возвращает подробную информацию об ошибке.

Amazon QuickSight использует ограничение запросов API, чтобы обеспечить более стабильный пользовательский опыт в течение определенного времени для клиентов, когда они вызывают API StartDashboardSnapshotJob. По умолчанию, 12 задач могут выполняться одновременно в одной учетной записи Amazon Web Services, и пользователи могут отправлять до 10 запросов API в секунду, прежде чем учетная запись будет ограничена. Если один и тот же пользователь делает большое количество запросов API в короткий промежуток времени, Amazon QuickSight ограничивает вызовы API, чтобы поддерживать оптимальный опыт и надёжность для всех пользователей Amazon QuickSight.

В следующем списке представлена информация о наиболее распространённых сценариях ограничения, которые могут возникнуть.

• Большое количество задач API ``SnapshotExport`` выполняются одновременно в учетной записи Amazon Web Services. Когда создаётся новая StartDashboardSnapshotJob и уже есть 12 задач со статусом RUNNING, запрос на новую задачу отклоняется и возвращает ошибку LimitExceededException. Подождите, пока текущая задача не завершится, прежде чем повторно отправить новую задачу.
• Большое количество запросов API отправлено в учетной записи Amazon Web Services. Когда пользователь делает более 10 вызовов API к API Amazon QuickSight за одну секунду, возвращается ThrottlingException.

Если ваш случай использования требует более высокого лимита ограничения, обратитесь к администратору вашей учетной записи или службе поддержки Amazon Web Services, чтобы изучить возможности настройки более оптимального опыта для вашей учетной записи.

Если ваш случай использования предполагает большой трафик API, старайтесь уменьшить частоту и параллелизм вызовов API, чтобы избежать ограничения. Вы также можете провести тест по времени, чтобы рассчитать приблизительное время обработки запланированной нагрузки, которое остаётся в пределах лимитов ограничения API Amazon QuickSight. Например, если ваш прогнозируемый трафик составляет 100 задач снимка до 12:00 дня, запустите 12 задач параллельно и измерьте время, необходимое для обработки всех 12 задач. После получения результата, умножьте продолжительность на 9, например (12 minutes * 9 = 108 minutes). Используйте новый результат, чтобы определить самое позднее время, в которое задачи должны быть запущены, чтобы достичь вашей целевой даты.

Время обработки задачи может зависеть от следующих факторов:

• Тип набора данных (Прямой запрос или SPICE).
• Размер набора данных.
• Сложность вычисляемых полей, используемых в панели инструментов.
• Количество визуальных элементов на листе.
• Типы визуальных элементов на листе.
• Количество форматов и снимков, запрошенных в конфигурации задачи.
• Размер сгенерированных снимков.

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

Синопсис

  start-dashboard-snapshot-job
--aws-account-id <value>
--dashboard-id <value>
--snapshot-job-id <value>
--user-configuration <value>
--snapshot-configuration <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 (строка)

--user-configuration (структура)

Синтаксис JSON:

{
  "AnonymousUsers": [
    {
      "RowLevelPermissionTags": [
        {
          "Key": "string",
          "Value": "string"
        }
        ...
      ]
    }
    ...
  ]
}

--snapshot-configuration (структура)

Синтаксис JSON:

{
  "FileGroups": [
    {
      "Files": [
        {
          "SheetSelections": [
            {
              "SheetId": "string",
              "SelectionScope": "ALL_VISUALS"|"SELECTED_VISUALS",
              "VisualIds": ["string", ...]
            }
            ...
          ],
          "FormatType": "CSV"|"PDF"|"EXCEL"
        }
        ...
      ]
    }
    ...
  ],
  "DestinationConfiguration": {
    "S3Destinations": [
      {
        "BucketConfiguration": {
          "BucketName": "string",
          "BucketPrefix": "string",
          "BucketRegion": "string"
        }
      }
      ...
    ]
  },
  "Parameters": {
    "StringParameters": [
      {
        "Name": "string",
        "Values": ["string", ...]
      }
      ...
    ],
    "IntegerParameters": [
      {
        "Name": "string",
        "Values": [long, ...]
      }
      ...
    ],
    "DecimalParameters": [
      {
        "Name": "string",
        "Values": [double, ...]
      }
      ...
    ],
    "DateTimeParameters": [
      {
        "Name": "string",
        "Values": [timestamp, ...]
      }
      ...
    ]
  }
}

--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 -> (строка)

SnapshotJobId -> (строка)

RequestId -> (строка)

Status -> (целое число)