Exemplos do Amazon IVS Chat usando AWS CLI

Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o Amazon IVS Chat.

Ações são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar funções de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.

Cada exemplo inclui um link para o código-fonte completo, onde você pode encontrar instruções sobre como configurar e executar o código no contexto.

Tópicos

Ações

Ações

O código de exemplo a seguir mostra como usar create-chat-token.

AWS CLI

Para criar um token de bate-papo

O create-chat-token exemplo a seguir cria um token de bate-papo criptografado que é usado para estabelecer uma WebSocket conexão individual com uma sala. O token é válido por um minuto e uma conexão (sessão) estabelecida com o token é válida pela duração especificada.


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

Saída:


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

Para obter mais informações, consulte Etapa 3: Autenticar e autorizar clientes de chat no Guia do usuário do Amazon Interactive Video Service.

Para API obter detalhes, consulte CreateChatTokenna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar create-logging-configuration.

AWS CLI

Para criar um LoggingConfiguration recurso de bate-papo

O create-logging-configuration exemplo a seguir cria um LoggingConfiguration recurso que permite aos clientes armazenar e registrar as mensagens enviadas.


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

Saída:


{
    "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"
}

Para obter mais informações, consulte Conceitos básicos do Amazon IVS Chat no Guia do usuário do Amazon Interactive Video Service.

Para API obter detalhes, consulte CreateLoggingConfigurationna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar create-room.

AWS CLI

Para criar uma sala

O create-room exemplo a seguir cria uma nova sala.


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

Saída:


{
    "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"
}

Para obter mais informações, consulte Etapa 2: Criar uma sala de bate-papo no Guia do usuário do Amazon Interactive Video Service.

Para API obter detalhes, consulte CreateRoomna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar delete-logging-configuration.

AWS CLI

Para excluir um LoggingConfiguration recurso de bate-papo

O delete-logging-configuration exemplo a seguir exclui o LoggingConfiguration recurso para o especificadoARN.


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

Este comando não produz saída.

Para obter mais informações, consulte Conceitos básicos do Amazon IVS Chat no Guia do usuário do Amazon Interactive Video Service.

Para API obter detalhes, consulte DeleteLoggingConfigurationna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar delete-message.

AWS CLI

Para excluir mensagens de uma sala específica

O delete-message exemplo a seguir envia um evento para a sala especificada, o que direciona os clientes a excluírem a mensagem especificada: ou seja, retirá-la da exibição e excluí-la do histórico de bate-papo do cliente.


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

Saída:


{
    "id": "12345689012"
}

Para obter mais informações, consulte Conceitos básicos do Amazon IVS Chat no Guia do usuário do Amazon Interactive Video Service.

Para API obter detalhes, consulte DeleteMessagena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar delete-room.

AWS CLI

Para excluir uma sala

O delete-room exemplo a seguir exclui a sala especificada. Os clientes conectados são desconectados. Em caso de sucesso, ele retorna HTTP 204 com um corpo de resposta vazio.


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

Este comando não produz saída.

Para obter mais informações, consulte Conceitos básicos do Amazon IVS Chat no Guia do usuário do Amazon Interactive Video Service.

Para API obter detalhes, consulte DeleteRoomna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar disconnect-user.

AWS CLI

Para desconectar um usuário de uma sala

O disconnect-user exemplo a seguir desconecta todas as conexões do usuário especificado da sala especificada. Em caso de sucesso, ele retorna HTTP 200 com um corpo de resposta vazio.


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

Este comando não produz saída.

Para obter mais informações, consulte Conceitos básicos do Amazon IVS Chat no Guia do usuário do Amazon Interactive Video Service.

Para API obter detalhes, consulte DisconnectUserna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-logging-configuration.

AWS CLI

Para obter informações sobre um LoggingConfiguration recurso

O get-logging-configuration exemplo a seguir obtém informações sobre o LoggingConfiguration recurso especificadoARN.


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

Saída:


{
    "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"
}

Para obter mais informações, consulte Conceitos básicos do Amazon IVS Chat no Guia do usuário do Amazon Interactive Video Service.

Para API obter detalhes, consulte GetLoggingConfigurationna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-room.

AWS CLI

Para obter o quarto especificado

O get-room exemplo a seguir obtém informações sobre a sala especificada.


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

Saída:


