[ aws . pinpoint-email ]

put-deliverability-dashboard-option

Description

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 .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  put-deliverability-dashboard-option
--dashboard-enabled | --no-dashboard-enabled
[--subscribed-domains <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--dashboard-enabled | --no-dashboard-enabled (boolean)

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

--subscribed-domains (list)

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

(structure)

An object that contains information about the Deliverability dashboard subscription for a verified domain that you use to send email and currently has an active Deliverability dashboard subscription. If a Deliverability dashboard subscription is active for a domain, you gain access to reputation, inbox placement, and other metrics for the domain.

Domain -> (string)

A verified domain that’s associated with your AWS account and currently has an active Deliverability dashboard subscription.

SubscriptionStartDate -> (timestamp)

The date, in Unix time format, when you enabled the Deliverability dashboard for the domain.

InboxPlacementTrackingOption -> (structure)

An object that contains information about the inbox placement data settings for the domain.

Global -> (boolean)

Specifies whether inbox placement data is being tracked for the domain.

TrackedIsps -> (list)

An array of strings, one for each major email provider that the inbox placement data applies to.

(string)

The name of an email provider.

Shorthand Syntax:

Domain=string,SubscriptionStartDate=timestamp,InboxPlacementTrackingOption={Global=boolean,TrackedIsps=[string,string]} ...

JSON Syntax:

[
  {
    "Domain": "string",
    "SubscriptionStartDate": timestamp,
    "InboxPlacementTrackingOption": {
      "Global": true|false,
      "TrackedIsps": ["string", ...]
    }
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

None