Contoh Obrolan Amazon IVS menggunakan AWS CLI

Contoh kode berikut menunjukkan cara melakukan tindakan dan menerapkan skenario umum dengan menggunakan AWS Command Line Interface dengan Amazon IVS Chat.

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.

Topik

Tindakan

Tindakan

Contoh kode berikut menunjukkan cara menggunakancreate-chat-token.

AWS CLI

Cara membuat token obrolan

create-chat-tokenContoh berikut membuat token obrolan terenkripsi yang digunakan untuk membuat WebSocket koneksi individual ke ruangan. Token berlaku selama satu menit, dan koneksi (sesi) yang dibuat dengan token berlaku untuk durasi yang ditentukan.


aws ivschat create-chat-token \
    --room-identifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6", \
    --user-id "11231234" \
    --capabilities "SEND_MESSAGE", \
    --session-duration-in-minutes 30

Output:


{
    "token": "ACEGmnoq#1rstu2...BDFH3vxwy!4hlm!#5",
    "sessionExpirationTime": "2022-03-16T04:44:09+00:00"
    "state": "CREATING",
    "tokenExpirationTime": "2022-03-16T03:45:09+00:00"
}

Untuk informasi selengkapnya, lihat Langkah 3: Mengautentikasi dan Mengotorisasi Klien Obro lan di Panduan Pengguna Layanan Video Interaktif Amazon.

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

Contoh kode berikut menunjukkan cara menggunakancreate-logging-configuration.

AWS CLI

Untuk membuat sumber LoggingConfiguration daya obrolan

create-logging-configurationContoh berikut membuat sumber LoggingConfiguration daya yang memungkinkan klien untuk menyimpan dan merekam pesan yang dikirim.


aws ivschat create-logging-configuration \
    --destination-configuration s3={bucketName=demo-logging-bucket} \
    --name "test-logging-config" \
    --tags "key1=value1, key2=value2"

Output:


{
    "arn": "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ",
    "createTime": "2022-09-14T17:48:00.653000+00:00",
    "destinationConfiguration": {
        "s3": {
            "bucketName": "demo-logging-bucket"
        }
    },
    "id": "ABcdef34ghIJ",
    "name": "test-logging-config",
    "state": "ACTIVE",
    "tags": { "key1" : "value1", "key2" : "value2" },
    "updateTime": "2022-09-14T17:48:01.104000+00:00"
}

Untuk informasi selengkapnya, lihat Mem ulai dengan Amazon IVS Chat di Panduan Pengguna Layanan Video Interaktif Amazon.

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

Contoh kode berikut menunjukkan cara menggunakancreate-room.

AWS CLI

Untuk membuat ruangan

create-roomContoh berikut menciptakan ruangan baru.


aws ivschat create-room \
    --name "test-room-1" \
    --logging-configuration-identifiers "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ" \
    --maximum-message-length 256 \
    --maximum-message-rate-per-second 5

Output:


{
    "arn": "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6",
    "id": "g1H2I3j4k5L6",
    "createTime": "2022-03-16T04:44:09+00:00",
    "loggingConfigurationIdentifiers": ["arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ"],
    "maximumMessageLength": 256,
    "maximumMessageRatePerSecond": 5,
    "name": "test-room-1",
    "tags": {}
    "updateTime": "2022-03-16T07:22:09+00:00"
}

Untuk informasi selengkapnya, lihat Langkah 2: Membuat Ruang Obro lan di Panduan Pengguna Layanan Video Interaktif Amazon.

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

Contoh kode berikut menunjukkan cara menggunakandelete-logging-configuration.

AWS CLI

Untuk menghapus LoggingConfiguration sumber obrolan

delete-logging-configurationContoh berikut menghapus sumber LoggingConfiguration daya untuk ARN yang ditentukan.


aws ivschat delete-logging-configuration \
    --identifier "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ"

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Mem ulai dengan Amazon IVS Chat di Panduan Pengguna Layanan Video Interaktif Amazon.

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

Contoh kode berikut menunjukkan cara menggunakandelete-message.

AWS CLI

Untuk menghapus pesan dari ruang tertentu

delete-messageContoh berikut mengirimkan genap ke ruang yang ditentukan, yang mengarahkan klien untuk menghapus pesan yang ditentukan: yaitu, membatalkan render dari tampilan dan menghapusnya dari riwayat obrolan klien.


aws ivschat delete-message \
    --room-identifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6" \
    --id "ABC123def456" \
    --reason "Message contains profanity"

Output:


{
    "id": "12345689012"
}

Untuk informasi selengkapnya, lihat Mem ulai dengan Amazon IVS Chat di Panduan Pengguna Layanan Video Interaktif Amazon.

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

Contoh kode berikut menunjukkan cara menggunakandelete-room.

AWS CLI

Untuk menghapus ruangan

delete-roomContoh berikut menghapus ruangan yang ditentukan. Klien yang terhubung terputus. Jika berhasil, ia mengembalikan HTTP 204 dengan badan respons kosong.


