Memantau CodePipeline peristiwa - AWS CodePipeline
Jenis detailPeristiwa tingkat saluran pipaAcara tingkat panggungAcara tingkat aksiBuat Aturan yang Mengirim Pemberitahuan pada Acara Pipeline

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Memantau CodePipeline peristiwa

Anda dapat memantau CodePipeline peristiwa di EventBridge, yang mengirimkan aliran data real-time dari aplikasi Anda sendiri, aplikasi software-as-a-service (SaaS), dan. Layanan AWS EventBridge merutekan data tersebut ke target seperti AWS Lambda dan Amazon Simple Notification Service. Peristiwa ini sama dengan yang muncul di Amazon CloudWatch Events, yang memberikan aliran peristiwa sistem yang mendekati waktu nyata yang menggambarkan perubahan AWS sumber daya. Untuk informasi selengkapnya, lihat Apa itu Amazon EventBridge? di Panduan EventBridge Pengguna Amazon.

catatan

Amazon EventBridge adalah cara yang lebih disukai untuk mengelola acara Anda. Amazon CloudWatch Events dan EventBridge merupakan layanan dan API dasar yang sama, tetapi EventBridge menyediakan lebih banyak fitur. Perubahan yang Anda buat di CloudWatch Acara atau EventBridge akan muncul di setiap konsol.

Acara terdiri dari aturan. Aturan dikonfigurasi dengan memilih yang berikut:

  • Pola Acara. Setiap aturan dinyatakan sebagai pola peristiwa dengan sumber dan jenis peristiwa untuk memantau, dan target acara. Untuk memantau peristiwa, Anda membuat aturan dengan layanan yang Anda pantau sebagai sumber acara, seperti CodePipeline. Misalnya, Anda dapat membuat aturan dengan pola peristiwa yang digunakan CodePipeline sebagai sumber peristiwa untuk memicu aturan ketika ada perubahan dalam status pipeline, tahapan, atau tindakan.

  • Target. Aturan baru menerima layanan yang dipilih sebagai target acara. Anda mungkin ingin menyiapkan layanan target untuk mengirim pemberitahuan, menangkap informasi status, mengambil tindakan korektif, memulai peristiwa, atau mengambil tindakan lain. Ketika Anda menambahkan target Anda, Anda juga harus memberikan izin EventBridge untuk mengizinkannya memanggil layanan target yang dipilih.

Setiap jenis peristiwa perubahan status eksekusi memancarkan pemberitahuan dengan konten pesan tertentu, di mana:

  • versionEntri awal menunjukkan nomor versi untuk acara tersebut.

  • versionEntri di bawah pipeline detail menunjukkan nomor versi struktur pipa.

  • execution-idEntri di bawah pipeline detail menunjukkan ID eksekusi untuk eksekusi pipeline yang menyebabkan perubahan status. Lihat panggilan GetPipelineExecution API di Referensi AWS CodePipeline API.

  • pipeline-execution-attemptEntri menunjukkan jumlah upaya, atau percobaan ulang, untuk ID eksekusi tertentu.

CodePipeline melaporkan suatu peristiwa EventBridge kapan pun keadaan sumber daya dalam Akun AWS perubahan Anda. Acara dipancarkan dengan jaminan, at-least-once berdasarkan sumber daya berikut:

  • Eksekusi saluran pipa

  • Eksekusi panggung

  • Eksekusi aksi

Peristiwa dipancarkan EventBridge dengan pola acara dan skema yang dirinci di atas. Untuk acara yang diproses, seperti peristiwa yang Anda terima melalui notifikasi yang telah dikonfigurasi di konsol Alat Pengembang, pesan acara menyertakan bidang pola peristiwa dengan beberapa variasi. Misalnya, detail-type bidang dikonversi kedetailType. Untuk informasi selengkapnya, lihat panggilan PutEvents API di Referensi Amazon EventBridge API.

Contoh berikut menunjukkan acara untuk CodePipeline. Jika memungkinkan, setiap contoh menunjukkan skema untuk peristiwa yang dipancarkan bersama dengan skema untuk acara yang diproses.

Jenis detail

Saat mengatur acara untuk dipantau, Anda dapat memilih jenis detail untuk acara tersebut.

Anda dapat mengonfigurasi notifikasi yang akan dikirim saat status berubah untuk:

  • Pipa tertentu atau semua saluran pipa Anda. Anda mengontrol ini dengan menggunakan "detail-type":"CodePipeline Pipeline Execution State Change".

  • Tahapan yang ditentukan atau semua tahapan Anda, dalam pipa tertentu atau semua saluran pipa Anda. Anda mengontrol ini dengan menggunakan "detail-type":"CodePipeline Stage Execution State Change".

  • Tindakan tertentu atau semua tindakan, dalam tahap tertentu atau semua tahapan, dalam pipa tertentu atau semua saluran pipa Anda. Anda mengontrol ini dengan menggunakan "detail-type":"CodePipeline Action Execution State Change".

catatan

Peristiwa yang dipancarkan oleh EventBridge berisi detail-type parameter, yang dikonversi ke detailType saat peristiwa diproses.

Jenis detail Status Deskripsi
CodePipeline Perubahan Status Eksekusi Pipeline MEMBATALKAN Eksekusi pipa dibatalkan karena struktur pipa diperbarui.
FAILED Eksekusi pipeline tidak berhasil diselesaikan.
DILANJUTKAN Eksekusi pipeline yang gagal telah dicoba ulang sebagai respons terhadap panggilan RetryStageExecution API.
DIMULAI Eksekusi pipeline saat ini sedang berjalan.
DIHENTIKAN Proses penghentian selesai, dan eksekusi pipa dihentikan.
BERHENTI Eksekusi pipeline berhenti karena permintaan untuk berhenti dan menunggu atau menghentikan dan meninggalkan eksekusi pipa.
SUKSES Eksekusi pipa selesai dengan sukses.
DIGANTIKAN

