updateAppInstanceUserEndpoint method

Future<UpdateAppInstanceUserEndpointResponse> updateAppInstanceUserEndpoint({ required String appInstanceUserArn, required String endpointId, AllowMessages? allowMessages, String? name, })

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

May throw BadRequestException. May throw ConflictException. May throw ForbiddenException. May throw ServiceFailureException. May throw ServiceUnavailableException. May throw ThrottledClientException. May throw UnauthorizedClientException.

Parameter appInstanceUserArn : The ARN of the AppInstanceUser.

Parameter endpointId : The unique identifier of the AppInstanceUserEndpoint.

Parameter allowMessages : 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.

Parameter name : The name of the AppInstanceUserEndpoint.

Implementation

Future<UpdateAppInstanceUserEndpointResponse> updateAppInstanceUserEndpoint({
  required String appInstanceUserArn,
  required String endpointId,
  AllowMessages? allowMessages,
  String? name,
}) async {
  final $payload = <String, dynamic>{
    if (allowMessages != null) 'AllowMessages': allowMessages.value,
    if (name != null) 'Name': name,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'PUT',
    requestUri:
        '/app-instance-users/${Uri.encodeComponent(appInstanceUserArn)}/endpoints/${Uri.encodeComponent(endpointId)}',
    exceptionFnMap: _exceptionFns,
  );
  return UpdateAppInstanceUserEndpointResponse.fromJson(response);
}