Spec-Zone.ru › AWS CLI v2

[ aws . dms ]

describe-data-providers

Описание

Возвращает постраничный список поставщиков данных для вашей учетной записи в текущем регионе.

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

Синтаксис

  describe-data-providers
[--filters <value>]
[--max-records <value>]
[--marker <value>]
[--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]

Параметры

--filters (список)

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

Допустимые имена и значения фильтров: data-provider-identifier, data provider arn или name

(структура)

Идентифицирует имя и значение объекта фильтра. Этот фильтр используется для ограничения количества и типа объектов DMS, возвращаемых для конкретного вызова Describe* или аналогичной операции. Фильтры используются в качестве необязательного параметра для определённых операций API.

Имя -> (строка)

Имя фильтра, как указано для операции Describe* или аналогичной операции.

Значения -> (список)

Значение фильтра, которое может указать одно или несколько значений, используемых для сужения возвращаемых результатов.

(строка)

Сокращённый синтаксис:

Name=string,Values=string,string ...

Синтаксис JSON:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

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

Максимальное количество записей, включаемых в ответ. Если записей больше, чем указанное значение MaxRecords, DMS включает маркер постраничной навигации в ответ, чтобы вы могли получить оставшиеся результаты.

--marker (строка)

Указывает уникальный маркер постраничной навигации, который позволяет отобразить следующую страницу результатов. Если этот параметр указан, ответ включает только записи после маркера, до значения, указанного параметром MaxRecords.

Если Marker возвращён предыдущим ответом, доступны дополнительные результаты. Значение Marker — это уникальный маркер постраничной навигации для каждой страницы. Чтобы получить следующую страницу, необходимо снова вызвать операцию, используя возвращённый маркер и сохранив все другие аргументы неизменными.

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

--generate-cli-skeleton (строка) Выводит каркас JSON в стандартный вывод без отправки запроса к API. Если предоставлено значение null или 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
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

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

Вывод

Маркер -> (строка)

Указывает уникальный токен постраничной навигации, который позволяет отобразить следующую страницу результатов. Если этот параметр указан, ответ включает только записи за маркером, до значения, указанного в MaxRecords.

Если в предыдущем ответе возвращено Marker, то доступны дополнительные результаты. Значение Marker является уникальным токеном постраничной навигации для каждой страницы. Для получения следующей страницы необходимо повторно выполнить вызов, используя возвращённый токен и сохранив все остальные аргументы неизменными.

DataProviders -> (список)

Описание поставщиков данных.

(структура)

Предоставляет информацию, определяющую поставщика данных.

DataProviderName -> (строка)

Название поставщика данных.

DataProviderArn -> (строка)

Строка Amazon Resource Name (ARN), уникально идентифицирующая поставщика данных.

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

Время создания поставщика данных.

Description -> (строка)

Описание поставщика данных. Описания могут содержать до 31 символа. Описание может содержать только символы ASCII, цифры и дефисы (‘-‘). Также оно не может заканчиваться дефисом или содержать два дефиса подряд, и должно начинаться с буквы.

Engine -> (строка)

Тип СУБД для поставщика данных. Допустимые значения включают "aurora" , "aurora-postgresql" , "mysql" , "oracle" , "postgres" , "sqlserver" , redshift , mariadb , mongodb , db2 , db2-zos и docdb . Значение "aurora" представляет Amazon Aurora MySQL-совместимое издание.

Settings -> (структура помеченного объединения)

Настройки в формате JSON для поставщика данных.

Примечание

Это структура помеченного объединения. Только один из следующих верхнеуровневых ключей может быть задан: RedshiftSettings, PostgreSqlSettings, MySqlSettings, OracleSettings, MicrosoftSqlServerSettings, DocDbSettings, MariaDbSettings, IbmDb2LuwSettings, IbmDb2zOsSettings, MongoDbSettings.

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

Предоставляет информацию, определяющую поставщика данных Amazon Redshift.

ServerName -> (строка)

Имя сервера Amazon Redshift.

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

Значение порта для поставщика данных Amazon Redshift.

DatabaseName -> (строка)

Имя базы данных на поставщике данных Amazon Redshift.

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

Предоставляет информацию, определяющую поставщика данных PostgreSQL.

ServerName -> (строка)

Имя сервера PostgreSQL.

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

Значение порта для поставщика данных PostgreSQL.

DatabaseName -> (строка)

Имя базы данных на поставщике данных PostgreSQL.

SslMode -> (строка)

Режим SSL, используемый для подключения к поставщику данных PostgreSQL. Значение по умолчанию — none.

CertificateArn -> (строка)

Amazon Resource Name (ARN) сертификата, используемого для SSL-соединения.

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

Предоставляет информацию, определяющую поставщика данных MySQL.

ServerName -> (строка)

Имя сервера MySQL.

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

Значение порта для поставщика данных MySQL.

SslMode -> (строка)

Режим SSL, используемый для подключения к поставщику данных MySQL. Значение по умолчанию — none.

CertificateArn -> (строка)

Amazon Resource Name (ARN) сертификата, используемого для SSL-соединения.

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

Предоставляет информацию, определяющую поставщика данных Oracle.

ServerName -> (строка)

Имя сервера Oracle.

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

Значение порта для поставщика данных Oracle.

DatabaseName -> (строка)

