codepipeline

Описание

Это справочник по API CodePipeline. В этом руководстве описаны действия и типы данных для CodePipeline. Некоторые функции вашей конвейерной линии могут быть настроены только через API. Дополнительную информацию см. в руководстве пользователя CodePipeline.

Вы можете использовать API CodePipeline для работы с конвейерными линиями, этапами, действиями и переходами.

Вы можете работать с конвейерными линиями, вызывая:

• CreatePipeline, которое создает конвейерную линию с уникальным именем.
• DeletePipeline, которое удаляет указанную конвейерную линию.
• GetPipeline, которое возвращает информацию о структуре конвейерной линии и метаданных конвейерной линии, включая Amazon Resource Name (ARN) конвейерной линии.
• GetPipelineExecution, которое возвращает информацию о конкретном выполнении конвейерной линии.
• GetPipelineState, которое возвращает информацию о текущем состоянии этапов и действий конвейерной линии.
• ListActionExecutions, которое возвращает детали действий на уровне действий для предыдущих выполнений. Эти детали включают полные сведения на уровне этапа и действия, включая продолжительность отдельных действий, статус, любые ошибки, возникшие во время выполнения, и сведения о местоположении входных и выходных артефактов.
• ListPipelines, которое получает сводку всех конвейерных линий, связанных с вашей учетной записью.
• ListPipelineExecutions, которое получает сводку последних выполнений для конвейерной линии.
• StartPipelineExecution, которое запускает последнюю ревизию артефакта через конвейерную линию.
• StopPipelineExecution, которое останавливает указанное выполнение конвейерной линии, чтобы оно не продолжало проходить через конвейерную линию.
• UpdatePipeline, которое обновляет конвейерную линию с изменениями или правками в структуре конвейерной линии.

Конвейерные линии включают этапы. Каждый этап содержит одно или несколько действий, которые должны быть завершены перед началом следующего этапа. Этап завершается успешно или с ошибкой. Если этап завершается с ошибкой, конвейерная линия останавливается на этом этапе и остается остановленной до тех пор, пока либо новая версия артефакта не появится в исходном расположении, либо пользователь не предпримет действия для повторного запуска последнего артефакта через конвейерную линию. Вы можете вызвать GetPipelineState, которое отображает состояние конвейерной линии, включая состояние этапов в конвейерной линии, или GetPipeline, которое возвращает всю структуру конвейерной линии, включая этапы этой конвейерной линии. Дополнительную информацию о структуре этапов и действий см. в справочнике по структуре конвейерной линии CodePipeline.

Этапы конвейерной линии включают действия, которые классифицируются по категориям, таким как действия по получению или сборке, выполняемые на этапе конвейерной линии. Например, вы можете использовать действие по получению артефактов для импорта артефактов в конвейерную линию из источника, такого как Amazon S3. Как и этапы, в большинстве случаев вы не работаете напрямую с действиями, но вы определяете и взаимодействуете с действиями при работе с операциями конвейерной линии, такими как CreatePipeline и GetPipelineState. Допустимые категории действий:

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

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

Вы можете работать с переходами, вызывая:

• DisableStageTransition, которое предотвращает переход артефактов на следующий этап в конвейерной линии.
• EnableStageTransition, которое включает переход артефактов между этапами в конвейерной линии.

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

Вы можете работать с задачами, вызывая:

• AcknowledgeJob, которое подтверждает, получил ли рабочий задачу.
• GetJobDetails, которое возвращает детали задачи.
• PollForJobs, которое определяет, есть ли задачи для обработки.
• PutJobFailureResult, которое предоставляет сведения об ошибке задачи.
• PutJobSuccessResult, которое предоставляет сведения об успехе задачи.

Вы можете работать с задачами сторонних разработчиков, вызывая:

• AcknowledgeThirdPartyJob, которое подтверждает, получил ли рабочий задачу.
• GetThirdPartyJobDetails, которое запрашивает детали задачи для действия партнера.
• PollForThirdPartyJobs, которое определяет, есть ли задачи для обработки.
• PutThirdPartyJobFailureResult, которое предоставляет сведения об ошибке задачи.
• PutThirdPartyJobSuccessResult, которое предоставляет сведения об успехе задачи.

Доступные команды