Spec-Zone.ru › AWS CLI v2

[ aws . dms ]

describe-data-migrations

Описание

Возвращает информацию о миграциях данных.

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

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

Синтаксис

  describe-data-migrations
[--filters <value>]
[--without-settings | --no-without-settings]
[--without-statistics | --no-without-statistics]
[--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]

Параметры

--filters (список)

Фильтры, применяемые к миграциям данных.

(структура)

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

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

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

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

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

(строка)

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

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

Синтаксис JSON:

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

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

Параметр, устанавливаемый для предотвращения возврата информации о настройках. Используйте его для снижения нагрузки, когда информация о настройках слишком велика. Для использования этого параметра выберите true; в противном случае выберите false (по умолчанию).

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

Параметр, устанавливаемый для предотвращения возврата информации о статистике. Используйте его для снижения нагрузки, когда статистическая информация слишком велика. Для использования этого параметра выберите true; в противном случае выберите false (по умолчанию).

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

Вывод

DataMigrations -> (список)

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

(структура)

Этот объект предоставляет информацию о миграции данных DMS.

DataMigrationName -> (строка)

Наименование миграции данных для удобства пользователя.

DataMigrationArn -> (строка)

Amazon Resource Name (ARN), идентифицирующий данную репликацию.

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

Время UTC, когда DMS создал миграцию данных.

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

Время UTC, когда DMS начал миграцию данных.

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

Время UTC, когда миграция данных завершилась.

ServiceAccessRoleArn -> (строка)

IAM-роль, которую миграция данных использует для доступа к ресурсам Amazon Web Services.

MigrationProjectArn -> (строка)

Amazon Resource Name (ARN) связанного с миграцией проекта.

DataMigrationType -> (строка)

Указывает, является ли миграция данных только полной загрузкой, только захватом изменений (CDC), или полной загрузкой и захватом изменений.

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

Определяет параметры CloudWatch и правила выбора для миграции данных.

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

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

CloudwatchLogsEnabled -> (булево значение)

Включить или выключить логирование CloudWatch для миграции данных.

SelectionRules -> (строка)

Строка в формате JSON, определяющая, какие объекты включать и исключать из миграции.

SourceDataSettings -> (список)

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

(структура)

Определяет параметры поставщика исходных данных для миграции данных.

CDCStartPosition -> (строка)

Начальная позиция захвата изменений (CDC) для поставщика исходных данных.

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

Время начала захвата изменений (CDC) для поставщика исходных данных.

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

Время окончания захвата изменений (CDC) для поставщика исходных данных.

SlotName -> (строка)

Имя слота репликации на поставщике исходных данных. Этот атрибут действителен только для источника PostgreSQL или Aurora PostgreSQL.

TargetDataSettings -> (список)

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

(структура)

Определяет параметры целевого поставщика данных для миграции данных.

TablePreparationMode -> (строка)

Этот параметр определяет, как DMS обращается с целевыми таблицами перед началом миграции данных: не трогать, удалить и воссоздать или обнулить существующие данные в целевых таблицах.

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

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

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

Количество загруженных таблиц во время текущего выполнения миграции данных.

ElapsedTimeMillis -> (длинное целое число)

Прошедшее время выполнения миграции данных.

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

Прогресс загрузки таблиц в миграции данных.

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

Прогресс миграции в фазе полной загрузки.

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

Текущая задержка операции захвата изменений (CDC).

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

Количество таблиц, ожидающих обработки.

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

Количество таблиц, которые DMS не смог обработать.

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

Время начала миграции.

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

Время остановки или завершения миграции с ошибкой.

DataMigrationStatus -> (строка)

Текущий статус миграции данных.

PublicIpAddresses -> (список)

IP-адреса конечных точек для миграции данных.

(строка)

DataMigrationCidrBlocks -> (список)

CIDR-блоки конечных точек для миграции данных.

(строка)

LastFailureMessage -> (строка)

Информация о последней ошибке или сбою миграции данных.

StopReason -> (строка)

Причина последней остановки миграции данных.

Marker -> (строка)

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

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

Spec-Zone.ru

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