Имя базы данных на поставщике данных Oracle.

SslMode -> (строка)

Режим SSL, используемый для подключения к поставщику данных Oracle. Значение по умолчанию — none.

CertificateArn -> (строка)

Amazon Resource Name (ARN) сертификата, используемого для SSL-соединения.

AsmServer -> (строка)

Адрес сервера Oracle Automatic Storage Management (ASM). Вы можете задать это значение из asm_server. Вы устанавливаете asm_server в качестве части дополнительной строки атрибута подключения для доступа к серверу Oracle с Binary Reader, использующему ASM. Для получения дополнительной информации см. Конфигурация для изменения данных (CDC) на базе данных Oracle.

SecretsManagerOracleAsmSecretId -> (строка)

Идентификатор секрета в Secrets Manager, содержащего данные подключения Oracle ASM.

Требуется только если ваш поставщик данных использует сервер Oracle ASM.

SecretsManagerOracleAsmAccessRoleArn -> (строка)

ARN роли IAM, предоставляющей доступ к секрету в Secrets Manager, содержащему данные подключения Oracle ASM.

SecretsManagerSecurityDbEncryptionSecretId -> (строка)

Идентификатор секрета в Secrets Manager, содержащего пароль прозрачного шифрования данных (TDE). DMS требует этого пароля для доступа к логам Oracle redo, зашифрованным с помощью TDE с использованием Binary Reader.

SecretsManagerSecurityDbEncryptionAccessRoleArn -> (строка)

ARN роли IAM, предоставляющей доступ к секрету в Secrets Manager, содержащему пароль TDE.

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

Предоставляет информацию, определяющую поставщика данных Microsoft SQL Server.

ServerName -> (строка)

Имя сервера Microsoft SQL Server.

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

Значение порта для поставщика данных Microsoft SQL Server.

DatabaseName -> (строка)

Имя базы данных на поставщике данных Microsoft SQL Server.

SslMode -> (строка)

Режим SSL, используемый для подключения к поставщику данных Microsoft SQL Server. Значение по умолчанию — none.

CertificateArn -> (строка)

Amazon Resource Name (ARN) сертификата, используемого для SSL-соединения.

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

Предоставляет информацию, определяющую поставщика данных DocumentDB.

ServerName -> (строка)

Имя сервера источника DocumentDB.

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

Значение порта для поставщика данных DocumentDB.

DatabaseName -> (строка)

Имя базы данных на поставщике данных DocumentDB.

SslMode -> (строка)

Режим SSL, используемый для подключения к поставщику данных DocumentDB. Значение по умолчанию — none.

CertificateArn -> (строка)

Amazon Resource Name (ARN) сертификата, используемого для SSL-соединения.

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

Предоставляет информацию, определяющую поставщика данных MariaDB.

ServerName -> (строка)

Имя сервера MariaDB.

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

Значение порта для поставщика данных MariaDB.

SslMode -> (строка)

Режим SSL, используемый для подключения к поставщику данных MariaDB. Значение по умолчанию — none.

CertificateArn -> (строка)

Amazon Resource Name (ARN) сертификата, используемого для SSL-соединения.

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

Предоставляет информацию, определяющую поставщика данных IBM DB2 LUW.

ServerName -> (строка)

Имя сервера DB2 LUW.

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

Значение порта для поставщика данных DB2 LUW.

DatabaseName -> (строка)

Имя базы данных на поставщике данных DB2 LUW.

SslMode -> (строка)

Режим SSL, используемый для подключения к поставщику данных DB2 LUW. Значение по умолчанию — none. Допустимые значения: none и verify-ca.

CertificateArn -> (строка)

Amazon Resource Name (ARN) сертификата, используемого для SSL-соединения.

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

Предоставляет информацию, определяющую поставщика данных IBM DB2 for z/OS.

ServerName -> (строка)

Имя сервера DB2 for z/OS.

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

Значение порта для поставщика данных DB2 for z/OS.

DatabaseName -> (строка)

Имя базы данных на поставщике данных DB2 for z/OS.

SslMode -> (строка)

Режим SSL, используемый для подключения к поставщику данных DB2 for z/OS. Значение по умолчанию — none. Допустимые значения: none и verify-ca.

CertificateArn -> (строка)

Amazon Resource Name (ARN) сертификата, используемого для SSL-соединения.

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

Предоставляет информацию, определяющую поставщика данных MongoDB.

ServerName -> (строка)

Имя сервера MongoDB.

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

Значение порта для поставщика данных MongoDB.

DatabaseName -> (строка)

Имя базы данных на поставщике данных MongoDB.

SslMode -> (строка)

Режим SSL, используемый для подключения к поставщику данных MongoDB. Значение по умолчанию — none.

CertificateArn -> (строка)

Amazon Resource Name (ARN) сертификата, используемого для SSL-соединения.

AuthType -> (строка)

Тип аутентификации для подключения к базе данных. Допустимые значения: PASSWORD или NO.

AuthSource -> (строка)

Имя базы данных MongoDB. Эта настройка не используется, когда AuthType задано как "no".

Значение по умолчанию — "admin".

AuthMechanism -> (строка)

Метод аутентификации для подключения к поставщику данных. Допустимые значения: DEFAULT, MONGODB_CR или SCRAM_SHA_1.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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