本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
# 使用 的 Amazon IVS 即時串流範例 AWS CLI
下列程式碼範例示範如何使用 AWS Command Line Interface 搭配 Amazon IVS 即時串流來執行動作和實作常見案例。
*Actions* 是大型程式的程式碼摘錄，必須在內容中執行。雖然動作會告訴您如何呼叫個別服務函數，但您可以在其相關情境中查看內容中的動作。
每個範例均包含完整原始碼的連結，您可在連結中找到如何設定和執行內容中程式碼的相關指示。
**Topics**
+ [動作](#actions)
## 動作
### `create-encoder-configuration`
以下程式碼範例顯示如何使用 `create-encoder-configuration`。
**AWS CLI**
**建立合成編碼器組態**
下列 `create-encoder-configuration` 範例會建立具有指定屬性的合成編碼器組態。
```
aws ivs-realtime create-encoder-configuration \
--name test-ec --video bitrate=3500000,framerate=30.0,height=1080,width=1920
```
輸出：
```
{
"encoderConfiguration": {
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef",
"name": "test-ec",
"tags": {},
"video": {
"bitrate": 3500000,
"framerate": 30,
"height": 1080,
"width": 1920
}
}
}
```
如需詳細資訊，請參閱《Amazon 互動式影片服務使用者指南》**中的[在 Amazon IVS 串流啟用多個主機](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreateEncoderConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/create-encoder-configuration.html)。
### `create-ingest-configuration`
以下程式碼範例顯示如何使用 `create-ingest-configuration`。
**AWS CLI**
**建立擷取組態**
下列 `create-ingest-configuration` 範例會使用 RTMPS 通訊協定建立擷取組態。
```
aws ivs-realtime create-ingest-configuration \
--name ingest1 \
--ingest-protocol rtmps
```
輸出：
```
{
"ingestConfiguration": {
"name": "ingest1",
"arn": "arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234",
"ingestProtocol": "RTMPS",
"streamKey": "rt_123456789012_us-west-2_AbCdEfGh1234_abcd1234efgh5678ijkl9012MNOP34",
"stageArn": "",
"participantId": "xyZ654abC321",
"state": "INACTIVE",
"userId": "",
"tags": {}
}
}
```
如需詳細資訊，請參閱《Amazon 互動式影片服務使用者指南》**中的 [IVS 串流擷取 \$1 即時串流](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreateIngestConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/create-ingest-configuration.html)。
### `create-participant-token`
以下程式碼範例顯示如何使用 `create-participant-token`。
**AWS CLI**
**建立階段參與者權杖**
下列 `create-participant-token` 範例會為指定的階段建立參與者權杖。
```
aws ivs-realtime create-participant-token \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--user-id bob
```
輸出：
```
{
"participantToken": {
"expirationTime": "2023-03-07T09:47:43+00:00",
"participantId": "ABCDEfghij01234KLMN6789",
"token": "abcd1234defg5678"
}
}
```
如需詳細資訊，請參閱《Amazon 互動式影片服務使用者指南》**中的[在 Amazon IVS 串流啟用多個主機](https://docs.aws.amazon.com/ivs/latest/userguide/multiple-hosts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreateParticipantToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/create-participant-token.html)。
### `create-stage`
以下程式碼範例顯示如何使用 `create-stage`。
**AWS CLI**
**範例 1：建立階段**
下列 `create-stage` 範例會為指定的使用者建立階段和階段參與者權杖。
```
aws ivs-realtime create-stage \
--name stage1 \
--participant-token-configurations userId=alice
```
輸出：
```
{
"participantTokens": [
{
"participantId": "ABCDEfghij01234KLMN5678",
"token": "a1b2c3d4567890ab",
"userId": "alice"
}
],
"stage": {
"activeSessionId": "st-a1b2c3d4e5f6g",
"arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
"autoParticipantRecordingConfiguration": {
"storageConfigurationArn": "",
"mediaTypes": [
"AUDIO_VIDEO"
],
"thumbnailConfiguration": {
"targetIntervalSeconds": 60,
"storage": [
"SEQUENTIAL"
],
"recordingMode": "DISABLED"
},
"recordingReconnectWindowSeconds": 0,
"hlsConfiguration": {
"targetSegmentDurationSeconds": 6
},
"recordParticipantReplicas": true
},
"endpoints": {
"events": "wss://global.events.live-video.net",
"rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/",
"rtmps": "rtmps://9x0y8z7s6t5u.global-contribute-staging.live-video.net:443/app/",
"whip": "https://9x0y8z7s6t5u.global-bm.whip.live-video.net"
},
"name": "stage1",
"tags": {}
}
}
```
如需詳細資訊，請參閱《*Amazon IVS 低延遲串流功能使用者指南*》中的在 [Amazon IVS 串流啟用多個主機](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)。
**範例 2：建立階段並設定個別參與者錄音**
下列 `create-stage` 範例會建立階段並設定個別參與者記錄。
```
aws ivs-realtime create-stage \
--name stage1 \
--auto-participant-recording-configuration '{"mediaTypes": ["AUDIO_VIDEO"],"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh", "recordingReconnectWindowSeconds": 100, \
"hlsConfiguration": {"targetSegmentDurationSeconds": 5}}'
```
輸出：
```
{
"stage": {
"activeSessionId": "st-a1b2c3d4e5f6g",
"arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
"autoParticipantRecordingConfiguration": {
"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh"
"mediaTypes": [
"AUDIO_VIDEO"
],
"thumbnailConfiguration": {
"targetIntervalSeconds": 60,
"storage": [
"SEQUENTIAL"
],
"recordingMode": "DISABLED"
},
"recordingReconnectWindowSeconds": 100,
"hlsConfiguration": {
"targetSegmentDurationSeconds": 5
},
"recordParticipantReplicas": true
},
"endpoints": {
"events": "wss://global.events.live-video.net",
"rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/",
"rtmps": "rtmps://9x0y8z7s6t5u.global-contribute-staging.live-video.net:443/app/",
"whip": "https://9x0y8z7s6t5u.global-bm.whip.live-video.net"
},
"name": "stage1",
"tags": {}
}
}
```
如需詳細資訊，請參閱《*Amazon IVS 低延遲串流功能使用者指南*》中的在 [Amazon IVS 串流啟用多個主機](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)。
**範例 3：建立階段並設定啟用縮圖錄製的個別參與者錄製**
下列 `create-stage` 範例會建立階段，與設定啟用縮圖記錄的個別參與者記錄。
```
aws ivs-realtime create-stage \
--name stage1 \
--auto-participant-recording-configuration '{"mediaTypes": ["AUDIO_VIDEO"],"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh", \
"thumbnailConfiguration": {"recordingMode": "INTERVAL","storage": ["SEQUENTIAL"],"targetIntervalSeconds": 60}}'
```
輸出：
```
{
"stage": {
"activeSessionId": "st-a1b2c3d4e5f6g",
"arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
"autoParticipantRecordingConfiguration": {
"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh",
"mediaTypes": [
"AUDIO_VIDEO"
],
"thumbnailConfiguration": {
"targetIntervalSeconds": 60,
"storage": [
"SEQUENTIAL"
],
"recordingMode": "INTERVAL"
},
"recordingReconnectWindowSeconds": 0,
"hlsConfiguration": {
"targetSegmentDurationSeconds": 6
},
"recordParticipantReplicas": true
},
"endpoints": {
"events": "wss://global.events.live-video.net",
"rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/",
"rtmps": "rtmps://9x0y8z7s6t5u.global-contribute-staging.live-video.net:443/app/",
"whip": "https://9x0y8z7s6t5u.global-bm.whip.live-video.net"
},
"name": "stage1",
"tags": {}
}
}
```
如需詳細資訊，請參閱《*Amazon IVS 低延遲串流功能使用者指南*》中的在 [Amazon IVS 串流啟用多個主機](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreateStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/create-stage.html)。
### `create-storage-configuration`
以下程式碼範例顯示如何使用 `create-storage-configuration`。
**AWS CLI**
**建立合成儲存組態**
下列 `create-storage-configuration` 範例會建立具有指定屬性的合成儲存組態。
```
aws ivs-realtime create-storage-configuration \
--name "test-sc" --s3 "bucketName=amzn-s3-demo-bucket"
```
輸出：
```
{
"storageConfiguration": {
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/ABabCDcdEFef",
"name": "test-sc",
"s3": {
"bucketName": "amzn-s3-demo-bucket"
},
"tags": {}
}
}
```
如需詳細資訊，請參閱《Amazon 互動式影片服務使用者指南》**中的[在 Amazon IVS 串流啟用多個主機](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreateStorageConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/create-storage-configuration.html)。
### `delete-encoder-configuration`
以下程式碼範例顯示如何使用 `delete-encoder-configuration`。
**AWS CLI**
**刪除合成編碼器組態**
以下 `delete-encoder-configuration` 刪除指定 ARN (Amazon Resource Name) 指定的合成編碼器組態。
```
aws ivs-realtime delete-encoder-configuration \
--arn "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
```
此命令不會產生輸出。
如需詳細資訊，請參閱《Amazon 互動式影片服務使用者指南》**中的[在 Amazon IVS 串流啟用多個主機](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteEncoderConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/delete-encoder-configuration.html)。
### `delete-ingest-configuration`
以下程式碼範例顯示如何使用 `delete-ingest-configuration`。
**AWS CLI**
**範例 1：刪除非作用中的擷取組態**
下列 `delete-ingest-configuration` 範例會刪除指定擷取組態 ARN (Amazon Resource Name) 的非作用中擷取組態。
```
aws ivs-realtime delete-ingest-configuration \
--arn arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234
```
此命令不會產生輸出。
如需詳細資訊，請參閱《Amazon 互動式影片服務使用者指南》**中的 [IVS 串流擷取 \$1 即時串流](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html)。
**範例 2：強制刪除作用中的擷取組態**
下列 `delete-ingest-configuration` 範例會強制刪除指定擷取組態 ARN (Amazon Resource Name) 的作用中擷取組態。
```
aws ivs-realtime delete-ingest-configuration \
--arn arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234 \
--force
```
此命令不會產生輸出。
如需詳細資訊，請參閱《Amazon 互動式影片服務使用者指南》**中的 [IVS 串流擷取 \$1 即時串流](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteIngestConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/delete-ingest-configuration.html)。
### `delete-public-key`
以下程式碼範例顯示如何使用 `delete-public-key`。
**AWS CLI**
**刪除公有金鑰**
以下 `delete-public-key` 會刪除指定的公有金鑰。
```
aws ivs-realtime delete-public-key \
--arn arn:aws:ivs:us-west-2:123456789012:public-key/abcdABC1efg2
```
此命令不會產生輸出。
如需詳細資訊，請參閱《Amazon IVS 即時串流功能使用者指南》**中的[分配參與者權杖](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeletePublicKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/delete-public-key.html)。
### `delete-stage`
以下程式碼範例顯示如何使用 `delete-stage`。
**AWS CLI**
**刪除階段**
以下 `delete-stage` 範例會刪除指定的階段。
```
aws ivs-realtime delete-stage \
--arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh
```
此命令不會產生輸出。
如需詳細資訊，請參閱《Amazon 互動式影片服務使用者指南》**中的[在 Amazon IVS 串流啟用多個主機](https://docs.aws.amazon.com/ivs/latest/userguide/multiple-hosts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/delete-stage.html)。
### `delete-storage-configuration`
以下程式碼範例顯示如何使用 `delete-storage-configuration`。
**AWS CLI**
**刪除合成儲存組態**
以下 `delete-storage-configuration` 刪除指定 ARN (Amazon Resource Name) 指定的合成儲存組態。
```
aws ivs-realtime delete-storage-configuration \
--arn "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/ABabCDcdEFef"
```
此命令不會產生輸出。
如需詳細資訊，請參閱《Amazon 互動式影片服務使用者指南》**中的[在 Amazon IVS 串流啟用多個主機](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteStorageConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/delete-storage-configuration.html)。
### `disconnect-participant`
以下程式碼範例顯示如何使用 `disconnect-participant`。
**AWS CLI**
**中斷與階段參與者的連線**
下列 `disconnect-participant` 範例會中斷與指定參與者與指定階段的連線。
```
aws ivs-realtime disconnect-participant \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--participant-id ABCDEfghij01234KLMN5678
```
此命令不會產生輸出。
如需詳細資訊，請參閱《Amazon 互動式影片服務使用者指南》**中的[在 Amazon IVS 串流啟用多個主機](https://docs.aws.amazon.com/ivs/latest/userguide/multiple-hosts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DisconnectParticipant](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/disconnect-participant.html)。
### `get-composition`
以下程式碼範例顯示如何使用 `get-composition`。
**AWS CLI**
**範例 1：使用預設配置設定取得合成**
下列 `get-composition` 範例取得指定 ARN (Amazon Resource Name) 的合成。
```
aws ivs-realtime get-composition \
--arn "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh"
```
輸出：
```
{
"composition": {
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh",
"destinations": [
{
"configuration": {
"channel": {
"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg",
"encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
},
"name": ""
},
"id": "AabBCcdDEefF",
"startTime": "2023-10-16T23:26:00+00:00",
"state": "ACTIVE"
},
{
"configuration": {
"name": "",
"s3": {
"encoderConfigurationArns": [
"arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
],
"recordingConfiguration": {
"format": "HLS",
"hlsConfiguration": {
"targetSegmentDurationSeconds": 2
}
},
"storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE",
}
},
"detail": {
"s3": {
"recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite"
}
},
"id": "GHFabcgefABC",
"startTime": "2023-10-16T23:26:00+00:00",
"state": "STARTING"
}
],
"layout": {
"grid": {
"featuredParticipantAttribute": "",
"gridGap": 2,
"omitStoppedVideo": false,
"participantOrderAttribute": "",
"videoAspectRatio": "VIDEO",
"videoFillMode": ""
}
},
"stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd",
"startTime": "2023-10-16T23:24:00+00:00",
"state": "ACTIVE",
"tags": {}
}
}
```
如需詳細資訊，請參閱《*Amazon Interactive Video Service 使用者指南*》中的 [IVS 複合錄製 \$1 即時串流](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html)。
**範例 2：使用 PiP 配置取得合成**
下列 `get-composition` 範例取得指定之 ARN (Amazon Resource Name) 的合成，其使用的是 PiP 配置。
```
aws ivs-realtime get-composition \
--arn "arn:aws:ivs:ap-northeast-1:123456789012:composition/wxyzWXYZpqrs"
```
輸出：
```
{
"composition": {
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/wxyzWXYZpqrs",
"destinations": [
{
"configuration": {
"channel": {
"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg",
"encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
},
"name": ""
},
"id": "AabBCcdDEefF",
"startTime": "2023-10-16T23:26:00+00:00",
"state": "ACTIVE"
},
{
"configuration": {
"name": "",
"s3": {
"encoderConfigurationArns": [
"arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
],
"recordingConfiguration": {
"format": "HLS",
"hlsConfiguration": {
"targetSegmentDurationSeconds": 2
}
},
"storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"
}
},
"detail": {
"s3": {
"recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite"
}
},
"id": "GHFabcgefABC",
"startTime": "2023-10-16T23:26:00+00:00",
"state": "STARTING"
}
],
"layout": {
"pip": {
"featuredParticipantAttribute": "abcdefg",
"gridGap": 0,
"omitStoppedVideo": false,
"participantOrderAttribute": "",
"pipBehavior": "STATIC",
"pipOffset": 0,
"pipParticipantAttribute": "",
"pipPosition": "BOTTOM_RIGHT",
"videoFillMode": "COVER"
}
},
"stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd",
"startTime": "2023-10-16T23:24:00+00:00",
"state": "ACTIVE",
"tags": {}
}
}
```
如需詳細資訊，請參閱《*Amazon Interactive Video Service 使用者指南*》中的 [IVS 複合錄製 \$1 即時串流](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html)。
**範例 3：取得已啟用縮圖錄製的合成**
下列 `get-composition` 範例取得指定 ARN (Amazon Resource Name) 的合成，該 ARN 已使用預設設定啟用縮圖錄製。
```
aws ivs-realtime get-composition \
--arn "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh"
```
輸出：
```
{
"composition": {
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh",
"destinations": [
{
"configuration": {
"channel": {
"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg",
"encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
},
"name": ""
},
"id": "AabBCcdDEefF",
"startTime": "2023-10-16T23:26:00+00:00",
"state": "ACTIVE"
},
{
"configuration": {
"name": "",
"s3": {
"encoderConfigurationArns": [
"arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
],
"recordingConfiguration": {
"format": "HLS",
"hlsConfiguration": {
"targetSegmentDurationSeconds": 2
}
},
"storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE",
"thumbnailConfigurations": [
{
"targetIntervalSeconds": 60,
"storage": [
"SEQUENTIAL"
],
}
]
}
},
"detail": {
"s3": {
"recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite"
}
},
"id": "GHFabcgefABC",
"startTime": "2023-10-16T23:26:00+00:00",
"state": "STARTING"
}
],
"layout": {
"grid": {
"featuredParticipantAttribute": ""
"gridGap": 2,
"omitStoppedVideo": false,
"participantOrderAttribute": "",
"videoAspectRatio": "VIDEO",
"videoFillMode": "" }
},
"stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd",
"startTime": "2023-10-16T23:24:00+00:00",
"state": "ACTIVE",
"tags": {}
}
}
```
如需詳細資訊，請參閱《*Amazon Interactive Video Service 使用者指南*》中的 [IVS 複合錄製 \$1 即時串流](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetComposition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-composition.html)。
### `get-encoder-configuration`
以下程式碼範例顯示如何使用 `get-encoder-configuration`。
**AWS CLI**
**取得合成編碼器組態**
以下 `get-encoder-configuration` 範例會取得指定 ARN (Amazon Resource Name) 指定的合成編碼器組態。
```
aws ivs-realtime get-encoder-configuration \
--arn "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/abcdABCDefgh"
```
輸出：
```
{
"encoderConfiguration": {
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/abcdABCDefgh",
"name": "test-ec",
"tags": {},
"video": {
"bitrate": 3500000,
"framerate": 30,
"height": 1080,
"width": 1920
}
}
}
```
如需詳細資訊，請參閱《Amazon 互動式影片服務使用者指南》**中的[在 Amazon IVS 串流啟用多個主機](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetEncoderConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-encoder-configuration.html)。
### `get-ingest-configuration`
以下程式碼範例顯示如何使用 `get-ingest-configuration`。
**AWS CLI**
**取得擷取組態資訊**
下列 `get-ingest-configuration` 範例會取得指定擷取組態 ARN (Amazon Resource Name) 的擷取組態。
```
aws ivs-realtime get-ingest-configuration \
--arn arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234
```
輸出：
```
{
"ingestConfiguration": {
"name": "ingest1",
"arn": "arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234",
"ingestProtocol": "RTMPS",
"streamKey": "rt_123456789012_us-west-2_AbCdEfGh1234_abcd1234efgh5678ijkl9012MNOP34",
"stageArn": "",
"participantId": "xyZ654abC321",
"state": "INACTIVE",
"userId": "",
"tags": {}
}
}
```
如需詳細資訊，請參閱《Amazon 互動式影片服務使用者指南》**中的 [IVS 串流擷取 \$1 即時串流](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetIngestConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-ingest-configuration.html)。
### `get-participant`
以下程式碼範例顯示如何使用 `get-participant`。
**AWS CLI**
**範例 1：取得階段參與者**
下列 `get-participant` 範例取得指定階段 ARN (Amazon Resource Name) 中指定參與者 ID 和工作階段 ID 的階段參與者。
```
aws ivs-realtime get-participant \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--session-id st-a1b2c3d4e5f6g \
--participant-id abCDEf12GHIj
```
輸出：
```
{
"participant": {
"browserName": "Google Chrome",
"browserVersion": "116",
"firstJoinTime": "2023-04-26T20:30:34+00:00",
"ispName": "Comcast",
"osName": "Microsoft Windows 10 Pro",
"osVersion": "10.0.19044",
"participantId": "abCDEf12GHIj",
"published": true,
"recordingS3BucketName": "bucket-name",
"recordingS3Prefix": "abcdABCDefgh/st-a1b2c3d4e5f6g/abCDEf12GHIj/1234567890",
"recordingState": "ACTIVE",
"sdkVersion": "",
"state": "CONNECTED",
"userId": ""
}
}
```
如需詳細資訊，請參閱《*Amazon IVS 低延遲串流功能使用者指南*》中的在 [Amazon IVS 串流啟用多個主機](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)。
**範例 2：取得已複寫至另一個階段的階段參與者**
下列 `get-participant` 範例會在也將參與者複寫至另一個階段時，取得指定階段 ARN (Amazon Resource Name) 中指定參與者 ID 和工作階段 ID 的階段參與者。
```
aws ivs-realtime get-participant \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--session-id st-a1b2c3d4e5f6g \
--participant-id abCDEf12GHIj
```
輸出：
```
{
"participant": {
"browserName": "Google Chrome",
"browserVersion": "116",
"firstJoinTime": "2023-04-26T20:30:34+00:00",
"ispName": "Comcast",
"osName": "Microsoft Windows 10 Pro",
"osVersion": "10.0.19044",
"participantId": "abCDEf12GHIj",
"published": true,
"recordingS3BucketName": "bucket-name",
"recordingS3Prefix": "abcdABCDefgh/st-a1b2c3d4e5f6g/abCDEf12GHIj/1234567890",
"recordingState": "ACTIVE",
"replicationState": "ACTIVE",
"replicationType": "SOURCE",
"sdkVersion": "",
"state": "CONNECTED",
"userId": ""
}
}
```
如需詳細資訊，請參閱《*Amazon IVS 低延遲串流功能使用者指南*》中的在 [Amazon IVS 串流啟用多個主機](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)。
**範例 3：取得已從另一個階段複寫的階段參與者**
下列 `get-participant` 範例會在從另一個階段複寫參與者時，取得指定階段 ARN (Amazon Resource Name) 中指定參與者 ID 和工作階段 ID 的階段參與者。
```
aws ivs-realtime get-participant \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--session-id st-a1b2c3d4e5f6g \
--participant-id abCDEf12GHIj
```
輸出：
```
{
"participant": {
"browserName": "Google Chrome",
"browserVersion": "116",
"firstJoinTime": "2023-04-26T20:30:34+00:00",
"ispName": "Comcast",
"osName": "Microsoft Windows 10 Pro",
"osVersion": "10.0.19044",
"participantId": "abCDEf12GHIj",
"published": true,
"recordingS3BucketName": "bucket-name",
"recordingS3Prefix": "abcdABCDefgh/st-a1b2c3d4e5f6g/abCDEf12GHIj/1234567890",
"recordingState": "ACTIVE",
"replicationState": "ACTIVE",
"replicationType": "REPLICA",
"sdkVersion": "",
"state": "CONNECTED",
"userId": ""
}
}
```
如需詳細資訊，請參閱《*Amazon IVS 低延遲串流功能使用者指南*》中的在 [Amazon IVS 串流啟用多個主機](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)。
+ 如需 API 詳細資訊，請參閱 *AWS CLI Command Reference* 中的 [GetParticipant](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-participant.html)。
### `get-public-key`
以下程式碼範例顯示如何使用 `get-public-key`。
**AWS CLI**
**取得用來簽署階段參與者權杖的現有公有金鑰**
下列 `get-public-key` 範例會取得由提供的 ARN 指定的公有金鑰，用於簽署階段參與者權杖。
```
aws ivs-realtime get-public-key \
--arn arn:aws:ivs:us-west-2:123456789012:public-key/abcdABC1efg2
```
輸出：
```
{
"publicKey": {
"arn": "arn:aws:ivs:us-west-2:123456789012:public-key/abcdABC1efg2",
"name": "",
"publicKeyMaterial": "-----BEGIN PUBLIC KEY-----\nMHYwEAYHKoZIzj0CAQYFK4EEACIDYgAEqVWUtqs6EktQMR1sCYmEzGvRwtaycI16\n9pmzcpiWu/uhNStGlteJ5odRfRwVkoQUMnSZXTCcbn9bBTTmiWo4mJcFOOAzsthH\n0UAb8NdD4tUE0At4a9hYP9IETEXAMPLE\n-----END PUBLIC KEY-----",
"fingerprint": "12:a3:44:56:bc:7d:e8:9f:10:2g:34:hi:56:78:90:12",
"tags": {}
}
}
```
如需詳細資訊，請參閱《Amazon IVS 即時串流功能使用者指南》**中的[分配參與者權杖](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetPublicKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-public-key.html)。
### `get-stage-session`
以下程式碼範例顯示如何使用 `get-stage-session`。
**AWS CLI**
**取得階段工作階段**
下列 `get-stage-session` 範例取得指定階段 ARN (Amazon Resource Name) 之指定工作階段 ID 的階段工作階段。
```
aws ivs-realtime get-stage-session \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--session-id st-a1b2c3d4e5f6g
```
輸出：
```
{
"stageSession": {
"endTime": "2023-04-26T20:36:29+00:00",
"sessionId": "st-a1b2c3d4e5f6g",
"startTime": "2023-04-26T20:30:29.602000+00:00"
}
}
```
如需詳細資訊，請參閱《Amazon 互動式影片服務使用者指南》**中的[在 Amazon IVS 串流啟用多個主機](https://docs.aws.amazon.com/ivs/latest/userguide/multiple-hosts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetStageSession](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-stage-session.html)。
### `get-stage`
以下程式碼範例顯示如何使用 `get-stage`。
**AWS CLI**
**取得階段的組態資訊**
下列 `get-stage` 範例取得指定階段 ARN (Amazon Resource Name) 的階段組態。
```
aws ivs-realtime get-stage \
--arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh
```
輸出：
```
{
"stage": {
"activeSessionId": "st-a1b2c3d4e5f6g",
"arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
"autoParticipantRecordingConfiguration": {
"storageConfigurationArn": "",
"mediaTypes": [
"AUDIO_VIDEO"
],
"thumbnailConfiguration": {
"targetIntervalSeconds": 60,
"storage": [
"SEQUENTIAL"
],
"recordingMode": "DISABLED"
},
"recordingReconnectWindowSeconds": 0,
"hlsConfiguration": {
"targetSegmentDurationSeconds": 6
},
"recordParticipantReplicas": true
},
"endpoints": {
"events": "wss://global.events.live-video.net",
"rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/",
"rtmps": "rtmps://9x0y8z7s6t5u.global-contribute-staging.live-video.net:443/app/",
"whip": "https://9x0y8z7s6t5u.global-bm.whip.live-video.net"
},
"name": "test",
"tags": {}
}
}
```
如需詳細資訊，請參閱《*Amazon IVS 低延遲串流功能使用者指南*》中的在 [Amazon IVS 串流啟用多個主機](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-stage.html)。
### `get-storage-configuration`
以下程式碼範例顯示如何使用 `get-storage-configuration`。
**AWS CLI**
**取得合成儲存組態**
以下 `get-storage-configuration` 範例會取得指定 ARN (Amazon Resource Name) 指定的合成儲存組態。
```
aws ivs-realtime get-storage-configuration \
--name arn "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/abcdABCDefgh"
```
輸出：
```
{
"storageConfiguration": {
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/abcdABCDefgh",
"name": "test-sc",
"s3": {
"bucketName": "amzn-s3-demo-bucket"
},
"tags": {}
}
}
```
如需詳細資訊，請參閱《Amazon 互動式影片服務使用者指南》**中的[在 Amazon IVS 串流啟用多個主機](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetStorageConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-storage-configuration.html)。
### `import-public-key`
以下程式碼範例顯示如何使用 `import-public-key`。
**AWS CLI**
**匯入用來簽署階段參與者字符的現有公有金鑰**
下列 `import-public-key` 範例會從物料檔案匯入公有金鑰，以用於簽署階段參與者字符。
```
aws ivs-realtime import-public-key \
--public-key-material="`cat public.pem`"
```
輸出：
```
{
"publicKey": {
"arn": "arn:aws:ivs:us-west-2:123456789012:public-key/abcdABC1efg2",
"name": "",
"publicKeyMaterial": "-----BEGIN PUBLIC KEY-----\nMHYwEAYHKoZIzj0CAQYFK4EEACIDYgAEqVWUtqs6EktQMR1sCYmEzGvRwtaycI16\n9pmzcpiWu/uhNStGlteJ5odRfRwVkoQUMnSZXTCcbn9bBTTmiWo4mJcFOOAzsthH\n0UAb8NdD4tUE0At4a9hYP9IETEXAMPLE\n-----END PUBLIC KEY-----",
"fingerprint": "12:a3:44:56:bc:7d:e8:9f:10:2g:34:hi:56:78:90:12",
"tags": {}
}
}
```
如需詳細資訊，請參閱《Amazon IVS 即時串流功能使用者指南》**中的[分配參與者權杖](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ImportPublicKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/import-public-key.html)。
### `list-compositions`
以下程式碼範例顯示如何使用 `list-compositions`。
**AWS CLI**
**取得合成清單**
以下`list-compositions`列出處理 API 請求的 AWS 區域中，您 AWS 帳戶的所有組成。
```
aws ivs-realtime list-compositions
```
輸出：
```
{
"compositions": [
{
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh",
"destinations": [
{
"id": "AabBCcdDEefF",
"startTime": "2023-10-16T23:25:23+00:00",
"state": "ACTIVE"
}
],
"stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd",
"startTime": "2023-10-16T23:25:21+00:00",
"state": "ACTIVE",
"tags": {}
},
{
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/ABcdabCDefgh",
"destinations": [
{
"endTime": "2023-10-16T23:25:00.786512+00:00",
"id": "aABbcCDdeEFf",
"startTime": "2023-10-16T23:24:01+00:00",
"state": "STOPPED"
},
{
"endTime": "2023-10-16T23:25:00.786512+00:00",
"id": "deEFfaABbcCD",
"startTime": "2023-10-16T23:24:01+00:00",
"state": "STOPPED"
}
],
"endTime": "2023-10-16T23:25:00+00:00",
"stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/efghabcdABCD",
"startTime": "2023-10-16T23:24:00+00:00",
"state": "STOPPED",
"tags": {}
}
]
}
```
如需詳細資訊，請參閱《Amazon 互動式影片服務使用者指南》**中的[在 Amazon IVS 串流啟用多個主機](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListCompositions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-compositions.html)。
### `list-encoder-configurations`
以下程式碼範例顯示如何使用 `list-encoder-configurations`。
**AWS CLI**
**列出合成編碼器組態**
以下`list-encoder-configurations`列出處理 API 請求的 AWS 區域中，您 AWS 帳戶的所有合成編碼器組態。
```
aws ivs-realtime list-encoder-configurations
```
輸出：
```
{
"encoderConfigurations": [
{
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/abcdABCDefgh",
"name": "test-ec-1",
"tags": {}
},
{
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABCefgEFGabc",
"name": "test-ec-2",
"tags": {}
}
]
}
```
如需詳細資訊，請參閱《Amazon 互動式影片服務使用者指南》**中的[在 Amazon IVS 串流啟用多個主機](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListEncoderConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-encoder-configurations.html)。
### `list-ingest-configurations`
以下程式碼範例顯示如何使用 `list-ingest-configurations`。
**AWS CLI**
**取得所有擷取組態的摘要資訊**
下列`list-ingest-configurations`範例列出處理 API 請求 AWS 的區域中，您 AWS 帳戶的所有擷取組態。
```
aws ivs-realtime list-ingest-configurations
```
輸出：
```
{
"ingestConfigurations": [
{
"name": "",
"arn": "arn:aws:ivs:us-west-2:123456789012:ingest-configuration/XYZuvwSt4567",
"ingestProtocol": "RTMPS",
"stageArn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
"participnatId": "abC789Xyz456",
"state": "INACTIVE"
"userId": "",
}
]
}
```
如需詳細資訊，請參閱《Amazon 互動式影片服務使用者指南》**中的 [IVS 串流擷取 \$1 即時串流](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListIngestConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-ingest-configurations.html)。
### `list-participant-events`
以下程式碼範例顯示如何使用 `list-participant-events`。
**AWS CLI**
**範例 1：取得階段參與者事件的清單**
下列 `list-participant-events` 範例列出指定參與者 ID 的所有參與者事件，以及指定階段 ARN (Amazon Resource Name) 的工作階段 ID。
```
aws ivs-realtime list-participant-events \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--session-id st-a1b2c3d4e5f6g \
--participant-id abCDEf12GHIj
```
輸出：
```
{
"events": [
{
"eventTime": "2023-04-26T20:36:28+00:00",
"name": "LEFT",
"participantId": "abCDEf12GHIj"
},
{
"eventTime": "2023-04-26T20:36:28+00:00",
"name": "PUBLISH_STOPPED",
"participantId": "abCDEf12GHIj"
},
{
"eventTime": "2023-04-26T20:30:34+00:00",
"name": "JOINED",
"participantId": "abCDEf12GHIj"
},
{
"eventTime": "2023-04-26T20:30:34+00:00",
"name": "PUBLISH_STARTED",
"participantId": "abCDEf12GHIj"
}
]
}
```
如需詳細資訊，請參閱《*Amazon IVS 低延遲串流功能使用者指南*》中的在 [Amazon IVS 串流啟用多個主機](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)。
**範例 2：取得階段參與者事件的清單，包括參與者複寫停止和開始**
下列 `list-participant-events` 範例列出指定階段 ARN (Amazon Resource Name) 之指定工作階段 ID 的所有參與者事件，其中會將參與者複寫至另一個階段。
```
aws ivs-realtime list-participant-events \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--session-id st-a1b2c3d4e5f6g \
--participant-id abCDEf12GHIj
```
輸出：
```
{
"events": [
{
"eventTime": "2025-04-26T20:36:28+00:00",
"name": "LEFT",
"participantId": "abCDEf12GHIj"
},
{
"eventTime": "2025-04-26T20:36:28+00:00",
"name": "PUBLISH_STOPPED",
"participantId": "abCDEf12GHIj"
},
{
"eventTime": "2025-04-26T20:30:34+00:00",
"name": "JOINED",
"participantId": "abCDEf12GHIj"
},
{
"eventTime": "2025-04-26T20:30:34+00:00",
"name": "PUBLISH_STARTED",
"participantId": "abCDEf12GHIj"
},
{
"name": "REPLICATION_STARTED",
"participantId": "abCDEf12GHIj",
"eventTime": "2025-04-26T20:30:34+00:00",
"destinationStageArn": "arn:aws:ivs:us-west-2:12345678901:stage/ABCDabcdefgh",
"destinationSessionId": "st-b1c2d3e4f5g6a"
},
{
"name": "REPLICATION_STOPPED",
"participantId": "abCDEf12GHIj",
"eventTime": "2025-04-26T20:32:34+00:00",
"destinationStageArn": "arn:aws:ivs:us-west-2:12345678901:stage/ABCDabcdefgh",
"destinationSessionId": "st-b1c2d3e4f5g6a"
}
]
}
```
如需詳細資訊，請參閱《*Amazon IVS 低延遲串流功能使用者指南*》中的在 [Amazon IVS 串流啟用多個主機](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListParticipantEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-participant-events.html)。
### `list-participant-replicas`
以下程式碼範例顯示如何使用 `list-participant-replicas`。
**AWS CLI**
**取得階段參與者複本的清單**
下列 `list-participant-replicas` 範例列出從指定來源階段 ARN (Amazon Resource Name) 複寫到另一個階段的所有階段參與者。
```
aws ivs-realtime list-participant-replicas \
--source-stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--participant-id abCDEf12GHIj
```
輸出：
```
{
"replicas": [
{
"sourceStageArn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
"participantId": "abCDEf12GHIj",
"sourceSessionId": "st-a1b2c3d4e5f6g",
"destinationStageArn": "arn:aws:ivs:us-west-2:012345678901:stage/ABCDabcdefgh",
"destinationSessionId": "st-b1c2d3e4f5g6a",
"replicationState": "ACTIVE"
}
]
}
```
如需詳細資訊，請參閱《Amazon IVS 即時串流功能使用者指南》**中的 [IVS 參與者複寫](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-participant-replication.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListParticipantReplicas](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-participant-replicas.html)。
### `list-participants`
以下程式碼範例顯示如何使用 `list-participants`。
**AWS CLI**
**範例 1：取得階段參與者的清單**
下列 `list-participants` 範例列出指定階段 ARN (Amazon Resource Name) 之指定工作階段 ID 的所有參與者。
```
aws ivs-realtime list-participants \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--session-id st-a1b2c3d4e5f6g
```
輸出：
```
{
"participants": [
{
"firstJoinTime": "2023-04-26T20:30:34+00:00",
"participantId": "abCDEf12GHIj",
"published": true,
"recordingState": "STOPPED",
"state": "DISCONNECTED",
"userId": ""
}
]
}
```
如需詳細資訊，請參閱《*Amazon IVS 低延遲串流功能使用者指南*》中的在 [Amazon IVS 串流啟用多個主機](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)。
**範例 2：將參與者複寫至另一個階段時，取得階段參與者的清單**
下列 `list-participants` 範例列出將參與者複寫到另一個階段時，指定階段 ARN (Amazon Resource Name) 之指定工作階段 ID 的所有參與者。
```
aws ivs-realtime list-participants \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--session-id st-a1b2c3d4e5f6g
```
輸出：
```
{
"participants": [
{
"firstJoinTime": "2023-04-26T20:30:34+00:00",
"participantId": "abCDEf12GHIj",
"published": true,
"recordingState": "STOPPED",
"state": "DISCONNECTED",
"userId": "",
"replicationState": "ACTIVE",
"replicationType": "SOURCE",
"sourceStageArn": "",
"sourceSessionId": ""
}
]
}
```
如需詳細資訊，請參閱《*Amazon IVS 低延遲串流功能使用者指南*》中的在 [Amazon IVS 串流啟用多個主機](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)。
**範例 3：從另一個階段複寫參與者時，取得階段參與者的清單**
下列 `list-participants` 範例列出從另一個階段複寫參與者時，指定階段 ARN (Amazon Resource Name) 之指定工作階段 ID 的所有參與者。
```
aws ivs-realtime list-participants \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--session-id st-a1b2c3d4e5f6g
```
輸出：
```
{
"participants": [
{
"firstJoinTime": "2023-04-26T20:30:34+00:00",
"participantId": "abCDEf12GHIj",
"published": true,
"recordingState": "STOPPED",
"state": "DISCONNECTED",
"userId": "",
"replicationState": "ACTIVE",
"replicationType": "REPLICA",
"sourceStageArn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
"sourceSessionId": "st-a1b2c3d4e5f6g"
}
]
}
```
如需詳細資訊，請參閱《*Amazon IVS 低延遲串流功能使用者指南*》中的在 [Amazon IVS 串流啟用多個主機](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListParticipants](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-participants.html)。
### `list-public-keys`
以下程式碼範例顯示如何使用 `list-public-keys`。
**AWS CLI**
**列出可用於簽署階段參與者權杖的現有公有金鑰**
下列`list-public-keys`範例列出在處理 API 請求的 AWS 區域中，可用於簽署階段參與者字符的所有公有金鑰。
```
aws ivs-realtime list-public-keys
```
輸出：
```
{
"publicKeys": [
{
"arn": "arn:aws:ivs:us-west-2:123456789012:public-key/abcdABC1efg2",
"name": "",
"tags": {}
},
{
"arn": "arn:aws:ivs:us-west-2:123456789012:public-key/3bcdABCDefg4",
"name": "",
"tags": {}
}
]
}
```
如需詳細資訊，請參閱《Amazon IVS 即時串流功能使用者指南》**中的[分配參與者權杖](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListPublicKeys](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-public-keys.html)。
### `list-stage-sessions`
以下程式碼範例顯示如何使用 `list-stage-sessions`。
**AWS CLI**
**取得階段工作階段的清單**
下列 `list-stage-sessions` 範例列出指定階段 ARN (Amazon Resource Name) 的所有工作階段。
```
aws ivs-realtime list-stage-sessions \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh
```
輸出：
```
{
"stageSessions": [
{
"endTime": "2023-04-26T20:36:29+00:00",
"sessionId": "st-a1b2c3d4e5f6g",
"startTime": "2023-04-26T20:30:29.602000+00:00"
}
]
}
```
如需詳細資訊，請參閱《Amazon 互動式影片服務使用者指南》**中的[在 Amazon IVS 串流啟用多個主機](https://docs.aws.amazon.com/ivs/latest/userguide/multiple-hosts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListStageSessions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-stage-sessions.html)。
### `list-stages`
以下程式碼範例顯示如何使用 `list-stages`。
**AWS CLI**
**取得所有階段的摘要資訊**
下列`list-stages`範例列出處理 API 請求 AWS 的區域中您 AWS 帳戶的所有階段。
```
aws ivs-realtime list-stages
```
輸出：
```
{
"stages": [
{
"activeSessionId": "st-a1b2c3d4e5f6g",
"arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
"name": "stage1",
"tags": {}
},
{
"activeSessionId": "st-a123bcd456efg",
"arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcd1234ABCD",
"name": "stage2",
"tags": {}
},
{
"activeSessionId": "st-abcDEF1234ghi",
"arn": "arn:aws:ivs:us-west-2:123456789012:stage/ABCD1234efgh",
"name": "stage3",
"tags": {}
}
]
}
```
如需詳細資訊，請參閱《Amazon 互動式影片服務使用者指南》**中的[在 Amazon IVS 串流啟用多個主機](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListStages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-stages.html)。
### `list-storage-configurations`
以下程式碼範例顯示如何使用 `list-storage-configurations`。
**AWS CLI**
**列出合成儲存組態**
以下`list-storage-configurations`列出處理 API 請求的 AWS 區域中，您 AWS 帳戶的所有合成儲存組態。
```
aws ivs-realtime list-storage-configurations
```
輸出：
```
{
"storageConfigurations": [
{
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/abcdABCDefgh",
"name": "test-sc-1",
"s3": {
"bucketName": "amzn-s3-demo-bucket-1"
},
"tags": {}
},
{
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/ABCefgEFGabc",
"name": "test-sc-2",
"s3": {
"bucketName": "amzn-s3-demo-bucket-2"
},
"tags": {}
}
]
}
```
如需詳細資訊，請參閱《Amazon 互動式影片服務使用者指南》**中的[在 Amazon IVS 串流啟用多個主機](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListStorageConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-storage-configurations.html)。
### `start-composition`
以下程式碼範例顯示如何使用 `start-composition`。
**AWS CLI**
**範例 1：使用預設配置設定開始合成**
下列 `start-composition` 範例會開始要串流至指定位置之指定階段的合成。
```
aws ivs-realtime start-composition \
--stage-arn arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd \
--destinations '[{"channel": {"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", \
"encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"}}, \
{"s3":{"encoderConfigurationArns":["arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"], \
"recordingConfiguration": {"hlsConfiguration": {"targetSegmentDurationSeconds": 5}}, \
"storageConfigurationArn":"arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"}}]'
```
輸出：
```
{
"composition": {
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh",
"destinations": [
{
"configuration": {
"channel": {
"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg",
"encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
},
"name": ""
},
"id": "AabBCcdDEefF",
"state": "STARTING"
},
{
"configuration": {
"name": "",
"s3": {
"encoderConfigurationArns": [
"arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
],
"recordingConfiguration": {
"format": "HLS",
"hlsConfiguration": {
"targetSegmentDurationSeconds": 5
}
},
"storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"
}
},
"detail": {
"s3": {
"recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite"
}
},
"id": "GHFabcgefABC",
"state": "STARTING"
}
],
"layout": {
"grid": {
"featuredParticipantAttribute": ""
"gridGap": 2,
"omitStoppedVideo": false,
"participantOrderAttribute": "",
"videoAspectRatio": "VIDEO",
"videoFillMode": ""
}
},
"stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd",
"startTime": "2023-10-16T23:24:00+00:00",
"state": "STARTING",
"tags": {}
}
}
```
如需詳細資訊，請參閱《*Amazon Interactive Video Service 使用者指南*》中的 [IVS 複合錄製 \$1 即時串流](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html)。
**範例 2：使用 PiP 配置開始合成**
下列 `start-composition` 範例會使用 PiP 配置，開始要串流至指定位置之指定階段的合成。
```
aws ivs-realtime start-composition \
--stage-arn arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd \
--destinations '[{"channel": {"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", \
"encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"}}, \
{"s3":{"encoderConfigurationArns":["arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"], \
"storageConfigurationArn":"arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"}}]' \
--layout pip='{featuredParticipantAttribute="abcdefg"}'
```
輸出：
```
{
"composition": {
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/wxyzWXYZpqrs",
"destinations": [
{
"configuration": {
"channel": {
"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg",
"encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
},
"name": ""
},
"id": "AabBCcdDEefF",
"state": "STARTING"
},
{
"configuration": {
"name": "",
"s3": {
"encoderConfigurationArns": [
"arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
],
"recordingConfiguration": {
"format": "HLS",
"hlsConfiguration": {
"targetSegmentDurationSeconds": 2
}
},
"storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"
}
},
"detail": {
"s3": {
"recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite"
}
},
"id": "GHFabcgefABC",
"state": "STARTING"
}
],
"layout": {
"pip": {
"featuredParticipantAttribute": "abcdefg",
"gridGap": 0,
"omitStoppedVideo": false,
"participantOrderAttribute": "",
"pipBehavior": "STATIC",
"pipOffset": 0,
"pipParticipantAttribute": "",
"pipPosition": "BOTTOM_RIGHT",
"videoFillMode": "COVER"
}
},
"stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd",
"startTime": "2023-10-16T23:24:00+00:00",
"state": "STARTING",
"tags": {}
}
}
```
如需詳細資訊，請參閱《*Amazon Interactive Video Service 使用者指南*》中的 [IVS 複合錄製 \$1 即時串流](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html)。
**範例 3：開始已啟用縮圖錄製的合成**
下列 `start-composition` 範例會開始指定階段的合成，該指定階段會串流至已啟用縮圖錄製的指定位置。
```
aws ivs-realtime start-composition \
--stage-arn arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd \
--destinations '[{"channel": {"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", \
"encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"}}, \
{"s3": {"encoderConfigurationArns": ["arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"], \
"storageConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE", \
"thumbnailConfigurations": [{"storage": ["SEQUENTIAL"],"targetIntervalSeconds": 60}]}}]'
```
輸出：
```
{
"composition": {
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh",
"destinations": [
{
"configuration": {
"channel": {
"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg",
"encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
},
"name": ""
},
"id": "AabBCcdDEefF",
"state": "STARTING"
},
{
"configuration": {
"name": "",
"s3": {
"encoderConfigurationArns": [
"arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
],
"recordingConfiguration": {
"format": "HLS",
"hlsConfiguration": {
"targetSegmentDurationSeconds": 2
}
},
"storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE",
"thumbnailConfigurations": [
{
"targetIntervalSeconds": 60,
"storage": [
"SEQUENTIAL"
]
}
]
}
},
"detail": {
"s3": {
"recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite"
}
},
"id": "GHFabcgefABC",
"state": "STARTING"
}
],
"layout": {
"grid": {
"featuredParticipantAttribute": ""
"gridGap": 2,
"omitStoppedVideo": false,
"participantOrderAttribute": "",
"videoAspectRatio": "VIDEO",
"videoFillMode": ""
}
},
"stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd",
"startTime": "2023-10-16T23:24:00+00:00",
"state": "STARTING",
"tags": {}
}
}
```
如需詳細資訊，請參閱《*Amazon Interactive Video Service 使用者指南*》中的[複合錄製 （即時串流）](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html)。
**範例 4：使用網格配置搭配自訂參與者排序來啟動合成**
下列`start-composition`範例使用網格配置搭配自訂參與者順序，開始將指定階段的合成串流至指定的位置。
```
aws ivs-realtime start-composition \
--stage-arn arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd \
--destinations '[{"channel": {"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", \
"encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"}}, \
{"s3": {"encoderConfigurationArns": ["arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"], \
"storageConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE", \
"thumbnailConfigurations": [{"storage": ["SEQUENTIAL"],"targetIntervalSeconds": 60}]}}]' \
--layout grid='{participantOrderAttribute="abcdefg"}'
```
輸出：
```
{
"composition": {
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh",
"destinations": [
{
"configuration": {
"channel": {
"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg",
"encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
},
"name": ""
},
"id": "AabBCcdDEefF",
"state": "STARTING"
},
{
"configuration": {
"name": "",
"s3": {
"encoderConfigurationArns": [
"arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
],
"recordingConfiguration": {
"format": "HLS",
"hlsConfiguration": {
"targetSegmentDurationSeconds": 2
}
},
"storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE",
"thumbnailConfigurations": [
{
"targetIntervalSeconds": 60,
"storage": [
"SEQUENTIAL"
]
}
]
}
},
"detail": {
"s3": {
"recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite"
}
},
"id": "GHFabcgefABC",
"state": "STARTING"
}
],
"layout": {
"grid": {
"featuredParticipantAttribute": ""
"gridGap": 2,
"omitStoppedVideo": false,
"participantOrderAttribute": "abcdefg",
"videoAspectRatio": "VIDEO",
"videoFillMode": ""
}
},
"stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd",
"startTime": "2023-10-16T23:24:00+00:00",
"state": "STARTING",
"tags": {}
}
}
```
如需詳細資訊，請參閱《*Amazon Interactive Video Service 使用者指南*》中的 [IVS 複合錄製 \$1 即時串流](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [StartComposition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/start-composition.html)。
### `start-participant-replication`
以下程式碼範例顯示如何使用 `start-participant-replication`。
**AWS CLI**
**開始將參與者從某個階段複寫到另一個階段**
下列 `start-participant-replication` 範例會將參與者從來源階段複寫到目的地階段，每個階段由其 ARN (Amazon Resource Name) 指定。
```
aws ivs-realtime start-participant-replication \
--source-stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--destination-stage-arn arn:aws:ivs:us-west-2:234567890123:stage/bcdABCDefghi \
--participant-id abCDEf12GHIj
```
輸出：
```
{
"accessControlAllowOrigin": "*",
"accessControlExposeHeaders": "Access-Control-Allow-Origin,Access-Control-Expose-Headers,Cache-Control,Content-Length, \
Content-Security-Policy,Content-Type,date,Strict-Transport-Security,x-amz-apigw-id,x-amzn-errormessage,x-amzn-errortype, \
x-amzn-requestid,x-amzn-trace-id,X-Content-Type-Options,X-Frame-Options",
"cacheControl": "no-store, no-cache",
"contentSecurityPolicy": "default-src 'self'; upgrade-insecure-requests;",
"strictTransportSecurity": "max-age:47304000; includeSubDomains",
"xContentTypeOptions": "nosniff",
"xFrameOptions": "DENY"
}
```
如需詳細資訊，請參閱《Amazon IVS 即時串流功能使用者指南》**中的 [IVS 參與者複寫](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-participant-replication.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [StartParticipantReplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/start-participant-replication.html)。
### `stop-composition`
以下程式碼範例顯示如何使用 `stop-composition`。
**AWS CLI**
**停止合成**
以下 `stop-composition` 會停止指定 ARN (Amazon Resource Name) 指定的合成。
```
aws ivs-realtime stop-composition \
--arn "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh"
```
此命令不會產生輸出。
如需詳細資訊，請參閱《Amazon 互動式影片服務使用者指南》**中的[在 Amazon IVS 串流啟用多個主機](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [StopComposition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/stop-composition.html)。
### `stop-participant-replication`
以下程式碼範例顯示如何使用 `stop-participant-replication`。
**AWS CLI**
**停止將參與者從某個階段複寫到另一個階段**
下列 `stop-participant-replication` 範例會停止將參與者從來源階段複寫到目的地階段，其中每個階段由其 ARN (Amazon Resource Name) 指定。
```
aws ivs-realtime stop-participant-replication \
--source-stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--destination-stage-arn arn:aws:ivs:us-west-2:234567890123:stage/bcdABCDefghi \
--participant-id abCDEf12GHIj
```
輸出：
```
{
"accessControlAllowOrigin": "*",
"accessControlExposeHeaders": "Access-Control-Allow-Origin,Access-Control-Expose-Headers,Cache-Control,Content-Length, \
Content-Security-Policy,Content-Type,date,Strict-Transport-Security,x-amz-apigw-id,x-amzn-errormessage,x-amzn-errortype, \
x-amzn-requestid,x-amzn-trace-id,X-Content-Type-Options,X-Frame-Options",
"cacheControl": "no-store, no-cache",
"contentSecurityPolicy": "default-src 'self'; upgrade-insecure-requests;",
"strictTransportSecurity": "max-age:47304000; includeSubDomains",
"xContentTypeOptions": "nosniff",
"xFrameOptions": "DENY"
}
```
如需詳細資訊，請參閱《Amazon IVS 即時串流功能使用者指南》**中的 [IVS 參與者複寫](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-participant-replication.html)。
+ 如需 API 詳細資訊，請參閱《*AWS CLI 命令參考*》中的 [StopParticipantReplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/stop-participant-replication.html)。
### `update-ingest-configuration`
以下程式碼範例顯示如何使用 `update-ingest-configuration`。
**AWS CLI**
**更新擷取組態**
下列 `update-inegst-configuration` 範例會更新擷取組態，以將其連接至階段。
```
aws ivs-realtime update-ingest-configuration \
--arn arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234 \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh
```
輸出：
```
{
"ingestConfiguration": {
"name": "ingest1",
"arn": "arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234",
"ingestProtocol": "RTMPS",
"streamKey": "rt_123456789012_us-west-2_AbCdEfGh1234_abcd1234efgh5678ijkl9012MNOP34",
"stageArn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
"participantId": "xyZ654abC321",
"state": "INACTIVE",
"userId": "",
"tags": {}
}
}
```
如需詳細資訊，請參閱《Amazon 互動式影片服務使用者指南》**中的 [IVS 串流擷取 \$1 即時串流](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [UpdateIngestConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/update-ingest-configuration.html)。
### `update-stage`
以下程式碼範例顯示如何使用 `update-stage`。
**AWS CLI**
**範例 1：更新階段的組態**
下列 `update-stage` 範例會更新指定階段 ARN 的階段，以更新階段名稱，以及在啟用縮圖錄製的情況下設定個別參與者錄製。
```
aws ivs-realtime update-stage \
--arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--auto-participant-recording-configuration '{"mediaTypes": ["AUDIO_VIDEO"],"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh", "recordingReconnectWindowSeconds": 100, \
"thumbnailConfiguration": {"recordingMode": "INTERVAL","storage": ["SEQUENTIAL"],"targetIntervalSeconds": 60}} \
"hlsConfiguration": {"targetSegmentDurationSeconds": 5}}' \
--name stage1a
```
輸出：
```
{
"stage": {
"arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
"autoParticipantRecordingConfiguration": {
"mediaTypes": [
"AUDIO_VIDEO"
],
"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh",
"thumbnailConfiguration": {
"targetIntervalSeconds": 60,
"storage": [
"SEQUENTIAL"
],
"recordingMode": "INTERVAL"
},
"recordingReconnectWindowSeconds": 100,
"hlsConfiguration": {
"targetSegmentDurationSeconds": 5
},
"recordParticipantReplicas": true
},
"endpoints": {
"events": "wss://global.events.live-video.net",
"rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/",
"rtmps": "rtmps://9x0y8z7s6t5u.global-contribute-staging.live-video.net:443/app/",
"whip": "https://1a2b3c4d5e6f.global-bm.whip.live-video.net"
},
"name": "stage1a",
"tags": {}
}
}
```
如需詳細資訊，請參閱《*Amazon IVS 低延遲串流功能使用者指南*》中的在 [Amazon IVS 串流啟用多個主機](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)。
**範例 2：更新階段的組態，包括停用參與者複本錄製**
下列 `update-stage` 範例會更新指定階段 ARN 的階段，以更新階段名稱，以及在啟用縮圖錄製和停用參與者複本錄製的情況下設定個別參與者錄製。
```
aws ivs-realtime update-stage \
--arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--auto-participant-recording-configuration '{"mediaTypes": ["AUDIO_VIDEO"],"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh", "recordingReconnectWindowSeconds": 100, \
"thumbnailConfiguration": {"recordingMode": "INTERVAL","storage": ["SEQUENTIAL"],"targetIntervalSeconds": 60}, "recordParticipantReplicas":false} \
"hlsConfiguration": {"targetSegmentDurationSeconds": 5}}' \
--name stage1a
```
輸出：
```
{
"stage": {
"arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
"autoParticipantRecordingConfiguration": {
"mediaTypes": [
"AUDIO_VIDEO"
],
"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh",
"thumbnailConfiguration": {
"targetIntervalSeconds": 60,
"storage": [
"SEQUENTIAL"
],
"recordingMode": "INTERVAL"
},
"recordingReconnectWindowSeconds": 100,
"hlsConfiguration": {
"targetSegmentDurationSeconds": 5
},
"recordParticipantReplicas": false
},
"endpoints": {
"events": "wss://global.events.live-video.net",
"rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/",
"rtmps": "rtmps://9x0y8z7s6t5u.global-contribute-staging.live-video.net:443/app/",
"whip": "https://1a2b3c4d5e6f.global-bm.whip.live-video.net"
},
"name": "stage1a",
"tags": {}
}
}
```
如需詳細資訊，請參閱《*Amazon IVS 低延遲串流功能使用者指南*》中的在 [Amazon IVS 串流啟用多個主機](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [UpdateStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/update-stage.html)。