Spec-Zone.ru › AWS CLI v2

[ aws . codepipeline ]

get-third-party-job-details

Описание

Запрашивает детали задачи для стороннего действия. Используется только для действий партнеров.

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

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

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

Синтаксис

  get-third-party-job-details
--job-id <value>
--client-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]

Параметры

--job-id (строка)

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

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

Часть clientToken пары clientId и clientToken, используемая для проверки того, что вызывающий субъект имеет право доступа к задаче и ее деталям.

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

Вывод

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

Подробные данные о задании, включая любые защищённые значения, определённые для него.

id -> (строка)

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

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

Данные, которые должны быть возвращены рабочим заданием третьей стороны.

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

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

category -> (строка)

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

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

owner -> (строка)

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

provider -> (строка)

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

version -> (строка)

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

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

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

configuration -> (карта)

Данные конфигурации для действия.

key -> (строка)

value -> (строка)

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

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

Примечание

Не включает pipelineArn и pipelineExecutionId для заданий третьей стороны.

pipelineName -> (строка)

Имя конвейера. Это значение, задаваемое пользователем. Имена конвейеров должны быть уникальными для всех имён конвейеров в рамках учётной записи Amazon Web Services.

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

Этап конвейера.

name -> (строка)

Имя этапа.

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

Контекст действия для рабочего задания на этапе конвейера.

name -> (строка)

Имя действия в контексте задания.

actionExecutionId -> (строка)

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

pipelineArn -> (строка)

Amazon Resource Name (ARN) конвейера.

pipelineExecutionId -> (строка)

Идентификатор выполнения конвейера.

inputArtifacts -> (список)

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

(структура)

Артефакты — это файлы, над которыми работают действия в конвейере. Подробные сведения об параметрах артефактов см. в конфигурации действия. Например, артефакт действия источника S3 — это имя файла (или путь к файлу), и файлы, как правило, предоставляются в формате ZIP. Пример имени артефакта: SampleApp_Windows.zip

name -> (строка)

Имя артефакта.

revision -> (строка)

Идентификатор ревизии артефакта. В зависимости от типа объекта, это может быть идентификатор коммита (GitHub) или идентификатор ревизии (Amazon S3).

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

Расположение артефакта.

type -> (строка)

Тип артефакта в расположении.

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

Ведро S3, содержащее артефакт.

bucketName -> (строка)

Имя ведра S3.

objectKey -> (строка)

Ключ объекта в ведре S3, который однозначно идентифицирует объект в ведре.

outputArtifacts -> (список)

Имя артефакта, являющегося результатом действия, если таковой имеется. Это имя может быть сгенерировано системой, например, «MyBuiltApp», или определено пользователем при создании действия.

(структура)

Артефакты — это файлы, над которыми работают действия в конвейере. Подробные сведения об параметрах артефактов см. в конфигурации действия. Например, артефакт действия источника S3 — это имя файла (или путь к файлу), и файлы, как правило, предоставляются в формате ZIP. Пример имени артефакта: SampleApp_Windows.zip

name -> (строка)

Имя артефакта.

revision -> (строка)

Идентификатор ревизии артефакта. В зависимости от типа объекта, это может быть идентификатор коммита (GitHub) или идентификатор ревизии (Amazon S3).

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

Расположение артефакта.

type -> (строка)

Тип артефакта в расположении.

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

Ведро S3, содержащее артефакт.

bucketName -> (строка)

Имя ведра S3.

objectKey -> (строка)

Ключ объекта в ведре S3, который однозначно идентифицирует объект в ведре.

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

Представляет объект сеансовых учетных данных Amazon Web Services. Эти временные учетные данные выдаются службой Amazon Web Services Secure Token Service (STS). Они могут использоваться для доступа к входным и выходным артефактам в ведре S3, используемом для хранения артефактов конвейера в CodePipeline.

accessKeyId -> (строка)

Ключ доступа к сеансу.

secretAccessKey -> (строка)

Секретный ключ доступа к сеансу.

sessionToken -> (строка)

Токен сеанса.

continuationToken -> (строка)

Сгенерированный системой токен, такой как идентификатор развертывания CodeDeploy, необходимый заданию для асинхронного продолжения.

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

Ключ шифрования, используемый для шифрования и расшифрования данных в хранилище артефактов для конвейера, например, ключ Amazon Web Services Key Management Service (Amazon Web Services KMS). Это необязательно и может отсутствовать.

id -> (строка)

Идентификатор, используемый для идентификации ключа. Для ключа Amazon Web Services KMS можно использовать идентификатор ключа, ARN ключа или ARN псевдонима.

Примечание

Псевдонимы распознаются только в учётной записи, в которой был создан ключ KMS. Для действий между учётными записями можно использовать только идентификатор ключа или ARN ключа для идентификации ключа. Действия между учётными записями предполагают использование роли из другой учётной записи (AccountB), поэтому указание идентификатора ключа будет использовать ключ из другой учётной записи (AccountB).

type -> (строка)

Тип ключа шифрования, например, ключ Amazon Web Services KMS. При создании или обновлении конвейера значение должно быть установлено в «KMS».

nonce -> (строка)

Случайное число, сгенерированное системой CodePipeline, для обеспечения того, что над заданием работает только один рабочий. Используйте это число в запросе AcknowledgeThirdPartyJob.

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

Spec-Zone.ru

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