Spec-Zone.ru › AWS CLI v2

[ aws . dms ]

describe-instance-profiles

Описание

Возвращает постраничный список профилей экземпляров для вашей учетной записи в текущем регионе.

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

Синтаксис

  describe-instance-profiles
[--filters <value>]
[--max-records <value>]
[--marker <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]

Параметры

--filters (список)

Фильтры, применяемые к профилям экземпляров в виде пар ключ-значение.

Допустимые имена и значения фильтров: instance-profile-identifier, arn или имя профиля экземпляра

(структура)

Идентифицирует имя и значение объекта фильтра. Этот фильтр используется для ограничения количества и типа объектов DMS, возвращаемых для определенного вызова Describe* или аналогичной операции. Фильтры используются в качестве необязательного параметра для определенных операций API.

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

Имя фильтра, как указано для операции Describe* или аналогичной операции.

Значения -> (список)

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

(строка)

Сокращенный синтаксис:

Name=string,Values=string,string ...

Синтаксис JSON:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--max-records (целое число)

Максимальное количество записей для включения в ответ. Если записей больше, чем указанное значение MaxRecords, DMS включает в ответ маркер для постраничной навигации, чтобы вы могли получить оставшиеся результаты.

--marker (строка)

Указывает уникальный маркер постраничной навигации, который позволяет отображать следующую страницу результатов. Если этот параметр указан, в ответ включаются только записи, начиная с маркера, до значения, указанного параметром MaxRecords.

Если Marker возвращается предыдущим ответом, доступны дополнительные результаты. Значение Marker — это уникальный маркер постраничной навигации для каждой страницы. Чтобы получить следующую страницу, необходимо снова выполнить вызов с возвращенным маркером и сохранением всех других аргументов без изменений.

--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 (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время соединения сокета в секундах. Если значение установлено в 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.

Вывод

Маркер -> (строка)

Указывает уникальный маркер постраничной навигации, который позволяет отображать следующую страницу результатов. Если этот параметр указан, в ответ включаются только записи, начиная с маркера, до значения, указанного параметром MaxRecords.

Если Marker возвращается предыдущим ответом, доступны дополнительные результаты. Значение Marker — это уникальный маркер постраничной навигации для каждой страницы. Чтобы получить следующую страницу, необходимо снова выполнить вызов с возвращенным маркером и сохранением всех других аргументов без изменений.

InstanceProfiles -> (список)

Описание профилей экземпляров.

(структура)

Предоставляет информацию, которая определяет профиль экземпляра.

InstanceProfileArn -> (строка)

Строка Amazon Resource Name (ARN), которая уникально идентифицирует профиль экземпляра.

AvailabilityZone -> (строка)

Аварийная зона, в которой работает профиль экземпляра.

KmsKeyArn -> (строка)

Amazon Resource Name (ARN) ключа KMS, используемого для шифрования параметров подключения для профиля экземпляра.

Если вы не указываете значение для параметра KmsKeyArn, DMS использует ваш ключ шифрования по умолчанию.

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

PubliclyAccessible -> (логическое)

Указывает параметры доступности для профиля экземпляра. Значение true представляет профиль экземпляра с общедоступным IP-адресом. Значение false представляет профиль экземпляра с частным IP-адресом. Значение по умолчанию — true.

NetworkType -> (строка)

Указывает тип сети для профиля экземпляра. Значение IPV4 представляет профиль экземпляра с типом сети IPv4 и поддерживает только адреса IPv4. Значение IPV6 представляет профиль экземпляра с типом сети IPv6 и поддерживает только адреса IPv6. Значение DUAL представляет профиль экземпляра с двойным типом сети, который поддерживает адреса IPv4 и IPv6.

InstanceProfileName -> (строка)

Наименование профиля экземпляра для удобства пользователя.

Описание -> (строка)

Описание профиля экземпляра. Описания могут содержать до 31 символа. Описание может содержать только буквы ASCII, цифры и дефисы (‘-‘). Кроме того, оно не может заканчиваться дефисом или содержать два дефиса подряд, и может начинаться только с буквы.

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

Время создания профиля экземпляра.

SubnetGroupIdentifier -> (строка)

Идентификатор группы подсетей, связанной с профилем экземпляра.

VpcSecurityGroups -> (список)

Включаемые группы безопасности VPC для профиля экземпляра. Группа безопасности VPC должна работать с VPC, содержащей профиль экземпляра.

(строка)

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API