{
    "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"
}

Para obter mais informações, consulte Conceitos básicos do Amazon IVS Chat no Guia do usuário do Amazon Interactive Video Service.

Para API obter detalhes, consulte GetRoomna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar list-logging-configurations.

AWS CLI

Para obter informações resumidas sobre todas as configurações de registro para o usuário na AWS região em que a API solicitação é processada

O list-logging-configurations exemplo a seguir lista informações sobre todos os LoggingConfiguration recursos do usuário na AWS região em que a API solicitação é processada.


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

Saída:


{
    "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"
        }
        ...
    ]
}

Para obter mais informações, consulte Conceitos básicos do Amazon IVS Chat no Guia do usuário do Amazon Interactive Video Service.

Para API obter detalhes, consulte ListLoggingConfigurationsna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar list-rooms.

AWS CLI

Para obter informações resumidas sobre todos os seus quartos na região atual

O list-rooms exemplo a seguir obtém informações resumidas sobre todas as salas na AWS região em que a solicitação é processada. Os resultados são classificados em ordem decrescente de. updateTime


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

Saída:


{
    "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"
        }
    ]
}

Para obter mais informações, consulte Conceitos básicos do Amazon IVS Chat no Guia do usuário do Amazon Interactive Video Service.

Para API obter detalhes, consulte ListRoomsna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar list-tags-for-resource.

AWS CLI

Para listar todas as tags de um AWS recurso (por exemplo: Room)

O list-tags-for-resource exemplo a seguir lista todas as tags de um recurso específico ARN (Amazon Resource Name).


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

Saída:


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

Para obter mais informações, consulte Marcação na APIReferência do Amazon Interactive Video Service.

Para API obter detalhes, consulte ListTagsForResourcena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar send-event.

AWS CLI

Para enviar um evento para uma sala

O send-event exemplo a seguir envia o evento fornecido para a sala especificada.


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."

Saída:


{
    "id": "12345689012"
}

Para obter mais informações, consulte Conceitos básicos do Amazon IVS Chat no Guia do usuário do Amazon Interactive Video Service.

Para API obter detalhes, consulte SendEventna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar tag-resource.

AWS CLI

Para adicionar ou atualizar tags para um AWS recurso (por exemplo: Sala)

O tag-resource exemplo a seguir adiciona ou atualiza tags para um recurso específico ARN (Amazon Resource Name). Em caso de sucesso, ele retorna HTTP 200 com um corpo de resposta vazio.


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

Este comando não produz saída.

Para obter mais informações, consulte Marcação na APIReferência do Amazon Interactive Video Service.

Para API obter detalhes, consulte TagResourcena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar untag-resource.

AWS CLI

Para remover tags de um AWS recurso (por exemplo: Sala)

O untag-resource exemplo a seguir remove as tags especificadas para um recurso específico ARN (Amazon Resource Name). Em caso de sucesso, ele retorna HTTP 200 com um corpo de resposta vazio.


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

Este comando não produz saída.

Para obter mais informações, consulte Marcação na APIReferência do Amazon Interactive Video Service.

Para API obter detalhes, consulte UntagResourcena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar update-logging-configuration.

AWS CLI

Para atualizar a configuração de registro de uma sala

O update-logging-configuration exemplo a seguir atualiza um LoggingConfiguration recurso com os dados fornecidos.


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"

Saída:


{
    "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"
}

Para obter mais informações, consulte Conceitos básicos do Amazon IVS Chat no Guia do usuário do Amazon Interactive Video Service.

Para API obter detalhes, consulte UpdateLoggingConfigurationna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar update-room.

AWS CLI

Para atualizar a configuração de uma sala

O update-room exemplo a seguir atualiza a configuração da sala especificada com os dados fornecidos.


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

Saída:


{
    "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"
}

Para obter mais informações, consulte Conceitos básicos do Amazon IVS Chat no Guia do usuário do Amazon Interactive Video Service.

Para API obter detalhes, consulte UpdateRoomna Referência de AWS CLI Comandos.

Atenção O Javascript está desativado ou não está disponível no seu navegador.

Para usar a documentação da AWS, o Javascript deve estar ativado. Consulte as páginas de Ajuda do navegador para obter instruções.

Convenções do documento

Amazon IVS

Streaming IVS em tempo real da Amazon