Spec-Zone.ru › AWS CLI v2

[ aws . servicecatalog ]

search-provisioned-products

Описание

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

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

Синтаксис

  search-provisioned-products
[--accept-language <value>]
[--access-level-filter <value>]
[--filters <value>]
[--sort-by <value>]
[--sort-order <value>]
[--page-size <value>]
[--page-token <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]

Параметры

--accept-language (строка)

Код языка.

  • jp - Японский
  • zh - Китайский

--access-level-filter (структура)

Уровень доступа для получения результатов. По умолчанию - Account.

Ключ -> (строка)

Уровень доступа.

  • Account - Фильтрует результаты на основе учетной записи.
  • Role - Фильтрует результаты на основе федеральной роли указанного пользователя.
  • User - Фильтрует результаты на основе указанного пользователя.

Значение -> (строка)

Пользователь, к которому относится уровень доступа. Поддерживается только значение self.

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

Key=string,Value=string

Синтаксис JSON:

{
  "Key": "Account"|"Role"|"User",
  "Value": "string"
}

--filters (массив)

Фильтр поиска.

Когда ключ равен SearchQuery , разрешенные поля для поиска - arn , createdTime , id , lastRecordId , idempotencyToken , name , physicalId , productId , provisioningArtifactId , type , status , tags , userArn , userArnSession , lastProvisioningRecordId , lastSuccessfulProvisioningRecordId , productName и provisioningArtifactName.

Пример: "SearchQuery":["status:AVAILABLE"]

ключ -> (строка)

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

(строка)

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

  KeyName1=string,string,KeyName2=string,string

Where valid key names are:
  SearchQuery

Синтаксис JSON:

{"SearchQuery": ["string", ...]
  ...}

--sort-by (строка)

Поле сортировки. Если значение не указано, результаты не сортируются. Допустимые значения - arn , id , name и lastRecordId.

--sort-order (строка)

Порядок сортировки. Если значение не указано, результаты не сортируются.

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

  • ASCENDING
  • DESCENDING

--page-size (целое число)

Максимальное количество элементов, возвращаемых в этом вызове.

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

Токен страницы для следующего набора результатов. Для получения первого набора результатов используйте null.

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

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

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

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

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

Примеры

Примечание

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

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

Для поиска предоставленных продуктов

Следующий search-provisioned-products пример ищет предоставленные продукты, соответствующие указанному идентификатору продукта, используя файл JSON для передачи параметров.

aws servicecatalog search-provisioned-products \
    --cli-input-json file://search-provisioned-products-input.json

Содержимое search-provisioned-products-input.json:

{
    "Filters": {
        "SearchQuery": [
            "prod-tcjvfz3syn2rg"
        ]
    }
}

Вывод:

{
    "ProvisionedProducts": [
        {
            "ProvisioningArtifactId": "pa-pcz347abcdcfm",
            "Name": "mytestppname3",
            "CreatedTime": 1577222793.358,
            "Id": "pp-abcd27bm4mldq",
            "Status": "ERROR",
            "UserArn": "arn:aws:iam::123456789012:user/cliuser",
            "StatusMessage": "AmazonCloudFormationException  Parameters: [KeyName] must have values (Service: AmazonCloudFormation; Status Code: 400; Error Code: ValidationError; Request ID: 5528602a-a9ef-427c-825c-f82c31b814f5)",
            "Arn": "arn:aws:servicecatalog:us-west-2:123456789012:stack/mytestppname3/pp-abcd27bm4mldq",
            "Tags": [
                {
                    "Value": "arn:aws:catalog:us-west-2:123456789012:product/prod-abcdfz3syn2rg",
                    "Key": "aws:servicecatalog:productArn"
                },
                {
                    "Value": "arn:aws:iam::123456789012:user/cliuser",
                    "Key": "aws:servicecatalog:provisioningPrincipalArn"
                },
                {
                    "Value": "value-3",
                    "Key": "1234"
                },
                {
                    "Value": "pa-pcz347abcdcfm",
                    "Key": "aws:servicecatalog:provisioningArtifactIdentifier"
                },
                {
                    "Value": "arn:aws:catalog:us-west-2:123456789012:portfolio/port-2s6abcdq5wdh4",
                    "Key": "aws:servicecatalog:portfolioArn"
                },
                {
                    "Value": "arn:aws:servicecatalog:us-west-2:123456789012:stack/mytestppname3/pp-abcd27bm4mldq",
                    "Key": "aws:servicecatalog:provisionedProductArn"
                }
            ],
            "IdempotencyToken": "527c5358-2a1a-4b9e-b1b9-7293b0ddff42",
            "UserArnSession": "arn:aws:iam::123456789012:user/cliuser",
            "Type": "CFN_STACK",
            "LastRecordId": "rec-tfuawdabcdxge",
            "ProductId": "prod-abcdfz3syn2rg"
        }
    ],
    "TotalResultsCount": 1
}

