describe_channel_moderated_by_app_instance_user
(**kwargs)¶Returns the full details of a channel moderated by the specified AppInstanceUser
.
Note
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.describe_channel_moderated_by_app_instance_user(
ChannelArn='string',
AppInstanceUserArn='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the moderated channel.
[REQUIRED]
The ARN of the AppInstanceUser
in the moderated channel.
[REQUIRED]
The AppInstanceUserArn
of the user that makes the API call.
dict
Response Syntax
{
'Channel': {
'ChannelSummary': {
'Name': 'string',
'ChannelArn': 'string',
'Mode': 'UNRESTRICTED'|'RESTRICTED',
'Privacy': 'PUBLIC'|'PRIVATE',
'Metadata': 'string',
'LastMessageTimestamp': datetime(2015, 1, 1)
}
}
}
Response Structure
(dict) --
Channel (dict) --
The moderated channel.
ChannelSummary (dict) --
Summary of the details of a Channel
.
Name (string) --
The name of the channel.
ChannelArn (string) --
The ARN of the channel.
Mode (string) --
The mode of the channel.
Privacy (string) --
The privacy setting of the channel.
Metadata (string) --
The metadata of the channel.
LastMessageTimestamp (datetime) --
The time at which the last persistent message in a channel was sent.
Exceptions
ChimeSDKMessaging.Client.exceptions.BadRequestException
ChimeSDKMessaging.Client.exceptions.ForbiddenException
ChimeSDKMessaging.Client.exceptions.UnauthorizedClientException
ChimeSDKMessaging.Client.exceptions.ThrottledClientException
ChimeSDKMessaging.Client.exceptions.ServiceUnavailableException
ChimeSDKMessaging.Client.exceptions.ServiceFailureException