Spec-Zone.ru › AWS CLI v2

[ aws . datazone ]

получить-соединение

Описание

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

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

Синтаксис

  get-connection
--domain-identifier <value>
--identifier <value>
[--with-secret | --no-with-secret]
[--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-identifier (строка)

Идентификатор домена, где мы получаем соединение.

--identifier (строка)

Идентификатор соединения.

--with-secret | --no-with-secret (булево)

Указывает, содержит ли соединение секрет.

--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 (целое число)

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

Вывод

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

Удостоверения подключения.

accessKeyId -> (строка)

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

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

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

secretAccessKey -> (строка)

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

sessionToken -> (строка)

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

connectionId -> (строка)

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

description -> (строка)

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

domainId -> (строка)

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

domainUnitId -> (строка)

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

environmentId -> (строка)

Идентификатор среды.

environmentUserRole -> (строка)

Роль пользователя в среде.

name -> (строка)

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

physicalEndpoints -> (список)

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

(структура)

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

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

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

accessRole -> (строка)

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

awsAccountId -> (строка)

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

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 -> (строка)

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

userManagedClientApplicationClientId -> (строка)

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

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

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

accessToken -> (строка)

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

jwtToken -> (строка)

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

refreshToken -> (строка)

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

userManagedClientApplicationClientSecret -> (строка)

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

oAuth2GrantType -> (строка)

Тип предоставления oAuth2 свойств 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 -> (список)

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

(строка)

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 -> (булево)

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

jdbcIamUrl -> (строка)

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

jdbcUrl -> (строка)

jdbcURL свойств Amazon Redshift.

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

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

enabled -> (булево)

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

lineageJobId -> (строка)

Идентификатор задачи синхронизации происхождения Amazon Redshift.

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

Расписание конфигурации синхронизации происхождения Amazon 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 хранилища доверенных сертификатов 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 -> (строка)

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

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

Spec-Zone.ru

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