Spec-Zone.ru › AWS CLI v2

[ aws . resource-explorer-2 ]

создание-представления

Описание

Создаёт представление, которое пользователи могут запросить с помощью операции поиска. Результаты запросов, которые вы выполняете с помощью этого представления, включают только ресурсы, которые соответствуют Filters представления. Дополнительную информацию о представлениях Amazon Web Services Resource Explorer см. в руководстве пользователя Amazon Web Services Resource Explorer.

Только принципалы с политикой IAM на основе идентификатора пользователя, предоставляющей Allow для действия Search по Resource с ARN этого представления, могут выполнять поиск с помощью созданных вами представлений с помощью этой операции.

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

Синтаксис

  create-view
[--client-token <value>]
[--filters <value>]
[--included-properties <value>]
[--scope <value>]
[--tags <value>]
--view-name <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]

Параметры

--client-token (строка)

Это значение помогает обеспечить идемпотентность. Resource Explorer использует это значение для предотвращения случайного создания дублирующих версий. Рекомендуется генерировать значение типа UUID для обеспечения уникальности ваших представлений.

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

Массив строк, определяющий, какие ресурсы включаются в результаты запросов, выполненных с помощью этого представления. При использовании этого представления в операции поиска строка фильтра объединяется с параметром QueryString поиска с помощью логического оператора AND.

Дополнительную информацию о поддерживаемом синтаксисе см. в справочнике по запросам поиска для Resource Explorer в руководстве пользователя Amazon Web Services Resource Explorer.

Предупреждение

В контексте этой операции строка запроса поддерживает только префиксы фильтра с необязательными операторами. Она не поддерживает свободный текст. Например, строка region:us* service:ec2 -tag:stage=prod включает все ресурсы Amazon EC2 в любой Регион Amazon Web Services, начинающиеся с букв us и не помеченные ключом Stage со значением prod.

FilterString -> (строка)

Строка, содержащая ключевые слова поиска, префиксы и операторы для управления результатами, которые может вернуть операция поиска. Дополнительные сведения см. в синтаксисе запросов поиска.

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

FilterString=string

Синтаксис JSON:

{
  "FilterString": "string"
}

--included-properties (список)

Указывает необязательные поля, которые вы хотите включить в результаты поиска из этого представления. Это список объектов, каждый из которых описывает поле для включения.

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

(структура)

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

Name -> (строка)

Имя свойства, включённого в это представление.

Вы можете указать следующие имена свойств для этого поля:

  • tags

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

Name=string ...

Синтаксис JSON:

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

--scope (строка)

Корневой ARN учётной записи, организационной единицы (OU) или организации ARN. Если поле пустое, по умолчанию используется учётная запись.

--tags (карта)

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

key -> (строка)

value -> (строка)

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--view-name (строка)

Имя нового представления. Это имя отображается в списке представлений в Resource Explorer.

Имя должно содержать не более 64 символов и может включать буквы, цифры и символ дефиса (-). Имя должно быть уникальным в своей области Amazon Web Services.

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

--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 версии 1, а двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое отображается в двоичный блок, 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.

Пример 1: Создание нефильтрованного представления для индекса в области AWS

Следующий пример создаёт представление в указанной области AWS, которое возвращает все результаты в области без каких-либо фильтров. Представление включает необязательное поле тегов в возвращаемых результатах. Поскольку это представление создаётся в области, содержащей индекс агрегатора, оно может включать результаты из всех областей в учётной записи, содержащих индекс Resource Explorer.

aws resource-explorer-2 create-view \
    --view-name My-Main-View \
    --included-properties Name=tags \
    --region us-east-1

Вывод:

{
    "View": {
        "Filters": {
            "FilterString": ""
        },
        "IncludedProperties": [
            {
                "Name": "tags"
            }
        ],
        "LastUpdatedAt": "2022-07-13T20:34:11.314000+00:00",
        "Owner": "123456789012",
        "Scope": "arn:aws:iam::123456789012:root",
        "ViewArn": "arn:aws:resource-explorer-2:us-east-1:123456789012:view/My-Main-View/EXAMPLE8-90ab-cdef-fedc-EXAMPLE11111"
    }
}

Пример 2: Создание представления, возвращающего только ресурсы, связанные с Amazon EC2

Следующий пример создаёт представление в области AWS us-east-1, которое возвращает только те ресурсы в области, которые связаны с сервисом Amazon EC2. Представление включает необязательное поле Tags в возвращаемых результатах. Поскольку это представление создаётся в области, содержащей индекс агрегатора, оно может включать результаты из всех областей в учётной записи, содержащих индекс Resource Explorer.

aws resource-explorer-2 create-view \
    --view-name My-EC2-Only-View \
    --included-properties Name=tags \
    --filters FilterString="service:ec2" \
    --region us-east-1

Вывод:

{
    "View": {
        "Filters": {
            "FilterString": "service:ec2"
        },
        "IncludedProperties": [
            {
                "Name":"tags"
            }
        ],
        "LastUpdatedAt": "2022-07-13T21:35:09.059Z",
        "Owner": "123456789012",
        "Scope": "arn:aws:iam::123456789012:root",
        "ViewArn": "arn:aws:resource-explorer-2:us-east-1:123456789012:view/My-EC2-Only-View/EXAMPLE8-90ab-cdef-fedc-EXAMPLE22222"
    }
}

Дополнительную информацию см. в разделе Создание представлений для поиска в руководстве пользователя AWS Resource Explorer.

Вывод

Вид -> (структура)

Структура, содержащая подробности о новом виде.

Фильтры -> (структура)

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

Строка фильтра -> (строка)

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

Включенные свойства -> (список)

Структура, содержащая дополнительную информацию о виде.

(структура)

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

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

Имя свойства, включенного в этот вид.

Можно указать следующие имена свойств для этого поля:

  • tags

Последнее обновление -> (метка времени)

Дата и время последнего изменения этого вида.

Владелец -> (строка)

Учетная запись Amazon Web Services, являющаяся владельцем этого вида.

Область -> (строка)

Идентификатор ресурса Amazon (ARN) учетной записи Amazon Web Services, организации или организационной единицы (OU), который определяет, включает ли этот вид ресурсы только из указанной учетной записи Amazon Web Services, все учетные записи в указанной организации или все учетные записи в указанной OU.

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

ARN вида -> (строка)

Идентификатор ресурса Amazon (ARN) вида.

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

Spec-Zone.ru

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