Skip to content

IvschatClient#

Index > Ivschat > IvschatClient

Auto-generated documentation for Ivschat type annotations stubs module types-boto3-ivschat.

IvschatClient#

Type annotations and code completion for boto3.client("ivschat"). boto3 documentation

# IvschatClient usage example

from boto3.session import Session
from types_boto3_ivschat.client import IvschatClient

def get_ivschat_client() -> IvschatClient:
    return Session().client("ivschat")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("ivschat").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("ivschat")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.PendingVerification,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from types_boto3_ivschat.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("ivschat").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("ivschat").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

create_chat_token#

Creates an encrypted token that is used by a chat participant to establish an individual WebSocket chat connection to a room.

Type annotations and code completion for boto3.client("ivschat").create_chat_token method. boto3 documentation

# create_chat_token method definition

def create_chat_token(
    self,
    *,
    roomIdentifier: str,
    userId: str,
    capabilities: Sequence[ChatTokenCapabilityType] = ...,  # (1)
    sessionDurationInMinutes: int = ...,
    attributes: Mapping[str, str] = ...,
) -> CreateChatTokenResponseTypeDef:  # (2)
    ...
  1. See Sequence[ChatTokenCapabilityType]
  2. See CreateChatTokenResponseTypeDef
# create_chat_token method usage example with argument unpacking

kwargs: CreateChatTokenRequestTypeDef = {  # (1)
    "roomIdentifier": ...,
    "userId": ...,
}

parent.create_chat_token(**kwargs)
  1. See CreateChatTokenRequestTypeDef

create_logging_configuration#

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

Type annotations and code completion for boto3.client("ivschat").create_logging_configuration method. boto3 documentation

# create_logging_configuration method definition

