получить-соединение
Описание
Получает соединение. В 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 -> (строка)
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 -> (список)
Список ID групп безопасности требований к физическому подключению подключения.
(строка)
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 -> (структура)
Расписание конфигурации синхронизации происхождения Amazon 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 -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.