Spec-Zone.ru › AWS CLI v2

[ aws . transfer ]

test-identity-provider

Описание

Если IdentityProviderType сервера с поддержкой протокола передачи файлов является AWS_DIRECTORY_SERVICE или API_Gateway , проверяет, успешно ли настроено ваше поставщик удостоверений. Мы настоятельно рекомендуем вызвать эту операцию для проверки вашего метода аутентификации сразу после создания сервера. Таким образом, вы можете устранить проблемы с интеграцией поставщика удостоверений, чтобы убедиться, что ваши пользователи могут успешно использовать службу.

Параметры ServerId и UserName обязательны. Параметры ServerProtocol , SourceIp и UserPassword необязательны.

Обратите внимание на следующее:

  • Вы не можете использовать TestIdentityProvider, если IdentityProviderType вашего сервера является SERVICE_MANAGED.
  • TestIdentityProvider не работает с ключами: он принимает только пароли.
  • TestIdentityProvider может проверить операцию с паролем для пользовательского поставщика удостоверений, который обрабатывает ключи и пароли.
  • Если вы предоставите какие-либо неправильные значения для каких-либо параметров, поле Response будет пустым.
  • Если вы укажете идентификатор сервера для сервера, использующего управляемых службой пользователей, вы получите ошибку: An error occurred (InvalidRequestException) when calling the TestIdentityProvider operation: s-*server-ID* not configured for external auth
  • Если вы введете идентификатор сервера для параметра --server-id, который не идентифицирует фактический сервер передачи, вы получите следующую ошибку: An error occurred (ResourceNotFoundException) when calling the TestIdentityProvider operation: Unknown server . Возможно, ваш сервер находится в другом регионе. Вы можете указать регион, добавив следующее: --region region-code , например --region us-east-2, чтобы указать сервер в Восточная часть США (Огайо) .

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

Синтаксис

  test-identity-provider
--server-id <value>
[--server-protocol <value>]
[--source-ip <value>]
--user-name <value>
[--user-password <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]

Параметры

--server-id (строка)

Присвоенный системой идентификатор конкретного сервера. Метод аутентификации пользователя этого сервера проверяется с использованием имени пользователя и пароля.

--server-protocol (строка)

Тип протокола передачи файлов, который нужно проверить.

Доступные протоколы:

  • Протокол передачи файлов по защищенному каналу (SFTP)
  • Защищенный протокол передачи файлов (FTPS)
  • Протокол передачи файлов (FTP)
  • Заявление о применимости 2 (AS2)

Возможные значения:

  • SFTP
  • FTP
  • FTPS
  • AS2

--source-ip (строка)

IP-адрес источника учетной записи, которую нужно проверить.

--user-name (строка)

Имя учетной записи, которую нужно проверить.

--user-password (строка)

Пароль учетной записи, которую нужно проверить.

--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.

Вывод

Ответ -> (строка)

Ответ, возвращаемый вашим API Gateway или вашей функцией Lambda.

Код состояния -> (целое число)

Код HTTP-статуса, являющийся ответом вашего API Gateway или вашей функции Lambda.

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

Сообщение, которое указывает, был ли тест успешным или нет.

Примечание

Если возвращается пустая строка, наиболее вероятная причина состоит в том, что аутентификация не удалась из-за неправильного имени пользователя или пароля.

Url -> (строка)

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

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

Spec-Zone.ru

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