[ aws . opensearch ]
describe-dry-run-progress
Описание
Описывает прогресс анализа предварительного выполнения операции без изменения данных для домена Amazon OpenSearch Service. Дополнительная информация: Определение того, вызовет ли изменение развертывание сине-зелёного типа.
См. также: Документацию API AWS
Синтаксис
describe-dry-run-progress
--domain-name <value>
[--dry-run-id <value>]
[--load-dry-run-config | --no-load-dry-run-config]
[--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]
Параметры
--domain-name (строка)
--dry-run-id (строка)
--load-dry-run-config | --no-load-dry-run-config (логическое значение)
--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 версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, сопоставленного с двоичным блоком, 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.
Вывод
DryRunProgressStatus -> (структура)
Текущий статус пробного запуска, включая любые ошибки проверки.
DryRunId -> (строка)
DryRunStatus -> (строка)
CreationDate -> (строка)
UpdateDate -> (строка)
ValidationFailures -> (список)
Любые ошибки проверки, возникшие в результате пробного запуска.
(структура)
Ошибка проверки, возникшая в результате предварительной проверки на обновление (подробный пробный запуск) домена.
Code -> (строка)
Message -> (строка)
DryRunConfig -> (структура)
Подробная информация о планируемых изменениях в домене.
DomainId -> (строка)
DomainName -> (строка)
ARN -> (строка)
Created -> (булево)
Deleted -> (булево)
Endpoint -> (строка)
EndpointV2 -> (строка)
IPAddressType необходимо установить на значение dualstack, предоставляется конечный пункт домена версии 2. Этот конечный пункт работает как обычный конечный пункт, за исключением того, что он работает как с адресами IPv4, так и с адресами IPv6. Обычные конечные пункты работают только с адресами IPv4.Endpoints -> (карта)
Пара ключ-значение, если домен OpenSearch Service использует VPC-конечные точки. Например:
-
IP-адреса IPv4 -
'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com' -
Адреса с двойной стековой технологией -
'vpcv2':'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws'
key -> (строка)
value -> (строка)
search-imdb-movies-oopcnjfn6ugo.eu-west-1.es.amazonaws.com или doc-imdb-movies-oopcnjfn6u.eu-west-1.es.amazonaws.com.DomainEndpointV2HostedZoneId -> (строка)
Processing -> (булево)
UpgradeProcessing -> (булево)
EngineVersion -> (строка)
Elasticsearch_X.Y или OpenSearch_X.Y.ClusterConfig -> (структура)
Контейнер для конфигурации кластера домена.
InstanceType -> (строка)
InstanceCount -> (целое число)
DedicatedMasterEnabled -> (булево)
ZoneAwarenessEnabled -> (булево)
ZoneAwarenessConfig -> (структура)
Контейнер для параметров конфигурации с учетом зон доступности. Требуется только если ZoneAwarenessEnabled равно true.
AvailabilityZoneCount -> (целое число)
2 и 3. Если ваш домен развернут в VPC, это значение равно количеству подсетей.DedicatedMasterType -> (строка)
DedicatedMasterCount -> (целое число)
WarmEnabled -> (булево)
WarmType -> (строка)
WarmCount -> (целое число)
ColdStorageOptions -> (структура)
Контейнер для параметров конфигурации холодного хранения.
Enabled -> (булево)
MultiAZWithStandbyEnabled -> (булево)
NodeOptions -> (список)
Список параметров узлов для домена.
(структура)
Настройки конфигурации для определения типа узла в кластере.
NodeType -> (строка)
NodeConfig -> (структура)
Параметры конфигурации для определения настроек любого типа узла.
Enabled -> (булево)
Type -> (строка)
Count -> (целое число)
EBSOptions -> (структура)
Контейнер для настроек хранения на основе EBS для домена.
EBSEnabled -> (булево)
VolumeType -> (строка)
VolumeSize -> (целое число)
Iops -> (целое число)
gp3 и типов томов EBS с предоставленными IOPS.Throughput -> (целое число)
gp3 типа тома.AccessPolicies -> (строка)
IPAddressType -> (строка)
SnapshotOptions -> (структура)
УСТАРЕЛО. Контейнер для параметров, необходимых для настройки автоматических снимков индексов домена.
AutomatedSnapshotStartHour -> (целое число)
0 часов.VPCOptions -> (структура)
Конфигурация VPC для домена.
VPCId -> (строка)
SubnetIds -> (список)
Список идентификаторов подсетей, связанных с VPC-конечными точками для домена.
(строка)
AvailabilityZones -> (список)
Список зон доступности, связанных с VPC-подсетями.
(строка)
SecurityGroupIds -> (список)
Список идентификаторов групп безопасности, связанных с VPC-конечными точками для домена.
(строка)
CognitoOptions -> (структура)
Пара ключ-значение для настройки аутентификации Amazon Cognito для OpenSearch Dashboards.
Enabled -> (булево)
UserPoolId -> (строка)
IdentityPoolId -> (строка)
RoleArn -> (строка)
AmazonOpenSearchServiceCognitoAccess роль, позволяющая OpenSearch Service настроить ваш пул пользователей и пул идентификаторов.EncryptionAtRestOptions -> (структура)
Настройки шифрования в состоянии покоя для домена.
Enabled -> (булево)
KmsKeyId -> (строка)
1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.NodeToNodeEncryptionOptions -> (структура)
Включено или выключено шифрование между узлами.
Enabled -> (булево)
AdvancedOptions -> (карта)
Пара ключ-значение, определяющие параметры расширенной конфигурации.
key -> (строка)
value -> (строка)
LogPublishingOptions -> (карта)
Параметры публикации логов для домена.
key -> (строка)
Тип файла журнала. Может быть одним из следующих:
- INDEX_SLOW_LOGS - Журналы медленных запросов индекса содержат запросы вставки, которые заняли больше времени, чем заданный порог времени выполнения запроса журнала индекса.
- SEARCH_SLOW_LOGS - Журналы медленных запросов поиска содержат запросы поиска, которые заняли больше времени, чем заданный порог времени выполнения запроса журнала поиска.
- ES_APPLICATION_LOGS - Логи приложения OpenSearch содержат информацию об ошибках и предупреждениях, возникающих во время работы сервиса, и могут быть полезны для устранения неполадок.
- AUDIT_LOGS - Журналы аудита содержат записи о запросах пользователей для доступа к домену.
value -> (структура)
Указывает, публикует ли Amazon OpenSearch Service в Amazon CloudWatch журналы приложения OpenSearch и медленные запросы. Дополнительная информация: Мониторинг логов OpenSearch с помощью Amazon CloudWatch Logs.
Примечание
После включения публикации логов вам все равно нужно включить сбор медленных логов с помощью OpenSearch REST API.CloudWatchLogsLogGroupArn -> (строка)
Enabled -> (булево)
ServiceSoftwareOptions -> (структура)
Текущий статус программного обеспечения службы домена.
CurrentVersion -> (string)
NewVersion -> (string)
UpdateAvailable -> (boolean)
Cancellable -> (boolean)
UpdateStatus -> (string)
Description -> (string)
AutomatedUpdateDate -> (timestamp)
OptionalDeployment -> (boolean)
DomainEndpointOptions -> (structure)
Дополнительные параметры для конечной точки домена, такие как требование HTTPS для всего трафика.
EnforceHTTPS -> (boolean)
TLSSecurityPolicy -> (string)
Укажите политику безопасности TLS для применения к HTTPS-конечной точке домена. Политика может принимать одно из следующих значений:
- Policy-Min-TLS-1-0-2019-07: Политика безопасности TLS, поддерживающая версии TLS от 1.0 до 1.2
- Policy-Min-TLS-1-2-2019-07: Политика безопасности TLS, поддерживающая только версию TLS 1.2
- Policy-Min-TLS-1-2-PFS-2023-10: Политика безопасности TLS, поддерживающая версии TLS от 1.2 до 1.3 с шифрами с совершенной прямой секретностью
CustomEndpointEnabled -> (boolean)
CustomEndpoint -> (string)
CustomEndpointCertificateArn -> (string)
AdvancedSecurityOptions -> (structure)
Настройки для точного управления доступом.
Enabled -> (boolean)
InternalUserDatabaseEnabled -> (boolean)
SAMLOptions -> (structure)
Контейнер для информации о конфигурации SAML для OpenSearch Dashboards.
Enabled -> (boolean)
Idp -> (structure)
Описание информации поставщика идентификации SAML.
MetadataContent -> (string)
EntityId -> (string)
SubjectKey -> (string)
RolesKey -> (string)
SessionTimeoutMinutes -> (integer)
JWTOptions -> (structure)
Контейнер для информации о конфигурации JWT Amazon OpenSearch Service.
Enabled -> (boolean)
SubjectKey -> (string)
RolesKey -> (string)
PublicKey -> (string)
AnonymousAuthDisableDate -> (timestamp)
AnonymousAuthEnabled -> (boolean)
IdentityCenterOptions -> (structure)
Параметры конфигурации для управления интеграцией IAM Identity Center в домен.
EnabledAPIAccess -> (boolean)
IdentityCenterInstanceARN -> (string)
SubjectKey -> (string)
RolesKey -> (string)
IdentityCenterApplicationARN -> (string)
IdentityStoreId -> (string)
AutoTuneOptions -> (structure)
Настройки автоматической настройки для домена.
State -> (string)
ErrorMessage -> (string)
UseOffPeakWindow -> (boolean)
ChangeProgressDetails -> (structure)
Информация о текущем изменении конфигурации домена.
ChangeId -> (string)
Message -> (string)
ConfigChangeStatus -> (string)
InitiatedBy -> (string)
StartTime -> (timestamp)
LastUpdatedTime -> (timestamp)
OffPeakWindowOptions -> (structure)
Параметры, которые задают пользовательское 10-часовое окно, в течение которого OpenSearch Service может выполнять изменения конфигурации в домене.
Enabled -> (boolean)
Включить ли окно вне пиковой нагрузки.
Этот параметр доступен только при изменении домена, созданного до 16 февраля 2023 г., а не при создании нового домена. Для всех доменов, созданных после этой даты, окно вне пиковой нагрузки включено по умолчанию. Вы не можете отключить окно вне пиковой нагрузки после его включения для домена.
OffPeakWindow -> (structure)
Настройки окна вне пиковой нагрузки для домена.
WindowStartTime -> (structure)
Пользовательское начальное время окна вне пиковой нагрузки в формате UTC. Длительность окна всегда составляет 10 часов, поэтому вы не можете указать конечное время. Например, если вы укажете 23:00 UTC как начальное время, конечное время будет автоматически установлено на 9:00.
Hours -> (long)
17 означает 17:00 UTC.Minutes -> (long)
SoftwareUpdateOptions -> (structure)
Параметры обновления программного обеспечения службы для домена.
AutoSoftwareUpdateEnabled -> (boolean)
DomainProcessingStatus -> (string)
ModifyingProperties -> (list)
Информация о свойствах домена, которые в настоящее время изменяются.
(structure)
Информация о свойствах домена, которые в настоящее время изменяются.
Name -> (string)
ActiveValue -> (string)
PendingValue -> (string)
ValueType -> (string)
Тип значения, который в настоящее время изменяется. Свойства могут иметь два типа:
-
PLAIN_TEXT: Содержат прямые значения, такие как «1», «True» или «c5.large.search». -
STRINGIFIED_JSON: Содержат содержимое в формате JSON, например {“Enabled”:”True”}”.
AIMLOptions -> (structure)
Контейнер для параметров, необходимых для включения всех функций машинного обучения.
NaturalLanguageQueryGenerationOptions -> (structure)
Контейнер для параметров, необходимых для генерации запросов на естественном языке для указанного домена.
DesiredState -> (string)
CurrentState -> (string)
DryRunResults -> (structure)
Результаты моделирования.
DeploymentType -> (string)
Указывает способ применения OpenSearch Service обновления. Возможные значения:
- Blue/Green - Обновление требует развертывания blue/green.
- DynamicUpdate - Развертывание blue/green не требуется
- Undetermined - Домен находится в процессе обновления и не может определить тип развертывания. Повторите попытку после завершения обновления.
- None - Запрос не содержит никаких изменений конфигурации.
Message -> (string)
© Copyright 2025, Amazon Web Services. Created using Sphinx.