Sementara eksekusi pipeline ini menunggu tahap berikutnya selesai, eksekusi pipeline yang lebih baru maju dan dilanjutkan melalui pipeline sebagai gantinya.
CodePipeline Perubahan Status Eksekusi Tahap MEMBATALKAN Panggung dibatalkan karena struktur pipa diperbarui.
FAILED Panggung tidak selesai dengan sukses.
DILANJUTKAN Tahap yang gagal telah dicoba ulang sebagai respons terhadap panggilan RetryStageExecution API.
DIMULAI Panggung sedang berjalan.
DIHENTIKAN Proses penghentian selesai, dan eksekusi panggung dihentikan.
BERHENTI Eksekusi tahap berhenti karena permintaan untuk berhenti dan menunggu atau berhenti dan meninggalkan eksekusi pipa.
SUKSES Panggung selesai dengan sukses.
CodePipeline Perubahan Status Eksekusi Tindakan MENELANTARKAN Tindakan ini ditinggalkan karena permintaan untuk menghentikan dan meninggalkan eksekusi pipa.
MEMBATALKAN Tindakan dibatalkan karena struktur pipa diperbarui.
FAILED Untuk tindakan persetujuan, status GAGAL berarti tindakan ditolak oleh pengulas atau gagal karena konfigurasi tindakan yang salah.
DIMULAI Tindakan saat ini sedang berjalan.
SUKSES Tindakan itu selesai dengan sukses.

Peristiwa tingkat saluran pipa

Peristiwa tingkat pipeline dipancarkan ketika ada perubahan status untuk eksekusi pipeline.

Acara PIPELINE STARTED

Ketika eksekusi pipeline dimulai, ia memancarkan peristiwa yang mengirimkan pemberitahuan dengan konten berikut. Contoh ini untuk pipa yang dinamai "myPipeline" di us-east-1 Wilayah. idBidang mewakili ID peristiwa, dan account bidang tersebut mewakili ID akun tempat pipeline dibuat.

Emitted event
{
    "version": "0",
    "id": "01234567-EXAMPLE",
    "detail-type": "CodePipeline Pipeline Execution State Change",
    "source": "aws.codepipeline",
    "account": "123456789012",
    "time": "2020-01-24T22:03:07Z",
    "region": "us-east-1",
    "resources": [
        "arn:aws:codepipeline:us-east-1:123456789012:myPipeline"
    ],
    "detail": {
        "pipeline": "myPipeline",
        "execution-id": "12345678-1234-5678-abcd-12345678abcd",
        "start-time": "2023-10-26T13:49:39.208Z",
        "execution-trigger": {
            "trigger-type": "StartPipelineExecution",
            "trigger-detail": "arn:aws:sts::123456789012:assumed-role/Admin/my-user"
        },
        "state": "STARTED",
        "version": 1.0,
        "pipeline-execution-attempt": 1.0
    }
}
Processed event
{
    "account": "123456789012",
    "detailType": "CodePipeline Pipeline Execution State Change",
    "region": "us-east-1",
    "source": "aws.codepipeline",
    "time": "2021-06-24T00:44:50Z",
    "notificationRuleArn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/a69c62c21EXAMPLE",
    "detail": {
        "pipeline": "myPipeline",
        "execution-id": "12345678-1234-5678-abcd-12345678abcd",
        "start-time": "2023-10-26T13:49:39.208Z",
        "execution-trigger": {
            "trigger-type": "StartPipelineExecution",
            "trigger-detail": "arn:aws:sts::123456789012:assumed-role/Admin/my-user"
        },
        "state": "STARTED",
        "version": 1.0,
        "pipeline-execution-attempt": 1.0
    },
    "resources": [
        "arn:aws:codepipeline:us-east-1:123456789012:myPipeline"
    ],
    "additionalAttributes": {}
}

Acara STOPLINE STOPING

Ketika eksekusi pipeline berhenti, ia memancarkan peristiwa yang mengirimkan pemberitahuan dengan konten berikut. Contoh ini untuk pipa yang dinamai myPipeline di us-west-2 Wilayah.

{
    "version": "0",
    "id": "01234567-EXAMPLE",
    "detail-type": "CodePipeline Pipeline Execution State Change",
    "source": "aws.codepipeline",
    "account": "123456789012",
    "time": "2020-01-24T22:02:20Z",
    "region": "us-west-2",
    "resources": [
        "arn:aws:codepipeline:us-west-2:123456789012:myPipeline"
    ],
    "detail": {
        "pipeline": "myPipeline",
        "execution-id": "12345678-1234-5678-abcd-12345678abcd",
        "start-time": "2023-10-26T13:49:39.208Z",
        "state": "STOPPING",
        "version": 3.0,
        "pipeline-execution-attempt": 1.0
        "stop-execution-comments": "Stopping the pipeline for an update"
    }
}

Acara PIPELINE BERHASIL

Ketika eksekusi pipeline berhasil, ia memancarkan peristiwa yang mengirimkan notifikasi dengan konten berikut. Contoh ini untuk pipa yang dinamai myPipeline di us-east-1 Wilayah.

