文件 AWS 開發套件範例 GitHub 儲存庫中有更多可用的 [AWS SDK 範例](https://github.com/awsdocs/aws-doc-sdk-examples)。

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# 使用 的 API Gateway Management API 範例 AWS CLI
<a name="cli_2_apigatewaymanagementapi_code_examples"></a>

下列程式碼範例示範如何使用 AWS Command Line Interface 搭配 API Gateway Management API 來執行動作和實作常見案例。

*Actions* 是大型程式的程式碼摘錄，必須在內容中執行。雖然動作會告訴您如何呼叫個別服務函數，但您可以在其相關情境中查看內容中的動作。

每個範例均包含完整原始碼的連結，您可在連結中找到如何設定和執行內容中程式碼的相關指示。

**Topics**
+ [動作](#actions)

## 動作
<a name="actions"></a>

### `delete-connection`
<a name="apigatewaymanagementapi_DeleteConnection_cli_2_topic"></a>

以下程式碼範例顯示如何使用 `delete-connection`。

**AWS CLI**  
**刪除 WebSocket 連線**  
下列 `delete-connection` 範例中斷用戶端與指定之 WebSocket API 的連線。  

```
aws apigatewaymanagementapi delete-connection \
    --connection-id L0SM9cOFvHcCIhw= \
    --endpoint-url https://aabbccddee.execute-api.us-west-2.amazonaws.com/prod
```
此命令不會產生輸出。  
如需詳細資訊，請參閱《*Amazon API Gateway 開發人員指南*》中的[在後端服務中使用 @connections 命令](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewaymanagementapi/delete-connection.html)。

### `get-connection`
<a name="apigatewaymanagementapi_GetConnection_cli_2_topic"></a>

以下程式碼範例顯示如何使用 `get-connection`。

**AWS CLI**  
**取得 WebSocket 連線的相關資訊**  
下列 `get-connection` 範例描述與指定之 WebSocket API 的連線。  

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

```
{
    "ConnectedAt": "2020-04-30T20:10:33.236Z",
    "Identity": {
        "SourceIp": "192.0.2.1"
    },
    "LastActiveAt": "2020-04-30T20:10:42.997Z"
}
```
如需詳細資訊，請參閱《*Amazon API Gateway 開發人員指南*》中的[在後端服務中使用 @connections 命令](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewaymanagementapi/get-connection.html)。

### `post-to-connection`
<a name="apigatewaymanagementapi_PostToConnection_cli_2_topic"></a>

以下程式碼範例顯示如何使用 `post-to-connection`。

**AWS CLI**  
**將資料傳送至 WebSocket 連線**  
下列 `post-to-connection` 範例會將訊息傳送至與指定 WebSocket API 連線的用戶端。  

```
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
```
此命令不會產生輸出。  
如需詳細資訊，請參閱《*Amazon API Gateway 開發人員指南*》中的[在後端服務中使用 @connections 命令](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [PostToConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewaymanagementapi/post-to-connection.html)。