Spec-Zone.ru › AWS CLI v2

[ aws . codepipeline ]

get-job-details

Описание

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

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

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

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

Синтаксис

  get-job-details
--job-id <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 (строка)

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

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

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

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

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

Примеры

Примечание

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

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

Получение подробностей о задании

Этот пример возвращает данные о задании с идентификатором f4f4ff82-2d11-EXAMPLE. Эта команда используется только для пользовательских действий. При вызове этой команды AWS CodePipeline возвращает временные учетные данные для ведра Amazon S3, используемого для хранения артефактов для пайплайна, если это необходимо для пользовательского действия. Эта команда также вернёт любые секретные значения, определённые для действия, если они есть.

Команда:

aws codepipeline get-job-details --job-id f4f4ff82-2d11-EXAMPLE

Вывод:

{
 "jobDetails": {
  "accountId": "111111111111",
  "data": {
    "actionConfiguration": {
      "__type": "ActionConfiguration",
      "configuration": {
        "ProjectName": "MyJenkinsExampleTestProject"
      }
    },
    "actionTypeId": {
      "__type": "ActionTypeId",
      "category": "Test",
      "owner": "Custom",
      "provider": "MyJenkinsProviderName",
      "version": "1"
    },
    "artifactCredentials": {
      "__type": "AWSSessionCredentials",
      "accessKeyId": "AKIAIOSFODNN7EXAMPLE",
      "secretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
      "sessionToken": "fICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcNMTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9TrDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpEIbb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0FkbFFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTbNYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE="
    },
    "inputArtifacts": [
      {
        "__type": "Artifact",
        "location": {
          "s3Location": {
            "bucketName": "codepipeline-us-east-1-11EXAMPLE11",
            "objectKey": "MySecondPipeline/MyAppBuild/EXAMPLE"
          },
          "type": "S3"
        },
        "name": "MyAppBuild"
      }
    ],
    "outputArtifacts": [],
    "pipelineContext": {
      "__type": "PipelineContext",
      "action": {
        "name": "MyJenkinsTest-Action"
      },
      "pipelineName": "MySecondPipeline",
      "stage": {
        "name": "Testing"
      }
    }
  },
  "id": "f4f4ff82-2d11-EXAMPLE"
 }
}

Вывод

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

Подробности задачи.

Примечание

Если используется AWSSessionCredentials, задача с длительным выполнением может снова вызвать GetJobDetails для получения новых учетных данных.

id -> (строка)

Уникальный, сгенерированный системой идентификатор задачи.

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 -> (список)

Артефакт, предоставленный задаче.

(структура)

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

name -> (строка)

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

revision -> (строка)

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

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

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

type -> (строка)

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

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

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

bucketName -> (строка)

Имя ведра S3.

objectKey -> (строка)

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

outputArtifacts -> (список)

Результат выполнения задачи.

(структура)

Артефакты — это файлы, над которыми работают действия в конвейере. Подробности параметров артефактов см. в конфигурации действия для каждого действия. Например, артефакт действия источника 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 -> (строка)

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

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

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

id -> (строка)

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

Примечание

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

type -> (строка)

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

accountId -> (строка)

Идентификатор учетной записи Amazon Web Services, связанной с задачей.

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

Spec-Zone.ru

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