get-environment

Описание

Описывает среду Amazon Managed Workflows for Apache Airflow (MWAA).

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

Синтаксис

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

Имя среды Amazon MWAA. Например, MyMWAAEnvironment .

--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 для вывода.

--cli-auto-prompt (логическое)

Автоматически запрашивать параметры CLI.

--no-cli-auto-prompt (логическое)

Отключить автоматическое запроса параметров CLI.

Вывод

Окружение -> (структура)

Объект, содержащий все доступные сведения об окружении.

Имя -> (строка)

Имя среды Amazon MWAA. Например, MyMWAAEnvironment .

Состояние -> (строка)

Состояние среды Amazon MWAA.

Допустимые значения:

CREATING - Указывает, что запрос на создание среды находится в процессе выполнения.
CREATING_SNAPSHOT - Указывает, что запрос на обновление деталей среды или обновление версии среды находится в процессе выполнения, и Amazon MWAA создает моментальный снимок тома хранения кластера Amazon RDS, связанного со средой. Моментальный снимок базы данных — это резервная копия, созданная в определенный момент времени. Amazon MWAA использует моментальные снимки для восстановления метаданных среды в случае сбоя процесса обновления или модернизации среды.
CREATE_FAILED - Указывает, что запрос на создание среды завершился ошибкой, и среда не была создана.
AVAILABLE - Указывает, что запрос выполнен успешно, и среда готова к использованию.
PENDING - Указывает, что запрос выполнен успешно, но процесс создания среды приостановлен до создания необходимых конечных точек VPC в вашей VPC. После создания конечных точек VPC процесс возобновляется.
UPDATING - Указывает, что запрос на обновление среды находится в процессе выполнения.
ROLLING_BACK - Указывает, что запрос на обновление деталей среды или обновление версии среды завершился ошибкой, и Amazon MWAA восстанавливает среду с помощью последнего моментального снимка тома хранения.
DELETING - Указывает, что запрос на удаление среды находится в процессе выполнения.
DELETED - Указывает, что запрос на удаление среды завершен, и среда была удалена.
UNAVAILABLE - Указывает, что запрос завершился ошибкой, но среда не вернулась к предыдущему состоянию и нестабильна.
UPDATE_FAILED - Указывает, что запрос на обновление среды завершился ошибкой, но среда успешно восстановлена до предыдущего состояния и готова к использованию.
MAINTENANCE - Указывает, что среда находится в режиме технического обслуживания. В зависимости от выполняемой работы Amazon MWAA, ваша среда может быть недоступна в течение этого процесса. После завершения всех операций ваша среда вернется к состоянию до начала операций технического обслуживания.

Рекомендуется ознакомиться с руководством по устранению неполадок, чтобы узнать список распространенных ошибок и их решений. Для получения дополнительной информации см. Устранение неполадок Amazon MWAA.

Arn -> (строка)

Идентификатор ресурса Amazon (ARN) среды Amazon MWAA.

CreatedAt -> (временная метка)

Дата и время создания среды.

WebserverUrl -> (строка)

Имя хоста веб-сервера Apache Airflow для среды Amazon MWAA. Для получения дополнительной информации см. Доступ к интерфейсу Apache Airflow UI.

ExecutionRoleArn -> (строка)

Идентификатор ресурса Amazon (ARN) роли выполнения в IAM, позволяющей MWAA получать доступ к ресурсам Amazon Web Services в вашей среде. Например, arn:aws:iam::123456789:role/my-execution-role . Для получения дополнительной информации см. Роль выполнения Amazon MWAA.

ServiceRoleArn -> (строка)

Идентификатор ресурса Amazon (ARN) для роли связанного сервиса среды. Для получения дополнительной информации см. Роль связанного сервиса Amazon MWAA.

KmsKey -> (строка)

Ключ шифрования KMS, используемый для шифрования данных в вашей среде.

AirflowVersion -> (строка)

Версия Apache Airflow в вашей среде.

Допустимые значения: 1.10.12 , 2.0.2 , 2.2.2 , 2.4.3 , 2.5.1 , 2.6.3 , 2.7.2 , 2.8.1 , 2.9.2 , 2.10.1 и 2.10.3 .

SourceBucketArn -> (строка)

Идентификатор ресурса Amazon (ARN) ведра Amazon S3, где хранятся ваш код DAG и вспомогательные файлы. Например, arn:aws:s3:::my-airflow-bucket-unique-name . Для получения дополнительной информации см. Создание ведра Amazon S3 для Amazon MWAA.

DagS3Path -> (строка)

Относительный путь к папке DAG в вашем ведре Amazon S3. Например, s3://mwaa-environment/dags . Для получения дополнительной информации см. Добавление или обновление DAG.

PluginsS3Path -> (строка)

