를 사용한 Amazon IVS 실시간 스트리밍 예제 AWS CLI - AWS Command Line Interface
작업

이 설명서는 의 버전 1 AWS CLI 전용입니다. 의 버전 2와 관련된 설명서는 버전 2 사용 설명서 를 AWS CLI참조하세요.

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

를 사용한 Amazon IVS 실시간 스트리밍 예제 AWS CLI

다음 코드 예제에서는 Amazon IVS Real-Time Streaming과 AWS Command Line Interface 함께 를 사용하여 작업을 수행하고 일반적인 시나리오를 구현하는 방법을 보여줍니다.

작업은 대규모 프로그램에서 발췌한 코드이며 컨텍스트에 맞춰 실행해야 합니다. 작업은 개별 서비스 함수를 직접적으로 호출하는 방법을 보여주며 관련 시나리오의 컨텍스트에 맞는 작업을 볼 수 있습니다.

각 예제에는 컨텍스트에서 코드를 설정하고 실행하는 방법에 대한 지침을 찾을 수 있는 전체 소스 코드에 대한 링크가 포함되어 있습니다.

주제

작업

다음 코드 예시에서는 create-encoder-configuration을 사용하는 방법을 보여 줍니다.

AWS CLI

구성 인코더 구성을 생성하려면

다음 create-encoder-configuration 예제에서는 지정된 속성을 사용하여 구성 인코더 구성을 생성합니다.

aws ivs-realtime create-encoder-configuration \
    --name test-ec --video bitrate=3500000,framerate=30.0,height=1080,width=1920

출력:

{
    "encoderConfiguration": {
        "arn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef",
        "name": "test-ec",
        "tags": {},
        "video": {
            "bitrate": 3500000,
            "framerate": 30,
            "height": 1080,
            "width": 1920
        }
    }
}

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 Amazon IVS Stream에서 다중 호스트 활성화를 참조하세요.

다음 코드 예시에서는 create-participant-token을 사용하는 방법을 보여 줍니다.

AWS CLI

스테이지 참가자 토큰을 생성하려면

다음 create-participant-token 예제에서는 지정된 단계에 대한 참가자 토크를 생성합니다.

aws ivs-realtime create-participant-token \
    --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
    --user-id bob

출력:

{
    "participantToken": {
        "expirationTime": "2023-03-07T09:47:43+00:00",
        "participantId": "ABCDEfghij01234KLMN6789",
        "token": "abcd1234defg5678"
    }
}

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 Amazon IVS Stream에서 다중 호스트 활성화를 참조하세요.

다음 코드 예시에서는 create-stage을 사용하는 방법을 보여 줍니다.

AWS CLI

예제 1: 스테이지 생성

다음 create-stage 예제에서는 지정된 사용자에 대한 스테이지 및 스테이지 참가자 토큰을 생성합니다.

aws ivs-realtime create-stage \
    --name stage1 \
    --participant-token-configurations userId=alice

출력:

{
    "participantTokens": [
        {
            "participantId": "ABCDEfghij01234KLMN5678",
            "token": "a1b2c3d4567890ab",
            "userId": "alice"
        }
    ],
    "stage": {
        "activeSessionId": "st-a1b2c3d4e5f6g",
        "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
        "endpoints": {
            "events": "wss://global.events.live-video.net",
            "whip": "https://1a2b3c4d5e6f.global-bm.whip.live-video.net"
        },
        "name": "stage1",
        "tags": {}
    }
}

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 Amazon IVS Stream에서 다중 호스트 활성화를 참조하세요.

예제 2: 스테이지를 생성하고 개별 참가자 레코딩을 구성하려면

다음 create-stage 예제에서는 스테이지를 생성하고 개별 참가자 레코딩을 구성합니다.

aws ivs-realtime create-stage \
    --name stage1 \
    --auto-participant-recording-configuration '{"mediaTypes": ["AUDIO_VIDEO"],"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh"}'

출력:

