Skip to content

ivschatClient

Index > ivschat > ivschatClient

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

ivschatClient

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

Usage example
from boto3.session import Session
from mypy_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.

Usage example
client = boto3.client("ivschat")

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.ClientError,
    client.ConflictException,
    client.InternalServerException,
    client.PendingVerification,
    client.ResourceNotFoundException,
    client.ServiceQuotaExceededException,
    client.ThrottlingException,
    client.ValidationException,
) as e:
    print(e)
Type checking example
from mypy_boto3_ivschat.client import Exceptions

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

Methods

can_paginate

Check if an operation can be paginated.

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

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

close

Closes underlying endpoint connections.

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

Method definition
def close(
    self,
) -> None:
    ...

create_chat_token

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

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

Method definition
def create_chat_token(
    self,
    *,
    roomIdentifier: str,
    userId: str,
    attributes: Mapping[str, str] = ...,
    capabilities: Sequence[ChatTokenCapabilityType] = ...,  # (1)
    sessionDurationInMinutes: int = ...,
) -> CreateChatTokenResponseTypeDef:  # (2)
    ...
  1. See ChatTokenCapabilityType
  2. See CreateChatTokenResponseTypeDef
Usage example with kwargs
kwargs: CreateChatTokenRequestRequestTypeDef = {  # (1)
    "roomIdentifier": ...,
    "userId": ...,
}

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

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

Method definition
def create_room(
    self,
    *,
    maximumMessageLength: int = ...,
    maximumMessageRatePerSecond: int = ...,
    messageReviewHandler: MessageReviewHandlerTypeDef = ...,  # (1)
    name: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateRoomResponseTypeDef:  # (2)
    ...
  1. See MessageReviewHandlerTypeDef
  2. See CreateRoomResponseTypeDef
Usage example with kwargs
kwargs: CreateRoomRequestRequestTypeDef = {  # (1)
    "maximumMessageLength": ...,
}

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

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

Method definition
def delete_message(
    self,
    *,
    id: str,
    roomIdentifier: str,
    reason: str = ...,
) -> DeleteMessageResponseTypeDef:  # (1)
    ...
  1. See DeleteMessageResponseTypeDef
Usage example with kwargs
kwargs: DeleteMessageRequestRequestTypeDef = {  # (1)
    "id": ...,
    "roomIdentifier": ...,
}

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

delete_room

Deletes the specified room.

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

Method definition
def delete_room(
    self,
    *,
    identifier: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteRoomRequestRequestTypeDef = {  # (1)
    "identifier": ...,
}

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

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

Method definition
def disconnect_user(
    self,
    *,
    roomIdentifier: str,
    userId: str,
    reason: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DisconnectUserRequestRequestTypeDef = {  # (1)
    "roomIdentifier": ...,
    "userId": ...,
}

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

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

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

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

get_room

Gets the specified room.

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

Method definition
def get_room(
    self,
    *,
    identifier: str,
) -> GetRoomResponseTypeDef:  # (1)
    ...
  1. See GetRoomResponseTypeDef
Usage example with kwargs
kwargs: GetRoomRequestRequestTypeDef = {  # (1)
    "identifier": ...,
}

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

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

Method definition
def list_rooms(
    self,
    *,
    maxResults: int = ...,
    messageReviewHandlerUri: str = ...,
    name: str = ...,
    nextToken: str = ...,
) -> ListRoomsResponseTypeDef:  # (1)
    ...
  1. See ListRoomsResponseTypeDef
Usage example with kwargs
kwargs: ListRoomsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

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

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

Method definition
def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
Usage example with kwargs
kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

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

send_event

Sends an event to a room.

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

Method definition
def send_event(
    self,
    *,
    eventName: str,
    roomIdentifier: str,
    attributes: Mapping[str, str] = ...,
) -> SendEventResponseTypeDef:  # (1)
    ...
  1. See SendEventResponseTypeDef
Usage example with kwargs
kwargs: SendEventRequestRequestTypeDef = {  # (1)
    "eventName": ...,
    "roomIdentifier": ...,
}

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

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

Method definition
def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

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

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

Method definition
def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

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

update_room

Updates a room’s configuration.

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

Method definition
def update_room(
    self,
    *,
    identifier: str,
    maximumMessageLength: int = ...,
    maximumMessageRatePerSecond: int = ...,
    messageReviewHandler: MessageReviewHandlerTypeDef = ...,  # (1)
    name: str = ...,
) -> UpdateRoomResponseTypeDef:  # (2)
    ...
  1. See MessageReviewHandlerTypeDef
  2. See UpdateRoomResponseTypeDef
Usage example with kwargs
kwargs: UpdateRoomRequestRequestTypeDef = {  # (1)
    "identifier": ...,
}

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