Вывод

ProvisionedProducts -> (список)

Информация о зарезервированных продуктах.

(структура)

Информация о зарезервированном продукте.

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

Пользовательское имя зарезервированного продукта.

Arn -> (строка)

ARN зарезервированного продукта.

Тип -> (строка)

Тип зарезервированного продукта. Поддерживаемые значения — CFN_STACK, CFN_STACKSET, TERRAFORM_OPEN_SOURCE, TERRAFORM_CLOUD и EXTERNAL.

Id -> (строка)

Идентификатор зарезервированного продукта.

Статус -> (строка)

Текущий статус зарезервированного продукта.

  • AVAILABLE — Стабильное состояние, готовое к выполнению любой операции. Последняя операция завершилась успешно.
  • UNDER_CHANGE — Переходное состояние. Выполненные операции могут не иметь корректных результатов. Дождитесь статуса AVAILABLE перед выполнением операций.
  • TAINTED — Стабильное состояние, готовое к выполнению любой операции. Стек завершил запрошенную операцию, но результат отличается от запрошенного. Например, запрос на обновление до новой версии завершился неудачно, и стек вернулся к текущей версии.
  • ERROR — Возникла непредвиденная ошибка. Зарезервированный продукт существует, но стек не работает. Например, CloudFormation получил некорректное значение параметра и не смог запустить стек.
  • PLAN_IN_PROGRESS — Переходное состояние. Операции плана были выполнены для резервации нового продукта, но ресурсы ещё не созданы. После проверки списка ресурсов, подлежащих созданию, выполните план. Дождитесь статуса AVAILABLE перед выполнением операций.

StatusMessage -> (строка)

Текущее сообщение о статусе зарезервированного продукта.

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

Временная метка UTC времени создания.

IdempotencyToken -> (строка)

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

LastRecordId -> (строка)

Идентификатор записи последнего запроса, выполненного для этого зарезервированного продукта.

LastProvisioningRecordId -> (строка)

Идентификатор записи последнего запроса, выполненного для этого зарезервированного продукта следующих типов:

  • ProvisionProduct
  • UpdateProvisionedProduct
  • ExecuteProvisionedProductPlan
  • TerminateProvisionedProduct

LastSuccessfulProvisioningRecordId -> (строка)

Идентификатор записи последнего успешного запроса, выполненного для этого зарезервированного продукта следующих типов:

  • ProvisionProduct
  • UpdateProvisionedProduct
  • ExecuteProvisionedProductPlan
  • TerminateProvisionedProduct

Tags -> (список)

Один или несколько тегов.

(структура)

Информация о теге. Тег — это пара "ключ-значение". Теги распространяются на ресурсы, созданные при резервации продукта.

Ключ -> (строка)

Ключ тега.

Значение -> (строка)

Значение для данного ключа.

PhysicalId -> (строка)

Назначенный идентификатор для ресурса, например, ID экземпляра EC2 или имя ведра S3.

ProductId -> (строка)

Идентификатор продукта.

ProductName -> (строка)

Название продукта.

ProvisioningArtifactId -> (строка)

Идентификатор артефакта резервации.

ProvisioningArtifactName -> (строка)

Название артефакта резервации.

UserArn -> (строка)

Amazon Resource Name (ARN) пользователя.

UserArnSession -> (строка)

ARN пользователя в сессии. Этот ARN может содержать идентификатор сессии.

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

Количество найденных зарезервированных продуктов.

NextPageToken -> (строка)

Токен страницы для получения следующего набора результатов. Если дополнительных результатов нет, это значение равно null.

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

Spec-Zone.ru

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