{
    "stage": {
        "activeSessionId": "st-a1b2c3d4e5f6g",
        "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
        "autoParticipantRecordingConfiguration": {
             "mediaTypes": [
                   "AUDIO_VIDEO"
             ],
             "storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh",
        },
        "endpoints": {
            "events": "wss://global.events.live-video.net",
            "whip": "https://1a2b3c4d5e6f.global-bm.whip.live-video.net"
        },
        "name": "stage1",
        "tags": {}
    }
}

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 Amazon IVS Stream에서 다중 호스트 활성화를 참조하세요.

  • 자세한 API 내용은 명령 참조CreateStage의 섹션을 참조하세요. AWS CLI

다음 코드 예시에서는 create-storage-configuration을 사용하는 방법을 보여 줍니다.

AWS CLI

구성 스토리지 구성을 생성하려면

다음 create-storage-configuration 예제에서는 지정된 속성을 사용하여 구성 스토리지 구성을 생성합니다.

aws ivs-realtime create-storage-configuration \
    --name "test-sc" --s3 "bucketName=test-bucket-name"

출력:

{
    "storageConfiguration": {
        "arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/ABabCDcdEFef",
        "name": "test-sc",
        "s3": {
            "bucketName": "test-bucket-name"
        },
        "tags": {}
    }
}

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 Amazon IVS Stream에서 다중 호스트 활성화를 참조하세요.

다음 코드 예시에서는 delete-encoder-configuration을 사용하는 방법을 보여 줍니다.

AWS CLI

구성 인코더 구성을 삭제하려면

다음은 지정된 ARN (Amazon 리소스 이름)에서 지정한 구성 인코더 구성을 delete-encoder-configuration 삭제합니다.

aws ivs-realtime delete-encoder-configuration \
    --arn "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 Amazon IVS Stream에서 다중 호스트 활성화를 참조하세요.

다음 코드 예시에서는 delete-public-key을 사용하는 방법을 보여 줍니다.

AWS CLI

퍼블릭 키를 삭제하려면

다음은 지정된 퍼블릭 키를 delete-public-key 삭제합니다.

aws ivs-realtime delete-public-key \
    --arn arn:aws:ivs:us-west-2:123456789012:public-key/abcdABC1efg2

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 Amazon 실시간 스트리밍 사용 설명서의 참가자 토큰 배포를 참조하세요. IVS

  • 자세한 API 내용은 명령 참조DeletePublicKey의 섹션을 참조하세요. AWS CLI

다음 코드 예시에서는 delete-stage을 사용하는 방법을 보여 줍니다.

AWS CLI

단계를 삭제하려면

다음 delete-stage 예제에서는 지정된 단계를 삭제합니다.

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

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 Amazon IVS Stream에서 다중 호스트 활성화를 참조하세요.

  • 자세한 API 내용은 명령 참조DeleteStage의 섹션을 참조하세요. AWS CLI

다음 코드 예시에서는 delete-storage-configuration을 사용하는 방법을 보여 줍니다.

AWS CLI

구성 스토리지 구성을 삭제하려면

다음은 지정된 ARN (Amazon 리소스 이름)에서 지정한 구성 스토리지 구성을 delete-storage-configuration 삭제합니다.

aws ivs-realtime delete-storage-configuration \
    --arn "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/ABabCDcdEFef"

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 Amazon IVS Stream에서 다중 호스트 활성화를 참조하세요.

다음 코드 예시에서는 disconnect-participant을 사용하는 방법을 보여 줍니다.

AWS CLI

스테이지 참가자 연결 해제

다음 disconnect-participant 예제에서는 지정된 참가자를 지정된 스테이지에서 연결 해제합니다.

aws ivs-realtime disconnect-participant \
    --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
    --participant-id ABCDEfghij01234KLMN5678

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 Amazon IVS Stream에서 다중 호스트 활성화를 참조하세요.

다음 코드 예시에서는 get-composition을 사용하는 방법을 보여 줍니다.

AWS CLI

예제 1: 기본 레이아웃 설정을 사용하여 구성을 가져오려면

다음 get-composition 예제에서는 지정된 ARN (Amazon 리소스 이름)에 대한 구성을 가져옵니다.

aws ivs-realtime get-composition \
    --arn "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh"

출력:

