[ aws . synthetics ]
start-canary-dry-run
Описание
Используйте эту операцию, чтобы запустить пробный запуск для канарейки, которая уже была создана.
См. также: Документацию API AWS
Синтаксис
start-canary-dry-run
--name <value>
[--code <value>]
[--runtime-version <value>]
[--run-config <value>]
[--vpc-config <value>]
[--execution-role-arn <value>]
[--success-retention-period-in-days <value>]
[--failure-retention-period-in-days <value>]
[--visual-reference <value>]
[--artifact-s3-location <value>]
[--artifact-config <value>]
[--provisioned-resource-cleanup <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]
Параметры
--name (строка)
--code (структура)
Используйте эту структуру для ввода кода вашего скрипта для канарейки. Эта структура содержит обработчик Lambda с местоположением, где канарейка должна начать выполнение скрипта. Если скрипт хранится в ведре S3, также указаны имя ведра, ключ и версия. Если скрипт был передан канарейке непосредственно, код скрипта содержится в значении Zipfile .
Если вы загружаете скрипты канарейки с ведра Amazon S3, ваш zip-файл должен содержать скрипт в определённой структуре папок.
- Для канареек Node.js структура папок должна быть ``nodejs/node_modules/myCanaryFilename.js `` Дополнительную информацию см. в разделе Упаковка файлов канарейки Node.js
- Для канареек Python структура папок должна быть ``python/myCanaryFilename.py `` или ``python/myFolder/myCanaryFilename.py `` Дополнительную информацию см. в разделе Упаковка файлов канарейки Python
S3Bucket -> (строка)
s3:// в начале имени ведра.S3Key -> (строка)
S3Version -> (строка)
ZipFile -> (бинарный файл)
Если вы вводите скрипт канарейки непосредственно в канарейку вместо ссылки на расположение в S3, значение этого параметра — это код в формате base64 содержимого .zip-файла, содержащего скрипт. Он должен быть меньше 225 Кб.
Для больших скриптов канарейки рекомендуется использовать расположение в S3 вместо ввода непосредственно с помощью этого параметра.
Handler -> (строка)
syn-python-selenium-1.0 runtime или syn-nodejs.puppeteer runtime, более ранние чем syn-nodejs.puppeteer-3.4 , обработчик должен быть указан как `` fileName .handler`` . Для syn-python-selenium-1.1 , syn-nodejs.puppeteer-3.4 и более поздних версий runtime обработчик можно указать как `` fileName .*functionName* `` или указать папку, в которой находятся скрипты канарейки, как `` folder /fileName .*functionName* ``.Сокращенная синтаксическая запись:
S3Bucket=string,S3Key=string,S3Version=string,ZipFile=blob,Handler=string
Синтаксис JSON:
{
"S3Bucket": "string",
"S3Key": "string",
"S3Version": "string",
"ZipFile": blob,
"Handler": "string"
}
--runtime-version (строка)
--run-config (структура)
Структура, содержащая входные данные для запуска канарейки.
TimeoutInSeconds -> (целое число)
Время, в течение которого разрешается выполнение канарейки перед её остановкой. Это время не может быть больше частоты запуска этой канарейки.
Если этот параметр опущен, используется частота запуска канарейки, но не более 14 минут.
MemoryInMB -> (целое число)
ActiveTracing -> (логическое значение)
Указывает, должна ли эта канарейка использовать активное отслеживание X-Ray во время выполнения. Активное отслеживание позволяет отобразить этот запуск канарейки в картах ServiceLens и X-Ray, даже если канарейка не обращается к конечной точке, для которой включено отслеживание X-Ray. Использование отслеживания X-Ray влечёт за собой расходы. Дополнительную информацию см. в разделе Канарейки и отслеживание X-Ray .
Включить активное отслеживание можно только для канареек, использующих версию syn-nodejs-2.0 или более позднюю версию runtime.
EnvironmentVariables -> (массив)
Указывает ключи и значения для использования в переменных среды в скрипте канарейки. Используйте следующий формат:
{ “ключ1” : “значение1”, “ключ2” : “значение2”, …}
Ключи должны начинаться с буквы и содержать не менее двух символов. Общий размер ваших переменных среды не может превышать 4 Кб. Вы не можете указать какие-либо зарезервированные переменные среды Lambda в качестве ключей для ваших переменных среды. Дополнительную информацию о зарезервированных ключах см. в разделе Переменные среды runtime.
Предупреждение
Ключи и значения переменных среды шифруются при хранении с помощью собственных ключей KMS Amazon Web Services. Однако переменные среды не шифруются на стороне клиента. Не храните конфиденциальную информацию в них.ключ -> (строка)
значение -> (строка)
Сокращенная синтаксическая запись:
TimeoutInSeconds=integer,MemoryInMB=integer,ActiveTracing=boolean,EnvironmentVariables={KeyName1=string,KeyName2=string}
Синтаксис JSON:
{
"TimeoutInSeconds": integer,
"MemoryInMB": integer,
"ActiveTracing": true|false,
"EnvironmentVariables": {"string": "string"
...}
}
--vpc-config (структура)
Если эта канарейка должна протестировать конечную точку в VPC, эта структура содержит информацию о подсетях и группах безопасности конечной точки VPC. Дополнительную информацию см. в разделе Запуск канарейки в VPC .
SubnetIds -> (список)
Идентификаторы подсетей, в которых должна работать эта канарейка.
(строка)
SecurityGroupIds -> (список)
Идентификаторы групп безопасности для этой канарейки.
(строка)
Ipv6AllowedForDualStack -> (логическое значение)
true, чтобы разрешить исходящий IPv6-трафик для канареек VPC, подключенных к подсетям с двойной адресацией. Значение по умолчанию — false
Сокращенная синтаксическая запись:
SubnetIds=string,string,SecurityGroupIds=string,string,Ipv6AllowedForDualStack=boolean
Синтаксис JSON:
{
"SubnetIds": ["string", ...],
"SecurityGroupIds": ["string", ...],
"Ipv6AllowedForDualStack": true|false
}
--execution-role-arn (строка)
lambda.amazonaws.com в качестве принципала в политике доверия. Роль также должна иметь следующие разрешения:--success-retention-period-in-days (целое число)
Количество дней, в течение которых необходимо сохранять данные о неудачных запусках для этой канарейки. Допустимый диапазон — от 1 до 455 дней.
Это значение влияет на диапазон информации, возвращаемой GetCanaryRuns , а также на диапазон информации, отображаемой в консоли Synthetics.
--failure-retention-period-in-days (целое число)
Количество дней, в течение которых необходимо сохранять данные о неудачных запусках для этой канарейки. Допустимый диапазон — от 1 до 455 дней.
Это значение влияет на диапазон информации, возвращаемой GetCanaryRuns , а также на диапазон информации, отображаемой в консоли Synthetics.
--visual-reference (структура)
Объект, определяющий, какие скриншоты использовать в качестве базовых для визуального мониторинга этой канарейкой. Он также может указать части скриншотов, которые нужно игнорировать при сравнении визуального мониторинга.
Визуальный мониторинг поддерживается только для канареек, выполняющих runtime syn-puppeteer-node-3.2 или более позднюю версию. Дополнительную информацию см. в разделе Визуальный мониторинг и Схема визуального мониторинга
BaseScreenshots -> (список)
Массив скриншотов, которые будут использоваться в качестве базовых для визуального мониторинга в будущих запусках этой канарейки. Если есть скриншоты, которые вы не хотите использовать для визуального мониторинга, удалите их из этого массива.
(структура)
Структура, представляющая скриншот, используемый в качестве базового при сравнении визуального мониторинга, выполняемого канарейкой.
ScreenshotName -> (строка)
UpdateCanary, которая указала этой канарейке выполнить визуальный мониторинг.IgnoreCoordinates -> (список)
Координаты, определяющие часть экрана, которую следует игнорировать при сравнении скриншотов. Чтобы получить координаты, используемые здесь, используйте консоль CloudWatch для рисования границ на экране. Дополнительную информацию см. в разделе Редактирование или удаление канарейки
(строка)
BaseCanaryRunId -> (строка)
nextrun для использования скриншотов из следующего запуска после внесения этого обновления, lastrun для использования скриншотов из последнего запуска до внесения этого обновления или значение Id в CanaryRun из запуска этой канарейки в течение последних 31 дня. Если вы укажете Id запуска канарейки, старше 31 дня, операция возвращает ошибку валидации 400.Синтаксис JSON:
{
"BaseScreenshots": [
{
"ScreenshotName": "string",
"IgnoreCoordinates": ["string", ...]
}
...
],
"BaseCanaryRunId": "string"
}
--artifact-s3-location (строка)
--artifact-config (структура)
Структура, содержащая конфигурацию артефактов канарейки, включая параметры шифрования при хранении для артефактов, которые канарейка загружает в Amazon S3.
S3Encryption -> (структура)
Структура, содержащая конфигурацию параметров шифрования при хранении для артефактов, которые канарейка загружает в Amazon S3. Функциональность шифрования артефактов доступна только для канареек, использующих версию runtime Synthetics syn-nodejs-puppeteer-3.3 или более позднюю. Дополнительную информацию см. в разделе Шифрование артефактов канарейки
EncryptionMode -> (строка)
Метод шифрования, который нужно использовать для артефактов, созданных этой канарейкой. Укажите SSE_S3 для использования шифрования на стороне сервера (SSE) с управляемым Amazon S3 ключом. Укажите SSE-KMS для использования шифрования на стороне сервера с управляемым клиентом ключом KMS.
Если вы опустите этот параметр, будет использован управляемый Amazon Web Services ключ KMS.
KmsKeyArn -> (строка)
SSE-KMS для EncryptionMode
Сокращенная синтаксическая запись:
S3Encryption={EncryptionMode=string,KmsKeyArn=string}
Синтаксис JSON:
{
"S3Encryption": {
"EncryptionMode": "SSE_S3"|"SSE_KMS",
"KmsKeyArn": "string"
}
}
--provisioned-resource-cleanup (строка)
Указывает, нужно ли также удалить функции и слои Lambda, используемые этой канарейкой, при удалении канарейки. Если значение этого параметра — AUTOMATIC, это означает, что функции и слои Lambda будут удалены при удалении канарейки.
Если значение этого параметра — OFF, то значение параметра DeleteLambda операции DeleteCanary определяет, будут ли удалены функции и слои Lambda.
Возможные значения:
AUTOMATICOFF
--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
- таблица
- 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.
Вывод
DryRunConfig -> (структура)
Возвращает конфигурации отработки для канэри.
DryRunId -> (строка)
LastDryRunExecutionStatus -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.