View a markdown version of this page

AWS CodeStar Contoh notifikasi menggunakan AWS CLI - AWS Command Line Interface
Tindakan

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

AWS CodeStar Contoh notifikasi menggunakan AWS CLI

Contoh kode berikut menunjukkan cara melakukan tindakan dan menerapkan skenario umum dengan menggunakan AWS Command Line Interface dengan AWS CodeStar Notifikasi.

Tindakan merupakan kutipan kode dari program yang lebih besar dan harus dijalankan dalam konteks. Sementara tindakan menunjukkan cara memanggil fungsi layanan individual, Anda dapat melihat tindakan dalam konteks dalam skenario terkait.

Setiap contoh menyertakan tautan ke kode sumber lengkap, di mana Anda dapat menemukan instruksi tentang cara mengatur dan menjalankan kode dalam konteks.

Tindakan

Contoh kode berikut menunjukkan cara menggunakancreate-notification-rule.

AWS CLI

Untuk membuat aturan notifikasi

create-notification-ruleContoh berikut menggunakan file JSON bernama rule.json untuk membuat aturan notifikasi yang diberi nama MyNotificationRule untuk repositori yang dinamai MyDemoRepo di AWS akun yang ditentukan. Pemberitahuan dengan tipe FULL detail dikirim ke target topik Amazon SNS yang ditentukan saat cabang dan tag dibuat.

aws codestar-notifications create-notification-rule \
    --cli-input-json file://rule.json

Isi dari rule.json:

{
    "Name": "MyNotificationRule",
    "EventTypeIds": [
        "codecommit-repository-branches-and-tags-created"
    ],
    "Resource": "arn:aws:codecommit:us-east-1:123456789012:MyDemoRepo",
    "Targets": [
        {
            "TargetType": "SNS",
            "TargetAddress": "arn:aws:sns:us-east-1:123456789012:MyNotificationTopic"
        }
    ],
    "Status": "ENABLED",
    "DetailType": "FULL"
}

Output:

{
    "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE"
}

Untuk informasi selengkapnya, lihat Membuat aturan Pember itahuan di Panduan Pengguna Konsol Alat AWS Pengembang.

Contoh kode berikut menunjukkan cara menggunakandelete-notification-rule.

AWS CLI

Untuk menghapus aturan notifikasi

delete-notification-ruleContoh berikut menghapus aturan notifikasi yang ditentukan.

aws codestar-notifications delete-notification-rule \
    --arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE

Output:

{
    "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE"
}

Untuk informasi selengkapnya, lihat Menghapus Aturan Pem beritahuan di Panduan Pengguna Konsol Alat AWS Pengembang.

Contoh kode berikut menunjukkan cara menggunakandelete-target.

AWS CLI

Untuk menghapus target aturan notifikasi

delete-targetContoh berikut menghapus target yang ditentukan dari semua aturan notifikasi yang dikonfigurasi untuk menggunakannya sebagai target, dan kemudian menghapus target.

aws codestar-notifications  delete-target \
    --target-address arn:aws:sns:us-east-1:123456789012:MyNotificationTopic \
    --force-unsubscribe-all

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Menghapus Target Aturan Pem beritahuan di Panduan Pengguna Konsol Alat AWS Pengembang.

  • Untuk detail API, lihat DeleteTarget di Refer AWS CLI ensi Perintah.

Contoh kode berikut menunjukkan cara menggunakandescribe-notification-rule.

AWS CLI

Untuk mengambil rincian aturan notifikasi

describe-notification-ruleContoh berikut mengambil rincian aturan notifikasi yang ditentukan.

aws codestar-notifications describe-notification-rule \
    --arn arn:aws:codestar-notifications:us-west-2:123456789012:notificationrule/dc82df7a-EXAMPLE

Output:

{
    "LastModifiedTimestamp": 1569199844.857,
    "EventTypes": [
        {
            "ServiceName": "CodeCommit",
            "EventTypeName": "Branches and tags: Created",
            "ResourceType": "Repository",
            "EventTypeId": "codecommit-repository-branches-and-tags-created"
        }
    ],
    "Status": "ENABLED",
    "DetailType": "FULL",
    "Resource": "arn:aws:codecommit:us-west-2:123456789012:MyDemoRepo",
    "Arn": "arn:aws:codestar-notifications:us-west-w:123456789012:notificationrule/dc82df7a-EXAMPLE",
    "Targets": [
        {
            "TargetStatus": "ACTIVE",
            "TargetAddress": "arn:aws:sns:us-west-2:123456789012:MyNotificationTopic",
            "TargetType": "SNS"
        }
    ],
    "Name": "MyNotificationRule",
    "CreatedTimestamp": 1569199844.857,
    "CreatedBy": "arn:aws:iam::123456789012:user/Mary_Major"
}

