를 사용한 Amazon IVS Chat 예제 AWS CLI

채팅 토큰을 생성하려면

다음 create-chat-token 예제에서는 룸에 대한 개별 WebSocket 연결을 설정하는 데 사용되는 암호화된 채팅 토큰을 생성합니다. 토큰은 1분 동안 유효하며 토큰과 설정된 연결(세션)은 지정된 기간 동안 유효합니다.

aws ivschat create-chat-token \
    --roomIdentifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6", \
    --userId" "11231234" \
    --capabilities "SEND_MESSAGE", \
    --sessionDurationInMinutes" 30

출력:

{
    "token": "ACEGmnoq#1rstu2...BDFH3vxwy!4hlm!#5",
    "sessionExpirationTime": "2022-03-16T04:44:09+00:00"
    "state": "CREATING",
    "tokenExpirationTime": "2022-03-16T03:45:09+00:00"
}

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 3단계: 채팅 클라이언트 인증 및 승인을 참조하세요.

채팅 LoggingConfiguration 리소스를 생성하려면

다음 create-logging-configuration 예제에서는 클라이언트가 전송된 메시지를 저장하고 기록할 수 있는 LoggingConfiguration 리소스를 생성합니다.

aws ivschat create-logging-configuration \
    --destination-configuration s3={bucketName=demo-logging-bucket} \
    --name "test-logging-config" \
    --tags "key1=value1, key2=value2"

출력:

{
    "arn": "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ",
    "createTime": "2022-09-14T17:48:00.653000+00:00",
    "destinationConfiguration": {
        "s3": {
            "bucketName": "demo-logging-bucket"
        }
    },
    "id": "ABcdef34ghIJ",
    "name": "test-logging-config",
    "state": "ACTIVE",
    "tags": { "key1" : "value1", "key2" : "value2" },
    "updateTime": "2022-09-14T17:48:01.104000+00:00"
}

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 Amazon IVS Chat 시작하기를 참조하세요.

방을 생성하려면

다음 create-room 예제에서는 새 방을 생성합니다.

aws ivschat create-room \
    --name "test-room-1" \
    --logging-configuration-identifiers "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ" \
    --maximum-message-length 256 \
    --maximum-message-rate-per-second 5

출력:

{
    "arn": "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6",
    "id": "g1H2I3j4k5L6",
    "createTime": "2022-03-16T04:44:09+00:00",
    "loggingConfigurationIdentifiers": ["arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ"],
    "maximumMessageLength": 256,
    "maximumMessageRatePerSecond": 5,
    "name": "test-room-1",
    "tags": {}
    "updateTime": "2022-03-16T07:22:09+00:00"
}

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 2단계: 채팅룸 생성을 참조하세요.

채팅 LoggingConfiguration 리소스를 삭제하려면

다음 delete-logging-configuration 예제에서는 지정된 에 대한 LoggingConfiguration 리소스를 삭제합니다ARN.

aws ivschat delete-logging-configuration \
    --identifier "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ"

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

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 Amazon IVS Chat 시작하기를 참조하세요.

지정된 방에서 메시지를 삭제하려면

다음 delete-message 예제에서는 지정된 방으로 짝수를 전송하여 클라이언트가 지정된 메시지를 삭제하도록 지시합니다. 즉, 뷰에서 렌더링을 취소하고 클라이언트의 채팅 기록에서 삭제합니다.

aws ivschat delete-message \
    --roomIdentifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6" \
    --id "ABC123def456" \
    --reason "Message contains profanity"

출력:

{
    "id": "12345689012"
}

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 Amazon IVS Chat 시작하기를 참조하세요.

방을 삭제하려면

다음 delete-room 예제에서는 지정된 방을 삭제합니다. 연결된 클라이언트가 연결 해제되었습니다. 성공하면 빈 응답 본문과 함께 HTTP 204를 반환합니다.

aws ivschat delete-room \
    --identifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6"

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

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 Amazon IVS Chat 시작하기를 참조하세요.

