Ada lebih banyak contoh AWS SDK yang tersedia di repo Contoh [SDK AWS Doc](https://github.com/awsdocs/aws-doc-sdk-examples). GitHub
Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
# Contoh Obrolan Amazon IVS menggunakan AWS CLI
Contoh kode berikut menunjukkan cara melakukan tindakan dan menerapkan skenario umum AWS Command Line Interface dengan menggunakan Obrolan IVS Amazon.
*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.
**Topics**
+ [Tindakan](#actions)
## Tindakan
### `create-chat-token`
Contoh kode berikut menunjukkan cara menggunakan`create-chat-token`.
**AWS CLI**
**Untuk membuat token obrolan**
`create-chat-token`Contoh berikut membuat token obrolan terenkripsi yang digunakan untuk membuat WebSocket koneksi individual ke sebuah ruangan. Token berlaku selama satu menit, dan koneksi (sesi) yang dibuat dengan token berlaku untuk durasi yang ditentukan.
```
aws ivschat create-chat-token \
--roomIdentifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6", \
--userId" "11231234" \
--capabilities "SEND_MESSAGE", \
--sessionDurationInMinutes" 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 Obrolan](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) di *Panduan Pengguna Layanan Video Interaktif Amazon*.
+ Untuk detail API, lihat [CreateChatToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/create-chat-token.html)di *Referensi AWS CLI Perintah*.
### `create-logging-configuration`
Contoh kode berikut menunjukkan cara menggunakan`create-logging-configuration`.
**AWS CLI**
**Untuk membuat LoggingConfiguration sumber daya obrolan**
`create-logging-configuration`Contoh berikut menciptakan LoggingConfiguration sumber daya yang memungkinkan klien untuk menyimpan dan merekam pesan terkirim.
```
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 [Memulai Obrolan Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) di *Panduan Pengguna Layanan Video Interaktif Amazon*.
+ Untuk detail API, lihat [CreateLoggingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/create-logging-configuration.html)di *Referensi AWS CLI Perintah*.
### `create-room`
Contoh kode berikut menunjukkan cara menggunakan`create-room`.
**AWS CLI**
**Untuk membuat ruangan**
`create-room`Contoh 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 Obrolan](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) di *Panduan Pengguna Layanan Video Interaktif Amazon*.
+ Untuk detail API, lihat [CreateRoom](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/create-room.html)di *Referensi AWS CLI Perintah*.
### `delete-logging-configuration`
Contoh kode berikut menunjukkan cara menggunakan`delete-logging-configuration`.
**AWS CLI**
**Untuk menghapus LoggingConfiguration sumber daya obrolan**
`delete-logging-configuration`Contoh berikut menghapus LoggingConfiguration sumber 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 [Memulai Obrolan Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) di *Panduan Pengguna Layanan Video Interaktif Amazon*.
+ Untuk detail API, lihat [DeleteLoggingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/delete-logging-configuration.html)di *Referensi AWS CLI Perintah*.
### `delete-message`
Contoh kode berikut menunjukkan cara menggunakan`delete-message`.
**AWS CLI**
**Untuk menghapus pesan dari ruangan tertentu**
`delete-message`Contoh 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 \
--roomIdentifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6" \
--id "ABC123def456" \
--reason "Message contains profanity"
```
Output:
```
{
"id": "12345689012"
}
```
Untuk informasi selengkapnya, lihat [Memulai Obrolan Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) di *Panduan Pengguna Layanan Video Interaktif Amazon*.
+ Untuk detail API, lihat [DeleteMessage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/delete-message.html)di *Referensi AWS CLI Perintah*.
### `delete-room`
Contoh kode berikut menunjukkan cara menggunakan`delete-room`.
**AWS CLI**
**Untuk menghapus ruangan**
`delete-room`Contoh berikut menghapus ruangan yang ditentukan. Klien yang terhubung terputus. Setelah 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 [Memulai Obrolan Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) di *Panduan Pengguna Layanan Video Interaktif Amazon*.
+ Untuk detail API, lihat [DeleteRoom](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/delete-room.html)di *Referensi AWS CLI Perintah*.
### `disconnect-user`
Contoh kode berikut menunjukkan cara menggunakan`disconnect-user`.
**AWS CLI**
**Untuk memutuskan koneksi pengguna dari sebuah ruangan**
`disconnect-user`Contoh berikut memutus semua koneksi untuk pengguna yang ditentukan dari ruangan yang ditentukan. Setelah berhasil ia mengembalikan HTTP 200 dengan badan respons kosong.
```
aws ivschat disconnect-user \
--roomIdentifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6" \
--userId "ABC123def456" \
--reason "Violated terms of service"
```
Perintah ini tidak menghasilkan output.
Untuk informasi selengkapnya, lihat [Memulai Obrolan Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) di *Panduan Pengguna Layanan Video Interaktif Amazon*.
+ Untuk detail API, lihat [DisconnectUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/disconnect-user.html)di *Referensi AWS CLI Perintah*.
### `get-logging-configuration`
Contoh kode berikut menunjukkan cara menggunakan`get-logging-configuration`.
**AWS CLI**
**Untuk mendapatkan informasi tentang sumber LoggingConfiguration daya**
`get-logging-configuration`Contoh 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 [Memulai Obrolan Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) di *Panduan Pengguna Layanan Video Interaktif Amazon*.
+ Untuk detail API, lihat [GetLoggingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/get-logging-configuration.html)di *Referensi AWS CLI Perintah*.
### `get-room`
Contoh kode berikut menunjukkan cara menggunakan`get-room`.
**AWS CLI**
**Untuk mendapatkan ruangan yang ditentukan**
`get-room`Contoh berikut mendapat 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 [Memulai Obrolan Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) di *Panduan Pengguna Layanan Video Interaktif Amazon*.
+ Untuk detail API, lihat [GetRoom](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/get-room.html)di *Referensi AWS CLI Perintah*.
### `list-logging-configurations`
Contoh kode berikut menunjukkan cara menggunakan`list-logging-configurations`.
**AWS CLI**
**Untuk mendapatkan informasi ringkasan tentang semua konfigurasi logging untuk pengguna di AWS wilayah tempat permintaan API diproses**
`list-logging-configurations`Contoh 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 [Memulai Obrolan Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) di *Panduan Pengguna Layanan Video Interaktif Amazon*.
+ Untuk detail API, lihat [ListLoggingConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/list-logging-configurations.html)di *Referensi AWS CLI Perintah*.
### `list-rooms`
Contoh kode berikut menunjukkan cara menggunakan`list-rooms`.
**AWS CLI**
**Untuk mendapatkan informasi ringkasan tentang semua kamar Anda di wilayah saat ini**
`list-rooms`Contoh berikut mendapatkan informasi ringkasan tentang semua kamar di AWS wilayah tempat permintaan diproses. Hasil diurutkan dalam urutan menurun dari 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 [Memulai Obrolan Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) di *Panduan Pengguna Layanan Video Interaktif Amazon*.
+ Untuk detail API, lihat [ListRooms](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/list-rooms.html)di *Referensi AWS CLI Perintah*.
### `list-tags-for-resource`
Contoh kode berikut menunjukkan cara menggunakan`list-tags-for-resource`.
**AWS CLI**
**Untuk mencantumkan semua tag untuk AWS sumber daya (misalnya: Room)**
`list-tags-for-resource`Contoh berikut mencantumkan semua tag untuk ARN sumber daya tertentu (Amazon Resource Name).
```
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](https://docs.aws.amazon.com/ivs/latest/APIReference/Welcome.html) di *Referensi API Layanan Video Interaktif Amazon*.
+ Untuk detail API, lihat [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/list-tags-for-resource.html)di *Referensi AWS CLI Perintah*.
### `send-event`
Contoh kode berikut menunjukkan cara menggunakan`send-event`.
**AWS CLI**
**Untuk mengirim acara ke sebuah ruangan**
`send-event`Contoh berikut mengirimkan acara yang diberikan ke ruangan yang ditentukan.
```
aws ivschat send-event \
--roomIdentifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6" \
--eventName "SystemMessage" \
--attributes \
"msgType"="user-notification", \
"msgText"="This chat room will close in 15 minutes."
```
Output:
```
{
"id": "12345689012"
}
```
Untuk informasi selengkapnya, lihat [Memulai Obrolan Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) di *Panduan Pengguna Layanan Video Interaktif Amazon*.
+ Untuk detail API, lihat [SendEvent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/send-event.html)di *Referensi AWS CLI Perintah*.
### `tag-resource`
Contoh kode berikut menunjukkan cara menggunakan`tag-resource`.
**AWS CLI**
**Untuk menambah atau memperbarui tag untuk AWS sumber daya (misalnya: Room)**
`tag-resource`Contoh berikut menambahkan atau memperbarui tag untuk ARN sumber daya tertentu (Amazon Resource Name). Setelah 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](https://docs.aws.amazon.com/ivs/latest/APIReference/Welcome.html) di *Referensi API Layanan Video Interaktif Amazon*.
+ Untuk detail API, lihat [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/tag-resource.html)di *Referensi AWS CLI Perintah*.
### `untag-resource`
Contoh kode berikut menunjukkan cara menggunakan`untag-resource`.
**AWS CLI**
**Untuk menghapus tag untuk AWS sumber daya (misalnya: Room)**
`untag-resource`Contoh berikut menghapus tag yang ditentukan untuk ARN sumber daya tertentu (Amazon Resource Name). Setelah 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](https://docs.aws.amazon.com/ivs/latest/APIReference/Welcome.html) di *Referensi API Layanan Video Interaktif Amazon*.
+ Untuk detail API, lihat [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/untag-resource.html)di *Referensi AWS CLI Perintah*.
### `update-logging-configuration`
Contoh kode berikut menunjukkan cara menggunakan`update-logging-configuration`.
**AWS CLI**
**Untuk memperbarui konfigurasi logging ruangan**
`update-logging-configuration`Contoh berikut memperbarui LoggingConfiguration sumber 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 [Memulai Obrolan Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) di *Panduan Pengguna Layanan Video Interaktif Amazon*.
+ Untuk detail API, lihat [UpdateLoggingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/update-logging-configuration.html)di *Referensi AWS CLI Perintah*.
### `update-room`
Contoh kode berikut menunjukkan cara menggunakan`update-room`.
**AWS CLI**
**Untuk memperbarui konfigurasi ruangan**
`update-room`Contoh 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 [Memulai Obrolan Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) di *Panduan Pengguna Layanan Video Interaktif Amazon*.
+ Untuk detail API, lihat [UpdateRoom](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/update-room.html)di *Referensi AWS CLI Perintah*.