Spec-Zone.ru › AWS CLI v2

[ aws . datazone ]

list-connections

Описание

Перечисляет подключения. В Amazon DataZone подключение позволяет подключать ваши ресурсы (домены, проекты и среды) к внешним ресурсам и службам.

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

list-connections является постраничной операцией. Для получения всего набора результатов может потребоваться несколько вызовов API. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничностью, аргумент --query должен извлекать данные из результатов следующих выражений запроса: items

Синтаксис

  list-connections
--domain-identifier <value>
[--environment-identifier <value>]
[--name <value>]
--project-identifier <value>
[--sort-by <value>]
[--sort-order <value>]
[--type <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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-identifier (строка)

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

--environment-identifier (строка)

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

--name (строка)

Название подключения.

--project-identifier (строка)

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

--sort-by (строка)

Определяет порядок сортировки перечисленных подключений.

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

  • NAME

--sort-order (строка)

Определяет порядок сортировки перечисленных подключений.

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

  • ASCENDING
  • DESCENDING

--type (строка)

Тип подключения.

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

  • ATHENA
  • BIGQUERY
  • DATABRICKS
  • DOCUMENTDB
  • DYNAMODB
  • HYPERPOD
  • IAM
  • MYSQL
  • OPENSEARCH
  • ORACLE
  • POSTGRESQL
  • REDSHIFT
  • SAPHANA
  • SNOWFLAKE
  • SPARK
  • SQLSERVER
  • TERADATA
  • VERTICA
  • WORKFLOWS_MWAA

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные через JSON. Передавать произвольные двоичные значения с помощью значения JSON невозможно, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Токен, указывающий, где начать постраничную навигацию. Это NextToken из ранее усеченного ответа.

Примеры использования см. в разделе Постраничная навигация в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения данных от AWS-службы. Это не влияет на количество элементов, возвращаемых в выводе команды. Уменьшение размера страницы приводит к большему количеству вызовов AWS-службы, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-службы.

Примеры использования см. в разделе Постраничная навигация в Руководстве пользователя AWS Command Line Interface.

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

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Чтобы продолжить постраничную навигацию, укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken непосредственно вне AWS CLI.

Примеры использования см. в разделе Постраничная навигация в Руководстве пользователя AWS Command Line Interface.

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

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

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

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

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

Выходные данные

items -> (список)

Результаты действия ListConnections.

(структура)

Сводка подключения.

connectionId -> (строка)

Идентификатор подключения.

domainId -> (строка)

Идентификатор домена подключения.

domainUnitId -> (строка)

Идентификатор единицы домена подключения.

environmentId -> (строка)

Идентификатор среды подключения.

name -> (строка)

Имя подключения.

physicalEndpoints -> (список)

Физические конечные точки подключения.

(структура)

Физические конечные точки подключения.

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

Расположение подключения.

accessRole -> (строка)

Роль доступа подключения.

awsAccountId -> (строка)

Идентификатор учетной записи AWS подключения.

awsRegion -> (строка)

Регион подключения.

iamConnectionId -> (строка)

Идентификатор подключения IAM.

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

Подключение Amazon Web Services Glue.

athenaProperties -> (массив)

Свойства Amazon Athena для подключения Amazon Web Services Glue.

key -> (строка)

value -> (строка)

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

Настройка аутентификации подключения Amazon Web Services Glue.

authenticationType -> (строка)

Тип аутентификации подключения.

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

Свойства oAuth2 подключения.

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

Свойства кода авторизации для свойств OAuth2.

authorizationCode -> (строка)

Код авторизации подключения.

redirectUri -> (строка)

URI перенаправления подключения.

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

Приложение OAuth2 клиента для свойств OAuth2.

aWSManagedClientApplicationReference -> (строка)

Ссылка на управляемое приложение клиента AWS в приложении OAuth2Client.

userManagedClientApplicationClientId -> (строка)

Идентификатор клиента приложения клиента, управляемого пользователем, в приложении OAuth2Client.

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

Удостоверения OAuth2 для свойств OAuth2.

accessToken -> (строка)

Токен доступа подключения.

jwtToken -> (строка)

Токен JWT подключения.

refreshToken -> (строка)

Токен обновления подключения.

userManagedClientApplicationClientSecret -> (строка)

Секрет клиента приложения клиента, управляемого пользователем, для подключения.

oAuth2GrantType -> (строка)

Тип OAuth2 grant для свойств OAuth2.

tokenUrl -> (строка)

URL токена OAuth2 для свойств OAuth2.

tokenUrlParametersMap -> (массив)

Карта параметров URL токена OAuth2 для свойств OAuth2.

key -> (строка)

value -> (строка)

secretArn -> (строка)

ARN секрета подключения.

compatibleComputeEnvironments -> (список)

Совместимые среды вычислений для подключения Amazon Web Services Glue.

(строка)

connectionProperties -> (массив)

Свойства подключения Amazon Web Services Glue.

key -> (строка)

value -> (строка)

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

Версия схемы подключения для подключения Amazon Web Services Glue.

connectionType -> (строка)

Тип подключения Amazon Web Services Glue.

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

Время создания подключения Amazon Web Services Glue.

description -> (строка)

Описание подключения Amazon Web Services Glue.

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

Последнее время проверки подключения Amazon Web Services Glue.

lastUpdatedBy -> (строка)

Пользователь, который последний раз обновил подключение Amazon Web Services Glue.

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

Метка времени последнего обновления подключения Amazon Web Services Glue.

matchCriteria -> (список)

Критерии соответствия для подключения Amazon Web Services Glue.

(строка)

name -> (строка)

Имя подключения Amazon Web Services Glue.

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

Требования к физическому подключению для подключения Amazon Web Services Glue.

availabilityZone -> (строка)

Зона доступности требований к физическому подключению для подключения.

securityGroupIdList -> (список)

Список идентификаторов групп безопасности для требований к физическому подключению.

(строка)

subnetId -> (строка)

Идентификатор подсети требований к физическому подключению.

subnetIdList -> (список)

Список идентификаторов подсетей для требований к физическому подключению.

(строка)

pythonProperties -> (массив)

Свойства Python для подключения Amazon Web Services Glue.

key -> (строка)

value -> (строка)

sparkProperties -> (массив)

Свойства Spark для подключения Amazon Web Services Glue.

key -> (строка)

value -> (строка)

status -> (строка)

Статус подключения Amazon Web Services Glue.

statusReason -> (строка)

Причина статуса подключения Amazon Web Services Glue.

glueConnectionName -> (строка)

Имя подключения Amazon Web Services Glue.

host -> (строка)

Хост в физических конечных точках подключения.

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

Порт в физических конечных точках подключения.

protocol -> (строка)

Протокол в физических конечных точках подключения.

stage -> (строка)

Этап в физических конечных точках подключения.

projectId -> (строка)

Идентификатор проекта подключения.

props -> (структура объединённого типа)

Свойства подключения.

Примечание

Это структура помеченных объединений. Можно установить только один из следующих ключей верхнего уровня: athenaProperties, glueProperties, hyperPodProperties, iamProperties, redshiftProperties, sparkEmrProperties, sparkGlueProperties.

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

Свойства Amazon Athena для подключения.

workgroupName -> (строка)

Имя рабочей группы Amazon Athena для подключения.

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

Свойства Amazon Web Services Glue для подключения.

errorMessage -> (строка)

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

status -> (строка)

Статус подключения.

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

Свойства гипер-под для подключения.

clusterArn -> (строка)

ARN кластера свойств гипер-под.

clusterName -> (строка)

Имя кластера свойств гипер-под.

orchestrator -> (строка)

Органайзер свойств гипер-под.

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

Свойства IAM для подключения.

environmentId -> (строка)

Идентификатор среды подключения.

glueLineageSyncEnabled -> (булево)

Указывает, включена ли синхронизация родословной Amazon Web Services Glue для подключения.

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

Свойства Amazon Redshift для подключения.

credentials -> (структура помеченных объединений)

Учетные данные Amazon Redshift.

Примечание

Это структура помеченных объединений. Можно установить только один из следующих ключей верхнего уровня: secretArn, usernamePassword.

secretArn -> (строка)

ARN секрета учетных данных Amazon Redshift для подключения.

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

Имя пользователя и пароль учетных данных Amazon Redshift для подключения.

password -> (строка)

Пароль подключения.

username -> (строка)

Имя пользователя подключения.

databaseName -> (строка)

Имя базы данных Amazon Redshift.

isProvisionedSecret -> (булево)

Указывает, содержит ли Amaon Redshift свойства предварительно настроенный секрет.

jdbcIamUrl -> (строка)

URL jdbcIam свойств Amazon Redshift.

jdbcUrl -> (строка)

jdbcURL свойств Amazon Redshift.

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

Синхронизация родословной свойств Amazon Redshift.

enabled -> (булево)

Указывает, включена ли конфигурация синхронизации родословной Amaon Redshift.

lineageJobId -> (строка)

Идентификатор задачи синхронизации родословной Amaon Redshift.

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

График конфигурации синхронизации родословной Amaon Redshift.

schedule -> (строка)

График синхронизации родословной.

redshiftTempDir -> (строка)

redshiftTempDir свойств Amazon Redshift.

status -> (строка)

Статус в свойствах Amazon Redshift.

storage -> (структура помеченных объединений)

Хранилище в свойствах Amazon Redshift.

Примечание

Это структура помеченных объединений. Можно установить только один из следующих ключей верхнего уровня: clusterName, workgroupName.

clusterName -> (строка)

Имя кластера в свойствах хранилища Amazon Redshift.

workgroupName -> (строка)

Имя рабочей группы в свойствах хранилища Amazon Redshift.

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

Свойства Spark EMR для подключения.

computeArn -> (строка)

ARN вычислительных ресурсов Spark EMR.

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

Учетные данные Spark EMR.

password -> (строка)

Пароль подключения.

username -> (строка)

Имя пользователя подключения.

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

Срок действия учетных данных Spark EMR.

governanceType -> (строка)

Тип управления Spark EMR.

instanceProfileArn -> (строка)

ARN профиля экземпляра Spark EMR.

javaVirtualEnv -> (строка)

Виртуальная среда Java Spark EMR.

livyEndpoint -> (строка)

Конечная точка Livy Spark EMR.

logUri -> (строка)

URI логов Spark EMR.

pythonVirtualEnv -> (строка)

Виртуальная среда Python Spark EMR.

runtimeRole -> (строка)

Роль выполнения Spark EMR.

trustedCertificatesS3Uri -> (строка)

URL S3 доверенных сертификатов Spark EMR.

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

Свойства Spark Amazon Web Services Glue для подключения.

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

Дополнительные аргументы в свойствах Spark Amazon Web Services Glue.

connection -> (строка)

Подключение в аргументах Spark Amazon Web Services Glue.

glueConnectionName -> (строка)

Имя подключения Amazon Web Services Glue в свойствах Spark Amazon Web Services Glue.

glueVersion -> (строка)

Версия Amazon Web Services Glue в свойствах Spark Amazon Web Services Glue.

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

Таймаут бездействия в свойствах Spark Amazon Web Services Glue.

javaVirtualEnv -> (строка)

Виртуальная среда Java в свойствах Spark Amazon Web Services Glue.

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

Количество рабочих процессов в свойствах Spark Amazon Web Services Glue.

pythonVirtualEnv -> (строка)

Виртуальная среда Python в свойствах Spark Amazon Web Services Glue.

workerType -> (строка)

Тип рабочего процесса в свойствах Spark Amazon Web Services Glue.

type -> (строка)

Тип подключения.

nextToken -> (строка)

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

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

Spec-Zone.ru

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