Contoh API Gateway Management API menggunakan AWS CLI - AWS Command Line Interface
Tindakan

Dokumentasi ini AWS CLI hanya untuk Versi 1. Untuk dokumentasi yang terkait dengan Versi 2 AWS CLI, lihat Panduan Pengguna Versi 2.

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

Contoh API Gateway Management API menggunakan AWS CLI

Contoh kode berikut menunjukkan cara melakukan tindakan dan mengimplementasikan skenario umum AWS Command Line Interface dengan menggunakan API Gateway Management API.

Tindakan adalah 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 menggunakandelete-connection.

AWS CLI

Untuk menghapus WebSocket koneksi

delete-connectionContoh berikut memutus klien dari WebSocket API yang ditentukan.

aws apigatewaymanagementapi delete-connection \
    --connection-id L0SM9cOFvHcCIhw= \
    --endpoint-url https://aabbccddee.execute-api.us-west-2.amazonaws.com/prod

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Menggunakan perintah @connections di layanan backend Anda di Panduan Pengembang Amazon API Gateway.

Contoh kode berikut menunjukkan cara menggunakanget-connection.

AWS CLI

Untuk mendapatkan informasi tentang WebSocket koneksi

get-connectionContoh berikut menjelaskan koneksi ke WebSocket API yang ditentukan.

aws apigatewaymanagementapi get-connection \
    --connection-id L0SM9cOFvHcCIhw= \
    --endpoint-url https://aabbccddee.execute-api.us-west-2.amazonaws.com/prod

Output:

{
    "ConnectedAt": "2020-04-30T20:10:33.236Z",
    "Identity": {
        "SourceIp": "192.0.2.1"
    },
    "LastActiveAt": "2020-04-30T20:10:42.997Z"
}

Untuk informasi selengkapnya, lihat Menggunakan perintah @connections di layanan backend Anda di Panduan Pengembang Amazon API Gateway.

  • Untuk detail API, lihat GetConnectiondi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakanpost-to-connection.

AWS CLI

Untuk mengirim data ke WebSocket koneksi

post-to-connectionContoh berikut mengirimkan pesan ke klien yang terhubung ke WebSocket API yang ditentukan.

aws apigatewaymanagementapi post-to-connection \
    --connection-id L0SM9cOFvHcCIhw= \
    --data "Hello from API Gateway!" \
    --endpoint-url https://aabbccddee.execute-api.us-west-2.amazonaws.com/prod

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Menggunakan perintah @connections di layanan backend Anda di Panduan Pengembang Amazon API Gateway.