get-connections

Описание

Извлекает список определений подключений из каталога данных.

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

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

Синтаксис

  get-connections
[--catalog-id <value>]
[--filter <value>]
[--hide-password | --no-hide-password]
[--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]

Параметры

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

Идентификатор каталога данных, в котором находятся подключения. Если не указан, используется идентификатор учетной записи Amazon Web Services по умолчанию.

--filter (структура)

Фильтр, который контролирует, какие подключения возвращаются.

MatchCriteria -> (список)

Строка критерия, которая должна соответствовать критериям, записанным в определении подключения, для того, чтобы это определение подключения было возвращено.

(строка)

ConnectionType -> (строка)

Тип подключений для возврата. В настоящее время SFTP не поддерживается.

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

Указывает, было ли подключение создано со схемой версии 1 или 2.

Краткая запись синтаксиса:

MatchCriteria=string,string,ConnectionType=string,ConnectionSchemaVersion=integer

Синтаксис JSON:

{
  "MatchCriteria": ["string", ...],
  "ConnectionType": "JDBC"|"SFTP"|"MONGODB"|"KAFKA"|"NETWORK"|"MARKETPLACE"|"CUSTOM"|"SALESFORCE"|"VIEW_VALIDATION_REDSHIFT"|"VIEW_VALIDATION_ATHENA"|"GOOGLEADS"|"GOOGLESHEETS"|"GOOGLEANALYTICS4"|"SERVICENOW"|"MARKETO"|"SAPODATA"|"ZENDESK"|"JIRACLOUD"|"NETSUITEERP"|"HUBSPOT"|"FACEBOOKADS"|"INSTAGRAMADS"|"ZOHOCRM"|"SALESFORCEPARDOT"|"SALESFORCEMARKETINGCLOUD"|"SLACK"|"STRIPE"|"INTERCOM"|"SNAPCHATADS",
  "ConnectionSchemaVersion": integer
}

--hide-password | --no-hide-password (логическое значение)

Позволяет извлечь метаданные подключения без возврата пароля. Например, консоль Glue использует этот флаг для извлечения подключения и не отображает пароль. Установите этот параметр, когда у вызывающей стороны может не быть разрешения на использование ключа KMS для расшифровки пароля, но она имеет разрешение на доступ к остальным свойствам подключения.

--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
текст
таблица
yaml
yaml-поток

--query (строка)

Запрос JMESPath для использования при фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

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

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/отключить вывод цвета.

вкл
выкл
авто

--no-sign-request (логическое значение)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл-сборка сертификатов CA для использования при проверке SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

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

Вывод

ConnectionList -> (список)

Список запрошенных определений подключений.

(структура)

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

Name -> (строка)

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

Description -> (строка)

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

ConnectionType -> (строка)

Тип подключения. В настоящее время SFTP не поддерживается.

MatchCriteria -> (список)

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

(строка)

ConnectionProperties -> (карта)

Эти пары ключ-значение определяют параметры для подключения при использовании схемы подключения версии 1:

