Spec-Zone.ru › AWS CLI v2

[ aws . ssm ]

list-resource-data-sync

Описание

Отображает конфигурации синхронизации данных ресурсов. Включает информацию о последней попытке запуска синхронизации, последнем статусе синхронизации и последнем успешном завершении синхронизации.

Количество конфигураций синхронизации может быть слишком велико для возврата в одном вызове к ListResourceDataSync. Вы можете ограничить количество возвращаемых конфигураций синхронизации, используя параметр MaxResults. Чтобы определить, есть ли больше конфигураций синхронизации для отображения, проверьте значение NextToken в выводе. Если есть больше конфигураций синхронизации, вы можете запросить их, указав значение NextToken, возвращённое в вызове параметра последующего вызова.

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

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

Синтаксис

  list-resource-data-sync
[--sync-type <value>]
[--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]

Параметры

--sync-type (строка)

Просмотр списка синхронизаций данных ресурсов в соответствии с типом синхронизации. Укажите SyncToDestination, чтобы просмотреть синхронизации данных ресурсов, синхронизирующих данные с ведром Amazon S3. Укажите SyncFromSource, чтобы просмотреть синхронизации данных ресурсов из Организаций или из нескольких областей Amazon Web Services.

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

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

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запросы параметров ввода CLI.

Примеры

Примечание

Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве «Начало работы» в Руководстве пользователя AWS CLI.

Если не указано иное, во всех примерах используются правила цитирования, характерные для Unix-систем. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной оболочки. См. раздел «Использование кавычек со строками» в Руководстве пользователя AWS CLI.

Чтобы отобразить конфигурации синхронизации данных ресурсов

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

aws ssm list-resource-data-sync

Вывод:

{
    "ResourceDataSyncItems": [
        {
            "SyncName": "MyResourceDataSync",
            "S3Destination": {
                "BucketName": "ssm-resource-data-sync",
                "SyncFormat": "JsonSerDe",
                "Region": "us-east-1"
            },
            "LastSyncTime": 1550261472.003,
            "LastSuccessfulSyncTime": 1550261472.003,
            "LastStatus": "Successful",
            "SyncCreatedTime": 1543235736.72,
            "LastSyncStatusMessage": "The sync was successfully completed"
        }
    ]
}

Вывод

ResourceDataSyncItems -> (список)

Список ваших текущих конфигураций синхронизации данных ресурсов и их статусов.

(структура)

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

SyncName -> (строка)

Имя синхронизации данных ресурсов.

SyncType -> (строка)

Тип синхронизации данных ресурсов. Если SyncType равен SyncToDestination, то синхронизация данных ресурсов копирует данные в ведро S3. Если SyncType равен SyncFromSource, то синхронизация данных ресурсов копирует данные из организаций или из нескольких регионов Amazon Web Services.

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

Информация о источнике, из которого данные были синхронизированы.

SourceType -> (строка)

Тип источника данных для синхронизации данных ресурсов. SourceType это либо AwsOrganizations (если организация присутствует в Организациях) или singleAccountMultiRegions.

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

Имя поля в SyncSource для типа ResourceDataSyncAwsOrganizationsSource.

OrganizationSourceType -> (строка)

Если присутствует организация Amazon Web Services, это либо OrganizationalUnits, или EntireOrganization. Для OrganizationalUnits данные агрегируются из набора организационных единиц. Для EntireOrganization данные агрегируются из всей организации Amazon Web Services.

OrganizationalUnits -> (список)

Включаемые организационные единицы Организаций в синхронизации.

(структура)

Источник данных организационной единицы Организаций для синхронизации.

OrganizationalUnitId -> (строка)

Идентификатор организационной единицы Организаций в качестве источника данных для синхронизации.

SourceRegions -> (список)

Включаемые SyncSource регионы Amazon Web Services в синхронизации данных ресурсов.

(строка)

IncludeFutureRegions -> (булево)

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

State -> (строка)

Имя типа данных для включения состояния синхронизации данных ресурсов. Существует четыре состояния синхронизации:

OrganizationNotExists : Ваша организация не существует.

NoPermissions : Система не может найти роль, связанную с сервисом. Эта роль автоматически создается, когда пользователь создает синхронизацию данных ресурсов в Explorer.

InvalidOrganizationalUnit : Вы указали или выбрали неверную единицу в конфигурации синхронизации данных ресурсов.

TrustedAccessDisabled : Вы отключили доступ к Systems Manager в организации в Организациях.

EnableAllOpsDataSources -> (булево)

При создании синхронизации данных ресурсов, если вы выбрали один из вариантов Организаций, то Systems Manager автоматически включает все источники OpsData в выбранных регионах Amazon Web Services для всех учетных записей Amazon Web Services в вашей организации (или в выбранных организационных единицах). Дополнительную информацию см. в разделе Настройка Systems Manager Explorer для отображения данных из нескольких учетных записей и регионов в Руководстве пользователя Amazon Web Services Systems Manager.

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

Конфигурационная информация для целевого ведра S3.

BucketName -> (строка)

Имя ведра S3, в котором хранятся агрегированные данные.

Prefix -> (строка)

Префикс Amazon S3 для ведра.

SyncFormat -> (строка)

Поддерживаемый формат синхронизации. В настоящее время поддерживается только формат JsonSerDe.

Region -> (строка)

Регион Amazon Web Services с целевым ведром S3, на который нацелена синхронизация данных ресурсов.

AWSKMSKeyARN -> (строка)

ARN ключа шифрования для назначения в Amazon S3. Должен принадлежать тому же региону, что и целевое ведро S3.

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

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

DestinationDataSharingType -> (строка)

Тип данных совместного использования. Поддерживается только Organization.

LastSyncTime -> (временная метка)

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

LastSuccessfulSyncTime -> (временная метка)

Последнее время, когда операции синхронизации вернули статус SUCCESSFUL (UTC).

SyncLastModifiedTime -> (временная метка)

Дата и время изменения синхронизации данных ресурсов.

LastStatus -> (строка)

Статус, сообщенный последней синхронизацией.

SyncCreatedTime -> (временная метка)

Дата и время создания конфигурации (UTC).

LastSyncStatusMessage -> (строка)

Подробное сообщение о состоянии, сообщенное последней синхронизацией.

NextToken -> (строка)

Токен для следующего набора элементов для возврата. Используйте этот токен для получения следующего набора результатов.

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

Spec-Zone.ru

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