사용자를 방에서 연결 해제하려면

다음 disconnect-user 예제에서는 지정된 사용자의 모든 연결을 지정된 방에서 분리합니다. 성공하면 빈 응답 본문과 함께 HTTP 200을 반환합니다.

aws ivschat disconnect-user \
    --roomIdentifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6" \
    --userId "ABC123def456" \
    --reason "Violated terms of service"

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

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 Amazon IVS Chat 시작하기를 참조하세요.

LoggingConfiguration 리소스에 대한 정보를 가져오려면

다음 get-logging-configuration 예제에서는 지정된 의 LoggingConfiguration 리소스에 대한 정보를 가져옵니다ARN.

aws ivschat get-logging-configuration \
    --identifier "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ"

출력:

{
    "arn": "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ",
    "createTime": "2022-09-14T17:48:00.653000+00:00",
    "destinationConfiguration": {
        "s3": {
            "bucketName": "demo-logging-bucket"
        }
    },
    "id": "ABcdef34ghIJ",
    "name": "test-logging-config",
    "state": "ACTIVE",
    "tags": { "key1" : "value1", "key2" : "value2" },
    "updateTime": "2022-09-14T17:48:01.104000+00:00"
}

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 Amazon IVS Chat 시작하기를 참조하세요.

지정된 방을 가져오려면

다음 get-room 예제에서는 지정된 방에 대한 정보를 가져옵니다.

aws ivschat get-room \
    --identifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6"

출력:

{
    "arn": "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6",
    "createTime": "2022-03-16T04:44:09+00:00",
    "id": "g1H2I3j4k5L6",
    "loggingConfigurationIdentifiers": ["arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ"],
    "maximumMessageLength": 256,
    "maximumMessageRatePerSecond": 5,
    "name": "test-room-1",
    "tags": {},
    "updateTime": "2022-03-16T07:22:09+00:00"
}

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 Amazon IVS Chat 시작하기를 참조하세요.

API 요청이 처리되는 AWS 리전의 사용자에 대한 모든 로깅 구성에 대한 요약 정보를 가져오려면

다음 list-logging-configurations 예제에서는 API 요청이 처리되는 AWS 리전의 사용자에 대한 모든 LoggingConfiguration 리소스에 대한 정보를 나열합니다.

aws ivschat list-logging-configurations \
    --max-results 2 \
    --next-token ""

출력:

{
    "nextToken": "set-2",
    "loggingConfigurations": [
        {
            "arn": "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ",
            "createTime": "2022-09-14T17:48:00.653000+00:00",
            "destinationConfiguration": {
                "s3": {
                    "bucketName": "demo-logging-bucket"
                }
            },
            "id": "ABcdef34ghIJ",
            "name": "test-logging-config",
            "state": "ACTIVE",
            "tags": { "key1" : "value1", "key2" : "value2" },
            "updateTime": "2022-09-14T17:48:01.104000+00:00"
        }
        ...
    ]
}

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 Amazon IVS Chat 시작하기를 참조하세요.

현재 리전의 모든 방에 대한 요약 정보를 가져오려면

다음 list-rooms 예제에서는 요청이 처리되는 AWS 리전의 모든 방에 대한 요약 정보를 가져옵니다. 결과는 내림차순으로 정렬됩니다updateTime.

aws ivschat list-rooms \
    --logging-configuration-identifier "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ" \
    --max-results 10 \
    --next-token ""

출력:

{
    "nextToken": "page3",
    "rooms": [
        {
            "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6",
            "createTime": "2022-03-16T04:44:09+00:00",
            "id": "g1H2I3j4k5L6",
            "loggingConfigurationIdentifiers": ["arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ"],
            "name": "test-room-1",
            "tags": {},
            "updateTime": "2022-03-16T07:22:09+00:00"
        }
    ]
}

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 Amazon IVS Chat 시작하기를 참조하세요.

AWS 리소스의 모든 태그를 나열하려면(예: 룸)

다음 list-tags-for-resource 예제에서는 지정된 리소스ARN(Amazon 리소스 이름)에 대한 모든 태그를 나열합니다.

aws ivschat list-tags-for-resource \
    --resource-arn arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6

출력:

{
    "tags":
    {
        "key1": "value1",
        "key2": "value2"
    }
}

자세한 내용은 Amazon Interactive Video Service API 참조의 태그 지정을 참조하세요.

룸으로 이벤트를 보내려면

다음 send-event 예제에서는 지정된 이벤트를 지정된 방으로 보냅니다.

aws ivschat send-event \
    --roomIdentifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6" \
    --eventName "SystemMessage" \
    --attributes \
        "msgType"="user-notification", \
        "msgText"="This chat room will close in 15 minutes."

출력:

{
    "id": "12345689012"
}

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 Amazon IVS Chat 시작하기를 참조하세요.

AWS 리소스에 대한 태그를 추가하거나 업데이트하려면(예: 저장 폴더)

다음 tag-resource 예제에서는 지정된 리소스ARN(Amazon 리소스 이름)에 대한 태그를 추가하거나 업데이트합니다. 성공하면 빈 응답 본문과 함께 HTTP 200을 반환합니다.

aws ivschat tag-resource \
    --resource-arn arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6 \
    --tags "tagkey1=tagkeyvalue1, tagkey2=tagkeyvalue2"

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

자세한 내용은 Amazon Interactive Video Service API 참조의 태그 지정을 참조하세요.

AWS 리소스의 태그를 제거하려면(예: 저장 폴더)

다음 untag-resource 예제에서는 지정된 리소스ARN(Amazon 리소스 이름)에 대해 지정된 태그를 제거합니다. 성공하면 빈 응답 본문과 함께 HTTP 200을 반환합니다.

aws ivschat untag-resource \
    --resource-arn arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6 \
    --tag-keys "tagkey1, tagkey2"

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

자세한 내용은 Amazon Interactive Video Service API 참조의 태그 지정을 참조하세요.

방의 로깅 구성을 업데이트하려면

다음 update-logging-configuration 예제에서는 LoggingConfiguration 리소스를 지정된 데이터로 업데이트합니다.

aws ivschat update-logging-configuration \
    --destination-configuration s3={bucketName=demo-logging-bucket} \
    --identifier "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ" \
    --name "test-logging-config"

출력:

{
    "arn": "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ",
    "createTime": "2022-09-14T17:48:00.653000+00:00",
    "destinationConfiguration": {
        "s3": {
            "bucketName": "demo-logging-bucket"
        }
    },
    "id": "ABcdef34ghIJ",
    "name": "test-logging-config",
    "state": "ACTIVE",
    "tags": { "key1" : "value1", "key2" : "value2" },
    "updateTime": "2022-09-14T17:48:01.104000+00:00"
}

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 Amazon IVS Chat 시작하기를 참조하세요.

방의 구성을 업데이트하려면

다음 update-room 예제에서는 지정된 저장 폴더의 구성을 지정된 데이터로 업데이트합니다.

aws ivschat update-room \
    --identifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6" \
    --logging-configuration-identifiers "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ" \
    --name "chat-room-a" \
    --maximum-message-length 256 \
    --maximum-message-rate-per-second 5

출력:

{
    "arn": "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6",
    "createTime": "2022-03-16T04:44:09+00:00",
    "id": "g1H2I3j4k5L6",
    "loggingConfigurationIdentifiers": ["arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ"],
    "maximumMessageLength": 256,
    "maximumMessageRatePerSecond": 5,
    "name": "chat-room-a",
    "tags": {},
    "updateTime": "2022-03-16T07:22:09+00:00"
}

자세한 내용은 Amazon Interactive Video Service 사용 설명서의 Amazon IVS Chat 시작하기를 참조하세요.