{
    "composition": {
        "arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh",
        "destinations": [
            {
                "configuration": {
                    "channel": {
                        "channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg",
                        "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
                    },
                    "name": ""
                },
                "id": "AabBCcdDEefF",
                "startTime": "2023-10-16T23:26:00+00:00",
                "state": "ACTIVE"
            },
            {
                "configuration": {
                    "name": "",
                    "s3": {
                        "encoderConfigurationArns": [
                            "arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
                        ],
                        "recordingConfiguration": {
                            "format": "HLS"
                        },
                        "storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"
                    }
                },
                "detail": {
                    "s3": {
                        "recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite"
                    }
                },
                "id": "GHFabcgefABC",
                "startTime": "2023-10-16T23:26:00+00:00",
                "state": "STARTING"
            }
        ],
        "layout": {
            "grid": {
                "featuredParticipantAttribute": ""
                "gridGap": 2,
                "omitStoppedVideo": false,
                "videoAspectRatio": "VIDEO",
                "videoFillMode": ""                }
        },
        "stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd",
        "startTime": "2023-10-16T23:24:00+00:00",
        "state": "ACTIVE",
        "tags": {}
    }
}

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 복합 레코딩(실시간 스트리밍)을 참조하세요.

예제 2: PiP 레이아웃을 사용하여 구성을 가져오려면

다음 get-composition 예제에서는 PiP 레이아웃을 사용하는 지정된 ARN (Amazon 리소스 이름)의 구성을 가져옵니다.

aws ivs-realtime get-composition \
    --arn "arn:aws:ivs:ap-northeast-1:123456789012:composition/wxyzWXYZpqrs"

출력:

{
    "composition": {
        "arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/wxyzWXYZpqrs",
        "destinations": [
            {
                "configuration": {
                    "channel": {
                        "channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg",
                        "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
                    },
                    "name": ""
                },
                "id": "AabBCcdDEefF",
                "startTime": "2023-10-16T23:26:00+00:00",
                "state": "ACTIVE"
            },
            {
                "configuration": {
                    "name": "",
                    "s3": {
                        "encoderConfigurationArns": [
                            "arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
                        ],
                        "recordingConfiguration": {
                            "format": "HLS"
                        },
                        "storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"
                    }
                },
                "detail": {
                    "s3": {
                        "recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite"
                    }
                },
                "id": "GHFabcgefABC",
                "startTime": "2023-10-16T23:26:00+00:00",
                "state": "STARTING"
            }
        ],
        "layout": {
            "pip": {
                "featuredParticipantAttribute": "abcdefg",
                "gridGap": 0,
                "omitStoppedVideo": false,
                "pipBehavior": "STATIC",
                "pipOffset": 0,
                "pipParticipantAttribute": "",
                "pipPosition": "BOTTOM_RIGHT",
                "videoFillMode": "COVER"
            }
        },
        "stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd",
        "startTime": "2023-10-16T23:24:00+00:00",
        "state": "ACTIVE",
        "tags": {}
    }
}

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 복합 레코딩(실시간 스트리밍)을 참조하세요.

  • 자세한 API 내용은 명령 참조GetComposition의 섹션을 참조하세요. AWS CLI

다음 코드 예시에서는 get-encoder-configuration을 사용하는 방법을 보여 줍니다.

AWS CLI

구성 인코더 구성을 가져오려면

다음 get-encoder-configuration 예제에서는 지정된 ARN (Amazon 리소스 이름)에서 지정한 구성 인코더 구성을 가져옵니다.

aws ivs-realtime get-encoder-configuration \
    --arn "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/abcdABCDefgh"

출력:

{
    "encoderConfiguration": {
        "arn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/abcdABCDefgh",
        "name": "test-ec",
        "tags": {},
        "video": {
            "bitrate": 3500000,
            "framerate": 30,
            "height": 1080,
            "width": 1920
        }
    }
}

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 Amazon IVS Stream에서 다중 호스트 활성화를 참조하세요.

다음 코드 예시에서는 get-participant을 사용하는 방법을 보여 줍니다.

AWS CLI

스테이지 참가자를 가져오려면

다음 get-participant 예제에서는 지정된 스테이지(ARNAmazon 리소스 이름)의 지정된 참가자 ID 및 세션 ID에 대한 스테이지 참가자를 가져옵니다.

