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
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.
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)
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
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("ivschat").close
method.
boto3 documentation
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
def create_chat_token(
self,
*,
roomIdentifier: str,
userId: str,
attributes: Mapping[str, str] = ...,
capabilities: Sequence[ChatTokenCapabilityType] = ..., # (1)
sessionDurationInMinutes: int = ...,
) -> CreateChatTokenResponseTypeDef: # (2)
...
kwargs: CreateChatTokenRequestRequestTypeDef = { # (1)
"roomIdentifier": ...,
"userId": ...,
}
parent.create_chat_token(**kwargs)
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
def create_logging_configuration(
self,
*,
destinationConfiguration: DestinationConfigurationTypeDef, # (1)
name: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateLoggingConfigurationResponseTypeDef: # (2)
...
kwargs: CreateLoggingConfigurationRequestRequestTypeDef = { # (1)
"destinationConfiguration": ...,
}
parent.create_logging_configuration(**kwargs)
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
def create_room(
self,
*,
loggingConfigurationIdentifiers: Sequence[str] = ...,
maximumMessageLength: int = ...,
maximumMessageRatePerSecond: int = ...,
messageReviewHandler: MessageReviewHandlerTypeDef = ..., # (1)
name: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateRoomResponseTypeDef: # (2)
...
kwargs: CreateRoomRequestRequestTypeDef = { # (1)
"loggingConfigurationIdentifiers": ...,
}
parent.create_room(**kwargs)
delete_logging_configuration
Deletes the specified logging configuration.
Type annotations and code completion for boto3.client("ivschat").delete_logging_configuration
method.
boto3 documentation
def delete_logging_configuration(
self,
*,
identifier: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteLoggingConfigurationRequestRequestTypeDef = { # (1)
"identifier": ...,
}
parent.delete_logging_configuration(**kwargs)
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
def delete_message(
self,
*,
id: str,
roomIdentifier: str,
reason: str = ...,
) -> DeleteMessageResponseTypeDef: # (1)
...
kwargs: DeleteMessageRequestRequestTypeDef = { # (1)
"id": ...,
"roomIdentifier": ...,
}
parent.delete_message(**kwargs)
delete_room
Deletes the specified room.
Type annotations and code completion for boto3.client("ivschat").delete_room
method.
boto3 documentation
def delete_room(
self,
*,
identifier: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteRoomRequestRequestTypeDef = { # (1)
"identifier": ...,
}
parent.delete_room(**kwargs)
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
def disconnect_user(
self,
*,
roomIdentifier: str,
userId: str,
reason: str = ...,
) -> Dict[str, Any]:
...
kwargs: DisconnectUserRequestRequestTypeDef = { # (1)
"roomIdentifier": ...,
"userId": ...,
}
parent.disconnect_user(**kwargs)
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
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_logging_configuration
Gets the specified logging configuration.
Type annotations and code completion for boto3.client("ivschat").get_logging_configuration
method.
boto3 documentation
def get_logging_configuration(
self,
*,
identifier: str,
) -> GetLoggingConfigurationResponseTypeDef: # (1)
...
kwargs: GetLoggingConfigurationRequestRequestTypeDef = { # (1)
"identifier": ...,
}
parent.get_logging_configuration(**kwargs)
get_room
Gets the specified room.
Type annotations and code completion for boto3.client("ivschat").get_room
method.
boto3 documentation
kwargs: GetRoomRequestRequestTypeDef = { # (1)
"identifier": ...,
}
parent.get_room(**kwargs)
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
def list_logging_configurations(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListLoggingConfigurationsResponseTypeDef: # (1)
...
kwargs: ListLoggingConfigurationsRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_logging_configurations(**kwargs)
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
def list_rooms(
self,
*,
loggingConfigurationIdentifier: str = ...,
maxResults: int = ...,
messageReviewHandlerUri: str = ...,
name: str = ...,
nextToken: str = ...,
) -> ListRoomsResponseTypeDef: # (1)
...
kwargs: ListRoomsRequestRequestTypeDef = { # (1)
"loggingConfigurationIdentifier": ...,
}
parent.list_rooms(**kwargs)
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
def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
send_event
Sends an event to a room.
Type annotations and code completion for boto3.client("ivschat").send_event
method.
boto3 documentation
def send_event(
self,
*,
eventName: str,
roomIdentifier: str,
attributes: Mapping[str, str] = ...,
) -> SendEventResponseTypeDef: # (1)
...
kwargs: SendEventRequestRequestTypeDef = { # (1)
"eventName": ...,
"roomIdentifier": ...,
}
parent.send_event(**kwargs)
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
def tag_resource(
self,
*,
resourceArn: str,
tags: Mapping[str, str],
) -> Dict[str, Any]:
...
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
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
def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
update_logging_configuration
Updates a specified logging configuration.
Type annotations and code completion for boto3.client("ivschat").update_logging_configuration
method.
boto3 documentation
def update_logging_configuration(
self,
*,
identifier: str,
destinationConfiguration: DestinationConfigurationTypeDef = ..., # (1)
name: str = ...,
) -> UpdateLoggingConfigurationResponseTypeDef: # (2)
...
kwargs: UpdateLoggingConfigurationRequestRequestTypeDef = { # (1)
"identifier": ...,
}
parent.update_logging_configuration(**kwargs)
update_room
Updates a room’s configuration.
Type annotations and code completion for boto3.client("ivschat").update_room
method.
boto3 documentation
def update_room(
self,
*,
identifier: str,
loggingConfigurationIdentifiers: Sequence[str] = ...,
maximumMessageLength: int = ...,
maximumMessageRatePerSecond: int = ...,
messageReviewHandler: MessageReviewHandlerTypeDef = ..., # (1)
name: str = ...,
) -> UpdateRoomResponseTypeDef: # (2)
...