Относительный путь к файлу в вашем ведре Amazon S3. Например, s3://mwaa-environment/plugins.zip . Для получения дополнительной информации см. Установка пользовательских плагинов.

PluginsS3ObjectVersion -> (строка)

Версия файла plugins.zip в вашем ведре Amazon S3. Вы должны указать идентификатор версии, присвоенный файлу Amazon S3.

Идентификаторы версий — это Unicode-строки, закодированные в UTF-8, готовые к использованию в URL, непрозрачные строки, длина которых не превышает 1024 байта. Вот пример:

3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo

Для получения дополнительной информации см. Установка пользовательских плагинов.

RequirementsS3Path -> (строка)

Относительный путь к файлу requirements.txt в вашем ведре Amazon S3. Например, s3://mwaa-environment/requirements.txt . Для получения дополнительной информации см. Установка зависимостей Python.

RequirementsS3ObjectVersion -> (строка)

Версия файла requirements.txt в вашем ведре Amazon S3. Вы должны указать идентификатор версии, присвоенный файлу Amazon S3.

3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo

Для получения дополнительной информации см. Установка зависимостей Python.

StartupScriptS3Path -> (строка)

Относительный путь к скрипту запуска оболочки в вашем ведре Amazon S3. Например, s3://mwaa-environment/startup.sh .

Amazon MWAA запускает скрипт при запуске среды и перед запуском процесса Apache Airflow. Вы можете использовать этот скрипт для установки зависимостей, изменения параметров конфигурации Apache Airflow и установки переменных среды. Для получения дополнительной информации см. Использование скрипта запуска.

StartupScriptS3ObjectVersion -> (строка)

Версия скрипта запуска оболочки в вашем ведре Amazon S3. Вы должны указать идентификатор версии, присвоенный файлу Amazon S3.

3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo

Для получения дополнительной информации см. Использование скрипта запуска.

AirflowConfigurationOptions -> (словарь)

Список пар ключ-значение, содержащих параметры конфигурации Apache Airflow, связанные с вашей средой. Для получения дополнительной информации см. Параметры конфигурации Apache Airflow.

ключ -> (строка)

значение -> (строка)

EnvironmentClass -> (строка)

Тип класса среды. Допустимые значения: mw1.micro , mw1.small , mw1.medium , mw1.large , mw1.xlarge и mw1.2xlarge . Для получения дополнительной информации см. Класс среды Amazon MWAA.

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

Максимальное количество рабочих процессов, работающих в вашей среде. Например, 20 .

NetworkConfiguration -> (структура)

Описывает компоненты сети VPC, используемые для защиты и обеспечения сетевого трафика между ресурсами Amazon Web Services для вашей среды. Для получения дополнительной информации см. О сети в Amazon MWAA.

SubnetIds -> (список)

Список идентификаторов подсетей. Для получения дополнительной информации см. О сети в Amazon MWAA.

(строка)

SecurityGroupIds -> (список)

Список идентификаторов групп безопасности. Для получения дополнительной информации см. Безопасность в вашей VPC в Amazon MWAA.

(строка)

LoggingConfiguration -> (структура)

Логи Apache Airflow, опубликованные в CloudWatch Logs.

DagProcessingLogs -> (структура)

Логи обработки DAG Airflow, опубликованные в CloudWatch Logs, и уровень логирования.

Enabled -> (булево)

Указывает, включен ли тип логов Apache Airflow (например, DagProcessingLogs ).

LogLevel -> (строка)

Уровень логирования Apache Airflow для типа логов (например, DagProcessingLogs ).

CloudWatchLogGroupArn -> (строка)

Идентификатор ресурса Amazon (ARN) группы CloudWatch Logs, в которую опубликован тип логов Apache Airflow (например, DagProcessingLogs ). Например, arn:aws:logs:us-east-1:123456789012:log-group:airflow-MyMWAAEnvironment-MwaaEnvironment-DAGProcessing:* .

SchedulerLogs -> (структура)

Логи планировщика Airflow, опубликованные в CloudWatch Logs, и уровень логирования.

Enabled -> (булево)

Указывает, включен ли тип логов Apache Airflow (например, DagProcessingLogs ).

LogLevel -> (строка)

Уровень логирования Apache Airflow для типа логов (например, DagProcessingLogs ).

CloudWatchLogGroupArn -> (строка)

WebserverLogs -> (структура)

Логи веб-сервера Airflow, опубликованные в CloudWatch Logs, и уровень логирования.

Enabled -> (булево)

Указывает, включен ли тип логов Apache Airflow (например, DagProcessingLogs ).

LogLevel -> (строка)

Уровень логирования Apache Airflow для типа логов (например, DagProcessingLogs ).

CloudWatchLogGroupArn -> (строка)

WorkerLogs -> (структура)