Emitted event
{
    "version": "0",
    "id": "01234567-EXAMPLE",
    "detail-type": "CodePipeline Pipeline Execution State Change",
    "source": "aws.codepipeline",
    "account": "123456789012",
    "time": "2020-01-24T22:03:44Z",
    "region": "us-east-1",
    "resources": [
        "arn:aws:codepipeline:us-east-1:123456789012:myPipeline"
    ],
    "detail": {
        "pipeline": "myPipeline",
        "execution-id": "12345678-1234-5678-abcd-12345678abcd",
        "start-time": "2023-10-26T13:49:39.208Z",
        "state": "SUCCEEDED",
        "version": 3.0,
        "pipeline-execution-attempt": 1.0
    }
}
Processed event
{
    "account": "123456789012",
    "detailType": "CodePipeline Pipeline Execution State Change",
    "region": "us-east-1",
    "source": "aws.codepipeline",
    "time": "2021-06-30T22:13:51Z",
    "notificationRuleArn": "arn:aws:codestar-notifications:us-west-2:123456789012:notificationrule/a69c62c21EXAMPLE",
    "detail": {
        "pipeline": "myPipeline",
        "execution-id": "12345678-1234-5678-abcd-12345678abcd",
        "start-time": "2023-10-26T13:49:39.208Z",
        "state": "SUCCEEDED",
        "version": 1.0,
        "pipeline-execution-attempt": 1.0
    },
    "resources": [
        "arn:aws:codepipeline:us-west-2:123456789012:myPipeline"
    ],
    "additionalAttributes": {}
}

Pipeline BERHASIL (contoh dengan tag Git)

Ketika eksekusi pipeline memiliki tahap yang telah dicoba ulang dan berhasil, ia memancarkan peristiwa yang mengirimkan pemberitahuan dengan konten berikut. Contoh ini adalah untuk pipeline bernama myPipeline di eu-central-1 Wilayah di mana execution-trigger dikonfigurasi untuk tag Git.

catatan

execution-triggerBidang akan memiliki salah satu tag-name ataubranch-name, tergantung pada jenis peristiwa yang memicu pipeline.

{
    "version": "0",
    "id": "b128b002-09fd-4574-4eba-27152726c777",
    "detail-type": "CodePipeline Pipeline Execution State Change",
    "source": "aws.codepipeline",
    "account": "123456789012",
    "time": "2023-10-26T13:50:53Z",
    "region": "eu-central-1",
    "resources": [
        "arn:aws:codepipeline:eu-central-1:123456789012:BuildFromTag"
    ],
    "detail": {
        "pipeline": "BuildFromTag",
        "execution-id": "e17b5773-cc0d-4db2-9ad7-594c73888de8",
        "start-time": "2023-10-26T13:49:39.208Z",
        "execution-trigger": {
            "author-display-name": "Mary Major",
            "full-repository-name": "mmajor/sample-project",
            "provider-type": "GitLab",
            "author-email": "email_address",
            "commit-message": "Update file README.md",
            "author-date": "2023-08-16T21:08:08Z",
            "tag-name": "gitlab-v4.2.1",
            "commit-id": "commit_ID",
            "connection-arn": "arn:aws:codestar-connections:eu-central-1:123456789012:connection/0f5b706a-1a1d-46c5-86b6-f177321bcfb2",
            "author-id": "Mary Major"
        },
        "state": "SUCCEEDED",
        "version": 32.0,
        "pipeline-execution-attempt": 1.0
    }
}

Acara PIPELINE GAGAL

Ketika eksekusi pipeline gagal, ia memancarkan peristiwa yang mengirimkan pemberitahuan dengan konten berikut. Contoh ini untuk pipa yang dinamai "myPipeline" di us-west-2 Wilayah.