HOST - URI хоста: либо полное доменное имя (FQDN), либо IPv4-адрес хоста базы данных.
PORT - Номер порта (между 1024 и 65535) порта, на котором хост базы данных слушает подключения к базе данных.
USER_NAME - Имя пользователя для входа в базу данных. Строковое значение для USER_NAME равно “USERNAME”.
PASSWORD - Пароль, если он используется для имени пользователя.
ENCRYPTED_PASSWORD - Если защита паролей подключения включена, установив ConnectionPasswordEncryption в настройках шифрования каталога данных, это поле хранит зашифрованный пароль.
JDBC_DRIVER_JAR_URI - Путь к файлу JAR с JDBC-драйвером в Amazon S3.
JDBC_DRIVER_CLASS_NAME - Имя класса JDBC-драйвера.
JDBC_ENGINE - Имя используемого JDBC-движка.
JDBC_ENGINE_VERSION - Версия используемого JDBC-движка.
CONFIG_FILES - (Зарезервировано для будущего использования.)
INSTANCE_ID - Идентификатор экземпляра.
JDBC_CONNECTION_URL - URL для подключения к источнику данных JDBC.
JDBC_ENFORCE_SSL - Строка булевого значения (true, false), указывающая, включено ли безопасное соединение (SSL) с проверкой имени хоста для JDBC-подключения на клиенте. По умолчанию значение false.
CUSTOM_JDBC_CERT - Расположение в Amazon S3, содержащее корневой сертификат клиента. Glue использует этот сертификат для проверки сертификата клиента при подключении к базе данных клиента. Glue обрабатывает только сертификаты X.509. Предоставляемый сертификат должен быть закодирован в DER и предоставлен в формате PEM с кодировкой Base64.
SKIP_CUSTOM_JDBC_CERT_VALIDATION - По умолчанию это false . Glue проверяет алгоритм подписи и алгоритм алгоритма открытого ключа субъекта для сертификата клиента. Допустимые алгоритмы для алгоритма подписи — SHA256withRSA, SHA384withRSA или SHA512withRSA. Для алгоритма открытого ключа субъекта длина ключа должна быть не менее 2048. Вы можете установить значение этого свойства на true, чтобы пропустить проверку Glue сертификата клиента.
CUSTOM_JDBC_CERT_STRING - Специальная строка сертификата JDBC, используемая для сопоставления домена или имени, чтобы предотвратить атаку «человек посередине». В базе данных Oracle это используется в качестве SSL_SERVER_CERT_DN; в Microsoft SQL Server — в качестве hostNameInCertificate.
CONNECTION_URL - URL для подключения к общему (не-JDBC) источнику данных.
SECRET_ID - Идентификатор секрета, используемый для менеджера секретов учетных данных.
CONNECTOR_URL - URL коннектора для подключения MARKETPLACE или CUSTOM.
CONNECTOR_TYPE - Тип коннектора для подключения MARKETPLACE или CUSTOM.
CONNECTOR_CLASS_NAME - Имя класса коннектора для подключения MARKETPLACE или CUSTOM.
KAFKA_BOOTSTRAP_SERVERS - Список пар хост-порт через запятую, представляющих адреса брокеров Apache Kafka в кластере Kafka, к которым клиент Kafka будет подключаться и выполнять инициализацию.
KAFKA_SSL_ENABLED - Включать или выключать SSL для подключения к Apache Kafka. Значение по умолчанию — “true”.
KAFKA_CUSTOM_CERT - URL Amazon S3 для файла сертификата CA (.pem-формат). По умолчанию — пустая строка.
KAFKA_SKIP_CUSTOM_CERT_VALIDATION - Пропустить или нет проверку файла сертификата CA. Glue проверяет три алгоритма: SHA256withRSA, SHA384withRSA и SHA512withRSA. Значение по умолчанию — “false”.
KAFKA_CLIENT_KEYSTORE - Расположение в Amazon S3 файла-ключевого хранилища клиента для аутентификации клиента Kafka (необязательно).
KAFKA_CLIENT_KEYSTORE_PASSWORD - Пароль для доступа к предоставленному хранилищу ключей (необязательно).
KAFKA_CLIENT_KEY_PASSWORD - Хранилище ключей может содержать несколько ключей, поэтому это пароль для доступа к ключу клиента, используемому с ключом сервера Kafka (необязательно).
ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD - Зашифрованная версия пароля хранилища ключей клиента Kafka (если пользователь выбрал функцию шифрования паролей в Glue).
ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD - Зашифрованная версия пароля ключа клиента Kafka (если пользователь выбрал функцию шифрования паролей в Glue).
KAFKA_SASL_MECHANISM - "SCRAM-SHA-512", "GSSAPI", "AWS_MSK_IAM" или "PLAIN". Это поддерживаемые механизмы SASL.
KAFKA_SASL_PLAIN_USERNAME - Явное имя пользователя для аутентификации с помощью механизма «PLAIN».
KAFKA_SASL_PLAIN_PASSWORD - Явный пароль для аутентификации с помощью механизма «PLAIN».
ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD - Зашифрованная версия пароля Kafka SASL PLAIN (если пользователь выбрал функцию шифрования паролей в Glue).
KAFKA_SASL_SCRAM_USERNAME - Явное имя пользователя для аутентификации с помощью механизма «SCRAM-SHA-512».
KAFKA_SASL_SCRAM_PASSWORD - Явный пароль для аутентификации с помощью механизма «SCRAM-SHA-512».
ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD - Зашифрованная версия пароля Kafka SASL SCRAM (если пользователь выбрал функцию шифрования паролей в Glue).
KAFKA_SASL_SCRAM_SECRETS_ARN - Amazon Resource Name секрета в Amazon Web Services Secrets Manager.
KAFKA_SASL_GSSAPI_KEYTAB - Расположение в S3 файла Kerberos keytab. Keytab хранит долгосрочные ключи для одного или нескольких принципалов. Дополнительную информацию можно найти в документации MIT Kerberos: Keytab.
KAFKA_SASL_GSSAPI_KRB5_CONF - Расположение в S3 файла Kerberos krb5.conf. Файл krb5.conf хранит информацию о конфигурации Kerberos, например, расположение сервера KDC. Дополнительную информацию можно найти в документации MIT Kerberos: krb5.conf.
KAFKA_SASL_GSSAPI_SERVICE - Имя Kerberos-сервиса, заданное с помощью sasl.kerberos.service.name в вашей конфигурации Kafka.
KAFKA_SASL_GSSAPI_PRINCIPAL - Имя Kerberos-принципала, используемого Glue. Дополнительную информацию можно найти в документации Kafka: Настройка брокеров Kafka.
ROLE_ARN - Роль, которая будет использоваться для выполнения запросов.
REGION - Регион Amazon Web Services, в котором будут выполняться запросы.
WORKGROUP_NAME - Имя Amazon Redshift serverless workgroup или Amazon Athena workgroup, в котором будут выполняться запросы.
CLUSTER_IDENTIFIER - Идентификатор кластера Amazon Redshift, в котором будут выполняться запросы.
DATABASE - База данных Amazon Redshift, к которой осуществляется подключение.

