文件 AWS 開發套件範例 GitHub 儲存庫中有更多可用的 [AWS SDK 範例](https://github.com/awsdocs/aws-doc-sdk-examples)。
本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
# 使用 的 Amazon IVS 範例 AWS CLI
下列程式碼範例示範如何使用 AWS Command Line Interface 搭配 Amazon IVS 執行動作和實作常見案例。
*Actions* 是大型程式的程式碼摘錄，必須在內容中執行。雖然動作會告訴您如何呼叫個別服務函數，但您可以在其相關情境中查看內容中的動作。
每個範例均包含完整原始碼的連結，您可在連結中找到如何設定和執行內容中程式碼的相關指示。
**Topics**
+ [動作](#actions)
## 動作
### `batch-get-channel`
以下程式碼範例顯示如何使用 `batch-get-channel`。
**AWS CLI**
**取得多個頻道的頻道組態資訊**
下列 `batch-get-channel` 範例列出指定頻道的相關資訊。
```
aws ivs batch-get-channel \
--arns arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh \
arn:aws:ivs:us-west-2:123456789012:channel/efghEFGHijkl
```
輸出：
```
{
"channels": [
{
"arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
"authorized": false,
"containerFormat": "TS",
"ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
"insecureIngest": false,
"latencyMode": "LOW",
"multitrackInputConfiguration": {
"enabled": false,
"maximumResolution": "FULL_HD",
"policy": "ALLOW"
},
"name": "channel-1",
"playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel-1.abcdEFGH.m3u8",
"preset": "",
"playbackRestrictionPolicyArn": "",
"recordingConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABCD12cdEFgh",
"srt": {
"endpoint": "a1b2c3d4e5f6.srt.live-video.net",
"passphrase": "AB1C2defGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
},
"tags": {},
"type": "STANDARD"
},
{
"arn": "arn:aws:ivs:us-west-2:123456789012:channel/efghEFGHijkl",
"authorized": false,
"containerFormat": "FRAGMENTED_MP4",
"ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
"insecureIngest": false,
"latencyMode": "LOW",
"multitrackInputConfiguration": {
"enabled": true,
"maximumResolution": "FULL_HD",
"policy": "ALLOW"
},
"name": "channel-2",
"playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel-2.abcdEFGH.m3u8",
"preset": "",
"playbackRestrictionPolicyArn": "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ"",
"recordingConfigurationArn": "",
"srt": {
"endpoint": "a1b2c3d4e5f6.srt.live-video.net",
"passphrase": "BA1C2defGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
},
"tags": {},
"type": "STANDARD"
}
]
}
```
如需詳細資訊，請參閱《IVS 低延遲使用者指南》**中的[建立頻道](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [BatchGetChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/batch-get-channel.html)。
### `batch-get-stream-key`
以下程式碼範例顯示如何使用 `batch-get-stream-key`。
**AWS CLI**
**取得多個串流金鑰的相關資訊**
下列 `batch-get-stream-key` 範例取得指定串流金鑰的相關資訊。
```
aws ivs batch-get-stream-key \
--arns arn:aws:ivs:us-west-2:123456789012:stream-key/skSKABCDefgh \
arn:aws:ivs:us-west-2:123456789012:stream-key/skSKIJKLmnop
```
輸出：
```
{
"streamKeys": [
{
"arn": "arn:aws:ivs:us-west-2:123456789012:stream-key/skSKABCDefgh",
"value": "sk_us-west-2_abcdABCDefgh_567890abcdef",
"channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
"tags": {}
},
{
"arn": "arn:aws:ivs:us-west-2:123456789012:stream-key/skSKIJKLmnop",
"value": "sk_us-west-2_abcdABCDefgh_567890ghijkl",
"channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
"tags": {}
}
]
}
```
如需詳細資訊，請參閱《IVS 低延遲使用者指南》**中的[建立頻道](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [BatchGetStreamKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/batch-get-stream-key.html)。
### `batch-start-viewer-session-revocation`
以下程式碼範例顯示如何使用 `batch-start-viewer-session-revocation`。
**AWS CLI**
**撤銷多頻道 ARN 和檢視器 ID 對的檢視器工作階段**
下列 `batch-start-viewer-session-revocation` 範例會同時對多頻道 ARN 和檢視器 ID 對執行工作階段撤銷。如果呼叫者沒有指定工作階段的撤銷許可，請求可能會正常完成，但在錯誤欄位中傳回值。
```
aws ivs batch-start-viewer-session-revocation \
--viewer-sessions '[{"channelArn":"arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh1","viewerId":"abcdefg1","viewerSessionVersionsLessThanOrEqualTo":1234567890}, \
{"channelArn":"arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh2","viewerId":"abcdefg2","viewerSessionVersionsLessThanOrEqualTo":1234567890}]'
```
輸出：
```
{
"errors": [
{
"channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh1",
"viewerId": "abcdefg1",
"code": "403",
"message": "not authorized",
},
{
"channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh2",
"viewerId": "abcdefg2",
"code": "403",
"message": "not authorized",
}
]
}
```
如需詳細資訊，請參閱《Amazon 互動式影片服務使用者指南》中的[設定私有頻道](https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [BatchStartViewerSessionRevocation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/batch-start-viewer-session-revocation.html)。
### `create-channel`
以下程式碼範例顯示如何使用 `create-channel`。
**AWS CLI**
**範例 1：建立沒有錄製的頻道**
下列 `create-channel` 範例會建立新的頻道和相關聯的串流金鑰，以開始串流。
```
aws ivs create-channel \
--name 'test-channel' \
--no-insecure-ingest
```
輸出：
```
{
"channel": {
"arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
"authorized": false,
"containerFormat": "TS",
"name": "test-channel",
"latencyMode": "LOW",
"multitrackInputConfiguration": {
"enabled": false,
"maximumResolution": "FULL_HD",
"policy": "ALLOW"
},
"playbackRestrictionPolicyArn": "",
"recordingConfigurationArn": "",
"srt": {
"endpoint": "a1b2c3d4e5f6.srt.live-video.net",
"passphrase": "AB1C2defGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
},
"ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
"insecureIngest": false,
"playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8",
"preset": "",
"tags": {},
"type": "STANDARD"
},
"streamKey": {
"arn": "arn:aws:ivs:us-west-2:123456789012:stream-key/g1H2I3j4k5L6",
"value": "sk_us-west-2_abcdABCDefgh_567890abcdef",
"channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
"tags": {}
}
}
```
如需詳細資訊，請參閱《IVS 低延遲使用者指南》**中的[建立頻道](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html)。
**範例 2：若要建立已啟用錄製的頻道，請使用其 ARN 指定的 RecordingConfiguration 資源**
下列 `create-channel` 範例會建立新的頻道和相關聯的串流金鑰以開始串流，以及設定頻道的錄製：
```
aws ivs create-channel \
--name test-channel-with-recording \
--insecure-ingest \
--recording-configuration-arn 'arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABCD12cdEFgh'
```
輸出：
```
{
"channel": {
"arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
"containerFormat": "TS",
"name": "test-channel-with-recording",
"latencyMode": "LOW",
"multitrackInputConfiguration": {
"enabled": false,
"maximumResolution": "FULL_HD",
"policy": "ALLOW"
},
"type": "STANDARD",
"playbackRestrictionPolicyArn": "",
"recordingConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABCD12cdEFgh",
"srt": {
"endpoint": "a1b2c3d4e5f6.srt.live-video.net",
"passphrase": "BA1C2defGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
},
"ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
"insecureIngest": true,
"playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8",
"preset": "",
"authorized": false,
"tags": {},
"type": "STANDARD"
},
"streamKey": {
"arn": "arn:aws:ivs:us-west-2:123456789012:stream-key/abcdABCDefgh",
"value": "sk_us-west-2_abcdABCDefgh_567890abcdef",
"channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
"tags": {}
}
}
```
如需詳細資訊，請參閱《IVS 低延遲使用者指南》**中的[記錄到 Amazon S3](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/record-to-s3.html)。
**範例 3：使用 ARN 指定的播放限制政策建立頻道**
下列 `create-channel` 範例會建立新的頻道和相關聯的串流金鑰以開始串流，以及設定頻道的播放限制政策：
```
aws ivs create-channel \
--name test-channel-with-playback-restriction-policy\
--insecure-ingest \
--playback-restriction-policy-arn 'arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ'
```
輸出：
```
{
"channel": {
"arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
"containerFormat": "TS",
"name": "test-channel-with-playback-restriction-policy",
"latencyMode": "LOW",
"multitrackInputConfiguration": {
"enabled": false,
"maximumResolution": "FULL_HD",
"policy": "ALLOW"
},
"type": "STANDARD",
"playbackRestrictionPolicyArn": "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ",
"recordingConfigurationArn": "",
"srt": {
"endpoint": "a1b2c3d4e5f6.srt.live-video.net",
"passphrase": "AB1C2edfGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
},
"ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
"insecureIngest": true,
"playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8",
"preset": "",
"authorized": false,
"tags": {},
"type": "STANDARD"
},
"streamKey": {
"arn": "arn:aws:ivs:us-west-2:123456789012:stream-key/abcdABCDefgh",
"value": "sk_us-west-2_abcdABCDefgh_567890abcdef",
"channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
"tags": {}
}
}
```
如需詳細資訊，請參閱《IVS 低延遲使用者指南》**中的[不需要的內容和檢視器](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/undesired-content.html)。
**範例 4：建立已啟用多軌的頻道**
下列 `create-channel` 範例會建立新的頻道和相關聯的串流金鑰以開始串流，以及啟用多軌。
```
aws ivs create-channel \
--name 'test-channel' \
--no-insecure-ingest \
--container-format 'FRAGMENTED_MP4' \
--multitrack-input-configuration '{"enabled": true,"maximumResolution": "FULL_HD","policy": "ALLOW"}'
```
輸出：
```
{
"channel": {
"arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
"authorized": false,
"containerFormat": "FRAGMENTED_MP4",
"name": "test-channel",
"latencyMode": "LOW",
"multitrackInputConfiguration": {
"enabled": true,
"maximumResolution": "FULL_HD",
"policy": "ALLOW"
},
"playbackRestrictionPolicyArn": "",
"recordingConfigurationArn": "",
"srt": {
"endpoint": "a1b2c3d4e5f6.srt.live-video.net",
"passphrase": "AB1C2defGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
},
"ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
"insecureIngest": false,
"playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8",
"preset": "",
"tags": {},
"type": "STANDARD"
},
"streamKey": {
"arn": "arn:aws:ivs:us-west-2:123456789012:stream-key/g1H2I3j4k5L6",
"value": "sk_us-west-2_abcdABCDefgh_567890abcdef",
"channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
"tags": {}
}
}
```
如需詳細資訊，請參閱《IVS 低延遲使用者指南》**中的[建立頻道](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multitrack-video.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreateChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/create-channel.html)。
### `create-playback-restriction-policy`
以下程式碼範例顯示如何使用 `create-playback-restriction-policy`。
**AWS CLI**
**建立播放限制政策**
下列 `create-playback-restriction-policy` 範例會建立新的播放擷取政策。
```
aws ivs create-playback-restriction-policy \
--name "test-playback-restriction-policy" \
--enable-strict-origin-enforcement \
--tags "key1=value1, key2=value2" \
--allowed-countries US MX \
--allowed-origins https://www.website1.com https://www.website2.com
```
輸出：
```
{
"playbackRestrictionPolicy": {
"arn": "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ",
"allowedCountries": [
"US",
"MX"
],
"allowedOrigins": [
"https://www.website1.com",
"https://www.website2.com"
],
"enableStrictOriginEnforcement": true,
"name": "test-playback-restriction-policy",
"tags": {
"key1": "value1",
"key2": "value2"
}
}
}
```
如需詳細資訊，請參閱《IVS 低延遲使用者指南》**中的[不需要的內容和檢視器](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/undesired-content.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreatePlaybackRestrictionPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/create-playback-restriction-policy.html)。
### `create-recording-configuration`
以下程式碼範例顯示如何使用 `create-recording-configuration`。
**AWS CLI**
**建立 RecordingConfiguration 資源**
下列 `create-recording-configuration` 範例會建立 RecordingConfiguration 資源，以啟用記錄至 Amazon S3 的功能。
```
aws ivs create-recording-configuration \
--name "test-recording-config" \
--recording-reconnect-window-seconds 60 \
--tags "key1=value1, key2=value2" \
--rendition-configuration renditionSelection="CUSTOM",renditions="HD" \
--thumbnail-configuration recordingMode="INTERVAL",targetIntervalSeconds=1,storage="LATEST",resolution="LOWEST_RESOLUTION" \
--destination-configuration s3={bucketName=demo-recording-bucket}
```
輸出：
```
{
"recordingConfiguration": {
"arn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABcdef34ghIJ",
"name": "test-recording-config",
"destinationConfiguration": {
"s3": {
"bucketName": "demo-recording-bucket"
}
},
"state": "CREATING",
"tags": {
"key1": "value1",
"key2": "value2"
},
"thumbnailConfiguration": {
"recordingMode": "INTERVAL",
"targetIntervalSeconds": 1,
"resolution": "LOWEST_RESOLUTION",
"storage": [
"LATEST"
]
},
"recordingReconnectWindowSeconds": 60,
"renditionConfiguration": {
"renditionSelection": "CUSTOM",
"renditions": [
"HD"
]
}
}
}
```
如需詳細資訊，請參閱《Amazon 互動式影片服務使用者指南》**中的[記錄至 Amazon S3](https://docs.aws.amazon.com/ivs/latest/userguide/record-to-s3.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreateRecordingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/create-recording-configuration.html)。
### `create-stream-key`
以下程式碼範例顯示如何使用 `create-stream-key`。
**AWS CLI**
**建立串流金鑰**
下列 `create-stream-key` 範例會為指定的 ARN (Amazon Resource Name) 建立串流金鑰。
```
aws ivs create-stream-key \
--channel-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh
```
輸出：
```
{
"streamKey": {
"arn": "arn:aws:ivs:us-west-2:123456789012:stream-key/abcdABCDefgh",
"value": "sk_us-west-2_abcdABCDefgh_567890abcdef",
"channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
"tags": {}
}
}
```
如需詳細資訊，請參閱《IVS 低延遲使用者指南》**中的[建立頻道](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreateStreamKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/create-stream-key.html)。
### `delete-channel`
以下程式碼範例顯示如何使用 `delete-channel`。
**AWS CLI**
**刪除頻道及其相關聯的串流金鑰**
下列 `delete-channel` 範例會刪除具有指定 ARN (Amazon Resource Name) 的頻道。
```
aws ivs delete-channel \
--arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh
```
此命令不會產生輸出。
如需詳細資訊，請參閱《IVS 低延遲使用者指南》**中的[建立頻道](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/delete-channel.html)。
### `delete-playback-key-pair`
以下程式碼範例顯示如何使用 `delete-playback-key-pair`。
**AWS CLI**
**刪除指定的播放金鑰對**
下列 `delete-playback-key-pair` 範例會傳回指定金鑰對的指紋。
```
aws ivs delete-playback-key-pair \
--arn arn:aws:ivs:us-west-2:123456789012:playback-key/abcd1234efgh
```
此命令不會產生輸出。
如需詳細資訊，請參閱《Amazon 互動式影片服務使用者指南》中的[設定私有頻道](https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeletePlaybackKeyPair](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/delete-playback-key-pair.html)。
### `delete-playback-restriction-policy`
以下程式碼範例顯示如何使用 `delete-playback-restriction-policy`。
**AWS CLI**
**刪除播放限制政策**
下列 `delete-playback-restriction-policy` 範例會刪除具有指定政策 ARN (Amazon Resource Name) 的播放限制政策。
```
aws ivs delete-playback-restriction-policy \
--arn "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ"
```
此命令不會產生輸出。
如需詳細資訊，請參閱《IVS 低延遲使用者指南》**中的[不需要的內容和檢視器](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/undesired-content.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeletePlaybackRestrictionPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/delete-playback-restriction-policy.html)。
### `delete-recording-configuration`
以下程式碼範例顯示如何使用 `delete-recording-configuration`。
**AWS CLI**
**刪除其 ARN 指定的 RecordingConfiguration 資源**
下列 `delete-recording-configuration` 範例會刪除具有指定 ARN 的 RecordingConfiguration 資源。
```
aws ivs delete-recording-configuration \
--arn "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABcdef34ghIJ"
```
此命令不會產生輸出。
如需詳細資訊，請參閱《Amazon 互動式影片服務使用者指南》**中的[記錄至 Amazon S3](https://docs.aws.amazon.com/ivs/latest/userguide/record-to-s3.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteRecordingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/delete-recording-configuration.html)。
### `delete-stream-key`
以下程式碼範例顯示如何使用 `delete-stream-key`。
**AWS CLI**
**刪除串流金鑰**
下列 `delete-stream-key` 範例會刪除指定 ARN (Amazon Resource Name) 的串流金鑰，使其無法再用於串流。
```
aws ivs delete-stream-key \
--arn arn:aws:ivs:us-west-2:123456789012:stream-key/g1H2I3j4k5L6
```
此命令不會產生輸出。
如需詳細資訊，請參閱《IVS 低延遲使用者指南》**中的[建立頻道](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteStreamKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/delete-stream-key.html)。
### `get-channel`
以下程式碼範例顯示如何使用 `get-channel`。
**AWS CLI**
**取得頻道的組態資訊**
下列 `get-channel` 範例取得指定頻道 ARN (Amazon Resource Name) 的頻道組態。
```
aws ivs get-channel \
--arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh'
```
輸出：
```
{
"channel": {
"arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
"authorized": false,
"containerFormat": "TS",
"ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
"insecureIngest": false,
"latencyMode": "LOW",
"multitrackInputConfiguration": {
"enabled": false,
"maximumResolution": "FULL_HD",
"policy": "ALLOW"
},
"name": "channel-1",
"playbackRestrictionPolicyArn": "",
"playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8",
"preset": "",
"recordingConfigurationArn": "",
"srt": {
"endpoint": "a1b2c3d4e5f6.srt.live-video.net",
"passphrase": "AB1C2defGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
},
"tags": {}
"type": "STANDARD",
}
}
```
如需詳細資訊，請參閱《IVS 低延遲使用者指南》**中的[建立頻道](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/get-channel.html)。
### `get-playback-key-pair`
以下程式碼範例顯示如何使用 `get-playback-key-pair`。
**AWS CLI**
**取得指定的播放金鑰對**
下列 `get-playback-key-pair` 範例會傳回指定金鑰對的指紋。
```
aws ivs get-playback-key-pair \
--arn arn:aws:ivs:us-west-2:123456789012:playback-key/abcd1234efgh
```
輸出：
```
{
"keyPair": {
"arn": "arn:aws:ivs:us-west-2:123456789012:playback-key/abcd1234efgh",
"name": "my-playback-key",
"fingerprint": "0a:1b:2c:ab:cd:ef:34:56:70:b1:b2:71:01:2a:a3:72",
"tags": {}
}
}
```
如需詳細資訊，請參閱《Amazon 互動式影片服務使用者指南》中的[設定私有頻道](https://docs.aws.amazon.com/ivs/latest/userguide//private-channels.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetPlaybackKeyPair](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/get-playback-key-pair.html)。
### `get-playback-restriction-policy`
以下程式碼範例顯示如何使用 `get-playback-restriction-policy`。
**AWS CLI**
**取得播放限制政策的組態資訊**
下列 `get-playback-restriction-policy` 範例取得具有指定政策 ARN (Amazon Resource Name) 的播放限制政策組態。
```
aws ivs get-playback-restriction-policy \
--arn "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ"
```
輸出：
```
{
"playbackRestrictionPolicy": {
"arn": "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ",
"allowedCountries": [
"US",
"MX"
],
"allowedOrigins": [
"https://www.website1.com",
"https://www.website2.com"
],
"enableStrictOriginEnforcement": true,
"name": "test-playback-restriction-policy",
"tags": {
"key1": "value1",
"key2": "value2"
}
}
}
```
如需詳細資訊，請參閱《IVS 低延遲使用者指南》**中的[不需要的內容和檢視器](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/undesired-content.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetPlaybackRestrictionPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/get-playback-restriction-policy.html)。
### `get-recording-configuration`
以下程式碼範例顯示如何使用 `get-recording-configuration`。
**AWS CLI**
**取得 RecordingConfiguration 資源的相關資訊**
下列 `get-recording-configuration` 範例取得指定 ARN 的 RecordingConfiguration 資源相關資訊。
```
aws ivs get-recording-configuration \
--arn "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABcdef34ghIJ"
```
輸出：
```
{
"recordingConfiguration": {
"arn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABcdef34ghIJ",
"destinationConfiguration": {
"s3": {
"bucketName": "demo-recording-bucket"
}
},
"name": "test-recording-config",
"recordingReconnectWindowSeconds": 60,
"state": "ACTIVE",
"tags": {
"key1" : "value1",
"key2" : "value2"
},
"thumbnailConfiguration": {
"recordingMode": "INTERVAL",
"targetIntervalSeconds": 1,
"resolution": "LOWEST_RESOLUTION",
"storage": [
"LATEST"
]
},
"renditionConfiguration": {
"renditionSelection": "CUSTOM",
"renditions": [
"HD"
]
}
}
}
```
如需詳細資訊，請參閱《Amazon 互動式影片服務使用者指南》**中的[記錄至 Amazon S3](https://docs.aws.amazon.com/ivs/latest/userguide/record-to-s3.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetRecordingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/get-recording-configuration.html)。
### `get-stream-key`
以下程式碼範例顯示如何使用 `get-stream-key`。
**AWS CLI**
**取得串流的相關資訊**
下列 `get-stream-key` 範例取得指定串流金鑰的相關資訊。
```
aws ivs get-stream-key \
--arn arn:aws:ivs:us-west-2:123456789012:stream-key/skSKABCDefgh --region=us-west-2
```
輸出：
```
{
"streamKey": {
"arn": "arn:aws:ivs:us-west-2:123456789012:stream-key/skSKABCDefgh",
"value": "sk_us-west-2_abcdABCDefgh_567890abcdef",
"channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
"tags": {}
}
}
```
如需詳細資訊，請參閱《IVS 低延遲使用者指南》**中的[建立頻道](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetStreamKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/get-stream-key.html)。
### `get-stream-session`
以下程式碼範例顯示如何使用 `get-stream-session`。
**AWS CLI**
**取得指定串流的中繼資料**
下列 `get-stream-session` 範例會取得指定頻道 ARN (Amazon Resource Name) 和指定串流的中繼資料組態；如果未提供 `streamId`，則會選取頻道的最新串流。
```
aws ivs get-stream-session \
--channel-arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \
--stream-id 'mystream'
```
輸出：
```
{
"streamSession": {
"streamId": "mystream1",
"startTime": "2023-06-26T19:09:28+00:00",
"channel": {
"arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
"name": "mychannel",
"latencyMode": "LOW",
"type": "STANDARD",
"recordingConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABcdef34ghIJ",
"ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
"playbackUrl": "url-string",
"authorized": false,
"insecureIngest": false,
"preset": ""
},
"ingestConfiguration": {
"audio": {
"channels": 2,
"codec": "mp4a.40.2",
"sampleRate": 8000,
"targetBitrate": 46875,
"track": "Track0"
},
"video": {
"avcProfile": "Baseline",
"avcLevel": "4.2",
"codec": "avc1.42C02A",
"encoder": "Lavf58.45.100",
"level": "4.2",
"profile": "Baseline",
"targetBitrate": 8789062,
"targetFramerate": 60,
"track": "Track0",
"videoHeight": 1080,
"videoWidth": 1920
}
},
"ingestConfigurations": {
"audioConfigurations": [
{
"channels": 2,
"codec": "mp4a.40.2",
"sampleRate": 8000,
"targetBitrate": 46875,
"track": "Track0"
}
],
"videoConfigurations": [
{
"codec": "avc1.42C02A",
"encoder": "Lavf58.45.100",
"level": "4.2",
"profile": "Baseline",
"targetBitrate": 8789062,
"targetFramerate": 60,
"track": "Track0",
"videoHeight": 1080,
"videoWidth": 1920
}
]
},
"recordingConfiguration": {
"arn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABcdef34ghIJ",
"name": "test-recording-config",
"destinationConfiguration": {
"s3": {
"bucketName": "demo-recording-bucket"
}
},
"state": "ACTIVE",
"tags": {
"key1": "value1",
"key2": "value2"
},
"thumbnailConfiguration": {
"recordingMode": "INTERVAL",
"targetIntervalSeconds": 1,
"resolution": "LOWEST_RESOLUTION",
"storage": [
"LATEST"
]
},
"recordingReconnectWindowSeconds": 60,
"renditionConfiguration": {
"renditionSelection": "CUSTOM",
"renditions": [
"HD"
]
}
},
"truncatedEvents": [
{
"code": "StreamTakeoverInvalidPriority",
"name": "Stream Takeover Failure",
"type": "IVS Stream State Change",
"eventTime": "2023-06-26T19:09:48+00:00"
},
{
"name": "Stream Takeover",
"type": "IVS Stream State Change",
"eventTime": "2023-06-26T19:09:47+00:00"
},
{
"name": "Recording Start",
"type": "IVS Recording State Change",
"eventTime": "2023-06-26T19:09:35+00:00"
},
{
"name": "Stream Start",
"type": "IVS Stream State Change",
"eventTime": "2023-06-26T19:09:34+00:00"
},
{
"name": "Session Created",
"type": "IVS Stream State Change",
"eventTime": "2023-06-26T19:09:28+00:00"
}
]
}
}
```
如需詳細資訊，請參閱《IVS 低延遲使用者指南》**中的[建立頻道](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetStreamSession](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/get-stream-session.html)。
### `get-stream`
以下程式碼範例顯示如何使用 `get-stream`。
**AWS CLI**
**取得串流的相關資訊**
下列 `get-stream` 範例取得指定頻道之串流的相關資訊。
```
aws ivs get-stream \
--channel-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh
```
輸出：
```
{
"stream": {
"channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
"playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8",
"startTime": "2020-05-05T21:55:38Z",
"state": "LIVE",
"health": "HEALTHY",
"streamId": "st-ABCDEfghij01234KLMN5678",
"viewerCount": 1
}
}
```
如需詳細資訊，請參閱《IVS 低延遲使用者指南》**中的[建立頻道](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/get-stream.html)。
### `import-playback-key-pair`
以下程式碼範例顯示如何使用 `import-playback-key-pair`。
**AWS CLI**
**匯入新金鑰對的公有部分**
下列 `import-playback-key-pair` 範例會匯入指定的公有金鑰 (以 PEM 格式指定為字串)，並傳回新金鑰對的 arn 和指紋。
```
aws ivs import-playback-key-pair \
--name "my-playback-key" \
--public-key-material "G1lbnQxOTA3BgNVBAMMMFdoeSBhcmUgeW91IGRl..."
```
輸出：
```
{
"keyPair": {
"arn": "arn:aws:ivs:us-west-2:123456789012:playback-key/abcd1234efgh",
"name": "my-playback-key",
"fingerprint": "0a:1b:2c:ab:cd:ef:34:56:70:b1:b2:71:01:2a:a3:72",
"tags": {}
}
}
```
如需詳細資訊，請參閱《Amazon 互動式影片服務使用者指南》中的[設定私有頻道](https://docs.aws.amazon.com/ivs/latest/userguide//private-channels.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ImportPlaybackKeyPair](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/import-playback-key-pair.html)。
### `list-channels`
以下程式碼範例顯示如何使用 `list-channels`。
**AWS CLI**
**範例 1：取得所有頻道的摘要資訊**
下列`list-channels`範例列出您 AWS 帳戶的所有頻道。
```
aws ivs list-channels
```
輸出：
```
{
"channels": [
{
"arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
"name": "channel-1",
"latencyMode": "LOW",
"authorized": false,
"insecureIngest": false,
"preset": "",
"playbackRestrictionPolicyArn": "",
"recordingConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABCD12cdEFgh",
"tags": {},
"type": "STANDARD"
},
{
"arn": "arn:aws:ivs:us-west-2:123456789012:channel/efghEFGHijkl",
"name": "channel-2",
"latencyMode": "LOW",
"authorized": false,
"preset": "",
"playbackRestrictionPolicyArn": "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ",
"recordingConfigurationArn": "",
"tags": {},
"type": "STANDARD"
}
]
}
```
如需詳細資訊，請參閱《IVS 低延遲使用者指南》**中的[建立頻道](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html)。
**範例 2：若要取得所有頻道的摘要資訊，請依指定的 RecordingConfiguration ARN 進行篩選**
下列`list-channels`範例列出與指定 RecordingConfiguration ARN 相關聯的 AWS 帳戶的所有頻道。
```
aws ivs list-channels \
--filter-by-recording-configuration-arn "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABCD12cdEFgh"
```
輸出：
```
{
"channels": [
{
"arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
"name": "channel-1",
"latencyMode": "LOW",
"authorized": false,
"insecureIngest": false,
"preset": "",
"playbackRestrictionPolicyArn": "",
"recordingConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABCD12cdEFgh",
"tags": {},
"type": "STANDARD"
}
]
}
```
如需詳細資訊，請參閱《IVS 低延遲使用者指南》**中的[記錄到 Amazon S3](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/record-to-s3.html)。
**範例 3：若要取得所有頻道的摘要資訊，請依指定的 PlaybackRestrictionPolicy ARN 進行篩選**
下列`list-channels`範例列出與指定 PlaybackRestrictionPolicy ARN 相關聯的 AWS 帳戶的所有頻道。
```
aws ivs list-channels \
--filter-by-playback-restriction-policy-arn "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ"
```
輸出：
```
{
"channels": [
{
"arn": "arn:aws:ivs:us-west-2:123456789012:channel/efghEFGHijkl",
"name": "channel-2",
"latencyMode": "LOW",
"authorized": false,
"preset": "",
"playbackRestrictionPolicyArn": "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ",
"recordingConfigurationArn": "",
"tags": {},
"type": "STANDARD"
}
]
}
```
如需詳細資訊，請參閱《IVS 低延遲使用者指南》**中的[不需要的內容和檢視器](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/undesired-content.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListChannels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/list-channels.html)。
### `list-playback-key-pairs`
以下程式碼範例顯示如何使用 `list-playback-key-pairs`。
**AWS CLI**
**取得有關播放金鑰對的摘要資訊**
下列 `list-playback-key-pairs` 範例會傳回所有金鑰對的相關資訊。
```
aws ivs list-playback-key-pairs
```
輸出：
```
{
"keyPairs": [
{
"arn": "arn:aws:ivs:us-west-2:123456789012:playback-key/abcd1234efgh",
"name": "test-key-0",
"tags": {}
},
{
"arn": "arn:aws:ivs:us-west-2:123456789012:playback-key/ijkl5678mnop",
"name": "test-key-1",
"tags": {}
}
]
}
```
如需詳細資訊，請參閱《Amazon 互動式影片服務使用者指南》中的[設定私有頻道](https://docs.aws.amazon.com/ivs/latest/userguide//private-channels.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListPlaybackKeyPairs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/list-playback-key-pairs.html)。
### `list-playback-restriction-policies`
以下程式碼範例顯示如何使用 `list-playback-restriction-policies`。
**AWS CLI**
**取得所有播放限制政策的摘要資訊**
下列`list-playback-restriction-policies`範例列出您 AWS 帳戶的所有播放限制政策。
```
aws ivs list-playback-restriction-policies
```
輸出：
```
{
"playbackRestrictionPolicies": [
{
"arn": "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ",
"allowedCountries": [
"US",
"MX"
],
"allowedOrigins": [
"https://www.website1.com",
"https://www.website2.com"
],
"enableStrictOriginEnforcement": true,
"name": "test-playback-restriction-policy",
"tags": {
"key1": "value1",
"key2": "value2"
}
}
]
}
```
如需詳細資訊，請參閱《IVS 低延遲使用者指南》**中的[不需要的內容和檢視器](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/undesired-content.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListPlaybackRestrictionPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/list-playback-restriction-policies.html)。
### `list-recording-configurations`
以下程式碼範例顯示如何使用 `list-recording-configurations`。
**AWS CLI**
**列出在此帳戶中建立的所有 RecordingConfiguration 資源**
下列 `list-recording-configurations` 範例會取得您帳戶中所有 RecordingConfiguration 資源的相關資訊。
```
aws ivs list-recording-configurations
```
輸出：
```
{
"recordingConfigurations": [
{
"arn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABcdef34ghIJ",
"name": "test-recording-config-1",
"destinationConfiguration": {
"s3": {
"bucketName": "demo-recording-bucket-1"
}
},
"state": "ACTIVE",
"tags": {}
},
{
"arn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/CD12abcdGHIJ",
"name": "test-recording-config-2",
"destinationConfiguration": {
"s3": {
"bucketName": "demo-recording-bucket-2"
}
},
"state": "ACTIVE",
"tags": {}
}
]
}
```
如需詳細資訊，請參閱《Amazon 互動式影片服務使用者指南》**中的[記錄至 Amazon S3](https://docs.aws.amazon.com/ivs/latest/userguide/record-to-s3.html)。
+ 如需 API 詳細資訊，請參閱 *AWS CLI Command Reference* 中的 [ListRecordingConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/list-recording-configurations.html)。
### `list-stream-keys`
以下程式碼範例顯示如何使用 `list-stream-keys`。
**AWS CLI**
**取得串流金鑰清單**
下列 `list-stream-keys` 範例列出指定 ARN (Amazon Resource Name) 的所有串流金鑰。
```
aws ivs list-stream-keys \
--channel-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh
```
輸出：
```
{
"streamKeys": [
{
"arn": "arn:aws:ivs:us-west-2:123456789012:stream-key/abcdABCDefgh",
"channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
"tags": {}
}
]
}
```
如需詳細資訊，請參閱《IVS 低延遲使用者指南》**中的[建立頻道](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListStreamKeys](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/list-stream-keys.html)。
### `list-stream-sessions`
以下程式碼範例顯示如何使用 `list-stream-sessions`。
**AWS CLI**
**取得目前 AWS 區域中指定頻道的目前和先前串流摘要**
下列 `list-stream-sessions` 範例會報告指定頻道 ARN (Amazon Resource Name) 之串流的摘要資訊。
```
aws ivs list-stream-sessions \
--channel-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh \
--max-results 25 \
--next-token ""
```
輸出：
```
{
"nextToken": "set-2",
"streamSessions": [
{
"startTime": 1641578182,
"endTime": 1641579982,
"hasErrorEvent": false,
"streamId": "mystream"
}
...
]
}
```
如需詳細資訊，請參閱《IVS 低延遲使用者指南》**中的[建立頻道](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListStreamSessions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/list-stream-sessions.html)。
### `list-streams`
以下程式碼範例顯示如何使用 `list-streams`。
**AWS CLI**
**取得即時串流及其狀態的清單**
下列`list-streams`範例列出您 AWS 帳戶的所有即時串流。
```
aws ivs list-streams
```
輸出：
```
{
"streams": [
{
"channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
"state": "LIVE",
"health": "HEALTHY",
"streamId": "st-ABCDEfghij01234KLMN5678",
"viewerCount": 1
}
]
}
```
如需詳細資訊，請參閱《IVS 低延遲使用者指南》**中的[建立頻道](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListStreams](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/list-streams.html)。
### `list-tags-for-resource`
以下程式碼範例顯示如何使用 `list-tags-for-resource`。
**AWS CLI**
**列出 AWS 資源的所有標籤 （例如：頻道、串流金鑰）**
下列 `list-tags-for-resource` 範例列出指定資源 ARN (Amazon Resource Name) 的所有標籤。
```
aws ivs list-tags-for-resource \
--resource-arn arn:aws:ivs:us-west-2:12345689012:channel/abcdABCDefgh
```
輸出：
```
{
"tags":
{
"key1": "value1",
"key2": "value2"
}
}
```
如需詳細資訊，請參閱《*Amazon Interactive Video Service API 參考*》中的[標記](https://docs.aws.amazon.com/ivs/latest/APIReference/Welcome.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/list-tags-for-resource.html)。
### `put-metadata`
以下程式碼範例顯示如何使用 `put-metadata`。
**AWS CLI**
**將中繼資料插入指定頻道的作用中串流**
下列 `put-metadata` 範例會將指定的中繼資料插入指定頻道的串流。
```
aws ivs put-metadata \
--channel-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh \
--metadata '{"my": "metadata"}'
```
此命令不會產生輸出。
如需詳細資訊，請參閱《IVS 低延遲使用者指南》**中的[建立頻道](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [PutMetadata](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/put-metadata.html)。
### `start-viewer-session-revocation`
以下程式碼範例顯示如何使用 `start-viewer-session-revocation`。
**AWS CLI**
**撤銷指定多頻道 ARN 和檢視器 ID 對的檢視器工作階段**
下列 `start-viewer-session-revocation` 範例會開始撤銷與指定頻道 ARN 和檢視器 ID 相關聯的檢視器工作階段，直到並包括指定的工作階段版本編號。如果未提供版本，則預設為 0。
```
aws ivs batch-start-viewer-session-revocation \
--channel-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh \
--viewer-id abcdefg \
--viewer-session-versions-less-than-or-equal-to 1234567890
```
此命令不會產生輸出。
如需詳細資訊，請參閱《Amazon 互動式影片服務使用者指南》中的[設定私有頻道](https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [StartViewerSessionRevocation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/start-viewer-session-revocation.html)。
### `stop-stream`
以下程式碼範例顯示如何使用 `stop-stream`。
**AWS CLI**
**停止指定的串流**
下列 `stop-stream` 範例會停止指定頻道上的串流。
```
aws ivs stop-stream \
--channel-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh
```
此命令不會產生輸出。
如需詳細資訊，請參閱《IVS 低延遲使用者指南》**中的[建立頻道](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [StopStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/stop-stream.html)。
### `tag-resource`
以下程式碼範例顯示如何使用 `tag-resource`。
**AWS CLI**
**新增或更新 AWS 資源的標籤 （例如：頻道、串流金鑰）**
下列 `tag-resource` 範例會新增或更新指定資源 ARN (Amazon Resource Name) 的標籤。
```
aws ivs tag-resource \
--resource-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh \
--tags "tagkey1=tagvalue1, tagkey2=tagvalue2"
```
此命令不會產生輸出。
如需詳細資訊，請參閱《*Amazon Interactive Video Service API 參考*》中的[標記](https://docs.aws.amazon.com/ivs/latest/APIReference/Welcome.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/tag-resource.html)。
### `untag-resource`
以下程式碼範例顯示如何使用 `untag-resource`。
**AWS CLI**
**移除 AWS 資源的標籤 （例如：頻道、串流金鑰）**
下列 `untag-resource` 範例會移除指定資源 ARN (Amazon Resource Name) 的指定標籤。
```
aws ivs untag-resource \
--resource-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh \
--tag-keys "tagkey1, tagkey2"
```
此命令不會產生輸出。
如需詳細資訊，請參閱《*Amazon Interactive Video Service API 參考*》中的[標記](https://docs.aws.amazon.com/ivs/latest/APIReference/Welcome.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/untag-resource.html)。
### `update-channel`
以下程式碼範例顯示如何使用 `update-channel`。
**AWS CLI**
**範例 1：更新頻道的組態資訊**
下列 `update-channel` 範例會更新指定頻道 ARN 的頻道組態，以變更頻道名稱。這不會影響此頻道的持續串流；您必須停止並重新啟動串流，變更才會生效。
```
aws ivs update-channel \
--arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \
--name 'channel-1' \
--insecure-ingest
```
輸出：
```
{
"channel": {
"arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
"name": "channel-1",
"latencyMode": "LOW",
"containerFormat": "TS",
"multitrackInputConfiguration": {
"enabled": false,
"maximumResolution": "FULL_HD",
"policy": "ALLOW"
},
"type": "STANDARD",
"playbackRestrictionPolicyArn": "",
"recordingConfigurationArn": "",
"srt": {
"endpoint": "a1b2c3d4e5f6.srt.live-video.net",
"passphrase": "AB1C2defGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
},
"ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
"insecureIngest": true,
"playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8",
"preset": "",
"authorized": false,
"tags": {}
}
```
如需詳細資訊，請參閱《IVS 低延遲使用者指南》**中的[建立頻道](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html)。
**範例 2：更新頻道的組態以啟用錄製**
下列 `update-channel` 範例會更新指定頻道 ARN 的頻道組態，以啟用錄製。這不會影響此頻道的持續串流；您必須停止並重新啟動串流，變更才會生效。
```
aws ivs update-channel \
--arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \
--no-insecure-ingest \
--recording-configuration-arn 'arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABCD12cdEFgh'
```
輸出：
```
{
"channel": {
"arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
"name": "test-channel-with-recording",
"latencyMode": "LOW",
"containerFormat": "TS",
"multitrackInputConfiguration": {
"enabled": false,
"maximumResolution": "FULL_HD",
"policy": "ALLOW"
},
"type": "STANDARD",
"playbackRestrictionPolicyArn": "",
"recordingConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABCD12cdEFgh",
"srt": {
"endpoint": "a1b2c3d4e5f6.srt.live-video.net",
"passphrase": "BA1C2defGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
},
"ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
"insecureIngest": false,
"playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8",
"preset": "",
"authorized": false,
"tags": {}
}
}
```
如需詳細資訊，請參閱《IVS 低延遲使用者指南》**中的[記錄到 Amazon S3](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/record-to-s3.html)。
**範例 3：更新頻道的組態以停用錄製**
下列 `update-channel` 範例會更新指定頻道 ARN 的頻道組態，以停用錄製。這不會影響此頻道的持續串流；您必須停止並重新啟動串流，變更才會生效。
```
aws ivs update-channel \
--arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \
--recording-configuration-arn ''
```
輸出：
```
{
"channel": {
"arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
"name": "test-channel-with-recording",
"latencyMode": "LOW",
"containerFormat": "TS",
"multitrackInputConfiguration": {
"enabled": false,
"maximumResolution": "FULL_HD",
"policy": "ALLOW"
},
"type": "STANDARD",
"playbackRestrictionPolicyArn": "",
"recordingConfigurationArn": "",
"srt": {
"endpoint": "a1b2c3d4e5f6.srt.live-video.net",
"passphrase": "AB1C2edfGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
},
"ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
"insecureIngest": false,
"playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8",
"preset": "",
"authorized": false,
"tags": {}
}
}
```
如需詳細資訊，請參閱《IVS 低延遲使用者指南》**中的[記錄到 Amazon S3](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/record-to-s3.html)。
**範例 4：更新頻道的組態以啟用播放限制**
下列 `update-channel` 範例會更新指定頻道 ARN 的頻道組態，以套用播放限制政策。這不會影響此頻道的持續串流；您必須停止並重新啟動串流，變更才會生效。
```
aws ivs update-channel \
--arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \
--no-insecure-ingest \
--playback-restriction-policy-arn 'arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ'
```
輸出：
```
{
"channel": {
"arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
"name": "test-channel-with-playback-restriction-policy",
"latencyMode": "LOW",
"containerFormat": "TS",
"multitrackInputConfiguration": {
"enabled": false,
"maximumResolution": "FULL_HD",
"policy": "ALLOW"
},
"type": "STANDARD",
"playbackRestrictionPolicyArn": "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ",
"recordingConfigurationArn": "",
"srt": {
"endpoint": "a1b2c3d4e5f6.srt.live-video.net",
"passphrase": "AB1C2defGHijkLMNo3PqQRstUvwxyzaCBDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
},
"ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
"insecureIngest": false,
"playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8",
"preset": "",
"authorized": false,
"tags": {}
}
}
```
如需詳細資訊，請參閱《IVS 低延遲使用者指南》**中的[不需要的內容和檢視器](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/undesired-content.html)。
**範例 5：更新頻道的組態以停用播放限制**
下列 `update-channel` 範例會更新指定頻道 ARN 的頻道組態，以停用播放限制。這不會影響此頻道的持續串流；您必須停止並重新啟動串流，變更才會生效。
```
aws ivs update-channel \
--arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \
--playback-restriction-policy-arn ''
```
輸出：
```
{
"channel": {
"arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
"name": "test-channel-with-playback-restriction-policy",
"latencyMode": "LOW",
"containerFormat": "TS",
"multitrackInputConfiguration": {
"enabled": false,
"maximumResolution": "FULL_HD",
"policy": "ALLOW"
},
"type": "STANDARD",
"playbackRestrictionPolicyArn": "",
"recordingConfigurationArn": "",
"srt": {
"endpoint": "a1b2c3d4e5f6.srt.live-video.net",
"passphrase": "AB1C2defGHijkLMNo3PqQRstUvwxyzaBCDeFghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
},
"ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
"insecureIngest": false,
"playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8",
"preset": "",
"authorized": false,
"tags": {}
}
}
```
如需詳細資訊，請參閱《IVS 低延遲使用者指南》**中的[不需要的內容和檢視器](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/undesired-content.html)。
**範例 6：更新頻道的組態以啟用多軌**
下列 `update-channel` 範例會更新指定頻道 ARN 的頻道組態，以啟用多軌。這不會影響此頻道的持續串流；您必須停止並重新啟動串流，變更才會生效。
```
aws ivs update-channel \
--arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \
--container-format 'FRAGMENTED_MP4' \
--multitrack-input-configuration '{"enabled": true,"maximumResolution": "FULL_HD","policy": "ALLOW"}'
```
輸出：
```
{
"channel": {
"arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
"containerFormat": "FRAGMENTED_MP4",
"name": "test-channel-with-multitrack",
"latencyMode": "LOW",
"multitrackInputConfiguration": {
"enabled": true,
"maximumResolution": "FULL_HD",
"policy": "ALLOW"
},
"type": "STANDARD",
"playbackRestrictionPolicyArn": "",
"recordingConfigurationArn": "",
"srt": {
"endpoint": "a1b2c3d4e5f6.srt.live-video.net",
"passphrase": "AB1C2defGHijkLMNo3PqQRstUvwxyzaCBDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
},
"ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
"insecureIngest": false,
"playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8",
"preset": "",
"authorized": false,
"tags": {}
}
}
```
如需詳細資訊，請參閱《IVS 低延遲使用者指南》**中的[不需要的內容和檢視器](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multitrack-video.html)。
**範例 7：更新頻道的組態以停用播放限制**
下列 `update-channel` 範例會更新指定頻道 ARN 的頻道組態，以停用多軌。這不會影響此頻道的持續串流；您必須停止並重新啟動串流，變更才會生效。
```
aws ivs update-channel \
--arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \
--container-format 'TS' \
--multitrack-input-configuration '{"enabled": false}'
```
輸出：
```
{
"channel": {
""arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
"containerFormat": "TS",
"name": "test-channel-with-multitrack",
"latencyMode": "LOW",
"multitrackInputConfiguration": {
"enabled": false,
"maximumResolution": "FULL_HD",
"policy": "ALLOW"
},
"type": "STANDARD",
"playbackRestrictionPolicyArn": "",
"recordingConfigurationArn": "",
"srt": {
"endpoint": "a1b2c3d4e5f6.srt.live-video.net",
"passphrase": "AB1C2defGHijkLMNo3PqQRstUvwxyzaCBDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
},
"ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
"insecureIngest": false,
"playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8",
"preset": "",
"authorized": false,
"tags": {}
}
}
```
如需詳細資訊，請參閱《IVS 低延遲使用者指南》**中的[不需要的內容和檢視器](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multitrack-video.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [UpdateChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/update-channel.html)。
### `update-playback-restriction-policy`
以下程式碼範例顯示如何使用 `update-playback-restriction-policy`。
**AWS CLI**
**更新播放限制政策**
下列 `update-playback-restriction-policy` 範例會更新具有指定政策 ARN 的播放限制政策，以停用嚴格的原始伺服器強制執行。這不會影響相關聯頻道的持續串流；您必須停止並重新啟動串流，變更才會生效。
```
aws ivs update-playback-restriction-policy \
--arn "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ" \
--no-enable-strict-origin-enforcement
```
輸出：
```
{
"playbackRestrictionPolicy": {
"arn": "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ",
"allowedCountries": [
"US",
"MX"
],
"allowedOrigins": [
"https://www.website1.com",
"https://www.website2.com"
],
"enableStrictOriginEnforcement": false,
"name": "test-playback-restriction-policy",
"tags": {
"key1": "value1",
"key2": "value2"
}
}
}
```
如需詳細資訊，請參閱《IVS 低延遲使用者指南》**中的[不需要的內容和檢視器](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/undesired-content.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [UpdatePlaybackRestrictionPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/update-playback-restriction-policy.html)。