@aws-sdk/client-pinpoint-email 3.296.0 → 3.297.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (54) hide show
  1. package/dist-types/PinpointEmail.d.ts +43 -0
  2. package/dist-types/PinpointEmailClient.d.ts +24 -4
  3. package/dist-types/commands/CreateConfigurationSetCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateConfigurationSetEventDestinationCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateDedicatedIpPoolCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateDeliverabilityTestReportCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateEmailIdentityCommand.d.ts +16 -0
  8. package/dist-types/commands/DeleteConfigurationSetCommand.d.ts +16 -0
  9. package/dist-types/commands/DeleteConfigurationSetEventDestinationCommand.d.ts +16 -0
  10. package/dist-types/commands/DeleteDedicatedIpPoolCommand.d.ts +16 -0
  11. package/dist-types/commands/DeleteEmailIdentityCommand.d.ts +16 -0
  12. package/dist-types/commands/GetAccountCommand.d.ts +16 -0
  13. package/dist-types/commands/GetBlacklistReportsCommand.d.ts +16 -0
  14. package/dist-types/commands/GetConfigurationSetCommand.d.ts +16 -0
  15. package/dist-types/commands/GetConfigurationSetEventDestinationsCommand.d.ts +16 -0
  16. package/dist-types/commands/GetDedicatedIpCommand.d.ts +16 -0
  17. package/dist-types/commands/GetDedicatedIpsCommand.d.ts +16 -0
  18. package/dist-types/commands/GetDeliverabilityDashboardOptionsCommand.d.ts +16 -0
  19. package/dist-types/commands/GetDeliverabilityTestReportCommand.d.ts +16 -0
  20. package/dist-types/commands/GetDomainDeliverabilityCampaignCommand.d.ts +16 -0
  21. package/dist-types/commands/GetDomainStatisticsReportCommand.d.ts +16 -0
  22. package/dist-types/commands/GetEmailIdentityCommand.d.ts +16 -0
  23. package/dist-types/commands/ListConfigurationSetsCommand.d.ts +16 -0
  24. package/dist-types/commands/ListDedicatedIpPoolsCommand.d.ts +16 -0
  25. package/dist-types/commands/ListDeliverabilityTestReportsCommand.d.ts +16 -0
  26. package/dist-types/commands/ListDomainDeliverabilityCampaignsCommand.d.ts +16 -0
  27. package/dist-types/commands/ListEmailIdentitiesCommand.d.ts +16 -0
  28. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  29. package/dist-types/commands/PutAccountDedicatedIpWarmupAttributesCommand.d.ts +16 -0
  30. package/dist-types/commands/PutAccountSendingAttributesCommand.d.ts +16 -0
  31. package/dist-types/commands/PutConfigurationSetDeliveryOptionsCommand.d.ts +16 -0
  32. package/dist-types/commands/PutConfigurationSetReputationOptionsCommand.d.ts +16 -0
  33. package/dist-types/commands/PutConfigurationSetSendingOptionsCommand.d.ts +16 -0
  34. package/dist-types/commands/PutConfigurationSetTrackingOptionsCommand.d.ts +16 -0
  35. package/dist-types/commands/PutDedicatedIpInPoolCommand.d.ts +16 -0
  36. package/dist-types/commands/PutDedicatedIpWarmupAttributesCommand.d.ts +16 -0
  37. package/dist-types/commands/PutDeliverabilityDashboardOptionCommand.d.ts +16 -0
  38. package/dist-types/commands/PutEmailIdentityDkimAttributesCommand.d.ts +16 -0
  39. package/dist-types/commands/PutEmailIdentityFeedbackAttributesCommand.d.ts +16 -0
  40. package/dist-types/commands/PutEmailIdentityMailFromAttributesCommand.d.ts +16 -0
  41. package/dist-types/commands/SendEmailCommand.d.ts +16 -0
  42. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  43. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  44. package/dist-types/commands/UpdateConfigurationSetEventDestinationCommand.d.ts +16 -0
  45. package/dist-types/models/PinpointEmailServiceException.d.ts +2 -0
  46. package/dist-types/models/models_0.d.ts +174 -0
  47. package/dist-types/pagination/GetDedicatedIpsPaginator.d.ts +3 -0
  48. package/dist-types/pagination/Interfaces.d.ts +3 -0
  49. package/dist-types/pagination/ListConfigurationSetsPaginator.d.ts +3 -0
  50. package/dist-types/pagination/ListDedicatedIpPoolsPaginator.d.ts +3 -0
  51. package/dist-types/pagination/ListDeliverabilityTestReportsPaginator.d.ts +3 -0
  52. package/dist-types/pagination/ListDomainDeliverabilityCampaignsPaginator.d.ts +3 -0
  53. package/dist-types/pagination/ListEmailIdentitiesPaginator.d.ts +3 -0
  54. package/package.json +3 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetDeliverabilityTestReportRequest, GetDeliverabilityTestReportResponse } from "../models/models_0";