aws ivs-realtime get-participant \
    --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
    --session-id st-a1b2c3d4e5f6g \
    --participant-id abCDEf12GHIj

출력:

{
    "participant": {
        "browserName", "Google Chrome",
        "browserVersion", "116",
        "firstJoinTime": "2023-04-26T20:30:34+00:00",
        "ispName", "Comcast",
        "osName", "Microsoft Windows 10 Pro",
        "osVersion", "10.0.19044"
        "participantId": "abCDEf12GHIj",
        "published": true,
        "recordingS3BucketName": "bucket-name",
        "recordingS3Prefix": "abcdABCDefgh/st-a1b2c3d4e5f6g/abCDEf12GHIj/1234567890",
        "recordingState": "ACTIVE",
        "sdkVersion", "",
        "state": "CONNECTED",
        "userId": "",
    }
}

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 Amazon IVS Stream에서 다중 호스트 활성화를 참조하세요.

  • 자세한 API 내용은 명령 참조GetParticipant의 섹션을 참조하세요. AWS CLI

다음 코드 예시에서는 get-public-key을 사용하는 방법을 보여 줍니다.

AWS CLI

스테이지 참가자 토큰에 서명하는 데 사용되는 기존 퍼블릭 키를 가져오려면

다음 get-public-key 예제에서는 제공된 ARN에서 지정된 퍼블릭 키를 가져와서 스테이지 참가자 토큰을 사이징합니다.

aws ivs-realtime get-public-key \
    --arn arn:aws:ivs:us-west-2:123456789012:public-key/abcdABC1efg2

출력:

{
    "publicKey": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:public-key/abcdABC1efg2",
        "name": "",
        "publicKeyMaterial": "-----BEGIN PUBLIC KEY-----\nMHYwEAYHKoZIzj0CAQYFK4EEACIDYgAEqVWUtqs6EktQMR1sCYmEzGvRwtaycI16\n9pmzcpiWu/uhNStGlteJ5odRfRwVkoQUMnSZXTCcbn9bBTTmiWo4mJcFOOAzsthH\n0UAb8NdD4tUE0At4a9hYP9IETEXAMPLE\n-----END PUBLIC KEY-----",
        "fingerprint": "12:a3:44:56:bc:7d:e8:9f:10:2g:34:hi:56:78:90:12",
        "tags": {}
    }
}

자세한 내용은 Amazon 실시간 스트리밍 사용 설명서의 참가자 토큰 배포를 참조하세요. IVS

  • 자세한 API 내용은 명령 참조GetPublicKey의 섹션을 참조하세요. AWS CLI

다음 코드 예시에서는 get-stage-session을 사용하는 방법을 보여 줍니다.

AWS CLI

스테이지 세션을 가져오려면

다음 get-stage-session 예제에서는 지정된 스테이지(ARNAmazon 리소스 이름)의 지정된 세션 ID에 대한 스테이지 세션을 가져옵니다.

aws ivs-realtime get-stage-session \
    --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
    --session-id st-a1b2c3d4e5f6g

출력:

{
    "stageSession": {
        "endTime": "2023-04-26T20:36:29+00:00",
        "sessionId": "st-a1b2c3d4e5f6g",
        "startTime": "2023-04-26T20:30:29.602000+00:00"
    }
}

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 Amazon IVS Stream에서 다중 호스트 활성화를 참조하세요.

  • 자세한 API 내용은 명령 참조GetStageSession의 섹션을 참조하세요. AWS CLI

다음 코드 예시에서는 get-stage을 사용하는 방법을 보여 줍니다.

AWS CLI

스테이지의 구성 정보를 가져오려면

다음 get-stage 예제에서는 지정된 스테이지ARN(Amazon 리소스 이름)에 대한 스테이지 구성을 가져옵니다.

aws ivs-realtime get-stage \
    --arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh

출력:

{
    "stage": {
        "activeSessionId": "st-a1b2c3d4e5f6g",
        "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
        "autoParticipantRecordingConfiguration": {
             "mediaTypes": [
                   "AUDIO_VIDEO"
             ],
             "storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh",
        },
        "endpoints": {
            "events": "wss://global.events.live-video.net",
            "whip": "https://1a2b3c4d5e6f.global-bm.whip.live-video.net"
        },
        "name": "test",
        "tags": {}
    }
}

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 Amazon IVS Stream에서 다중 호스트 활성화를 참조하세요.

  • 자세한 API 내용은 명령 참조GetStage의 섹션을 참조하세요. AWS CLI

다음 코드 예시에서는 get-storage-configuration을 사용하는 방법을 보여 줍니다.

AWS CLI

구성 스토리지 구성을 가져오려면

다음 get-storage-configuration 예제에서는 지정된 ARN (Amazon 리소스 이름)에서 지정한 구성 스토리지 구성을 가져옵니다.

aws ivs-realtime get-storage-configuration \
    --name arn "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/abcdABCDefgh"

출력:

{
    "storageConfiguration": {
        "arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/abcdABCDefgh",
        "name": "test-sc",
        "s3": {
            "bucketName": "test-bucket-name"
        },
        "tags": {}
    }
}

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 Amazon IVS Stream에서 다중 호스트 활성화를 참조하세요.

다음 코드 예시에서는 import-public-key을 사용하는 방법을 보여 줍니다.

AWS CLI

스테이지 참가자 토큰에 서명하는 데 사용할 기존 퍼블릭 키를 가져오려면

다음 import-public-key 예제에서는 스테이지 참가자 토큰을 크기 조정하는 데 사용할 퍼블릭 키를 자재 파일에서 가져옵니다.

aws ivs-realtime import-public-key \
    --public-key-material="`cat public.pem`"

출력:

{
    "publicKey": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:public-key/abcdABC1efg2",
        "name": "",
        "publicKeyMaterial": "-----BEGIN PUBLIC KEY-----\nMHYwEAYHKoZIzj0CAQYFK4EEACIDYgAEqVWUtqs6EktQMR1sCYmEzGvRwtaycI16\n9pmzcpiWu/uhNStGlteJ5odRfRwVkoQUMnSZXTCcbn9bBTTmiWo4mJcFOOAzsthH\n0UAb8NdD4tUE0At4a9hYP9IETEXAMPLE\n-----END PUBLIC KEY-----",
        "fingerprint": "12:a3:44:56:bc:7d:e8:9f:10:2g:34:hi:56:78:90:12",
        "tags": {}
    }
}

자세한 내용은 Amazon 실시간 스트리밍 사용 설명서의 참가자 토큰 배포를 참조하세요. IVS

  • 자세한 API 내용은 명령 참조ImportPublicKey의 섹션을 참조하세요. AWS CLI

다음 코드 예시에서는 list-compositions을 사용하는 방법을 보여 줍니다.

AWS CLI

구성 목록을 가져오려면

다음은 API 요청이 처리되는 AWS 리전의 AWS 계정에 대한 모든 구성을 list-compositions 나열합니다.

aws ivs-realtime list-compositions

출력:

{
    "compositions": [
        {
            "arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh",
            "destinations": [
                {
                    "id": "AabBCcdDEefF",
                    "startTime": "2023-10-16T23:25:23+00:00",
                    "state": "ACTIVE"
                }
            ],
            "stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd",
            "startTime": "2023-10-16T23:25:21+00:00",
            "state": "ACTIVE",
            "tags": {}
        },
        {
            "arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/ABcdabCDefgh",
            "destinations": [
                {
                    "endTime": "2023-10-16T23:25:00.786512+00:00",
                    "id": "aABbcCDdeEFf",
                    "startTime": "2023-10-16T23:24:01+00:00",
                    "state": "STOPPED"
                },
                {
                    "endTime": "2023-10-16T23:25:00.786512+00:00",
                    "id": "deEFfaABbcCD",
                    "startTime": "2023-10-16T23:24:01+00:00",
                    "state": "STOPPED"
                }
            ],
            "endTime": "2023-10-16T23:25:00+00:00",
            "stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/efghabcdABCD",
            "startTime": "2023-10-16T23:24:00+00:00",
            "state": "STOPPED",
            "tags": {}
        }
    ]
}

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 Amazon IVS Stream에서 다중 호스트 활성화를 참조하세요.

  • 자세한 API 내용은 명령 참조ListCompositions의 섹션을 참조하세요. AWS CLI