aws ivschat delete-room \
    --identifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6"

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Mem ulai dengan Amazon IVS Chat di Panduan Pengguna Layanan Video Interaktif Amazon.

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

Contoh kode berikut menunjukkan cara menggunakandisconnect-user.

AWS CLI

Untuk memutuskan koneksi pengguna dari ruangan

disconnect-userContoh berikut memutuskan semua koneksi untuk pengguna yang ditentukan dari ruang yang ditentukan. Jika berhasil, ia mengembalikan HTTP 200 dengan badan respons kosong.


aws ivschat disconnect-user \
    --room-identifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6" \
    --user-id "ABC123def456" \
    --reason "Violated terms of service"

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Mem ulai dengan Amazon IVS Chat di Panduan Pengguna Layanan Video Interaktif Amazon.

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

Contoh kode berikut menunjukkan cara menggunakanget-logging-configuration.

AWS CLI

Untuk mendapatkan informasi tentang sumber LoggingConfiguration daya

get-logging-configurationContoh berikut mendapatkan informasi tentang LoggingConfiguration sumber daya untuk ARN yang ditentukan.


aws ivschat get-logging-configuration \
    --identifier "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ"

Output:


{
    "arn": "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ",
    "createTime": "2022-09-14T17:48:00.653000+00:00",
    "destinationConfiguration": {
        "s3": {
            "bucketName": "demo-logging-bucket"
        }
    },
    "id": "ABcdef34ghIJ",
    "name": "test-logging-config",
    "state": "ACTIVE",
    "tags": { "key1" : "value1", "key2" : "value2" },
    "updateTime": "2022-09-14T17:48:01.104000+00:00"
}

Untuk informasi selengkapnya, lihat Mem ulai dengan Amazon IVS Chat di Panduan Pengguna Layanan Video Interaktif Amazon.

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

Contoh kode berikut menunjukkan cara menggunakanget-room.

AWS CLI

Untuk mendapatkan ruangan yang ditentukan

get-roomContoh berikut mendapatkan informasi tentang ruangan yang ditentukan.


aws ivschat get-room \
    --identifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6"

Output:


{
    "arn": "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6",
    "createTime": "2022-03-16T04:44:09+00:00",
    "id": "g1H2I3j4k5L6",
    "loggingConfigurationIdentifiers": ["arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ"],
    "maximumMessageLength": 256,
    "maximumMessageRatePerSecond": 5,
    "name": "test-room-1",
    "tags": {},
    "updateTime": "2022-03-16T07:22:09+00:00"
}

Untuk informasi selengkapnya, lihat Mem ulai dengan Amazon IVS Chat di Panduan Pengguna Layanan Video Interaktif Amazon.

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

Contoh kode berikut menunjukkan cara menggunakanlist-logging-configurations.

AWS CLI

Untuk mendapatkan informasi ringkasan tentang semua konfigurasi logging untuk pengguna di AWS wilayah tempat permintaan API diproses

list-logging-configurationsContoh berikut mencantumkan informasi tentang semua LoggingConfiguration sumber daya untuk pengguna di AWS wilayah tempat permintaan API diproses.


aws ivschat list-logging-configurations \
    --max-results 2 \
    --next-token ""

Output:


{
    "nextToken": "set-2",
    "loggingConfigurations": [
        {
            "arn": "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ",
            "createTime": "2022-09-14T17:48:00.653000+00:00",
            "destinationConfiguration": {
                "s3": {
                    "bucketName": "demo-logging-bucket"
                }
            },
            "id": "ABcdef34ghIJ",
            "name": "test-logging-config",
            "state": "ACTIVE",
            "tags": { "key1" : "value1", "key2" : "value2" },
            "updateTime": "2022-09-14T17:48:01.104000+00:00"
        }
        ...
    ]
}

Untuk informasi selengkapnya, lihat Mem ulai dengan Amazon IVS Chat di Panduan Pengguna Layanan Video Interaktif Amazon.

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

Contoh kode berikut menunjukkan cara menggunakanlist-rooms.

AWS CLI

Untuk mendapatkan informasi ringkasan tentang semua kamar Anda di wilayah saat ini

list-roomsContoh berikut mendapatkan informasi ringkasan tentang semua kamar di AWS wilayah tempat permintaan diproses. Hasil diurutkan dalam urutan menurun updateTime.


aws ivschat list-rooms \
    --logging-configuration-identifier "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ" \
    --max-results 10 \
    --next-token ""

Output:


{
    "nextToken": "page3",
    "rooms": [
        {
            "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6",
            "createTime": "2022-03-16T04:44:09+00:00",
            "id": "g1H2I3j4k5L6",
            "loggingConfigurationIdentifiers": ["arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ"],
            "name": "test-room-1",
            "tags": {},
            "updateTime": "2022-03-16T07:22:09+00:00"
        }
    ]
}

Untuk informasi selengkapnya, lihat Mem ulai dengan Amazon IVS Chat di Panduan Pengguna Layanan Video Interaktif Amazon.

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

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

