[ aws . configservice ]
описание-агрегаторов-конфигураций
Описание
Возвращает подробную информацию об одном или нескольких агрегаторах конфигураций. Если агрегатор конфигураций не указан, данная операция возвращает подробности обо всех агрегаторах конфигураций, связанных со счетом.
См. также: Документацию API AWS
describe-configuration-aggregators является постраничной операцией. Для получения всего набора результатов может потребоваться несколько вызовов API. Вы можете отключить постраничную обработку, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной обработкой аргумент --query должен извлекать данные из результатов следующих выражений запроса: ConfigurationAggregators
Синтаксис
describe-configuration-aggregators
[--configuration-aggregator-names <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]
Параметры
--configuration-aggregator-names (список)
Имя агрегаторов конфигураций.
(строка)
Синтаксис:
"string" "string" ...
--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределяют значения, полученные из JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет интерпретироваться буквально. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Токен для указания места начала постраничной обработки. Это NextToken из ранее усеченного ответа.
Примеры использования см. в разделе Постраничная обработка в руководстве пользователя AWS CLI.
--page-size (целое число)
Размер каждой страницы для вызова службы AWS. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов службы AWS, при этом в каждом вызове извлекается меньше элементов. Это может помочь предотвратить истечение времени ожидания вызовов службы AWS.
Примеры использования см. в разделе Постраничная обработка в руководстве пользователя AWS CLI.
--max-items (целое число)
Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничной обработки укажите значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе Постраничная обработка в руководстве пользователя AWS CLI.
--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.
Вывод
ConfigurationAggregators -> (список)
Возвращает объект ConfigurationAggregators.
(структура)
Подробная информация об агрегаторе конфигурации, включая информацию о исходных учетных записях, регионах и метаданных агрегатора.
ConfigurationAggregatorName -> (строка)
ConfigurationAggregatorArn -> (строка)
AccountAggregationSources -> (список)
Предоставляет список исходных учетных записей и регионов для агрегирования.
(структура)
Коллекция учетных записей и регионов.
AccountIds -> (список)
12-значный идентификатор учетной записи агрегируемой учетной записи.
(строка)
AllAwsRegions -> (логическое значение)
AwsRegions -> (список)
Агрегируемые исходные регионы.
(строка)
OrganizationAggregationSource -> (структура)
Предоставляет организацию и список регионов для агрегирования.
RoleArn -> (строка)
AwsRegions -> (список)
Агрегируемые исходные регионы.
(строка)
AllAwsRegions -> (логическое значение)
CreationTime -> (временная метка)
LastUpdatedTime -> (временная метка)
CreatedBy -> (строка)
AggregatorFilters -> (структура)
Объект для фильтрации данных, которые вы указали для агрегатора.
ResourceType -> (структура)
Объект для фильтрации записей регистрирующих конфигураций на основе типов ресурсов, включенных в объем регистрации.
Type -> (строка)
INCLUDE указывает, что список типов ресурсов в поле Value будет агрегирован, и другие типы ресурсов не будут отфильтрованы.Value -> (список)
Список типов ресурсов через запятую для фильтрации агрегированных записей регистрирующих конфигураций.
(строка)
ServicePrincipal -> (структура)
Объект для фильтрации записей службы связанных записей регистрирующих конфигураций в агрегаторе на основе связанной службы Amazon Web Services.
Type -> (строка)
INCLUDE указывает, что список принципов служб в поле Value будет агрегирован, и другие принципы служб не будут отфильтрованы.Value -> (список)
Список принципов служб через запятую для связанных служб Amazon Web Services для фильтрации агрегированных службами связанных записей регистрирующих конфигураций.
(строка)
NextToken -> (строка)
nextToken строка, возвращенная на предыдущей странице, которую вы используете для получения следующей страницы результатов в ответе с постраничной обработкой.
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|