다음 코드 예시에서는 list-encoder-configurations을 사용하는 방법을 보여 줍니다.

AWS CLI

구성 인코더 구성을 나열하려면

다음은 API 요청이 처리되는 AWS 리전의 AWS 계정에 대한 모든 구성 인코더 구성을 list-encoder-configurations 나열합니다.

aws ivs-realtime list-encoder-configurations

출력:

{
    "encoderConfigurations": [
        {
            "arn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/abcdABCDefgh",
            "name": "test-ec-1",
            "tags": {}
        },
        {
            "arn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABCefgEFGabc",
            "name": "test-ec-2",
            "tags": {}
        }
    ]
}

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 Amazon IVS Stream에서 다중 호스트 활성화를 참조하세요.

다음 코드 예시에서는 list-participant-events을 사용하는 방법을 보여 줍니다.

AWS CLI

스테이지 참가자 이벤트 목록을 가져오려면

다음 list-participant-events 예제에서는 지정된 참가자 ID 및 지정된 단계의 세션 IDARN(Amazon 리소스 이름)에 대한 모든 참가자 이벤트를 나열합니다.

aws ivs-realtime list-participant-events \
    --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
    --session-id st-a1b2c3d4e5f6g \
    --participant-id abCDEf12GHIj

출력:

{
    "events": [
        {
            "eventTime": "2023-04-26T20:36:28+00:00",
            "name": "LEFT",
            "participantId": "abCDEf12GHIj"
        },
        {
            "eventTime": "2023-04-26T20:36:28+00:00",
            "name": "PUBLISH_STOPPED",
            "participantId": "abCDEf12GHIj"
        },
        {
            "eventTime": "2023-04-26T20:30:34+00:00",
            "name": "JOINED",
            "participantId": "abCDEf12GHIj"
        },
        {
            "eventTime": "2023-04-26T20:30:34+00:00",
            "name": "PUBLISH_STARTED",
            "participantId": "abCDEf12GHIj"
        }
    ]
}

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 Amazon IVS Stream에서 다중 호스트 활성화를 참조하세요.

다음 코드 예시에서는 list-participants을 사용하는 방법을 보여 줍니다.

AWS CLI

스테이지 참가자 목록을 가져오려면

다음 list-participants 예제에서는 지정된 단계의 지정된 세션 IDARN(Amazon 리소스 이름)에 대한 모든 참가자를 나열합니다.

aws ivs-realtime list-participants \
    --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
    --session-id st-a1b2c3d4e5f6g

출력:

{
    "participants": [
        {
            "firstJoinTime": "2023-04-26T20:30:34+00:00",
            "participantId": "abCDEf12GHIj"
            "published": true,
            "recordingState": "STOPPED",
            "state": "DISCONNECTED",
            "userId": ""
        }
    ]
}

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 Amazon IVS Stream에서 다중 호스트 활성화를 참조하세요.

  • 자세한 API 내용은 명령 참조ListParticipants의 섹션을 참조하세요. AWS CLI

다음 코드 예시에서는 list-public-keys을 사용하는 방법을 보여 줍니다.

AWS CLI

스테이지 참가자 토큰에 서명할 수 있는 기존 퍼블릭 키를 나열하려면

다음 list-public-keys 예제에서는 API 요청이 처리되는 AWS 리전에서 스테이지 참가자 토큰을 사이징하는 데 사용할 수 있는 모든 퍼블릭 키를 나열합니다.

aws ivs-realtime list-public-keys

출력:

{
    "publicKeys": [
        {
            "arn": "arn:aws:ivs:us-west-2:123456789012:public-key/abcdABC1efg2",
            "name": "",
            "tags": {}
        },
        {
            "arn": "arn:aws:ivs:us-west-2:123456789012:public-key/3bcdABCDefg4",
            "name": "",
            "tags": {}
        }
    ]
}