Логи рабочих процессов Airflow, опубликованные в CloudWatch Logs, и уровень логирования.

Enabled -> (булево)

Указывает, включен ли тип логов Apache Airflow (например, DagProcessingLogs ).

LogLevel -> (строка)

Уровень логирования Apache Airflow для типа логов (например, DagProcessingLogs ).

CloudWatchLogGroupArn -> (строка)

TaskLogs -> (структура)

Логи задач Airflow, опубликованные в CloudWatch Logs, и уровень логирования.

Enabled -> (булево)

Указывает, включен ли тип логов Apache Airflow (например, DagProcessingLogs ).

LogLevel -> (строка)

Уровень логирования Apache Airflow для типа логов (например, DagProcessingLogs ).

CloudWatchLogGroupArn -> (строка)

LastUpdate -> (структура)

Статус последнего обновления среды.

Статус -> (строка)

Статус последнего обновления среды.

CreatedAt -> (метка времени)

День и время последнего обновления среды.

Ошибка -> (структура)

Ошибка, возникшая во время последнего обновления среды.

Код ошибки -> (строка)

Код ошибки, соответствующий ошибке последнего обновления.

Сообщение об ошибке -> (строка)

Сообщение об ошибке, соответствующее коду ошибки.

Источник -> (строка)

Источник последнего обновления среды. Включает внутренние процессы Amazon MWAA, такие как обновление среды.

Начальная дата еженедельного окна обслуживания -> (строка)

День и время еженедельного окна обслуживания по координированному всемирному времени (UTC) в 24-часовом формате. Например: TUE:03:30 .

Теги -> (карта)

Пары значений тегов, связанные с вашей средой. Например, "Environment": "Staging" . Дополнительную информацию см. в разделе Описании тегов ресурсов Amazon Web Services.

ключ -> (строка)

значение -> (строка)

Режим доступа к веб-серверу -> (строка)

Режим доступа к веб-серверу Apache Airflow. Дополнительную информацию см. в разделе Режимы доступа к Apache Airflow.

Минимальное количество рабочих процессов -> (целое число)

Минимальное количество рабочих процессов, выполняемых в вашей среде. Например, 2 .

Планировщики -> (целое число)

Количество планировщиков Apache Airflow, выполняемых в вашей среде Amazon MWAA.

Служба VPC-эндпоинта веб-сервера -> (строка)

VPC-эндпоинт для веб-сервера среды.

Служба VPC-эндпоинта базы данных -> (строка)

VPC-эндпоинт для базы данных Amazon RDS среды.

Очередь CeleryExecutor -> (строка)

ARN очереди для Celery Executor среды. Amazon MWAA использует Celery Executor для распределения задач между несколькими рабочими процессами. При создании среды в общей VPC необходимо предоставить доступ к очереди Celery Executor из вашей VPC.

Управление эндпоинтами -> (строка)

Определяет, создаются и управляются ли VPC-эндпоинты, настроенные для среды, клиентом или Amazon MWAA. Если установлено значение SERVICE, Amazon MWAA создаст и будет управлять необходимыми VPC-эндпоинтами в вашей VPC. Если установлено значение CUSTOMER, вы должны создать и управлять VPC-эндпоинтами в вашей VPC.

Минимальное количество веб-серверов -> (целое число)

Минимальное количество веб-серверов, которые вы хотите запустить в своей среде. Amazon MWAA масштабирует количество веб-серверов Apache Airflow до значения, которое вы указали для MaxWebservers при взаимодействии с вашей средой Apache Airflow с помощью API Apache Airflow REST или командной строки Apache Airflow. По мере уменьшения частоты транзакций в секунду и сетевой нагрузки Amazon MWAA удаляет дополнительные веб-серверы и масштабирует вниз до значения, установленного в MinxWebserers.

Допустимые значения: Для сред, больших чем mw1.micro, принимаются значения от 2 до 5 . По умолчанию значение равно 2 для всех размеров среды, за исключением mw1.micro, для которого значение по умолчанию равно 1.

Максимальное количество веб-серверов -> (целое число)

Максимальное количество веб-серверов, которые вы хотите запустить в своей среде. Amazon MWAA масштабирует количество веб-серверов Apache Airflow до значения, которое вы указали для MaxWebservers при взаимодействии с вашей средой Apache Airflow с помощью API Apache Airflow REST или командной строки Apache Airflow. Например, в сценариях, когда ваша рабочая нагрузка требует сетевых вызовов API Apache Airflow REST с высокой частотой транзакций в секунду (TPS), Amazon MWAA увеличит количество веб-серверов до значения, установленного в MaxWebserers. По мере уменьшения частоты TPS Amazon MWAA удаляет дополнительные веб-серверы и масштабирует вниз до значения, установленного в MinxWebserers.