Untuk informasi selengkapnya, lihat Melihat Aturan Pem beritahuan di Panduan Pengguna Konsol Alat AWS Pengembang.

Contoh kode berikut menunjukkan cara menggunakanlist-event-types.

AWS CLI

Untuk mendapatkan daftar jenis acara untuk aturan notifikasi

list-event-typesContoh berikut mengambil daftar yang difilter dari semua jenis peristiwa notifikasi yang tersedia untuk CodeDeploy aplikasi. Jika sebagai gantinya Anda tidak menggunakan filter, perintah mengembalikan semua jenis peristiwa notifikasi untuk semua jenis sumber daya.

aws codestar-notifications list-event-types \
    --filters Name=SERVICE_NAME,Value=CodeDeploy

Output:

{
    "EventTypes": [
        {
            "EventTypeId": "codedeploy-application-deployment-succeeded",
            "ServiceName": "CodeDeploy",
            "EventTypeName": "Deployment: Succeeded",
            "ResourceType": "Application"
        },
        {
            "EventTypeId": "codedeploy-application-deployment-failed",
            "ServiceName": "CodeDeploy",
            "EventTypeName": "Deployment: Failed",
            "ResourceType": "Application"
        },
        {
            "EventTypeId": "codedeploy-application-deployment-started",
            "ServiceName": "CodeDeploy",
            "EventTypeName": "Deployment: Started",
            "ResourceType": "Application"
        }
    ]
}

Untuk informasi selengkapnya, lihat Membuat Aturan Pember itahuan di Panduan Pengguna Konsol Alat AWS Pengembang.

Contoh kode berikut menunjukkan cara menggunakanlist-notification-rules.

AWS CLI

Untuk mengambil daftar aturan notifikasi

list-notification-rulesContoh berikut mengambil daftar semua aturan notifikasi di Wilayah yang ditentukan AWS .

aws codestar-notifications list-notification-rules --region us-east-1

Output:

{
    "NotificationRules": [
        {
            "Id": "dc82df7a-EXAMPLE",
            "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE"
        },
        {
            "Id": "8d1f0983-EXAMPLE",
            "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/8d1f0983-EXAMPLE"
        }
    ]
}

Untuk informasi selengkapnya, lihat Melihat Aturan Pem beritahuan di Panduan Pengguna Konsol Alat AWS Pengembang.

Contoh kode berikut menunjukkan cara menggunakanlist-tags-for-resource.

AWS CLI

Untuk mendapatkan daftar tag yang dilampirkan pada aturan notifikasi

list-tags-for-resourceContoh berikut mengambil daftar semua tag yang dilampirkan pada aturan notifikasi yang ditentukan. Dalam contoh ini, aturan notifikasi saat ini tidak memiliki tag yang terkait dengannya.

aws codestar-notifications list-tags-for-resource \
    --arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/fe1efd35-EXAMPLE

Output:

{
    "Tags": {}
}

Untuk informasi selengkapnya, lihat Membuat Aturan Pember itahuan di Panduan Pengguna Konsol Alat AWS Pengembang.

Contoh kode berikut menunjukkan cara menggunakanlist-targets.

AWS CLI

Untuk mengambil daftar target aturan notifikasi

list-targetsContoh berikut mengambil daftar semua target aturan notifikasi di Wilayah yang ditentukan AWS .

aws codestar-notifications list-targets \
    --region us-east-1

Output:

{
    "Targets": [
        {
            "TargetAddress": "arn:aws:sns:us-east-1:123456789012:MySNSTopicForNotificationRules",
            "TargetType": "SNS",
            "TargetStatus": "ACTIVE"
        },
        {
            "TargetAddress": "arn:aws:sns:us-east-1:123456789012:MySNSTopicForNotificationsAboutMyDemoRepo",
            "TargetType": "SNS",
            "TargetStatus": "ACTIVE"
        }
    ]
}

