Amazon IVS examples using AWS CLI

次のコード例は、Amazon IVS で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。

アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。

各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。

トピック

アクション

アクション

次のコード例では、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 Low-Latency ユーザーガイド」の「チャネルの作成」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「BatchGetChannel」を参照してください。

次のコード例では、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 Low-Latency ユーザーガイド」の「チャネルの作成」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「BatchGetStreamKey」を参照してください。

次のコード例では、batch-start-viewer-session-revocation を使用する方法を示しています。

AWS CLI

複数の channel-ARN と viewer-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 Interactive Video Service ユーザーガイド」の「プライベートチャネルの設定」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「BatchStartViewerSessionRevocation」を参照してください。

次のコード例では、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 Low-Latency ユーザーガイド」の「チャネルの作成」を参照してください。

例 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 Low-Latency ユーザーガイド」の「Amazon S3 に記録」を参照してください。

例 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 Low-Latency ユーザーガイド」の「望ましくないコンテンツと視聴者」を参照してください。

例 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 Low-Latency ユーザーガイド」の「チャネルの作成」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「CreateChannel」を参照してください。

次のコード例では、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 Low-Latency ユーザーガイド」の「望ましくないコンテンツと視聴者」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「CreatePlaybackRestrictionPolicy」を参照してください。

次のコード例では、create-recording-configuration を使用する方法を示しています。

AWS CLI

RecordingConfiguration リソースを作成するには

次の create-recording-configuration の例では、Amazon S3 への録画を有効にする RecordingConfiguration リソースを作成します。


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 Interactive Video Service ユーザーガイド」の「Amazon S3 に記録」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「CreateRecordingConfiguration」を参照してください。

次のコード例では、create-stream-key を使用する方法を示しています。

AWS CLI

ストリームキーを作成するには

次の create-stream-key の例では、指定された ARN (Amazon リソースネーム) のストリームキーを作成します。


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 Low-Latency ユーザーガイド」の「チャネルの作成」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「CreateStreamKey」を参照してください。

次のコード例では、delete-channel を使用する方法を示しています。

AWS CLI

チャネルとその関連ストリームキーを削除するには

次の delete-channel の例では、指定された ARN (Amazon リソースネーム) を持つチャネルを削除します。


aws ivs delete-channel \
    --arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh

このコマンドは何も出力しません。

詳細については、「IVS Low-Latency ユーザーガイド」の「チャネルの作成」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteChannel」を参照してください。

次のコード例では、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 Interactive Video Service ユーザーガイド」の「プライベートチャネルの設定」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「DeletePlaybackKeyPair」を参照してください。

次のコード例では、delete-playback-restriction-policy を使用する方法を示しています。

AWS CLI

再生制限ポリシーを削除するには

次の delete-playback-restriction-policy の例では、指定されたポリシー ARN (Amazon リソースネーム) を持つ再生制限ポリシーを削除します。


aws ivs delete-playback-restriction-policy \
    --arn "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ"

このコマンドは何も出力しません。

詳細については、「IVS Low-Latency ユーザーガイド」の「望ましくないコンテンツと視聴者」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「DeletePlaybackRestrictionPolicy」を参照してください。

次のコード例では、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 Interactive Video Service ユーザーガイド」の「Amazon S3 に記録」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteRecordingConfiguration」を参照してください。

次のコード例では、delete-stream-key を使用する方法を示しています。

AWS CLI

ストリームキーを削除するには

次の delete-stream-key の例では、指定された ARN (Amazon リソースネーム) のストリームキーを削除して、ストリーミングに使用できないようにします。


aws ivs delete-stream-key \
    --arn arn:aws:ivs:us-west-2:123456789012:stream-key/g1H2I3j4k5L6

このコマンドは何も出力しません。

詳細については、「IVS Low-Latency ユーザーガイド」の「チャネルの作成」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteStreamKey」を参照してください。

次のコード例では、get-channel を使用する方法を示しています。

AWS CLI

チャネルの設定情報を取得するには

次の get-channel の例では、指定されたチャネル ARN (Amazon リソースネーム) のチャネル設定を取得します。


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 Low-Latency ユーザーガイド」の「チャネルの作成」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「GetChannel」を参照してください。

次のコード例では、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 Interactive Video Service ユーザーガイド」の「プライベートチャネルの設定」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「GetPlaybackKeyPair」を参照してください。

次のコード例では、get-playback-restriction-policy を使用する方法を示しています。

AWS CLI

再生制限ポリシーの設定情報を取得するには

次の get-playback-restriction-policy の例では、指定されたポリシー ARN (Amazon リソースネーム) を持つ再生制限ポリシーの設定を取得します。


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 Low-Latency ユーザーガイド」の「望ましくないコンテンツと視聴者」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「GetPlaybackRestrictionPolicy」を参照してください。

次のコード例では、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 Interactive Video Service ユーザーガイド」の「Amazon S3 に記録」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「GetRecordingConfiguration」を参照してください。

次のコード例では、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 Low-Latency ユーザーガイド」の「チャネルの作成」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「GetStreamKey」を参照してください。

次のコード例では、get-stream-session を使用する方法を示しています。

AWS CLI

指定されたストリームのメタデータを取得するには

次の get-stream-session の例では、指定されたチャネル ARN (Amazon リソースネーム) と指定されたストリームのメタデータ設定を取得します。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 Low-Latency ユーザーガイド」の「チャネルの作成」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「GetStreamSession」を参照してください。