def create_logging_configuration(
    self,
    *,
    destinationConfiguration: DestinationConfigurationTypeDef,  # (1)
    name: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateLoggingConfigurationResponseTypeDef:  # (2)
    ...
  1. See DestinationConfigurationTypeDef
  2. See CreateLoggingConfigurationResponseTypeDef
# create_logging_configuration method usage example with argument unpacking

kwargs: CreateLoggingConfigurationRequestTypeDef = {  # (1)
    "destinationConfiguration": ...,
}

parent.create_logging_configuration(**kwargs)
  1. See CreateLoggingConfigurationRequestTypeDef

create_room#

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

Type annotations and code completion for boto3.client("ivschat").create_room method. boto3 documentation

# create_room method definition

def create_room(
    self,
    *,
    name: str = ...,
    maximumMessageRatePerSecond: int = ...,
    maximumMessageLength: int = ...,
    messageReviewHandler: MessageReviewHandlerTypeDef = ...,  # (1)
    tags: Mapping[str, str] = ...,
    loggingConfigurationIdentifiers: Sequence[str] = ...,
) -> CreateRoomResponseTypeDef:  # (2)
    ...
  1. See MessageReviewHandlerTypeDef
  2. See CreateRoomResponseTypeDef
# create_room method usage example with argument unpacking

kwargs: CreateRoomRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_room(**kwargs)
  1. See CreateRoomRequestTypeDef

delete_logging_configuration#

Deletes the specified logging configuration.

Type annotations and code completion for boto3.client("ivschat").delete_logging_configuration method. boto3 documentation

# delete_logging_configuration method definition

def delete_logging_configuration(
    self,
    *,
    identifier: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_logging_configuration method usage example with argument unpacking

kwargs: DeleteLoggingConfigurationRequestTypeDef = {  # (1)
    "identifier": ...,
}

parent.delete_logging_configuration(**kwargs)
  1. See DeleteLoggingConfigurationRequestTypeDef

delete_message#

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.

Type annotations and code completion for boto3.client("ivschat").delete_message method. boto3 documentation

# delete_message method definition

def delete_message(
    self,
    *,
    roomIdentifier: str,
    id: str,
    reason: str = ...,
) -> DeleteMessageResponseTypeDef:  # (1)
    ...
  1. See DeleteMessageResponseTypeDef
# delete_message method usage example with argument unpacking

kwargs: DeleteMessageRequestTypeDef = {  # (1)
    "roomIdentifier": ...,
    "id": ...,
}

parent.delete_message(**kwargs)
  1. See DeleteMessageRequestTypeDef

delete_room#

Deletes the specified room.

Type annotations and code completion for boto3.client("ivschat").delete_room method. boto3 documentation

# delete_room method definition

def delete_room(
    self,
    *,
    identifier: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_room method usage example with argument unpacking

kwargs: DeleteRoomRequestTypeDef = {  # (1)
    "identifier": ...,
}

parent.delete_room(**kwargs)
  1. See DeleteRoomRequestTypeDef

disconnect_user#

Disconnects all connections using a specified user ID from a room.

Type annotations and code completion for boto3.client("ivschat").disconnect_user method. boto3 documentation

# disconnect_user method definition

def disconnect_user(
    self,
    *,
    roomIdentifier: str,
    userId: str,
    reason: str = ...,
) -> Dict[str, Any]:
    ...
# disconnect_user method usage example with argument unpacking

kwargs: DisconnectUserRequestTypeDef = {  # (1)
    "roomIdentifier": ...,
    "userId": ...,
}

parent.disconnect_user(**kwargs)
  1. See DisconnectUserRequestTypeDef

get_logging_configuration#

Gets the specified logging configuration.

Type annotations and code completion for boto3.client("ivschat").get_logging_configuration method. boto3 documentation

# get_logging_configuration method definition

def get_logging_configuration(
    self,
    *,
    identifier: str,
) -> GetLoggingConfigurationResponseTypeDef:  # (1)
    ...
  1. See GetLoggingConfigurationResponseTypeDef
# get_logging_configuration method usage example with argument unpacking

kwargs: GetLoggingConfigurationRequestTypeDef = {  # (1)
    "identifier": ...,
}

parent.get_logging_configuration(**kwargs)
  1. See GetLoggingConfigurationRequestTypeDef

get_room#

Gets the specified room.

Type annotations and code completion for boto3.client("ivschat").get_room method. boto3 documentation

# get_room method definition

def get_room(
    self,
    *,
    identifier: str,
) -> GetRoomResponseTypeDef:  # (1)
    ...
  1. See GetRoomResponseTypeDef
# get_room method usage example with argument unpacking

kwargs: GetRoomRequestTypeDef = {  # (1)
    "identifier": ...,
}

parent.get_room(**kwargs)
  1. See GetRoomRequestTypeDef

list_logging_configurations#

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

Type annotations and code completion for boto3.client("ivschat").list_logging_configurations method. boto3 documentation

# list_logging_configurations method definition

def list_logging_configurations(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListLoggingConfigurationsResponseTypeDef:  # (1)
    ...
  1. See ListLoggingConfigurationsResponseTypeDef
# list_logging_configurations method usage example with argument unpacking

kwargs: ListLoggingConfigurationsRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_logging_configurations(**kwargs)
  1. See ListLoggingConfigurationsRequestTypeDef

list_rooms#

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

Type annotations and code completion for boto3.client("ivschat").list_rooms method. boto3 documentation

# list_rooms method definition

def list_rooms(
    self,
    *,
    name: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
    messageReviewHandlerUri: str = ...,
    loggingConfigurationIdentifier: str = ...,
) -> ListRoomsResponseTypeDef:  # (1)
    ...
  1. See ListRoomsResponseTypeDef
# list_rooms method usage example with argument unpacking

kwargs: ListRoomsRequestTypeDef = {  # (1)
    "name": ...,
}

parent.list_rooms(**kwargs)
  1. See ListRoomsRequestTypeDef

list_tags_for_resource#

Gets information about AWS tags for the specified ARN.

Type annotations and code completion for boto3.client("ivschat").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestTypeDef

send_event#

Sends an event to a room.

Type annotations and code completion for boto3.client("ivschat").send_event method. boto3 documentation

# send_event method definition

def send_event(
    self,
    *,
    roomIdentifier: str,
    eventName: str,
    attributes: Mapping[str, str] = ...,
) -> SendEventResponseTypeDef:  # (1)
    ...
  1. See SendEventResponseTypeDef
# send_event method usage example with argument unpacking

kwargs: SendEventRequestTypeDef = {  # (1)
    "roomIdentifier": ...,
    "eventName": ...,
}

parent.send_event(**kwargs)
  1. See SendEventRequestTypeDef

tag_resource#

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

Type annotations and code completion for boto3.client("ivschat").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestTypeDef

untag_resource#

Removes tags from the resource with the specified ARN.

Type annotations and code completion for boto3.client("ivschat").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestTypeDef

update_logging_configuration#

Updates a specified logging configuration.

Type annotations and code completion for boto3.client("ivschat").update_logging_configuration method. boto3 documentation

# update_logging_configuration method definition

def update_logging_configuration(
    self,
    *,
    identifier: str,
    name: str = ...,
    destinationConfiguration: DestinationConfigurationTypeDef = ...,  # (1)
) -> UpdateLoggingConfigurationResponseTypeDef:  # (2)
    ...
  1. See DestinationConfigurationTypeDef
  2. See UpdateLoggingConfigurationResponseTypeDef
# update_logging_configuration method usage example with argument unpacking

kwargs: UpdateLoggingConfigurationRequestTypeDef = {  # (1)
    "identifier": ...,
}

parent.update_logging_configuration(**kwargs)
  1. See UpdateLoggingConfigurationRequestTypeDef

update_room#

Updates a room's configuration.

Type annotations and code completion for boto3.client("ivschat").update_room method. boto3 documentation

# update_room method definition

def update_room(
    self,
    *,
    identifier: str,
    name: str = ...,
    maximumMessageRatePerSecond: int = ...,
    maximumMessageLength: int = ...,
    messageReviewHandler: MessageReviewHandlerTypeDef = ...,  # (1)
    loggingConfigurationIdentifiers: Sequence[str] = ...,
) -> UpdateRoomResponseTypeDef:  # (2)
    ...
  1. See MessageReviewHandlerTypeDef
  2. See UpdateRoomResponseTypeDef
# update_room method usage example with argument unpacking

kwargs: UpdateRoomRequestTypeDef = {  # (1)
    "identifier": ...,
}

parent.update_room(**kwargs)
  1. See UpdateRoomRequestTypeDef