update_app_instance_user_endpoint

ChimeSDKIdentity.Client.update_app_instance_user_endpoint(**kwargs)

Updates the details of an AppInstanceUserEndpoint . You can update the name and AllowMessage values.

See also: AWS API Documentation

Request Syntax

response = client.update_app_instance_user_endpoint(
    AppInstanceUserArn='string',
    EndpointId='string',
    Name='string',
    AllowMessages='ALL'|'NONE'
)

Parameters

• AppInstanceUserArn (string) --

  [REQUIRED]

  The ARN of the AppInstanceUser .

• EndpointId (string) --

  [REQUIRED]

  The unique identifier of the AppInstanceUserEndpoint .

• Name (string) -- The name of the AppInstanceUserEndpoint .
• AllowMessages (string) -- Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no messages.

Return type

dict

Returns

Response Syntax

{
    'AppInstanceUserArn': 'string',
    'EndpointId': 'string'
}

Response Structure

• (dict) --

  • AppInstanceUserArn (string) --

    The ARN of the AppInstanceUser .

  • EndpointId (string) --

    The unique identifier of the AppInstanceUserEndpoint .

Exceptions

• ChimeSDKIdentity.Client.exceptions.BadRequestException
• ChimeSDKIdentity.Client.exceptions.ConflictException
• ChimeSDKIdentity.Client.exceptions.ForbiddenException
• ChimeSDKIdentity.Client.exceptions.ThrottledClientException
• ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException
• ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException
• ChimeSDKIdentity.Client.exceptions.ServiceFailureException