AWS CLI

Untuk mencantumkan semua tag untuk AWS sumber daya (misalnya: Ruangan)

list-tags-for-resourceContoh berikut mencantumkan semua tag untuk sumber daya tertentu ARN (Nama Sumber Daya Amazon).


aws ivschat list-tags-for-resource \
    --resource-arn arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6

Output:


{
    "tags":
    {
        "key1": "value1",
        "key2": "value2"
    }
}

Untuk informasi selengkapnya, lihat Menandai di Refer ensi API Layanan Video Interaktif Amazon.

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

Contoh kode berikut menunjukkan cara menggunakansend-event.

AWS CLI

Mengirim acara ke ruangan

send-eventContoh berikut mengirimkan acara yang diberikan ke ruang yang ditentukan.


aws ivschat send-event \
    --room-identifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6" \
    --event-name "SystemMessage" \
    --attributes \
        "msgType"="user-notification", \
        "msgText"="This chat room will close in 15 minutes."

Output:


{
    "id": "12345689012"
}

Untuk informasi selengkapnya, lihat Mem ulai dengan Amazon IVS Chat di Panduan Pengguna Layanan Video Interaktif Amazon.

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

Contoh kode berikut menunjukkan cara menggunakantag-resource.

AWS CLI

Untuk menambahkan atau memperbarui tag untuk AWS sumber daya (misalnya: Ruang)

tag-resourceContoh berikut menambahkan atau memperbarui tag untuk sumber daya tertentu ARN (Nama Sumber Daya Amazon). Jika berhasil, ia mengembalikan HTTP 200 dengan badan respons kosong.


aws ivschat tag-resource \
    --resource-arn arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6 \
    --tags "tagkey1=tagkeyvalue1, tagkey2=tagkeyvalue2"

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Menandai di Refer ensi API Layanan Video Interaktif Amazon.

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

Contoh kode berikut menunjukkan cara menggunakanuntag-resource.

AWS CLI

Untuk menghapus tag untuk AWS sumber daya (misalnya: Ruangan)

untag-resourceContoh berikut menghapus tag yang ditentukan untuk sumber daya tertentu ARN (Nama Sumber Daya Amazon). Jika berhasil, ia mengembalikan HTTP 200 dengan badan respons kosong.


aws ivschat untag-resource \
    --resource-arn arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6 \
    --tag-keys "tagkey1, tagkey2"

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Menandai di Refer ensi API Layanan Video Interaktif Amazon.

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

Contoh kode berikut menunjukkan cara menggunakanupdate-logging-configuration.

AWS CLI

Untuk memperbarui konfigurasi pencatatan ruangan

update-logging-configurationContoh berikut memperbarui sumber LoggingConfiguration daya dengan data yang diberikan.


aws ivschat update-logging-configuration \
    --destination-configuration s3={bucketName=demo-logging-bucket} \
    --identifier "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ" \
    --name "test-logging-config"

Output:


{
    "arn": "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ",
    "createTime": "2022-09-14T17:48:00.653000+00:00",
    "destinationConfiguration": {
        "s3": {
            "bucketName": "demo-logging-bucket"
        }
    },
    "id": "ABcdef34ghIJ",
    "name": "test-logging-config",
    "state": "ACTIVE",
    "tags": { "key1" : "value1", "key2" : "value2" },
    "updateTime": "2022-09-14T17:48:01.104000+00:00"
}

Untuk informasi selengkapnya, lihat Mem ulai dengan Amazon IVS Chat di Panduan Pengguna Layanan Video Interaktif Amazon.

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

Contoh kode berikut menunjukkan cara menggunakanupdate-room.

AWS CLI

Untuk memperbarui konfigurasi ruangan

update-roomContoh berikut memperbarui konfigurasi ruangan yang ditentukan dengan data yang diberikan.


aws ivschat update-room \
    --identifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6" \
    --logging-configuration-identifiers "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ" \
    --name "chat-room-a" \
    --maximum-message-length 256 \
    --maximum-message-rate-per-second 5

Output:


{
    "arn": "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6",
    "createTime": "2022-03-16T04:44:09+00:00",
    "id": "g1H2I3j4k5L6",
    "loggingConfigurationIdentifiers": ["arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ"],
    "maximumMessageLength": 256,
    "maximumMessageRatePerSecond": 5,
    "name": "chat-room-a",
    "tags": {},
    "updateTime": "2022-03-16T07:22:09+00:00"
}

Untuk informasi selengkapnya, lihat Mem ulai dengan Amazon IVS Chat di Panduan Pengguna Layanan Video Interaktif Amazon.

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

Awas Javascript dinonaktifkan atau tidak tersedia di browser Anda.

Untuk menggunakan Dokumentasi AWS, Javascript harus diaktifkan. Lihat halaman Bantuan browser Anda untuk petunjuk.

Konvensi Dokumen

Amazon IVS

Amazon IVS Streaming Real-Time