5
5
  import { PinpointEmailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointEmailClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetDeliverabilityTestReportCommand}.
8
10
  */
9
11
  export interface GetDeliverabilityTestReportCommandInput extends GetDeliverabilityTestReportRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetDeliverabilityTestReportCommand}.
13
17
  */
14
18
  export interface GetDeliverabilityTestReportCommandOutput extends GetDeliverabilityTestReportResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieve the results of a predictive inbox placement test.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetDeliverabilityTestReportCommandOutput extends GetDeliverabil
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetDeliverabilityTestReportCommandInput - {@link GetDeliverabilityTestReportCommandInput}
34
+ * @returns {@link GetDeliverabilityTestReportCommandOutput}
28
35
  * @see {@link GetDeliverabilityTestReportCommandInput} for command's `input` shape.
29
36
  * @see {@link GetDeliverabilityTestReportCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointEmailClientResolvedConfig | config} for PinpointEmailClient's `config` shape.
@@ -43,11 +50,20 @@ export interface GetDeliverabilityTestReportCommandOutput extends GetDeliverabil
43
50
  export declare class GetDeliverabilityTestReportCommand extends $Command<GetDeliverabilityTestReportCommandInput, GetDeliverabilityTestReportCommandOutput, PinpointEmailClientResolvedConfig> {
44
51
  readonly input: GetDeliverabilityTestReportCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: GetDeliverabilityTestReportCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointEmailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetDeliverabilityTestReportCommandInput, GetDeliverabilityTestReportCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetDomainDeliverabilityCampaignRequest, GetDomainDeliverabilityCampaignResponse } from "../models/models_0";
5
5
  import { PinpointEmailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointEmailClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetDomainDeliverabilityCampaignCommand}.
8
10
  */
9
11
  export interface GetDomainDeliverabilityCampaignCommandInput extends GetDomainDeliverabilityCampaignRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetDomainDeliverabilityCampaignCommand}.
13
17
  */
14
18
  export interface GetDomainDeliverabilityCampaignCommandOutput extends GetDomainDeliverabilityCampaignResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieve all the deliverability data for a specific campaign. This data is available
18
23
  * for a campaign only if the campaign sent email by using a domain that the
19
24
  * Deliverability dashboard is enabled for (<code>PutDeliverabilityDashboardOption</code>
@@ -28,6 +33,8 @@ export interface GetDomainDeliverabilityCampaignCommandOutput extends GetDomainD
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param GetDomainDeliverabilityCampaignCommandInput - {@link GetDomainDeliverabilityCampaignCommandInput}
37
+ * @returns {@link GetDomainDeliverabilityCampaignCommandOutput}
31
38
  * @see {@link GetDomainDeliverabilityCampaignCommandInput} for command's `input` shape.
32
39
  * @see {@link GetDomainDeliverabilityCampaignCommandOutput} for command's `response` shape.
33
40
  * @see {@link PinpointEmailClientResolvedConfig | config} for PinpointEmailClient's `config` shape.
@@ -46,11 +53,20 @@ export interface GetDomainDeliverabilityCampaignCommandOutput extends GetDomainD
46
53
  export declare class GetDomainDeliverabilityCampaignCommand extends $Command<GetDomainDeliverabilityCampaignCommandInput, GetDomainDeliverabilityCampaignCommandOutput, PinpointEmailClientResolvedConfig> {
47
54
  readonly input: GetDomainDeliverabilityCampaignCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: GetDomainDeliverabilityCampaignCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointEmailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetDomainDeliverabilityCampaignCommandInput, GetDomainDeliverabilityCampaignCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetDomainStatisticsReportRequest, GetDomainStatisticsReportResponse } from "../models/models_0";
5
5
  import { PinpointEmailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointEmailClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetDomainStatisticsReportCommand}.
8
10
  */
9
11
  export interface GetDomainStatisticsReportCommandInput extends GetDomainStatisticsReportRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetDomainStatisticsReportCommand}.
13
17
  */
14
18
  export interface GetDomainStatisticsReportCommandOutput extends GetDomainStatisticsReportResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieve inbox placement and engagement rates for the domains that you use to send
18
23
  * email.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface GetDomainStatisticsReportCommandOutput extends GetDomainStatist
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param GetDomainStatisticsReportCommandInput - {@link GetDomainStatisticsReportCommandInput}
35
+ * @returns {@link GetDomainStatisticsReportCommandOutput}
29
36
  * @see {@link GetDomainStatisticsReportCommandInput} for command's `input` shape.
30
37
  * @see {@link GetDomainStatisticsReportCommandOutput} for command's `response` shape.
31
38
  * @see {@link PinpointEmailClientResolvedConfig | config} for PinpointEmailClient's `config` shape.
@@ -44,11 +51,20 @@ export interface GetDomainStatisticsReportCommandOutput extends GetDomainStatist
44
51
  export declare class GetDomainStatisticsReportCommand extends $Command<GetDomainStatisticsReportCommandInput, GetDomainStatisticsReportCommandOutput, PinpointEmailClientResolvedConfig> {
45
52
  readonly input: GetDomainStatisticsReportCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: GetDomainStatisticsReportCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointEmailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetDomainStatisticsReportCommandInput, GetDomainStatisticsReportCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetEmailIdentityRequest, GetEmailIdentityResponse } from "../models/models_0";
5
5
  import { PinpointEmailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointEmailClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetEmailIdentityCommand}.
8
10
  */
9
11
  export interface GetEmailIdentityCommandInput extends GetEmailIdentityRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetEmailIdentityCommand}.
13
17
  */
14
18
  export interface GetEmailIdentityCommandOutput extends GetEmailIdentityResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Provides information about a specific identity associated with your Amazon Pinpoint account,
18
23
  * including the identity's verification status, its DKIM authentication status, and its
19
24
  * custom Mail-From settings.</p>
@@ -27,6 +32,8 @@ export interface GetEmailIdentityCommandOutput extends GetEmailIdentityResponse,
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param GetEmailIdentityCommandInput - {@link GetEmailIdentityCommandInput}
36
+ * @returns {@link GetEmailIdentityCommandOutput}
30
37
  * @see {@link GetEmailIdentityCommandInput} for command's `input` shape.
31
38
  * @see {@link GetEmailIdentityCommandOutput} for command's `response` shape.
32
39
  * @see {@link PinpointEmailClientResolvedConfig | config} for PinpointEmailClient's `config` shape.
@@ -45,11 +52,20 @@ export interface GetEmailIdentityCommandOutput extends GetEmailIdentityResponse,
45
52
  export declare class GetEmailIdentityCommand extends $Command<GetEmailIdentityCommandInput, GetEmailIdentityCommandOutput, PinpointEmailClientResolvedConfig> {
46
53
  readonly input: GetEmailIdentityCommandInput;
47
54
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
55
+ /**
56
+ * @public
57
+ */
48
58
  constructor(input: GetEmailIdentityCommandInput);
49
59
  /**
50
60
  * @internal
51
61
  */
52
62
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointEmailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetEmailIdentityCommandInput, GetEmailIdentityCommandOutput>;
63
+ /**
64
+ * @internal
65
+ */
53
66
  private serialize;
67
+ /**
68
+ * @internal
69
+ */
54
70
  private deserialize;
55
71
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListConfigurationSetsRequest, ListConfigurationSetsResponse } from "../models/models_0";
5
5
  import { PinpointEmailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointEmailClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListConfigurationSetsCommand}.
8
10
  */
9
11
  export interface ListConfigurationSetsCommandInput extends ListConfigurationSetsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListConfigurationSetsCommand}.
13
17
  */
14
18
  export interface ListConfigurationSetsCommandOutput extends ListConfigurationSetsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>List all of the configuration sets associated with your Amazon Pinpoint account in the current
18
23
  * region.</p>
19
24
  * <p>In Amazon Pinpoint, <i>configuration sets</i> are groups of rules that you can
@@ -31,6 +36,8 @@ export interface ListConfigurationSetsCommandOutput extends ListConfigurationSet
31
36
  * const response = await client.send(command);
32
37
  * ```
33
38
  *
39
+ * @param ListConfigurationSetsCommandInput - {@link ListConfigurationSetsCommandInput}
40
+ * @returns {@link ListConfigurationSetsCommandOutput}
34
41
  * @see {@link ListConfigurationSetsCommandInput} for command's `input` shape.
35
42
  * @see {@link ListConfigurationSetsCommandOutput} for command's `response` shape.
36
43
  * @see {@link PinpointEmailClientResolvedConfig | config} for PinpointEmailClient's `config` shape.
@@ -46,11 +53,20 @@ export interface ListConfigurationSetsCommandOutput extends ListConfigurationSet
46
53
  export declare class ListConfigurationSetsCommand extends $Command<ListConfigurationSetsCommandInput, ListConfigurationSetsCommandOutput, PinpointEmailClientResolvedConfig> {
47
54
  readonly input: ListConfigurationSetsCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: ListConfigurationSetsCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointEmailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListConfigurationSetsCommandInput, ListConfigurationSetsCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListDedicatedIpPoolsRequest, ListDedicatedIpPoolsResponse } from "../models/models_0";
5
5
  import { PinpointEmailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointEmailClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListDedicatedIpPoolsCommand}.
8
10
  */
9
11
  export interface ListDedicatedIpPoolsCommandInput extends ListDedicatedIpPoolsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListDedicatedIpPoolsCommand}.
13
17
  */
14
18
  export interface ListDedicatedIpPoolsCommandOutput extends ListDedicatedIpPoolsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current
18
23
  * AWS Region.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface ListDedicatedIpPoolsCommandOutput extends ListDedicatedIpPoolsR
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param ListDedicatedIpPoolsCommandInput - {@link ListDedicatedIpPoolsCommandInput}
35
+ * @returns {@link ListDedicatedIpPoolsCommandOutput}
29
36
  * @see {@link ListDedicatedIpPoolsCommandInput} for command's `input` shape.
30
37
  * @see {@link ListDedicatedIpPoolsCommandOutput} for command's `response` shape.
31
38
  * @see {@link PinpointEmailClientResolvedConfig | config} for PinpointEmailClient's `config` shape.
@@ -41,11 +48,20 @@ export interface ListDedicatedIpPoolsCommandOutput extends ListDedicatedIpPoolsR
41
48
  export declare class ListDedicatedIpPoolsCommand extends $Command<ListDedicatedIpPoolsCommandInput, ListDedicatedIpPoolsCommandOutput, PinpointEmailClientResolvedConfig> {
42
49
  readonly input: ListDedicatedIpPoolsCommandInput;
43
50
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
51
+ /**
52
+ * @public
53
+ */
44
54
  constructor(input: ListDedicatedIpPoolsCommandInput);
45
55
  /**
46
56
  * @internal
47
57
  */
48
58
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointEmailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListDedicatedIpPoolsCommandInput, ListDedicatedIpPoolsCommandOutput>;
59
+ /**
60
+ * @internal
61
+ */
49
62
  private serialize;
63
+ /**
64
+ * @internal
65
+ */
50
66
  private deserialize;
51
67
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListDeliverabilityTestReportsRequest, ListDeliverabilityTestReportsResponse } from "../models/models_0";
5
5
  import { PinpointEmailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointEmailClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListDeliverabilityTestReportsCommand}.
8
10
  */
9
11
  export interface ListDeliverabilityTestReportsCommandInput extends ListDeliverabilityTestReportsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListDeliverabilityTestReportsCommand}.
13
17
  */
14
18
  export interface ListDeliverabilityTestReportsCommandOutput extends ListDeliverabilityTestReportsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For
18
23
  * predictive inbox placement tests that are complete, you can use the <code>GetDeliverabilityTestReport</code>
19
24
  * operation to view the results.</p>
@@ -27,6 +32,8 @@ export interface ListDeliverabilityTestReportsCommandOutput extends ListDelivera
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param ListDeliverabilityTestReportsCommandInput - {@link ListDeliverabilityTestReportsCommandInput}
36
+ * @returns {@link ListDeliverabilityTestReportsCommandOutput}
30
37
  * @see {@link ListDeliverabilityTestReportsCommandInput} for command's `input` shape.
31
38
  * @see {@link ListDeliverabilityTestReportsCommandOutput} for command's `response` shape.
32
39
  * @see {@link PinpointEmailClientResolvedConfig | config} for PinpointEmailClient's `config` shape.
@@ -45,11 +52,20 @@ export interface ListDeliverabilityTestReportsCommandOutput extends ListDelivera
45
52
  export declare class ListDeliverabilityTestReportsCommand extends $Command<ListDeliverabilityTestReportsCommandInput, ListDeliverabilityTestReportsCommandOutput, PinpointEmailClientResolvedConfig> {
46
53
  readonly input: ListDeliverabilityTestReportsCommandInput;
47
54
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
55
+ /**
56
+ * @public
57
+ */
48
58
  constructor(input: ListDeliverabilityTestReportsCommandInput);
49
59
  /**
50
60
  * @internal
51
61
  */
52
62
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointEmailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListDeliverabilityTestReportsCommandInput, ListDeliverabilityTestReportsCommandOutput>;
63
+ /**
64
+ * @internal
65
+ */
53
66
  private serialize;
67
+ /**
68
+ * @internal
69
+ */
54
70
  private deserialize;
55
71
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListDomainDeliverabilityCampaignsRequest, ListDomainDeliverabilityCampaignsResponse } from "../models/models_0";
5
5
  import { PinpointEmailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointEmailClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListDomainDeliverabilityCampaignsCommand}.
8
10
  */
9
11
  export interface ListDomainDeliverabilityCampaignsCommandInput extends ListDomainDeliverabilityCampaignsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListDomainDeliverabilityCampaignsCommand}.
13
17
  */
14
18
  export interface ListDomainDeliverabilityCampaignsCommandOutput extends ListDomainDeliverabilityCampaignsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieve deliverability data for all the campaigns that used a specific domain to send
18
23
  * email during a specified time range. This data is available for a domain only if you
19
24
  * enabled the Deliverability dashboard (<code>PutDeliverabilityDashboardOption</code> operation)
@@ -28,6 +33,8 @@ export interface ListDomainDeliverabilityCampaignsCommandOutput extends ListDoma
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param ListDomainDeliverabilityCampaignsCommandInput - {@link ListDomainDeliverabilityCampaignsCommandInput}
37
+ * @returns {@link ListDomainDeliverabilityCampaignsCommandOutput}
31
38
  * @see {@link ListDomainDeliverabilityCampaignsCommandInput} for command's `input` shape.
32
39
  * @see {@link ListDomainDeliverabilityCampaignsCommandOutput} for command's `response` shape.
33
40
  * @see {@link PinpointEmailClientResolvedConfig | config} for PinpointEmailClient's `config` shape.
@@ -46,11 +53,20 @@ export interface ListDomainDeliverabilityCampaignsCommandOutput extends ListDoma
46
53
  export declare class ListDomainDeliverabilityCampaignsCommand extends $Command<ListDomainDeliverabilityCampaignsCommandInput, ListDomainDeliverabilityCampaignsCommandOutput, PinpointEmailClientResolvedConfig> {
47
54
  readonly input: ListDomainDeliverabilityCampaignsCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: ListDomainDeliverabilityCampaignsCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointEmailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListDomainDeliverabilityCampaignsCommandInput, ListDomainDeliverabilityCampaignsCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListEmailIdentitiesRequest, ListEmailIdentitiesResponse } from "../models/models_0";
5
5
  import { PinpointEmailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointEmailClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListEmailIdentitiesCommand}.
8
10
  */
9
11
  export interface ListEmailIdentitiesCommandInput extends ListEmailIdentitiesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListEmailIdentitiesCommand}.
13
17
  */
14
18
  export interface ListEmailIdentitiesCommandOutput extends ListEmailIdentitiesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a list of all of the email identities that are associated with your Amazon Pinpoint
18
23
  * account. An identity can be either an email address or a domain. This operation returns
19
24
  * identities that are verified as well as those that aren't.</p>
@@ -27,6 +32,8 @@ export interface ListEmailIdentitiesCommandOutput extends ListEmailIdentitiesRes
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param ListEmailIdentitiesCommandInput - {@link ListEmailIdentitiesCommandInput}
36
+ * @returns {@link ListEmailIdentitiesCommandOutput}
30
37
  * @see {@link ListEmailIdentitiesCommandInput} for command's `input` shape.
31
38
  * @see {@link ListEmailIdentitiesCommandOutput} for command's `response` shape.
32
39
  * @see {@link PinpointEmailClientResolvedConfig | config} for PinpointEmailClient's `config` shape.
@@ -42,11 +49,20 @@ export interface ListEmailIdentitiesCommandOutput extends ListEmailIdentitiesRes
42
49
  export declare class ListEmailIdentitiesCommand extends $Command<ListEmailIdentitiesCommandInput, ListEmailIdentitiesCommandOutput, PinpointEmailClientResolvedConfig> {
43
50
  readonly input: ListEmailIdentitiesCommandInput;
44
51
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
52
+ /**
53
+ * @public
54
+ */
45
55
  constructor(input: ListEmailIdentitiesCommandInput);
46
56
  /**
47
57
  * @internal
48
58
  */
49
59
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointEmailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListEmailIdentitiesCommandInput, ListEmailIdentitiesCommandOutput>;
60
+ /**
61
+ * @internal
62
+ */
50
63
  private serialize;
64
+ /**
65
+ * @internal
66
+ */
51
67
  private deserialize;
52
68
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
5
5
  import { PinpointEmailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointEmailClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListTagsForResourceCommand}.
8
10
  */
9
11
  export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListTagsForResourceCommand}.
13
17
  */
14
18
  export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieve a list of the tags (keys and values) that are associated with a specified
18
23
  * resource. A <i>tag</i> is a label that you optionally define and associate
19
24
  * with a resource in Amazon Pinpoint. Each tag consists of a required <i>tag
@@ -30,6 +35,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
39
+ * @returns {@link ListTagsForResourceCommandOutput}
33
40
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
34
41
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
35
42
  * @see {@link PinpointEmailClientResolvedConfig | config} for PinpointEmailClient's `config` shape.
@@ -48,11 +55,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
48
55
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, PinpointEmailClientResolvedConfig> {
49
56
  readonly input: ListTagsForResourceCommandInput;
50
57
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
58
+ /**
59
+ * @public
60
+ */
51
61
  constructor(input: ListTagsForResourceCommandInput);
52
62
  /**
53
63
  * @internal
54
64
  */
55
65
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointEmailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
66
+ /**
67
+ * @internal
68
+ */
56
69
  private serialize;
70
+ /**
71
+ * @internal
72
+ */
57
73
  private deserialize;
58
74
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { PutAccountDedicatedIpWarmupAttributesRequest, PutAccountDedicatedIpWarmupAttributesResponse } from "../models/models_0";
5
5
  import { PinpointEmailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointEmailClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutAccountDedicatedIpWarmupAttributesCommand}.
8
10
  */
9
11
  export interface PutAccountDedicatedIpWarmupAttributesCommandInput extends PutAccountDedicatedIpWarmupAttributesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutAccountDedicatedIpWarmupAttributesCommand}.
13
17
  */
14
18
  export interface PutAccountDedicatedIpWarmupAttributesCommandOutput extends PutAccountDedicatedIpWarmupAttributesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Enable or disable the automatic warm-up feature for dedicated IP addresses.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface PutAccountDedicatedIpWarmupAttributesCommandOutput extends PutA
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param PutAccountDedicatedIpWarmupAttributesCommandInput - {@link PutAccountDedicatedIpWarmupAttributesCommandInput}
34
+ * @returns {@link PutAccountDedicatedIpWarmupAttributesCommandOutput}
28
35
  * @see {@link PutAccountDedicatedIpWarmupAttributesCommandInput} for command's `input` shape.
29
36
  * @see {@link PutAccountDedicatedIpWarmupAttributesCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointEmailClientResolvedConfig | config} for PinpointEmailClient's `config` shape.
@@ -40,11 +47,20 @@ export interface PutAccountDedicatedIpWarmupAttributesCommandOutput extends PutA
40
47
  export declare class PutAccountDedicatedIpWarmupAttributesCommand extends $Command<PutAccountDedicatedIpWarmupAttributesCommandInput, PutAccountDedicatedIpWarmupAttributesCommandOutput, PinpointEmailClientResolvedConfig> {
41
48
  readonly input: PutAccountDedicatedIpWarmupAttributesCommandInput;
42
49
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
50
+ /**
51
+ * @public
52
+ */
43
53
  constructor(input: PutAccountDedicatedIpWarmupAttributesCommandInput);
44
54
  /**
45
55
  * @internal
46
56
  */
47
57
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointEmailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutAccountDedicatedIpWarmupAttributesCommandInput, PutAccountDedicatedIpWarmupAttributesCommandOutput>;
58
+ /**
59
+ * @internal
60
+ */
48
61
  private serialize;
62
+ /**
63
+ * @internal
64
+ */
49
65
  private deserialize;
50
66
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { PutAccountSendingAttributesRequest, PutAccountSendingAttributesResponse } from "../models/models_0";
5
5
  import { PinpointEmailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointEmailClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutAccountSendingAttributesCommand}.
8
10
  */
9
11
  export interface PutAccountSendingAttributesCommandInput extends PutAccountSendingAttributesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutAccountSendingAttributesCommand}.
13
17
  */
14
18
  export interface PutAccountSendingAttributesCommandOutput extends PutAccountSendingAttributesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Enable or disable the ability of your account to send email.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface PutAccountSendingAttributesCommandOutput extends PutAccountSend
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param PutAccountSendingAttributesCommandInput - {@link PutAccountSendingAttributesCommandInput}
34
+ * @returns {@link PutAccountSendingAttributesCommandOutput}
28
35
  * @see {@link PutAccountSendingAttributesCommandInput} for command's `input` shape.
29
36
  * @see {@link PutAccountSendingAttributesCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointEmailClientResolvedConfig | config} for PinpointEmailClient's `config` shape.
@@ -40,11 +47,20 @@ export interface PutAccountSendingAttributesCommandOutput extends PutAccountSend
40
47
  export declare class PutAccountSendingAttributesCommand extends $Command<PutAccountSendingAttributesCommandInput, PutAccountSendingAttributesCommandOutput, PinpointEmailClientResolvedConfig> {
41
48
  readonly input: PutAccountSendingAttributesCommandInput;
42
49
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
50
+ /**
51
+ * @public
52
+ */
43
53
  constructor(input: PutAccountSendingAttributesCommandInput);
44
54
  /**
45
55
  * @internal
46
56
  */
47
57
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointEmailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutAccountSendingAttributesCommandInput, PutAccountSendingAttributesCommandOutput>;
58
+ /**
59
+ * @internal
60
+ */
48
61
  private serialize;
62
+ /**
63
+ * @internal
64
+ */
49
65
  private deserialize;
50
66
  }