putDeliverabilityDashboardOption method

Future<void> putDeliverabilityDashboardOption({ required bool dashboardEnabled, List<DomainDeliverabilityTrackingOption>? subscribedDomains, })

Enable or disable the Deliverability dashboard for your Amazon Pinpoint account. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.

When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.

May throw AlreadyExistsException. May throw NotFoundException. May throw TooManyRequestsException. May throw LimitExceededException. May throw BadRequestException.

Parameter dashboardEnabled : Specifies whether to enable the Deliverability dashboard for your Amazon Pinpoint account. To enable the dashboard, set this value to true.

Parameter subscribedDomains : An array of objects, one for each verified domain that you use to send email and enabled the Deliverability dashboard for.

Implementation

Future<void> putDeliverabilityDashboardOption({
  required bool dashboardEnabled,
  List<DomainDeliverabilityTrackingOption>? subscribedDomains,
}) async {
  ArgumentError.checkNotNull(dashboardEnabled, 'dashboardEnabled');
  final $payload = <String, dynamic>{
    'DashboardEnabled': dashboardEnabled,
    if (subscribedDomains != null) 'SubscribedDomains': subscribedDomains,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'PUT',
    requestUri: '/v1/email/deliverability-dashboard',
    exceptionFnMap: _exceptionFns,
  );
}