자세한 내용은 Amazon 실시간 스트리밍 사용 설명서의 참가자 토큰 배포를 참조하세요. IVS

  • 자세한 API 내용은 명령 참조ListPublicKeys의 섹션을 참조하세요. AWS CLI

다음 코드 예시에서는 list-stage-sessions을 사용하는 방법을 보여 줍니다.

AWS CLI

스테이지 세션 목록을 가져오려면

다음 list-stage-sessions 예제에서는 지정된 단계ARN(Amazon 리소스 이름)의 모든 세션을 나열합니다.

aws ivs-realtime list-stage-sessions \
    --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh

출력:

{
    "stageSessions": [
        {
            "endTime": "2023-04-26T20:36:29+00:00",
            "sessionId": "st-a1b2c3d4e5f6g",
            "startTime": "2023-04-26T20:30:29.602000+00:00"
        }
    ]
}

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 Amazon IVS Stream에서 다중 호스트 활성화를 참조하세요.

  • 자세한 API 내용은 명령 참조ListStageSessions의 섹션을 참조하세요. AWS CLI

다음 코드 예시에서는 list-stages을 사용하는 방법을 보여 줍니다.

AWS CLI

모든 단계에 대한 요약 정보를 가져오려면

다음 list-stages 예제에서는 API 요청이 처리되는 AWS 리전의 AWS 계정의 모든 단계를 나열합니다.

aws ivs-realtime list-stages

출력:

{
    "stages": [
        {
            "activeSessionId": "st-a1b2c3d4e5f6g",
            "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
            "name": "stage1",
            "tags": {}
        },
        {
            "activeSessionId": "st-a123bcd456efg",
            "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcd1234ABCD",
            "name": "stage2",
            "tags": {}
        },
        {
            "activeSessionId": "st-abcDEF1234ghi",
            "arn": "arn:aws:ivs:us-west-2:123456789012:stage/ABCD1234efgh",
            "name": "stage3",
            "tags": {}
        }
    ]
}

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 Amazon IVS Stream에서 다중 호스트 활성화를 참조하세요.

  • 자세한 API 내용은 명령 참조ListStages의 섹션을 참조하세요. AWS CLI

다음 코드 예시에서는 list-storage-configurations을 사용하는 방법을 보여 줍니다.

AWS CLI

구성 스토리지 구성을 나열하려면

다음은 API 요청이 처리되는 AWS 리전의 AWS 계정에 대한 모든 구성 스토리지 구성을 list-storage-configurations 나열합니다.

aws ivs-realtime list-storage-configurations

출력:

{
    "storageConfigurations": [
        {
            "arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/abcdABCDefgh",
            "name": "test-sc-1",
            "s3": {
                "bucketName": "test-bucket-1-name"
            },
            "tags": {}
        },
        {
            "arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/ABCefgEFGabc",
            "name": "test-sc-2",
            "s3": {
                "bucketName": "test-bucket-2-name"
            },
            "tags": {}
        }
    ]
}

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 Amazon IVS Stream에서 다중 호스트 활성화를 참조하세요.

다음 코드 예시에서는 start-composition을 사용하는 방법을 보여 줍니다.

AWS CLI

예제 1: 기본 레이아웃 설정으로 구성을 시작하려면

다음 start-composition 예제에서는 지정된 스테이지의 구성이 지정된 위치로 스트리밍되기 시작합니다.

aws ivs-realtime start-composition \
    --stage-arn arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd \
    --destinations '[{"channel": {"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", \
        "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"}}, \
        {"s3":{"encoderConfigurationArns":["arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"], \
        "storageConfigurationArn":"arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"}}]'

출력:

{
    "composition": {
        "arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh",
        "destinations": [
            {
                "configuration": {
                    "channel": {
                        "channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg",
                        "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
                    },
                    "name": ""
                },
                "id": "AabBCcdDEefF",
                "state": "STARTING"
            },
            {
                "configuration": {
                    "name": "",
                    "s3": {
                        "encoderConfigurationArns": [
                            "arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
                        ],
                        "recordingConfiguration": {
                            "format": "HLS"
                        },
                        "storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"
                    }
                },
                "detail": {
                    "s3": {
                        "recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite"
                    }
                },
                "id": "GHFabcgefABC",
                "state": "STARTING"
            }
        ],
        "layout": {
            "grid": {
                "featuredParticipantAttribute": ""
                "gridGap": 2,
                "omitStoppedVideo": false,
                "videoAspectRatio": "VIDEO",
                "videoFillMode": ""
            }
        },
        "stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd",
        "startTime": "2023-10-16T23:24:00+00:00",
        "state": "STARTING",
        "tags": {}
    }
}

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 복합 레코딩(실시간 스트리밍)을 참조하세요.