Untuk informasi selengkapnya, lihat Melihat Target Aturan Pemberitahuan di Panduan Pengguna Konsol Alat AWS Pengembang.

  • Untuk detail API, lihat ListTargets di Refer AWS CLI ensi Perintah.

Contoh kode berikut menunjukkan cara menggunakansubscribe.

AWS CLI

Untuk menambahkan target ke aturan notifikasi

subscribeContoh berikut menambahkan topik Amazon SNS sebagai target untuk aturan notifikasi yang ditentukan.

aws codestar-notifications subscribe \
    --arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE \
    --target TargetType=SNS,TargetAddress=arn:aws:sns:us-east-1:123456789012:MyNotificationTopic

Output:

{
    "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE"
}

Untuk informasi selengkapnya, lihat Menambahkan atau Menghapus Topik Amazon SNS sebagai Target untuk Aturan Pemberitahuan di Panduan Pengguna Konsol Alat AWS Pengembang.

  • Untuk detail API, lihat Ber langganan di Refer AWS CLI ensi Perintah.

Contoh kode berikut menunjukkan cara menggunakantag-resource.

AWS CLI

Untuk menambahkan tag ke aturan notifikasi

tag-resourceContoh berikut menambahkan tag dengan nama kunci Team dan nilai Li_Juan untuk aturan notifikasi yang ditentukan.

aws codestar-notifications tag-resource \
    --arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/fe1efd35-EXAMPLE \
    --tags Team=Li_Juan

Output:

{
    "Tags": {
        "Team": "Li_Juan"
    }
}

Untuk informasi selengkapnya, lihat Membuat Aturan Pember itahuan di Panduan Pengguna Konsol Alat AWS Pengembang.

  • Untuk detail API, lihat TagResource di Refer AWS CLI ensi Perintah.

Contoh kode berikut menunjukkan cara menggunakanunsubscribe.

AWS CLI

Untuk menghapus target dari aturan notifikasi

unsubscribeContoh berikut menghapus topik Amazon SNS sebagai target dari aturan notifikasi yang ditentukan.

aws codestar-notifications unsubscribe \
    --arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE \
    --target TargetType=SNS,TargetAddress=arn:aws:sns:us-east-1:123456789012:MyNotificationTopic

Output:

{
    "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE"
    "TargetAddress": "arn:aws:sns:us-east-1:123456789012:MyNotificationTopic"
}

Untuk informasi selengkapnya, lihat Menambahkan atau Menghapus Topik Amazon SNS sebagai Target untuk Aturan Pemberitahuan di Panduan Pengguna Konsol Alat AWS Pengembang.

  • Untuk detail API, lihat Berhenti Berhenti Berlangganan di Refer AWS CLI ensi Perintah.

Contoh kode berikut menunjukkan cara menggunakanuntag-resource.

AWS CLI

Untuk menghapus tag dari aturan notifikasi

untag-resourceContoh berikut menghapus tag dengan nama kunci Team dari aturan notifikasi yang ditentukan.

aws codestar-notifications untag-resource \
    --arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/fe1efd35-EXAMPLE \
    --tag-keys Team

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Mengedit Aturan Pem beritahuan di Panduan Pengguna Konsol Alat AWS Pengembang.

Contoh kode berikut menunjukkan cara menggunakanupdate-notification-rule.

AWS CLI

Untuk memperbarui aturan notifikasi

update-notification-ruleContoh berikut memperbarui aturan notifikasi yang diberi nama MyNotificationRule di AWS akun 123456789012 menggunakan file JSON bernamaupdate.json.

aws codestar-notifications update-notification-rule \
    --cli-input-json file://update.json

Isi dari update.json:

{
    "Name": "MyUpdatedNotificationRule",
    "EventTypeIds": [
        "codecommit-repository-branches-and-tags-created"
    ],
    "Resource": "arn:aws:codecommit:us-east-1:123456789012:MyDemoRepo",
    "Targets": [
        {
            "TargetType": "SNS",
            "TargetAddress": "arn:aws:sns:us-east-1:123456789012:MyNotificationTopic"
        }
    ],
    "Status": "ENABLED",
    "DetailType": "FULL"
}

Output:

{
    "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE"
}

Untuk informasi selengkapnya, lihat Mengedit aturan notifikasi di Panduan Pengguna Konsol Alat AWS Pengembang.