Spec-Zone.ru › AWS CLI v2

[ aws . inspector2 ]

create-sbom-export

Описание

Создаёт отчёт о материальных компонентах программного обеспечения (SBOM).

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

Синтаксис

  create-sbom-export
--report-format <value>
[--resource-filter-criteria <value>]
--s3-destination <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]

Параметры

--report-format (строка)

Формат вывода отчёта о материальных компонентах программного обеспечения (SBOM).

Возможные значения:

  • CYCLONEDX_1_4
  • SPDX_2_3

--resource-filter-criteria (структура)

Критерии фильтрации ресурсов для отчёта о материальных компонентах программного обеспечения (SBOM).

accountId -> (список)

Идентификаторы учётных записей, используемые в качестве критериев фильтрации ресурсов.

(структура)

Фильтр ресурсов для отчёта о материальных компонентах программного обеспечения.

comparison -> (строка)

Оператор сравнения фильтра.

value -> (строка)

Значение фильтра.

ec2InstanceTags -> (список)

Теги экземпляров EC2, используемые в качестве критериев фильтрации ресурсов.

(структура)

Фильтр ресурсов в виде карты для отчёта о материальных компонентах программного обеспечения.

comparison -> (строка)

Оператор сравнения фильтра.

key -> (строка)

Ключ фильтра.

value -> (строка)

Значение фильтра.

ecrImageTags -> (список)

Теги изображений ECR, используемые в качестве критериев фильтрации ресурсов.

(структура)

Фильтр ресурсов в виде строки для отчёта о материальных компонентах программного обеспечения.

comparison -> (строка)

Оператор сравнения фильтра.

value -> (строка)

Значение фильтра.

ecrRepositoryName -> (список)

Имена репозиториев ECR, используемые в качестве критериев фильтрации ресурсов.

(структура)

Фильтр ресурсов в виде строки для отчёта о материальных компонентах программного обеспечения.

comparison -> (строка)

Оператор сравнения фильтра.

value -> (строка)

Значение фильтра.

lambdaFunctionName -> (список)

Имя функции Amazon Web Services Lambda, используемое в качестве критериев фильтрации ресурсов.

(структура)

Фильтр ресурсов в виде строки для отчёта о материальных компонентах программного обеспечения.

comparison -> (строка)

Оператор сравнения фильтра.

value -> (строка)

Значение фильтра.

lambdaFunctionTags -> (список)

Теги функций Amazon Web Services Lambda, используемые в качестве критериев фильтрации ресурсов.

(структура)

Фильтр ресурсов в виде карты для отчёта о материальных компонентах программного обеспечения.

comparison -> (строка)

Оператор сравнения фильтра.

key -> (строка)

Ключ фильтра.

value -> (строка)

Значение фильтра.

resourceId -> (список)

Идентификаторы ресурсов, используемые в качестве критериев фильтрации ресурсов.

(структура)

Фильтр ресурсов в виде строки для отчёта о материальных компонентах программного обеспечения.

comparison -> (строка)

Оператор сравнения фильтра.

value -> (строка)

Значение фильтра.

resourceType -> (список)

Типы ресурсов, используемые в качестве критериев фильтрации ресурсов.

(структура)

Фильтр ресурсов в виде строки для отчёта о материальных компонентах программного обеспечения.

comparison -> (строка)

Оператор сравнения фильтра.

value -> (строка)

Значение фильтра.

Синтаксис сокращённого ввода:

accountId=[{comparison=string,value=string},{comparison=string,value=string}],ec2InstanceTags=[{comparison=string,key=string,value=string},{comparison=string,key=string,value=string}],ecrImageTags=[{comparison=string,value=string},{comparison=string,value=string}],ecrRepositoryName=[{comparison=string,value=string},{comparison=string,value=string}],lambdaFunctionName=[{comparison=string,value=string},{comparison=string,value=string}],lambdaFunctionTags=[{comparison=string,key=string,value=string},{comparison=string,key=string,value=string}],resourceId=[{comparison=string,value=string},{comparison=string,value=string}],resourceType=[{comparison=string,value=string},{comparison=string,value=string}]

Синтаксис JSON:

{
  "accountId": [
    {
      "comparison": "EQUALS"|"NOT_EQUALS",
      "value": "string"
    }
    ...
  ],
  "ec2InstanceTags": [
    {
      "comparison": "EQUALS",
      "key": "string",
      "value": "string"
    }
    ...
  ],
  "ecrImageTags": [
    {
      "comparison": "EQUALS"|"NOT_EQUALS",
      "value": "string"
    }
    ...
  ],
  "ecrRepositoryName": [
    {
      "comparison": "EQUALS"|"NOT_EQUALS",
      "value": "string"
    }
    ...
  ],
  "lambdaFunctionName": [
    {
      "comparison": "EQUALS"|"NOT_EQUALS",
      "value": "string"
    }
    ...
  ],
  "lambdaFunctionTags": [
    {
      "comparison": "EQUALS",
      "key": "string",
      "value": "string"
    }
    ...
  ],
  "resourceId": [
    {
      "comparison": "EQUALS"|"NOT_EQUALS",
      "value": "string"
    }
    ...
  ],
  "resourceType": [
    {
      "comparison": "EQUALS"|"NOT_EQUALS",
      "value": "string"
    }
    ...
  ]
}

--s3-destination (структура)

Содержит подробности о ведре Amazon S3 и ключе KMS, используемых для экспорта результатов.

bucketName -> (строка)

Имя ведра Amazon S3 для экспорта результатов.

keyPrefix -> (строка)

Префикс, под которым будут записаны результаты.

kmsKeyArn -> (строка)

ARN ключа KMS, используемого для шифрования данных при экспорте результатов.

Синтаксис сокращённого ввода:

bucketName=string,keyPrefix=string,kmsKeyArn=string

Синтаксис JSON:

{
  "bucketName": "string",
  "keyPrefix": "string",
  "kmsKeyArn": "string"
}

--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
  • 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-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

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

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

Для создания отчёта о материальных компонентах программного обеспечения (SBOM)

Следующий create-sbom-export пример создаёт отчёт о материальных компонентах программного обеспечения (SBOM).

aws inspector2 create-sbom-export \
    --report-format SPDX_2_3 \
    --resource-filter-criteria 'ecrRepositoryName=[{comparison="EQUALS",value="debian"}]' \
    --s3-destination bucketName=inspector-sbom-123456789012,keyPrefix=sbom-key,kmsKeyArn=arn:aws:kms:us-west-2:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333

Вывод:

{
    "reportId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333"
}

Для получения дополнительной информации см. Экспорт SBOM с Amazon Inspector в Руководстве пользователя Amazon Inspector.

Вывод

reportId -> (строка)

Идентификатор отчёта о материальных компонентах программного обеспечения (SBOM).

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

Spec-Zone.ru

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