예제 2: PiP 레이아웃으로 구성 시작

다음 start-composition 예제에서는 PiP 레이아웃을 사용하여 지정된 위치로 스트리밍되는 지정된 스테이지의 구성을 시작합니다.

aws ivs-realtime start-composition \
    --stage-arn arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd \
    --destinations '[{"channel": {"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", \
        "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"}}, \
        {"s3":{"encoderConfigurationArns":["arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"], \
        "storageConfigurationArn":"arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"}}]' \
    --layout pip='{featuredParticipantAttribute="abcdefg"}'

출력:

{
    "composition": {
        "arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/wxyzWXYZpqrs",
        "destinations": [
            {
                "configuration": {
                    "channel": {
                        "channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg",
                        "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
                    },
                    "name": ""
                },
                "id": "AabBCcdDEefF",
                "state": "STARTING"
            },
            {
                "configuration": {
                    "name": "",
                    "s3": {
                        "encoderConfigurationArns": [
                            "arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
                        ],
                        "recordingConfiguration": {
                            "format": "HLS"
                        },
                        "storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"
                    }
                },
                "detail": {
                    "s3": {
                        "recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite"
                    }
                },
                "id": "GHFabcgefABC",
                "state": "STARTING"
            }
        ],
        "layout": {
            "pip": {
                "featuredParticipantAttribute": "abcdefg",
                "gridGap": 0,
                "omitStoppedVideo": false,
                "pipBehavior": "STATIC",
                "pipOffset": 0,
                "pipParticipantAttribute": "",
                "pipPosition": "BOTTOM_RIGHT",
                "videoFillMode": "COVER"
            }
        },
        "stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd",
        "startTime": "2023-10-16T23:24:00+00:00",
        "state": "STARTING",
        "tags": {}
    }
}

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 복합 레코딩(실시간 스트리밍)을 참조하세요.

  • 자세한 API 내용은 명령 참조StartComposition의 섹션을 참조하세요. AWS CLI

다음 코드 예시에서는 stop-composition을 사용하는 방법을 보여 줍니다.

AWS CLI

구성을 중지하려면

다음은 지정된 ARN (Amazon 리소스 이름)에서 지정한 구성을 stop-composition 중지합니다.

aws ivs-realtime stop-composition \
    --arn "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh"

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 Amazon IVS Stream에서 다중 호스트 활성화를 참조하세요.

  • 자세한 API 내용은 명령 참조StopComposition의 섹션을 참조하세요. AWS CLI

다음 코드 예시에서는 update-stage을 사용하는 방법을 보여 줍니다.

AWS CLI

스테이지의 구성을 업데이트하려면

다음 update-stage 예제에서는 지정된 단계의 단계를 업데이트ARN하여 단계 이름을 업데이트하고 개별 참가자 레코딩을 구성합니다.

aws ivs-realtime update-stage \
    --arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
    --auto-participant-recording-configuration '{"mediaTypes": ["AUDIO_VIDEO"],"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh"}' \
    --name stage1a

출력:

{
    "stage": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
        "autoParticipantRecordingConfiguration": {
             "mediaTypes": [
                   "AUDIO_VIDEO"
             ],
             "storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh",
        },
        "endpoints": {
            "events": "wss://global.events.live-video.net",
            "whip": "https://1a2b3c4d5e6f.global-bm.whip.live-video.net"
        },
        "name": "stage1a",
        "tags": {}
    }
}

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 Amazon IVS Stream에서 다중 호스트 활성화를 참조하세요.

  • 자세한 API 내용은 명령 참조UpdateStage의 섹션을 참조하세요. AWS CLI