Emitted event
{
    "version": "0",
    "id": "01234567-EXAMPLE",
    "detail-type": "CodePipeline Pipeline Execution State Change",
    "source": "aws.codepipeline",
    "account": "123456789012",
    "time": "2020-01-31T18:55:43Z",
    "region": "us-west-2",
    "resources": [
        "arn:aws:codepipeline:us-west-2:123456789012:myPipeline"
    ],
    "detail": {
        "pipeline": "myPipeline",
        "execution-id": "12345678-1234-5678-abcd-12345678abcd",
        "start-time": "2023-10-26T13:49:39.208Z",
        "state": "FAILED",
        "version": 4.0,
        "pipeline-execution-attempt": 1.0
    }
}
Processed event
{
    "account": "123456789012",
    "detailType": "CodePipeline Pipeline Execution State Change",
    "region": "us-west-2",
    "source": "aws.codepipeline",
    "time": "2021-06-24T00:46:16Z",
    "notificationRuleArn": "arn:aws:codestar-notifications:us-west-2:123456789012:notificationrule/a69c62c21EXAMPLE",
    "detail": {
        "pipeline": "myPipeline",
        "execution-id": "12345678-1234-5678-abcd-12345678abcd",
        "start-time": "2023-10-26T13:49:39.208Z",
        "state": "FAILED",
        "version": 1.0,
        "pipeline-execution-attempt": 1.0
    },
    "resources": [
        "arn:aws:codepipeline:us-west-2:123456789012:myPipeline"
    ],
    "additionalAttributes": {
        "failedActionCount": 1,
        "failedActions": [
            {
                "action": "Deploy",
                "additionalInformation": "Deployment <ID> failed"
            }
        ],
        "failedStage": "Deploy"
    }

Pipeline FAILED (contoh dengan tag Git)

Kecuali gagal pada tahap sumber, untuk konfigurasi pipeline dengan pemicu, ia memancarkan peristiwa yang mengirimkan pemberitahuan dengan konten berikut. Contoh ini adalah untuk pipeline bernama myPipeline di eu-central-1 Wilayah di mana execution-trigger dikonfigurasi untuk tag Git.

catatan

execution-triggerBidang akan memiliki salah satu tag-name ataubranch-name, tergantung pada jenis peristiwa yang memicu pipeline.

Emitted event
{
    "version": "0",
    "id": "01234567-EXAMPLE",
    "detail-type": "CodePipeline Pipeline Execution State Change",
    "source": "aws.codepipeline",
    "account": "123456789012",
    "time": "2020-01-31T18:55:43Z",
    "region": "us-west-2",
    "resources": [
        "arn:aws:codepipeline:us-west-2:123456789012:myPipeline"
    ],
    "detail": {
        "pipeline": "myPipeline",
        "execution-id": "12345678-1234-5678-abcd-12345678abcd",
        "start-time": "2023-10-26T13:49:39.208Z",
        "execution-trigger": {
            "author-display-name": "Mary Major",
            "full-repository-name": "mmajor/sample-project",
            "provider-type": "GitLab",
            "author-email": "email_address",
            "commit-message": "Update file README.md",
            "author-date": "2023-08-16T21:08:08Z",
            "tag-name": "gitlab-v4.2.1",
            "commit-id": "commit_ID",
            "connection-arn": "arn:aws:codestar-connections:eu-central-1:123456789012:connection/0f5b706a-1a1d-46c5-86b6-f177321bcfb2",
            "author-id": "Mary Major"
        },
        "state": "FAILED",
        "version": 4.0,
        "pipeline-execution-attempt": 1.0
    }
}
Processed event
{
    "account": "123456789012",
    "detailType": "CodePipeline Pipeline Execution State Change",
    "region": "us-west-2",
    "source": "aws.codepipeline",
    "time": "2021-06-24T00:46:16Z",
    "notificationRuleArn": "arn:aws:codestar-notifications:us-west-2:123456789012:notificationrule/a69c62c21EXAMPLE",
    "detail": {
        "pipeline": "myPipeline",
        "execution-id": "12345678-1234-5678-abcd-12345678abcd",
        "start-time": "2023-10-26T13:49:39.208Z",
        "execution-trigger": {
            "author-display-name": "Mary Major",
            "full-repository-name": "mmajor/sample-project",
            "provider-type": "GitLab",
            "author-email": "email_address",
            "commit-message": "Update file README.md",
            "author-date": "2023-08-16T21:08:08Z",
            "tag-name": "gitlab-v4.2.1",
            "commit-id": "commit_ID",
            "connection-arn": "arn:aws:codestar-connections:eu-central-1:123456789012:connection/0f5b706a-1a1d-46c5-86b6-f177321bcfb2",
            "author-id": "Mary Major"
        },
        "state": "FAILED",
        "version": 1.0,
        "pipeline-execution-attempt": 1.0
    },
    "resources": [
        "arn:aws:codepipeline:us-west-2:123456789012:myPipeline"
    ],
    "additionalAttributes": {
        "failedActionCount": 1,
        "failedActions": [
            {
                "action": "Deploy",
                "additionalInformation": "Deployment <ID> failed"
            }
        ],
        "failedStage": "Deploy"
    }

Acara tingkat panggung

Peristiwa tingkat tahap dipancarkan ketika ada perubahan status untuk eksekusi tahap.

Acara STAGE STARTED

Ketika eksekusi tahap dimulai, ia memancarkan peristiwa yang mengirimkan pemberitahuan dengan konten berikut. Contoh ini untuk pipa yang disebutkan "myPipeline" di us-east-1 Wilayah, untuk panggungProd.

Emitted event
{
    "version": "0",
    "id": 01234567-EXAMPLE,
    "detail-type": "CodePipeline Stage Execution State Change",
    "source": "aws.codepipeline",
    "account": 123456789012,
    "time": "2020-01-24T22:03:07Z",
    "region": "us-east-1",
    "resources": [
        "arn:aws:codepipeline:us-east-1:123456789012:myPipeline"
    ],
    "detail": {
        "pipeline": "myPipeline",
        "version": 1.0,
        "execution-id": 12345678-1234-5678-abcd-12345678abcd,
        "start-time": "2023-10-26T13:49:39.208Z",
        "stage": "Prod",
        "state": "STARTED",
        "pipeline-execution-attempt": 1.0
    }
}
Processed event
{
    "account": "123456789012",
    "detailType": "CodePipeline Stage Execution State Change",
    "region": "us-east-1",
    "source": "aws.codepipeline",
    "time": "2021-06-24T00:45:40Z",
    "notificationRuleArn": "arn:aws:codestar-notifications:us-west-2:123456789012:notificationrule/a69c62c21EXAMPLE",
    "detail": {
        "pipeline": "myPipeline",
        "execution-id": "12345678-1234-5678-abcd-12345678abcd",
        "start-time": "2023-10-26T13:49:39.208Z",
        "stage": "Source",
        "state": "STARTED",
        "version": 1.0,
        "pipeline-execution-attempt": 0.0
    },
    "resources": [
        "arn:aws:codepipeline:us-east-1:123456789012:myPipeline"
    ],
    "additionalAttributes": {
        "sourceActions": [
            {
                "sourceActionName": "Source",
                "sourceActionProvider": "CodeCommit",
                "sourceActionVariables": {
                    "BranchName": "main",
                    "CommitId": "<ID>",
                    "RepositoryName": "my-repo"
                }
            }
        ]
    }
}

Acara STAGE STOPING

Ketika eksekusi panggung berhenti, ia memancarkan peristiwa yang mengirimkan pemberitahuan dengan konten berikut. Contoh ini untuk pipa yang disebutkan myPipeline di us-west-2 Wilayah, untuk panggungDeploy.

{
    "version": "0",
    "id": "01234567-EXAMPLE",
    "detail-type": "CodePipeline Stage Execution State Change",
    "source": "aws.codepipeline",
    "account": "123456789012",
    "time": "2020-01-24T22:02:20Z",
    "region": "us-west-2",
    "resources": [
        "arn:aws:codepipeline:us-west-2:123456789012:myPipeline"
    ],
    "detail": {
        "pipeline": "myPipeline",
        "execution-id": "12345678-1234-5678-abcd-12345678abcd",
        "start-time": "2023-10-26T13:49:39.208Z",
        "stage": "Deploy",
        "state": "STOPPING",
        "version": 3.0,
        "pipeline-execution-attempt": 1.0
    }
}

Acara STAGE STOPTED

Ketika eksekusi panggung dihentikan, ia memancarkan peristiwa yang mengirimkan pemberitahuan dengan konten berikut. Contoh ini untuk pipa yang disebutkan myPipeline di us-west-2 Wilayah, untuk panggungDeploy.

{
    "version": "0",
    "id": "01234567-EXAMPLE",
    "detail-type": "CodePipeline Stage Execution State Change",
    "source": "aws.codepipeline",
    "account": "123456789012",
    "time": "2020-01-31T18:21:39Z",
    "region": "us-west-2",
    "resources": [
        "arn:aws:codepipeline:us-west-2:123456789012:myPipeline"
    ],
    "detail": {
        "pipeline": "myPipeline",
        "execution-id": "12345678-1234-5678-abcd-12345678abcd",
        "start-time": "2023-10-26T13:49:39.208Z",
        "stage": "Deploy",
        "state": "STOPPED",
        "version": 3.0,
        "pipeline-execution-attempt": 1.0
    }
}

Tahap DILANJUTKAN setelah acara coba lagi tahap

Ketika eksekusi panggung dilanjutkan dan memiliki tahap yang telah dicoba lagi, ia memancarkan peristiwa yang mengirimkan pemberitahuan dengan konten berikut.

Ketika sebuah panggung telah dicoba lagi, stage-last-retry-attempt-time bidang akan ditampilkan, seperti yang ditunjukkan pada contoh. Bidang ditampilkan pada semua acara panggung jika percobaan ulang dilakukan.

catatan

stage-last-retry-attempt-timeBidang akan hadir di semua acara tahap berikutnya setelah tahap telah dicoba lagi.

{
    "version": "0",
    "id": "38656bcd-a798-5f92-c738-02a71be484e1",
    "detail-type": "CodePipeline Stage Execution State Change",
    "source": "aws.codepipeline",
    "account": "123456789012",
    "time": "2023-10-26T14:14:56Z",
    "region": "eu-central-1",
    "resources": [
        "arn:aws:codepipeline:eu-central-1:123456789012:BuildFromTag"
    ],
    "detail": {
        "pipeline": "BuildFromTag",
        "execution-id": "05dafb6a-5a56-4951-a858-968795364846",
        "stage-last-retry-attempt-time": "2023-10-26T14:14:56.305Z",
        "stage": "Build",
        "state": "RESUMED",
        "version": 32.0,
        "pipeline-execution-attempt": 2.0
    }
}

Acara tingkat aksi

Peristiwa tingkat aksi dipancarkan ketika ada perubahan status untuk eksekusi tindakan.

Acara Aksi DIMULAI

Ketika eksekusi tindakan dimulai, ia memancarkan peristiwa yang mengirimkan pemberitahuan dengan konten berikut. Contoh ini untuk pipeline yang dinamai myPipeline di us-east-1 Wilayah, untuk tindakan myAction penerapan.

Emitted event
{
    "version": "0",
    "id": 01234567-EXAMPLE,
    "detail-type": "CodePipeline Action Execution State Change",
    "source": "aws.codepipeline",
    "account": 123456789012,
    "time": "2020-01-24T22:03:07Z",
    "region": "us-east-1",
    "resources": [
        "arn:aws:codepipeline:us-east-1:123456789012:myPipeline"
    ],
    "detail": {
        "pipeline": "myPipeline",
        "execution-id": 12345678-1234-5678-abcd-12345678abcd,
        "start-time": "2023-10-26T13:51:09.981Z",
        "stage": "Prod",
        "action-execution-id": "47f821c5-a902-44b2-ae61-b878d31ecd21",
        "action": "myAction",
        "state": "STARTED",
        "type": {
            "owner": "AWS",
            "category": "Deploy",
            "provider": "CodeDeploy",
            "version": "1"
        },
        "version": 2.0
        "pipeline-execution-attempt": 1.0
        "input-artifacts": [
            {
                "name": "SourceArtifact",
                "s3location": {
                    "bucket": "codepipeline-us-east-1-BUCKETEXAMPLE",
                    "key": "myPipeline/SourceArti/KEYEXAMPLE"
                }
            }
        ]
    }
}
Processed event
{
    "account": "123456789012",
    "detailType": "CodePipeline Action Execution State Change",
    "region": "us-west-2",
    "source": "aws.codepipeline",
    "time": "2021-06-24T00:45:44Z",
    "notificationRuleArn": "arn:aws:codestar-notifications:us-west-2:123456789012:notificationrule/a69c62c21EXAMPLE",
    "detail": {
        "pipeline": "myPipeline",
        "execution-id": "12345678-1234-5678-abcd-12345678abcd",
        "start-time": "2023-10-26T13:51:09.981Z",
        "stage": "Deploy",
        "action-execution-id": "47f821c5-a902-44b2-ae61-b878d31ecd21",
        "action": "Deploy",
        "input-artifacts": [
            {
                "name": "SourceArtifact",
                "s3location": {
                    "bucket": "codepipeline-us-east-1-EXAMPLE",
                    "key": "myPipeline/SourceArti/EXAMPLE"
                }
            }
        ],
        "state": "STARTED",
        "region": "us-east-1",
        "type": {
            "owner": "AWS",
            "provider": "CodeDeploy",
            "category": "Deploy",
            "version": "1"
        },
        "version": 1.0,
        "pipeline-execution-attempt": 1.0
    },
    "resources": [
        "arn:aws:codepipeline:us-east-1:123456789012:myPipeline"
    ],
    "additionalAttributes": {}
}

Acara Aksi BERHASIL

Ketika eksekusi tindakan berhasil, ia memancarkan peristiwa yang mengirimkan pemberitahuan dengan konten berikut. Contoh ini untuk pipeline yang dinamai "myPipeline" di us-west-2 Wilayah, untuk aksi sumber"Source". Untuk jenis acara ini, ada dua region bidang yang berbeda. regionBidang acara menentukan Wilayah untuk acara pipeline. regionBidang di bawah detail bagian menentukan Wilayah untuk tindakan.

Emitted event
{
    "version": "0",
    "id": "01234567-EXAMPLE",
    "detail-type": "CodePipeline Action Execution State Change",
    "source": "aws.codepipeline",
    "account": "123456789012",
    "time": "2020-01-24T22:03:11Z",
    "region": "us-west-2",
    "resources": [
        "arn:aws:codepipeline:us-west-2:123456789012:myPipeline"
    ],
    "detail": {
        "pipeline": "myPipeline",
        "execution-id": "12345678-1234-5678-abcd-12345678abcd",
        "start-time": "2023-10-26T13:51:09.981Z",
        "stage": "Source",
        "execution-result": {
            "external-execution-url": "https://us-west-2.console.aws.amazon.com/codecommit/home#/repository/my-repo/commit/8cf40f2EXAMPLE",
            "external-execution-summary": "Added LICENSE.txt",
            "external-execution-id": "8cf40fEXAMPLE"
        },
        "output-artifacts": [
            {
                "name": "SourceArtifact",
                "s3location": {
                    "bucket": "codepipeline-us-west-2-BUCKETEXAMPLE",
                    "key": "myPipeline/SourceArti/KEYEXAMPLE"
                }
            }
        ],
        "action-execution-id": "47f821c5-a902-44b2-ae61-b878d31ecd21",
        "action": "Source",
        "state": "SUCCEEDED",
        "region": "us-west-2",
        "type": {
            "owner": "AWS",
            "provider": "CodeCommit",
            "category": "Source",
            "version": "1"
        },
        "version": 3.0,
        "pipeline-execution-attempt": 1.0
    }
}
Processed event
{
    "account": "123456789012",
    "detailType": "CodePipeline Action Execution State Change",
    "region": "us-west-2",
    "source": "aws.codepipeline",
    "time": "2021-06-24T00:45:44Z",
    "notificationRuleArn": "arn:aws:codestar-notifications:us-west-2:ACCOUNT:notificationrule/a69c62c21EXAMPLE",
    "detail": {
        "pipeline": "myPipeline",
        "execution-id": "arn:aws:codepipeline:us-west-2:123456789012:myPipeline",
        "start-time": "2023-10-26T13:51:09.981Z",
        "stage": "Source",
        "execution-result": {
            "external-execution-url": "https://us-west-2.console.aws.amazon.com/codecommit/home#/repository/my-repo/commit/8cf40f2EXAMPLE",
            "external-execution-summary": "Edited index.html",
            "external-execution-id": "36ab3ab7EXAMPLE"
        },
        "output-artifacts": [
            {
                "name": "SourceArtifact",
                "s3location": {
                    "bucket": "codepipeline-us-west-2-EXAMPLE",
                    "key": "myPipeline/SourceArti/EXAMPLE"
                }
            }
        ],
        "action-execution-id": "47f821c5-a902-44b2-ae61-b878d31ecd21",
        "action": "Source",
        "state": "SUCCEEDED",
        "region": "us-west-2",
        "type": {
            "owner": "AWS",
            "provider": "CodeCommit",
            "category": "Source",
            "version": "1"
        },
        "version": 1.0,
        "pipeline-execution-attempt": 1.0
    },
    "resources": [
        "arn:aws:codepipeline:us-west-2:123456789012:myPipeline"
    ],
    "additionalAttributes": {}
}

Acara Aksi GAGAL

Ketika eksekusi tindakan gagal, ia memancarkan peristiwa yang mengirimkan pemberitahuan dengan konten berikut. Contoh ini untuk pipa yang dinamai "myPipeline" di us-west-2 Wilayah, untuk tindakan"Deploy".

Emitted event
{
    "version": "0",
    "id": "01234567-EXAMPLE",
    "detail-type": "CodePipeline Action Execution State Change",
    "source": "aws.codepipeline",
    "account": "123456789012",
    "time": "2020-01-31T18:55:43Z",
    "region": "us-west-2",
    "resources": [
        "arn:aws:codepipeline:us-west-2:123456789012:myPipeline"
    ],
    "detail": {
        "pipeline": "myPipeline",
        "execution-id": "12345678-1234-5678-abcd-12345678abcd", 
        "start-time": "2023-10-26T13:51:09.981Z",
        "stage": "Deploy",
        "execution-result": {
            "external-execution-url": "https://us-west-2.console.aws.amazon.com/codedeploy/home?#/deployments/<ID>",
            "external-execution-summary": "Deployment <ID> failed",
            "external-execution-id": "<ID>",
            "error-code": "JobFailed"
        },
        "action-execution-id": "47f821c5-a902-44b2-ae61-b878d31ecd21",
        "action": "Deploy",
        "state": "FAILED",
        "region": "us-west-2",
        "type": {
            "owner": "AWS",
            "provider": "CodeDeploy",
            "category": "Deploy",
            "version": "1"
        },
        "version": 4.0,
        "pipeline-execution-attempt": 1.0
    }
}
Processed event
{
    "account": "123456789012",
    "detailType": "CodePipeline Action Execution State Change",
    "region": "us-west-2",
    "source": "aws.codepipeline",
    "time": "2021-06-24T00:46:16Z",
    "notificationRuleArn": "arn:aws:codestar-notifications:us-west-2:123456789012:notificationrule/a69c62c21EXAMPLE",
    "detail": {
        "pipeline": "myPipeline",
        "execution-id": "12345678-1234-5678-abcd-12345678abcd",
        "stage": "Deploy",
        "execution-result": {
            "external-execution-url": "https://console.aws.amazon.com/codedeploy/home?region=us-west-2#/deployments/<ID>",
            "external-execution-summary": "Deployment <ID> failed",
            "external-execution-id": "<ID>",
            "error-code": "JobFailed"
        },  
        "action-execution-id": "47f821c5-a902-44b2-ae61-b878d31ecd21",
        "action": "Deploy",
        "state": "FAILED",
        "region": "us-west-2",
        "type": {
            "owner": "AWS",
            "provider": "CodeDeploy",
            "category": "Deploy",
            "version": "1"
        },
        "version": 13.0,
        "pipeline-execution-attempt": 1.0
    },
    "resources": [
        "arn:aws:codepipeline:us-west-2:123456789012:myPipeline"
    ],
    "additionalAttributes": {
        "additionalInformation": "Deployment <ID> failed"
    }
}

Acara Aksi ABANDONED

Ketika eksekusi tindakan ditinggalkan, ia memancarkan peristiwa yang mengirimkan pemberitahuan dengan konten berikut. Contoh ini untuk pipa yang dinamai "myPipeline" di us-west-2 Wilayah, untuk tindakan"Deploy".

{
    "version": "0",
    "id": "01234567-EXAMPLE",
    "detail-type": "CodePipeline Action Execution State Change",
    "source": "aws.codepipeline",
    "account": "123456789012",
    "time": "2020-01-31T18:21:39Z",
    "region": "us-west-2",
    "resources": [
        "arn:aws:codepipeline:us-west-2:123456789012:myPipeline"
    ],
    "detail": {
        "pipeline": "myPipeline",
        "execution-id": "12345678-1234-5678-abcd-12345678abcd",
        "stage": "Deploy",
        "action-execution-id": "47f821c5-a902-44b2-ae61-b878d31ecd21",
        "action": "Deploy",
        "state": "ABANDONED",
        "region": "us-west-2",
        "type": {
            "owner": "AWS",
            "provider": "CodeDeploy",
            "category": "Deploy",
            "version": "1"
        },
        "version": 3.0,
        "pipeline-execution-attempt": 1.0
    }
}

Buat Aturan yang Mengirim Pemberitahuan pada Acara Pipeline

Aturan mengawasi peristiwa tertentu dan kemudian mengarahkannya ke AWS target yang Anda pilih. Anda dapat membuat aturan yang melakukan AWS tindakan secara otomatis ketika AWS tindakan lain terjadi, atau aturan yang melakukan AWS tindakan secara teratur pada jadwal yang ditetapkan.

Mengirim Pemberitahuan Saat Status Pipeline Berubah (Konsol)

Langkah-langkah ini menunjukkan cara menggunakan EventBridge konsol untuk membuat aturan untuk mengirim pemberitahuan perubahan CodePipeline.

Untuk membuat EventBridge aturan yang menargetkan pipeline Anda dengan sumber Amazon S3

  1. Buka EventBridge konsol Amazon di https://console.aws.amazon.com/events/.

  2. Di panel navigasi, pilih Aturan. Biarkan bus default dipilih atau pilih bus acara. Pilih Buat aturan.

  3. Di Nama, masukkan nama untuk aturan Anda.

  4. Di bawah Jenis aturan, pilih Aturan dengan pola acara. Pilih Selanjutnya.

  5. Di bawah Pola acara, pilih AWS layanan.

  6. Dari daftar drop-down Jenis Acara, pilih tingkat perubahan status untuk notifikasi.

    • Untuk aturan yang berlaku untuk peristiwa tingkat pipeline, pilih Perubahan Status Eksekusi CodePipeline Pipeline.

    • Untuk aturan yang berlaku untuk peristiwa tingkat tahap, pilih Perubahan Status Eksekusi CodePipeline Tahap.

    • Untuk aturan yang berlaku untuk peristiwa tingkat tindakan, pilih Perubahan Status Eksekusi CodePipeline Tindakan.

  7. Tentukan perubahan status yang berlaku untuk aturan:

    • Untuk aturan yang berlaku untuk semua perubahan status, pilih Status apa pun.

    • Untuk aturan yang berlaku untuk beberapa perubahan status saja, pilih Status tertentu, lalu pilih satu atau beberapa nilai status dari daftar.

  8. Untuk pola acara yang lebih rinci daripada yang diizinkan oleh penyeleksi, Anda juga dapat menggunakan opsi Edit pola di jendela Pola acara untuk menunjuk pola acara dalam format JSON.

    catatan

    Jika tidak ditentukan lain, maka pola acara dibuat untuk semua pipeline/tahap/tindakan dan status.

    Untuk pola acara yang lebih rinci, Anda dapat menyalin dan menempelkan contoh pola peristiwa berikut ke dalam jendela pola Peristiwa.

    • Gunakan contoh pola peristiwa ini untuk menangkap tindakan penerapan dan pembuatan yang gagal di semua pipeline.

      {
"source": [
    "aws.codepipeline"
  ],
  "detail-type": [
    "CodePipeline Action Execution State Change"
  ],
  "detail": {
    "state": [
      "FAILED"
    ],
    "type": {
      "category": ["Deploy", "Build"]
    }
  }
}

    • Gunakan contoh pola peristiwa ini untuk menangkap semua tindakan persetujuan yang ditolak atau gagal di semua pipeline.

      {
 "source": [
    "aws.codepipeline"
  ],
  "detail-type": [
    "CodePipeline Action Execution State Change"
  ],
  "detail": {
    "state": [
      "FAILED"
    ],
    "type": {
      "category": ["Approval"]
    }
  }
}

    • Gunakan contoh pola peristiwa ini untuk menangkap semua peristiwa dari pipeline yang ditentukan.

      {
"source": [
    "aws.codepipeline"
  ],
  "detail-type": [
    "CodePipeline Pipeline Execution State Change",
    "CodePipeline Action Execution State Change",
    "CodePipeline Stage Execution State Change"
  ],
  "detail": {
    "pipeline": ["myPipeline", "my2ndPipeline"]
  }
}

  9. Pilih Selanjutnya.

  10. Di jenis Target, pilih AWS layanan.

  11. Di Pilih target, pilih CodePipeline. Di ARN Pipeline, masukkan ARN pipa agar pipa dimulai dengan aturan ini.

    catatan

    Untuk mendapatkan ARN pipeline, jalankan perintah. get-pipeline ARN pipa muncul di output. Itu dibangun dalam format ini:

    arn:aws:codepipeline: wilayah: akun: nama-pipa

    Contoh pipa ARN:

    arn:aws:codepipeline:us-east- 2:80398 CONTOH: MyFirstPipeline

  12. Untuk membuat atau menentukan peran layanan IAM yang memberikan EventBridge izin untuk memanggil target yang terkait dengan EventBridge aturan Anda (dalam hal ini, targetnya adalah): CodePipeline

    • Pilih Buat peran baru untuk sumber daya khusus ini untuk membuat peran layanan yang memberikan EventBridge izin untuk memulai eksekusi pipeline Anda.

    • Pilih Gunakan peran yang ada untuk memasukkan peran layanan yang memberikan EventBridge izin untuk memulai eksekusi pipeline Anda.

  13. Pilih Selanjutnya.

  14. Pada halaman Tag, pilih Berikutnya.

  15. Pada halaman Tinjau dan buat, tinjau konfigurasi aturan. Jika Anda puas dengan aturan, pilih Create rule (Buat aturan).

Kirim Pemberitahuan Saat Status Pipeline Berubah (CLI)

Langkah-langkah ini menunjukkan cara menggunakan CLI untuk membuat aturan CloudWatch Acara untuk mengirim pemberitahuan perubahan. CodePipeline

Untuk menggunakan aturan AWS CLI untuk membuat aturan, panggil put-rule perintah, dengan menentukan:

  • Nama yang secara unik mengidentifikasi aturan yang Anda buat. Nama ini harus unik di semua pipeline yang Anda buat CodePipeline terkait dengan AWS akun Anda.

  • Pola acara untuk bidang sumber dan detail yang digunakan oleh aturan. Untuk informasi selengkapnya, lihat Amazon EventBridge dan Pola Acara.

Untuk membuat EventBridge aturan dengan CodePipeline sebagai sumber acara

  1. Panggil put-rule perintah untuk membuat aturan yang menentukan pola acara. (Lihat tabel sebelumnya untuk status valid.)

    Perintah contoh berikut digunakan --event-pattern untuk membuat aturan yang disebut “MyPipelineStateChanges” yang memancarkan CloudWatch peristiwa ketika eksekusi pipeline gagal untuk pipeline bernama “MyPipeline.”

    aws events put-rule --name "MyPipelineStateChanges" --event-pattern "{\"source\":[\"aws.codepipeline\"],\"detail-type\":[\"CodePipeline Pipeline Execution State Change\"],\"detail\":{\"pipeline\":[\"myPipeline\"],\"state\":[\"FAILED\"]}}"

  2. Panggil put-targets perintah dan sertakan parameter berikut:

    • --ruleParameter digunakan dengan yang rule_name Anda buat dengan menggunakanput-rule.

    • --targetsParameter digunakan dengan Id daftar target dalam daftar target dan topik ARN Amazon SNS.

    Contoh perintah berikut menentukan bahwa untuk aturan yang dipanggilMyPipelineStateChanges, target Id terdiri dari nomor satu, menunjukkan bahwa dalam daftar target untuk aturan, ini adalah target 1. Perintah sampel juga menentukan contoh ARN untuk topik Amazon SNS.

    aws events put-targets --rule MyPipelineStateChanges --targets Id=1,Arn=arn:aws:sns:us-west-2:11111EXAMPLE:MyNotificationTopic

  3. Tambahkan izin EventBridge untuk menggunakan layanan target yang ditunjuk untuk memanggil notifikasi. Untuk informasi selengkapnya, lihat Menggunakan kebijakan berbasis sumber daya untuk Amazon. EventBridge