ключ -> (строка)

значение -> (строка)

SparkProperties -> (карта)

Свойства подключения, специфичные для среды вычислений Spark.

ключ -> (строка)

значение -> (строка)

AthenaProperties -> (карта)

Свойства подключения, специфичные для среды вычислений Athena.

ключ -> (строка)

значение -> (строка)

PythonProperties -> (карта)

Свойства подключения, специфичные для среды вычислений Python.

ключ -> (строка)

значение -> (строка)

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

Требования к физическому подключению, такие как виртуальная частная сеть (VPC) и SecurityGroup, необходимые для успешного подключения.

SubnetId -> (строка)

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

SecurityGroupIdList -> (список)

Список идентификаторов групп безопасности, используемых подключением.

(строка)

AvailabilityZone -> (строка)

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

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

Метка времени создания этого определения подключения.

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

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

LastUpdatedBy -> (строка)

Пользователь, группа или роль, которые последними обновили это определение подключения.

Status -> (строка)

Статус подключения. Может быть одним из: READY, IN_PROGRESS или FAILED.

StatusReason -> (строка)

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

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

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

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

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

AuthenticationType -> (строка)

Структура, содержащая настройки аутентификации.

SecretArn -> (строка)

ARN менеджера секретов для хранения учетных данных.

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

Свойства для аутентификации OAuth2.

OAuth2GrantType -> (строка)

Тип OAuth2-разрешения. Например, AUTHORIZATION_CODE, JWT_BEARER или CLIENT_CREDENTIALS.

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

Тип приложения-клиента. Например, AWS_MANAGED или USER_MANAGED.

UserManagedClientApplicationClientId -> (строка)

Идентификатор приложения-клиента, если ClientAppType — USER_MANAGED.

AWSManagedClientApplicationReference -> (строка)

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

TokenUrl -> (строка)

URL сервера аутентификации поставщика для обмена кодом авторизации на токен доступа.

TokenUrlParametersMap -> (карта)

Карта параметров, добавляемых к запросу получения токена GET.

ключ -> (строка)

значение -> (строка)

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

Версия схемы подключения для этого подключения. Версия 2 поддерживает свойства для определенных сред вычислений.

CompatibleComputeEnvironments -> (список)

Список сред вычислений, совместимых с подключением.

(строка)

NextToken -> (строка)

Маркер продолжения, если список подключений не содержит последнего из отфильтрованных подключений.