Spec-Zone.ru › AWS CLI v2

[ aws . codepipeline ]

list-action-types

Описание

Получает сводку всех типов действий CodePipeline, связанных с вашей учетной записью.

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

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

Синтаксис

  list-action-types
[--action-owner-filter <value>]
[--region-filter <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <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]

Параметры

--action-owner-filter (строка)

Фильтрует список типов действий до тех, которые были созданы указанным субъектом.

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

  • AWS
  • ThirdParty
  • Custom

--region-filter (строка)

Регион для фильтрации списка типов действий.

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

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

Токен для указания, с чего начать постраничную загрузку. Это NextToken из ранее обрезанного ответа.

Примеры использования см. в разделе Постраничная загрузка в Руководстве пользователя 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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

JMESPath-запрос для фильтрации данных ответа.

--profile (строка)

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

--region (строка)

Использовать указанный регион. Переопределяет параметры конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/отключить цветной вывод.

  • on
  • off
  • auto

--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 для вывода.

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

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

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

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

Примеры

Примечание

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

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

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

Используемая сама по себе команда list-action-types возвращает структуру всех действий, доступных вашей учетной записи AWS. В этом примере используется параметр –action-owner-filter для возврата только пользовательских действий.

Команда:

aws codepipeline list-action-types --action-owner-filter Custom

Вывод:

{
  "actionTypes": [
      {
          "inputArtifactDetails": {
              "maximumCount": 5,
              "minimumCount": 0
          },
          "actionConfigurationProperties": [
              {
                  "secret": false,
                  "required": true,
                  "name": "MyJenkinsExampleBuildProject",
                  "key": true,
                  "queryable": true
              }
          ],
          "outputArtifactDetails": {
              "maximumCount": 5,
              "minimumCount": 0
          },
          "id": {
              "category": "Build",
              "owner": "Custom",
              "version": "1",
              "provider": "MyJenkinsProviderName"
          },
          "settings": {
              "entityUrlTemplate": "http://192.0.2.4/job/{Config:ProjectName}",
              "executionUrlTemplate": "http://192.0.2.4/job/{Config:ProjectName}/{ExternalExecutionId}"
          }
      },
      {
          "inputArtifactDetails": {
              "maximumCount": 5,
              "minimumCount": 0
          },
          "actionConfigurationProperties": [
              {
                  "secret": false,
                  "required": true,
                  "name": "MyJenkinsExampleTestProject",
                  "key": true,
                  "queryable": true
              }
          ],
          "outputArtifactDetails": {
              "maximumCount": 5,
              "minimumCount": 0
          },
          "id": {
              "category": "Test",
              "owner": "Custom",
              "version": "1",
              "provider": "MyJenkinsProviderName"
          },
          "settings": {
              "entityUrlTemplate": "http://192.0.2.4/job/{Config:ProjectName}",
              "executionUrlTemplate": "http://192.0.2.4/job/{Config:ProjectName}/{ExternalExecutionId}"
          }
      }
  ]
}

Вывод

actionTypes -> (список)

Предоставляет подробные сведения о типах действий.

(структура)

Возвращает информацию о деталях типа действия.

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

Представляет информацию о типе действия.

category -> (строка)

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

  • Источник
  • Создание
  • Тестирование
  • Развертывание
  • Вызов
  • Утверждение
  • Вычисление

owner -> (строка)

Создатель вызываемого действия. Для поля Owner в разделе категории действия в структуре вашей конвейерной линии доступны три допустимых значения: AWS , ThirdParty и Custom . Дополнительные сведения см. в разделе Действительные типы и поставщики действий в CodePipeline .

provider -> (строка)

Поставщик службы, вызываемой действием. Допустимые поставщики определяются категорией действия. Например, действие в категории развертывания может иметь поставщика CodeDeploy, который будет указан как CodeDeploy . Дополнительные сведения см. в разделе Действительные типы и поставщики действий в CodePipeline .

version -> (строка)

Строка, описывающая версию действия.

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

Настройки типа действия.

thirdPartyConfigurationUrl -> (строка)

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

entityUrlTemplate -> (строка)

URL, возвращаемый в консоль CodePipeline, предоставляющий ссылку на ресурсы внешней системы, например, страницу настроек группы развертывания CodeDeploy. Эта ссылка предоставляется в качестве части отображения действия в конвейере.

executionUrlTemplate -> (строка)

URL, возвращаемый в консоль CodePipeline, содержащий ссылку на главную страницу внешней системы, например, страницу консоли CodeDeploy. Эта ссылка отображается на странице представления конвейера в консоли CodePipeline и предоставляет ссылку на сущность выполнения внешнего действия.

revisionUrlTemplate -> (строка)

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

actionConfigurationProperties -> (список)

Свойства конфигурации типа действия.

(структура)

Представляет информацию о свойстве конфигурации действия.

name -> (строка)

Имя свойства конфигурации действия.

required -> (булево)

Является ли свойство конфигурации обязательным значением.

key -> (булево)

Является ли свойство конфигурации ключом.

secret -> (булево)

Является ли свойство конфигурации секретным. Секреты скрыты от всех вызовов, кроме GetJobDetails , GetThirdPartyJobDetails , PollForJobs и PollForThirdPartyJobs .

При обновлении конвейера передача * * * * * без изменения других значений действия сохраняет предыдущее значение секрета.

queryable -> (булево)

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

Если вы создаете конвейер с типом пользовательского действия, и это пользовательское действие содержит свойство queryable, значение для этого свойства конфигурации ограничено другими условиями. Значение должно быть меньше или равно двадцати (20) символам. Значение может содержать только буквенно-цифровые символы, символы подчеркивания и дефисы.

description -> (строка)

Описание свойства конфигурации действия, отображаемое пользователям.

type -> (строка)

Тип свойства конфигурации.

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

Подробности входного артефакта для действия, например, его идентификатор коммита.

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

Минимальное количество артефактов, разрешенных для типа действия.

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

Максимальное количество артефактов, разрешенных для типа действия.

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

Подробности выходного артефакта действия, такие как его идентификатор коммита.

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

Минимальное количество артефактов, разрешенных для типа действия.

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

Максимальное количество артефактов, разрешенных для типа действия.

nextToken -> (строка)

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

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

Spec-Zone.ru

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