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 (строка)
Определяет порядок сортировки перечисленных подключений.
Возможные значения:
ASCENDINGDESCENDING
--type (строка)
Тип подключения.
Возможные значения:
ATHENABIGQUERYDATABRICKSDOCUMENTDBDYNAMODBHYPERPODIAMMYSQLOPENSEARCHORACLEPOSTGRESQLREDSHIFTSAPHANASNOWFLAKESPARKSQLSERVERTERADATAVERTICAWORKFLOWS_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 -> (строка)
awsRegion -> (строка)
iamConnectionId -> (строка)
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 -> (строка)
oAuth2ClientApplication -> (структура)
Приложение OAuth2 клиента для свойств OAuth2.
aWSManagedClientApplicationReference -> (строка)
userManagedClientApplicationClientId -> (строка)
oAuth2Credentials -> (структура)
Удостоверения OAuth2 для свойств OAuth2.
accessToken -> (строка)
jwtToken -> (строка)
refreshToken -> (строка)
userManagedClientApplicationClientSecret -> (строка)
oAuth2GrantType -> (строка)
tokenUrl -> (строка)
tokenUrlParametersMap -> (массив)
Карта параметров URL токена OAuth2 для свойств OAuth2.
key -> (строка)
value -> (строка)
secretArn -> (строка)
compatibleComputeEnvironments -> (список)
Совместимые среды вычислений для подключения Amazon Web Services Glue.
(строка)
connectionProperties -> (массив)
Свойства подключения Amazon Web Services Glue.
key -> (строка)
value -> (строка)
connectionSchemaVersion -> (целое число)
connectionType -> (строка)
creationTime -> (метка времени)
description -> (строка)
lastConnectionValidationTime -> (метка времени)
lastUpdatedBy -> (строка)
lastUpdatedTime -> (метка времени)
matchCriteria -> (список)
Критерии соответствия для подключения Amazon Web Services Glue.
(строка)
name -> (строка)
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 -> (строка)
statusReason -> (строка)
glueConnectionName -> (строка)
host -> (строка)
port -> (целое число)
protocol -> (строка)
stage -> (строка)
projectId -> (строка)
props -> (структура объединённого типа)
Свойства подключения.
Примечание
Это структура помеченных объединений. Можно установить только один из следующих ключей верхнего уровня:athenaProperties, glueProperties, hyperPodProperties, iamProperties, redshiftProperties, sparkEmrProperties, sparkGlueProperties.athenaProperties -> (структура)
Свойства Amazon Athena для подключения.
workgroupName -> (строка)
glueProperties -> (структура)
Свойства Amazon Web Services Glue для подключения.
errorMessage -> (строка)
status -> (строка)
hyperPodProperties -> (структура)
Свойства гипер-под для подключения.
clusterArn -> (строка)
clusterName -> (строка)
orchestrator -> (строка)
iamProperties -> (структура)
Свойства IAM для подключения.
environmentId -> (строка)
glueLineageSyncEnabled -> (булево)
redshiftProperties -> (структура)
Свойства Amazon Redshift для подключения.
credentials -> (структура помеченных объединений)
Учетные данные Amazon Redshift.
Примечание
Это структура помеченных объединений. Можно установить только один из следующих ключей верхнего уровня:secretArn, usernamePassword.secretArn -> (строка)
usernamePassword -> (структура)
Имя пользователя и пароль учетных данных Amazon Redshift для подключения.
password -> (строка)
username -> (строка)
databaseName -> (строка)
isProvisionedSecret -> (булево)
jdbcIamUrl -> (строка)
jdbcUrl -> (строка)
lineageSync -> (структура)
Синхронизация родословной свойств Amazon Redshift.
enabled -> (булево)
lineageJobId -> (строка)
schedule -> (структура)
График конфигурации синхронизации родословной Amaon Redshift.
schedule -> (строка)
redshiftTempDir -> (строка)
status -> (строка)
storage -> (структура помеченных объединений)
Хранилище в свойствах Amazon Redshift.
Примечание
Это структура помеченных объединений. Можно установить только один из следующих ключей верхнего уровня:clusterName, workgroupName.clusterName -> (строка)
workgroupName -> (строка)
sparkEmrProperties -> (структура)
Свойства Spark EMR для подключения.
computeArn -> (строка)
credentials -> (структура)
Учетные данные Spark EMR.
password -> (строка)
username -> (строка)
credentialsExpiration -> (метка времени)
governanceType -> (строка)
instanceProfileArn -> (строка)
javaVirtualEnv -> (строка)
livyEndpoint -> (строка)
logUri -> (строка)
pythonVirtualEnv -> (строка)
runtimeRole -> (строка)
trustedCertificatesS3Uri -> (строка)
sparkGlueProperties -> (структура)
Свойства Spark Amazon Web Services Glue для подключения.
additionalArgs -> (структура)
Дополнительные аргументы в свойствах Spark Amazon Web Services Glue.
connection -> (строка)
glueConnectionName -> (строка)
glueVersion -> (строка)
idleTimeout -> (целое число)
javaVirtualEnv -> (строка)
numberOfWorkers -> (целое число)
pythonVirtualEnv -> (строка)
workerType -> (строка)
type -> (строка)
nextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.