次のコード例では、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 Low-Latency ユーザーガイド」の「チャネルの作成」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「GetStream」を参照してください。

次のコード例では、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 Interactive Video Service ユーザーガイド」の「プライベートチャネルの設定」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「ImportPlaybackKeyPair」を参照してください。

次のコード例では、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 Low-Latency ユーザーガイド」の「チャネルの作成」を参照してください。

例 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 Low-Latency ユーザーガイド」の「Amazon S3 に記録」を参照してください。

例 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 Low-Latency ユーザーガイド」の「望ましくないコンテンツと視聴者」を参照してください。

API の詳細については、AWS CLI コマンドリファレンスの「ListChannels」を参照してください。

次のコード例では、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 Interactive Video Service ユーザーガイド」の「プライベートチャネルの設定」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「ListPlaybackKeyPairs」を参照してください。

次のコード例では、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 Low-Latency ユーザーガイド」の「望ましくないコンテンツと視聴者」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「ListPlaybackRestrictionPolicies」を参照してください。

次のコード例では、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 Interactive Video Service ユーザーガイド」の「Amazon S3 に記録」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「ListRecordingConfigurations」を参照してください。

次のコード例では、list-stream-keys を使用する方法を示しています。

AWS CLI

ストリームキーのリストを取得するには

次の list-stream-keys の例では、指定された ARN (Amazon リソースネーム) のすべてのストリームキーを一覧表示します。


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 Low-Latency ユーザーガイド」の「チャネルの作成」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「ListStreamKeys」を参照してください。

次のコード例では、list-stream-sessions を使用する方法を示しています。

AWS CLI

現在の AWS リージョンにおける指定されたチャネルの現在および以前のストリームの概要を取得するには

次の list-stream-sessions の例では、指定されたチャネル ARN (Amazon リソースネーム) のストリームの概要情報をレポートします。


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 Low-Latency ユーザーガイド」の「チャネルの作成」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「ListStreamSessions」を参照してください。

次のコード例では、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 Low-Latency ユーザーガイド」の「チャネルの作成」を参照してください。

API の詳細については、AWS CLI コマンドリファレンスの「ListStreams」を参照してください。

次のコード例では、list-tags-for-resource を使用する方法を示しています。

AWS CLI

AWS リソース (チャネル、ストリームキーなど) のすべてのタグを一覧表示するには

次の list-tags-for-resource の例では、指定されたリソース ARN (Amazon リソースネーム) のすべてのタグを一覧表示します。


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 リファレンス」の「Tagging」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「ListTagsForResource」を参照してください。

次のコード例では、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 Low-Latency ユーザーガイド」の「チャネルの作成」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「PutMetadata」を参照してください。

次のコード例では、start-viewer-session-revocation を使用する方法を示しています。

AWS CLI

特定の複数の channel-ARN と viewer-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 Interactive Video Service ユーザーガイド」の「プライベートチャネルの設定」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「StartViewerSessionRevocation」を参照してください。

次のコード例では、stop-stream を使用する方法を示しています。

AWS CLI

指定されたストリームを停止するには

次の stop-stream の例では、指定されたチャネルのストリームを停止します。


aws ivs stop-stream \
    --channel-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh

このコマンドは何も出力しません。

詳細については、「IVS Low-Latency ユーザーガイド」の「チャネルの作成」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「StopStream」を参照してください。

次のコード例では、tag-resource を使用する方法を示しています。

AWS CLI

AWS リソース (チャネル、ストリームキーなど) のタグを追加または更新するには

次の tag-resource の例では、指定されたリソース ARN (Amazon リソースネーム) のタグを追加または更新します。


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 リファレンス」の「Tagging」を参照してください。

API の詳細については、AWS CLI コマンドリファレンスの「TagResource」を参照してください。

次のコード例では、untag-resource を使用する方法を示しています。

AWS CLI

AWS リソースのタグ (チャンル、ストリームキーなど) を削除するには

次の untag-resource の例では、指定されたリソース ARN (Amazon リソースネーム) の指定されたタグを削除します。


aws ivs untag-resource \
    --resource-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh \
    --tag-keys "tagkey1, tagkey2"

このコマンドは何も出力しません。

詳細については、「Amazon Interactive Video Service API リファレンス」の「Tagging」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「UntagResource」を参照してください。

次のコード例では、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 Low-Latency ユーザーガイド」の「チャネルの作成」を参照してください。

例 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 Low-Latency ユーザーガイド」の「Amazon S3 に記録」を参照してください。

例 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 Low-Latency ユーザーガイド」の「Amazon S3 に記録」を参照してください。

例 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 Low-Latency ユーザーガイド」の「望ましくないコンテンツと視聴者」を参照してください。

例 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 Low-Latency ユーザーガイド」の「望ましくないコンテンツと視聴者」を参照してください。

例 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 Low-Latency ユーザーガイド」の「望ましくないコンテンツと視聴者」を参照してください。

例 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 Low-Latency ユーザーガイド」の「望ましくないコンテンツと視聴者」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「UpdateChannel」を参照してください。

次のコード例では、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 Low-Latency ユーザーガイド」の「望ましくないコンテンツと視聴者」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「UpdatePlaybackRestrictionPolicy」を参照してください。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

AWS IoT Wireless

Amazon IVS Chat