CreateChatToken

$result = $client->createChatToken([/* ... */]);
$promise = $client->createChatTokenAsync([/* ... */]);

Creates an encrypted token that is used by a chat participant to establish an individual WebSocket chat connection to a room. When the token is used to connect to chat, the connection is valid for the session duration specified in the request. The token becomes invalid at the token-expiration timestamp included in the response.

Use the capabilities field to permit an end user to send messages or moderate a room.

The attributes field securely attaches structured data to the chat session; the data is included within each message sent by the end user and received by other participants in the room. Common use cases for attributes include passing end-user profile data like an icon, display name, colors, badges, and other display features.

Encryption keys are owned by Amazon IVS Chat and never used directly by your application.

Parameter Syntax

$result = $client->createChatToken([
    'attributes' => ['<string>', ...],
    'capabilities' => ['<string>', ...],
    'roomIdentifier' => '<string>', // REQUIRED
    'sessionDurationInMinutes' => <integer>,
    'userId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'sessionExpirationTime' => <DateTime>,
    'token' => '<string>',
    'tokenExpirationTime' => <DateTime>,
]

Result Details

Errors

AccessDeniedException:

ResourceNotFoundException:

PendingVerification:

ValidationException:

CreateLoggingConfiguration

$result = $client->createLoggingConfiguration([/* ... */]);
$promise = $client->createLoggingConfigurationAsync([/* ... */]);

Creates a logging configuration that allows clients to store and record sent messages.

Parameter Syntax

$result = $client->createLoggingConfiguration([
    'destinationConfiguration' => [ // REQUIRED
        'cloudWatchLogs' => [
            'logGroupName' => '<string>', // REQUIRED
        ],
        'firehose' => [
            'deliveryStreamName' => '<string>', // REQUIRED
        ],
        's3' => [
            'bucketName' => '<string>', // REQUIRED
        ],
    ],
    'name' => '<string>',
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createTime' => <DateTime>,
    'destinationConfiguration' => [
        'cloudWatchLogs' => [
            'logGroupName' => '<string>',
        ],
        'firehose' => [
            'deliveryStreamName' => '<string>',
        ],
        's3' => [
            'bucketName' => '<string>',
        ],
    ],
    'id' => '<string>',
    'name' => '<string>',
    'state' => 'ACTIVE',
    'tags' => ['<string>', ...],
    'updateTime' => <DateTime>,
]

Result Details

Errors

ConflictException:

AccessDeniedException:

ResourceNotFoundException:

ServiceQuotaExceededException:

PendingVerification:

ValidationException:

CreateRoom

$result = $client->createRoom([/* ... */]);
$promise = $client->createRoomAsync([/* ... */]);

Creates a room that allows clients to connect and pass messages.

Parameter Syntax

$result = $client->createRoom([
    'loggingConfigurationIdentifiers' => ['<string>', ...],
    'maximumMessageLength' => <integer>,
    'maximumMessageRatePerSecond' => <integer>,
    'messageReviewHandler' => [
        'fallbackResult' => 'ALLOW|DENY',
        'uri' => '<string>',
    ],
    'name' => '<string>',
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createTime' => <DateTime>,
    'id' => '<string>',
    'loggingConfigurationIdentifiers' => ['<string>', ...],
    'maximumMessageLength' => <integer>,
    'maximumMessageRatePerSecond' => <integer>,
    'messageReviewHandler' => [
        'fallbackResult' => 'ALLOW|DENY',
        'uri' => '<string>',
    ],
    'name' => '<string>',
    'tags' => ['<string>', ...],
    'updateTime' => <DateTime>,
]

Result Details

Errors

ConflictException:

AccessDeniedException:

ResourceNotFoundException:

ServiceQuotaExceededException:

PendingVerification:

ValidationException:

DeleteLoggingConfiguration

$result = $client->deleteLoggingConfiguration([/* ... */]);
$promise = $client->deleteLoggingConfigurationAsync([/* ... */]);

Deletes the specified logging configuration.

Parameter Syntax

$result = $client->deleteLoggingConfiguration([
    'identifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConflictException:

AccessDeniedException:

ResourceNotFoundException:

PendingVerification:

ValidationException:

DeleteMessage

$result = $client->deleteMessage([/* ... */]);
$promise = $client->deleteMessageAsync([/* ... */]);

Sends an event to a specific room which directs clients to delete a specific message; that is, unrender it from view and delete it from the client’s chat history. This event’s EventName is aws:DELETE_MESSAGE. This replicates the DeleteMessage WebSocket operation in the Amazon IVS Chat Messaging API.

Parameter Syntax

$result = $client->deleteMessage([
    'id' => '<string>', // REQUIRED
    'reason' => '<string>',
    'roomIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'id' => '<string>',
]

Result Details

Errors

ThrottlingException:

AccessDeniedException:

ResourceNotFoundException:

PendingVerification:

ValidationException:

DeleteRoom

$result = $client->deleteRoom([/* ... */]);
$promise = $client->deleteRoomAsync([/* ... */]);

Deletes the specified room.

Parameter Syntax

$result = $client->deleteRoom([
    'identifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

ResourceNotFoundException:

PendingVerification:

ValidationException:

DisconnectUser

$result = $client->disconnectUser([/* ... */]);
$promise = $client->disconnectUserAsync([/* ... */]);

Disconnects all connections using a specified user ID from a room. This replicates the DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.

Parameter Syntax

$result = $client->disconnectUser([
    'reason' => '<string>',
    'roomIdentifier' => '<string>', // REQUIRED
    'userId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

AccessDeniedException:

ResourceNotFoundException:

PendingVerification:

ValidationException:

GetLoggingConfiguration

$result = $client->getLoggingConfiguration([/* ... */]);
$promise = $client->getLoggingConfigurationAsync([/* ... */]);

Gets the specified logging configuration.

Parameter Syntax

$result = $client->getLoggingConfiguration([
    'identifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createTime' => <DateTime>,
    'destinationConfiguration' => [
        'cloudWatchLogs' => [
            'logGroupName' => '<string>',
        ],
        'firehose' => [
            'deliveryStreamName' => '<string>',
        ],
        's3' => [
            'bucketName' => '<string>',
        ],
    ],
    'id' => '<string>',
    'name' => '<string>',
    'state' => 'CREATING|CREATE_FAILED|DELETING|DELETE_FAILED|UPDATING|UPDATE_FAILED|ACTIVE',
    'tags' => ['<string>', ...],
    'updateTime' => <DateTime>,
]

Result Details

Errors

AccessDeniedException:

ResourceNotFoundException:

ValidationException:

GetRoom

$result = $client->getRoom([/* ... */]);
$promise = $client->getRoomAsync([/* ... */]);

Gets the specified room.

Parameter Syntax

$result = $client->getRoom([
    'identifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createTime' => <DateTime>,
    'id' => '<string>',
    'loggingConfigurationIdentifiers' => ['<string>', ...],
    'maximumMessageLength' => <integer>,
    'maximumMessageRatePerSecond' => <integer>,
    'messageReviewHandler' => [
        'fallbackResult' => 'ALLOW|DENY',
        'uri' => '<string>',
    ],
    'name' => '<string>',
    'tags' => ['<string>', ...],
    'updateTime' => <DateTime>,
]

Result Details

Errors

AccessDeniedException:

ResourceNotFoundException:

ValidationException:

ListLoggingConfigurations

$result = $client->listLoggingConfigurations([/* ... */]);
$promise = $client->listLoggingConfigurationsAsync([/* ... */]);

Gets summary information about all your logging configurations in the AWS region where the API request is processed.

Parameter Syntax

$result = $client->listLoggingConfigurations([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'loggingConfigurations' => [
        [
            'arn' => '<string>',
            'createTime' => <DateTime>,
            'destinationConfiguration' => [
                'cloudWatchLogs' => [
                    'logGroupName' => '<string>',
                ],
                'firehose' => [
                    'deliveryStreamName' => '<string>',
                ],
                's3' => [
                    'bucketName' => '<string>',
                ],
            ],
            'id' => '<string>',
            'name' => '<string>',
            'state' => 'CREATING|CREATE_FAILED|DELETING|DELETE_FAILED|UPDATING|UPDATE_FAILED|ACTIVE',
            'tags' => ['<string>', ...],
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

AccessDeniedException:

ValidationException:

ListRooms

$result = $client->listRooms([/* ... */]);
$promise = $client->listRoomsAsync([/* ... */]);

Gets summary information about all your rooms in the AWS region where the API request is processed. Results are sorted in descending order of updateTime.

Parameter Syntax

$result = $client->listRooms([
    'loggingConfigurationIdentifier' => '<string>',
    'maxResults' => <integer>,
    'messageReviewHandlerUri' => '<string>',
    'name' => '<string>',
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'rooms' => [
        [
            'arn' => '<string>',
            'createTime' => <DateTime>,
            'id' => '<string>',
            'loggingConfigurationIdentifiers' => ['<string>', ...],
            'messageReviewHandler' => [
                'fallbackResult' => 'ALLOW|DENY',
                'uri' => '<string>',
            ],
            'name' => '<string>',
            'tags' => ['<string>', ...],
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

ResourceNotFoundException:

ValidationException:

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Gets information about AWS tags for the specified ARN.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFoundException:

InternalServerException:

ValidationException:

SendEvent

$result = $client->sendEvent([/* ... */]);
$promise = $client->sendEventAsync([/* ... */]);

Sends an event to a room. Use this within your application’s business logic to send events to clients of a room; e.g., to notify clients to change the way the chat UI is rendered.

Parameter Syntax

$result = $client->sendEvent([
    'attributes' => ['<string>', ...],
    'eventName' => '<string>', // REQUIRED
    'roomIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'id' => '<string>',
]

Result Details

Errors

ThrottlingException:

AccessDeniedException:

ResourceNotFoundException:

PendingVerification:

ValidationException:

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds or updates tags for the AWS resource with the specified ARN.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

InternalServerException:

ValidationException:

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes tags from the resource with the specified ARN.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

InternalServerException:

ValidationException:

UpdateLoggingConfiguration

$result = $client->updateLoggingConfiguration([/* ... */]);
$promise = $client->updateLoggingConfigurationAsync([/* ... */]);

Updates a specified logging configuration.

Parameter Syntax

$result = $client->updateLoggingConfiguration([
    'destinationConfiguration' => [
        'cloudWatchLogs' => [
            'logGroupName' => '<string>', // REQUIRED
        ],
        'firehose' => [
            'deliveryStreamName' => '<string>', // REQUIRED
        ],
        's3' => [
            'bucketName' => '<string>', // REQUIRED
        ],
    ],
    'identifier' => '<string>', // REQUIRED
    'name' => '<string>',
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createTime' => <DateTime>,
    'destinationConfiguration' => [
        'cloudWatchLogs' => [
            'logGroupName' => '<string>',
        ],
        'firehose' => [
            'deliveryStreamName' => '<string>',
        ],
        's3' => [
            'bucketName' => '<string>',
        ],
    ],
    'id' => '<string>',
    'name' => '<string>',
    'state' => 'ACTIVE',
    'tags' => ['<string>', ...],
    'updateTime' => <DateTime>,
]

Result Details

Errors

ConflictException:

AccessDeniedException:

ResourceNotFoundException:

PendingVerification:

ValidationException:

UpdateRoom

$result = $client->updateRoom([/* ... */]);
$promise = $client->updateRoomAsync([/* ... */]);

Updates a room’s configuration.

Parameter Syntax

$result = $client->updateRoom([
    'identifier' => '<string>', // REQUIRED
    'loggingConfigurationIdentifiers' => ['<string>', ...],
    'maximumMessageLength' => <integer>,
    'maximumMessageRatePerSecond' => <integer>,
    'messageReviewHandler' => [
        'fallbackResult' => 'ALLOW|DENY',
        'uri' => '<string>',
    ],
    'name' => '<string>',
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createTime' => <DateTime>,
    'id' => '<string>',
    'loggingConfigurationIdentifiers' => ['<string>', ...],
    'maximumMessageLength' => <integer>,
    'maximumMessageRatePerSecond' => <integer>,
    'messageReviewHandler' => [
        'fallbackResult' => 'ALLOW|DENY',
        'uri' => '<string>',
    ],
    'name' => '<string>',
    'tags' => ['<string>', ...],
    'updateTime' => <DateTime>,
]

Result Details

Errors

AccessDeniedException:

ResourceNotFoundException:

PendingVerification:

ValidationException: