@aws-sdk/client-pinpoint-email 3.295.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 +29 -29
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateEmailIdentityRequest, CreateEmailIdentityResponse } from "../models/models_0";
5
5
  import { PinpointEmailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointEmailClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateEmailIdentityCommand}.
8
10
  */
9
11
  export interface CreateEmailIdentityCommandInput extends CreateEmailIdentityRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateEmailIdentityCommand}.
13
17
  */
14
18
  export interface CreateEmailIdentityCommandOutput extends CreateEmailIdentityResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Verifies an email identity for use with Amazon Pinpoint. In Amazon Pinpoint, an identity is an email
18
23
  * address or domain that you use when you send email. Before you can use an identity to
19
24
  * send email with Amazon Pinpoint, you first have to verify it. By verifying an address, you
@@ -38,6 +43,8 @@ export interface CreateEmailIdentityCommandOutput extends CreateEmailIdentityRes
38
43
  * const response = await client.send(command);
39
44
  * ```
40
45
  *
46
+ * @param CreateEmailIdentityCommandInput - {@link CreateEmailIdentityCommandInput}
47
+ * @returns {@link CreateEmailIdentityCommandOutput}
41
48
  * @see {@link CreateEmailIdentityCommandInput} for command's `input` shape.
42
49
  * @see {@link CreateEmailIdentityCommandOutput} for command's `response` shape.
43
50
  * @see {@link PinpointEmailClientResolvedConfig | config} for PinpointEmailClient's `config` shape.
@@ -59,11 +66,20 @@ export interface CreateEmailIdentityCommandOutput extends CreateEmailIdentityRes
59
66
  export declare class CreateEmailIdentityCommand extends $Command<CreateEmailIdentityCommandInput, CreateEmailIdentityCommandOutput, PinpointEmailClientResolvedConfig> {
60
67
  readonly input: CreateEmailIdentityCommandInput;
61
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
62
72
  constructor(input: CreateEmailIdentityCommandInput);
63
73
  /**
64
74
  * @internal
65
75
  */
66
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointEmailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateEmailIdentityCommandInput, CreateEmailIdentityCommandOutput>;
77
+ /**
78
+ * @internal
79
+ */
67
80
  private serialize;
81
+ /**
82
+ * @internal
83
+ */
68
84
  private deserialize;
69
85
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteConfigurationSetRequest, DeleteConfigurationSetResponse } from "../models/models_0";
5
5
  import { PinpointEmailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointEmailClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteConfigurationSetCommand}.
8
10
  */
9
11
  export interface DeleteConfigurationSetCommandInput extends DeleteConfigurationSetRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteConfigurationSetCommand}.
13
17
  */
14
18
  export interface DeleteConfigurationSetCommandOutput extends DeleteConfigurationSetResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Delete an existing configuration set.</p>
18
23
  * <p>In Amazon Pinpoint, <i>configuration sets</i> are groups of rules that you can
19
24
  * apply to the emails you send. You apply a configuration set to an email by including a
@@ -30,6 +35,8 @@ export interface DeleteConfigurationSetCommandOutput extends DeleteConfiguration
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param DeleteConfigurationSetCommandInput - {@link DeleteConfigurationSetCommandInput}
39
+ * @returns {@link DeleteConfigurationSetCommandOutput}
33
40
  * @see {@link DeleteConfigurationSetCommandInput} for command's `input` shape.
34
41
  * @see {@link DeleteConfigurationSetCommandOutput} for command's `response` shape.
35
42
  * @see {@link PinpointEmailClientResolvedConfig | config} for PinpointEmailClient's `config` shape.
@@ -51,11 +58,20 @@ export interface DeleteConfigurationSetCommandOutput extends DeleteConfiguration
51
58
  export declare class DeleteConfigurationSetCommand extends $Command<DeleteConfigurationSetCommandInput, DeleteConfigurationSetCommandOutput, PinpointEmailClientResolvedConfig> {
52
59
  readonly input: DeleteConfigurationSetCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: DeleteConfigurationSetCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointEmailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteConfigurationSetCommandInput, DeleteConfigurationSetCommandOutput>;
69
+ /**
70
+ * @internal
71
+ */
59
72
  private serialize;
73
+ /**
74
+ * @internal
75
+ */
60
76
  private deserialize;
61
77
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteConfigurationSetEventDestinationRequest, DeleteConfigurationSetEventDestinationResponse } from "../models/models_0";
5
5
  import { PinpointEmailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointEmailClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteConfigurationSetEventDestinationCommand}.
8
10
  */
9
11
  export interface DeleteConfigurationSetEventDestinationCommandInput extends DeleteConfigurationSetEventDestinationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteConfigurationSetEventDestinationCommand}.
13
17
  */
14
18
  export interface DeleteConfigurationSetEventDestinationCommandOutput extends DeleteConfigurationSetEventDestinationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Delete an event destination.</p>
18
23
  * <p>In Amazon Pinpoint, <i>events</i> include message sends, deliveries, opens,
19
24
  * clicks, bounces, and complaints. <i>Event destinations</i> are places that
@@ -30,6 +35,8 @@ export interface DeleteConfigurationSetEventDestinationCommandOutput extends Del
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param DeleteConfigurationSetEventDestinationCommandInput - {@link DeleteConfigurationSetEventDestinationCommandInput}
39
+ * @returns {@link DeleteConfigurationSetEventDestinationCommandOutput}
33
40
  * @see {@link DeleteConfigurationSetEventDestinationCommandInput} for command's `input` shape.
34
41
  * @see {@link DeleteConfigurationSetEventDestinationCommandOutput} for command's `response` shape.
35
42
  * @see {@link PinpointEmailClientResolvedConfig | config} for PinpointEmailClient's `config` shape.
@@ -48,11 +55,20 @@ export interface DeleteConfigurationSetEventDestinationCommandOutput extends Del
48
55
  export declare class DeleteConfigurationSetEventDestinationCommand extends $Command<DeleteConfigurationSetEventDestinationCommandInput, DeleteConfigurationSetEventDestinationCommandOutput, PinpointEmailClientResolvedConfig> {
49
56
  readonly input: DeleteConfigurationSetEventDestinationCommandInput;
50
57
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
58
+ /**
59
+ * @public
60
+ */
51
61
  constructor(input: DeleteConfigurationSetEventDestinationCommandInput);
52
62
  /**
53
63
  * @internal
54
64
  */
55
65
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointEmailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteConfigurationSetEventDestinationCommandInput, DeleteConfigurationSetEventDestinationCommandOutput>;
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 { DeleteDedicatedIpPoolRequest, DeleteDedicatedIpPoolResponse } from "../models/models_0";
5
5
  import { PinpointEmailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointEmailClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteDedicatedIpPoolCommand}.
8
10
  */
9
11
  export interface DeleteDedicatedIpPoolCommandInput extends DeleteDedicatedIpPoolRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteDedicatedIpPoolCommand}.
13
17
  */
14
18
  export interface DeleteDedicatedIpPoolCommandOutput extends DeleteDedicatedIpPoolResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Delete a dedicated IP pool.</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 DeleteDedicatedIpPoolCommandOutput extends DeleteDedicatedIpPoo
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteDedicatedIpPoolCommandInput - {@link DeleteDedicatedIpPoolCommandInput}
34
+ * @returns {@link DeleteDedicatedIpPoolCommandOutput}
28
35
  * @see {@link DeleteDedicatedIpPoolCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteDedicatedIpPoolCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointEmailClientResolvedConfig | config} for PinpointEmailClient's `config` shape.
@@ -46,11 +53,20 @@ export interface DeleteDedicatedIpPoolCommandOutput extends DeleteDedicatedIpPoo
46
53
  export declare class DeleteDedicatedIpPoolCommand extends $Command<DeleteDedicatedIpPoolCommandInput, DeleteDedicatedIpPoolCommandOutput, PinpointEmailClientResolvedConfig> {
47
54
  readonly input: DeleteDedicatedIpPoolCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: DeleteDedicatedIpPoolCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointEmailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteDedicatedIpPoolCommandInput, DeleteDedicatedIpPoolCommandOutput>;
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 { DeleteEmailIdentityRequest, DeleteEmailIdentityResponse } from "../models/models_0";
5
5
  import { PinpointEmailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointEmailClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteEmailIdentityCommand}.
8
10
  */
9
11
  export interface DeleteEmailIdentityCommandInput extends DeleteEmailIdentityRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteEmailIdentityCommand}.
13
17
  */
14
18
  export interface DeleteEmailIdentityCommandOutput extends DeleteEmailIdentityResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes an email identity that you previously verified for use with Amazon Pinpoint. An identity
18
23
  * can be either an email address or a domain name.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DeleteEmailIdentityCommandOutput extends DeleteEmailIdentityRes
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DeleteEmailIdentityCommandInput - {@link DeleteEmailIdentityCommandInput}
35
+ * @returns {@link DeleteEmailIdentityCommandOutput}
29
36
  * @see {@link DeleteEmailIdentityCommandInput} for command's `input` shape.
30
37
  * @see {@link DeleteEmailIdentityCommandOutput} for command's `response` shape.
31
38
  * @see {@link PinpointEmailClientResolvedConfig | config} for PinpointEmailClient's `config` shape.
@@ -47,11 +54,20 @@ export interface DeleteEmailIdentityCommandOutput extends DeleteEmailIdentityRes
47
54
  export declare class DeleteEmailIdentityCommand extends $Command<DeleteEmailIdentityCommandInput, DeleteEmailIdentityCommandOutput, PinpointEmailClientResolvedConfig> {
48
55
  readonly input: DeleteEmailIdentityCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: DeleteEmailIdentityCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointEmailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteEmailIdentityCommandInput, DeleteEmailIdentityCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetAccountRequest, GetAccountResponse } from "../models/models_0";
5
5
  import { PinpointEmailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointEmailClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetAccountCommand}.
8
10
  */
9
11
  export interface GetAccountCommandInput extends GetAccountRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetAccountCommand}.
13
17
  */
14
18
  export interface GetAccountCommandOutput extends GetAccountResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Obtain information about the email-sending status and capabilities of your Amazon Pinpoint
18
23
  * account in the current AWS Region.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface GetAccountCommandOutput extends GetAccountResponse, __MetadataB
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param GetAccountCommandInput - {@link GetAccountCommandInput}
35
+ * @returns {@link GetAccountCommandOutput}
29
36
  * @see {@link GetAccountCommandInput} for command's `input` shape.
30
37
  * @see {@link GetAccountCommandOutput} for command's `response` shape.
31
38
  * @see {@link PinpointEmailClientResolvedConfig | config} for PinpointEmailClient's `config` shape.
@@ -41,11 +48,20 @@ export interface GetAccountCommandOutput extends GetAccountResponse, __MetadataB
41
48
  export declare class GetAccountCommand extends $Command<GetAccountCommandInput, GetAccountCommandOutput, PinpointEmailClientResolvedConfig> {
42
49
  readonly input: GetAccountCommandInput;
43
50
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
51
+ /**
52
+ * @public
53
+ */
44
54
  constructor(input: GetAccountCommandInput);
45
55
  /**
46
56
  * @internal
47
57
  */
48
58
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointEmailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetAccountCommandInput, GetAccountCommandOutput>;
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 { GetBlacklistReportsRequest, GetBlacklistReportsResponse } from "../models/models_0";
5
5
  import { PinpointEmailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointEmailClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetBlacklistReportsCommand}.
8
10
  */
9
11
  export interface GetBlacklistReportsCommandInput extends GetBlacklistReportsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetBlacklistReportsCommand}.
13
17
  */
14
18
  export interface GetBlacklistReportsCommandOutput extends GetBlacklistReportsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieve a list of the blacklists that your dedicated IP addresses appear on.</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 GetBlacklistReportsCommandOutput extends GetBlacklistReportsRes
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetBlacklistReportsCommandInput - {@link GetBlacklistReportsCommandInput}
34
+ * @returns {@link GetBlacklistReportsCommandOutput}
28
35
  * @see {@link GetBlacklistReportsCommandInput} for command's `input` shape.
29
36
  * @see {@link GetBlacklistReportsCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointEmailClientResolvedConfig | config} for PinpointEmailClient's `config` shape.
@@ -43,11 +50,20 @@ export interface GetBlacklistReportsCommandOutput extends GetBlacklistReportsRes
43
50
  export declare class GetBlacklistReportsCommand extends $Command<GetBlacklistReportsCommandInput, GetBlacklistReportsCommandOutput, PinpointEmailClientResolvedConfig> {
44
51
  readonly input: GetBlacklistReportsCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: GetBlacklistReportsCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointEmailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetBlacklistReportsCommandInput, GetBlacklistReportsCommandOutput>;
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 { GetConfigurationSetRequest, GetConfigurationSetResponse } from "../models/models_0";
5
5
  import { PinpointEmailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointEmailClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetConfigurationSetCommand}.
8
10
  */
9
11
  export interface GetConfigurationSetCommandInput extends GetConfigurationSetRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetConfigurationSetCommand}.
13
17
  */
14
18
  export interface GetConfigurationSetCommandOutput extends GetConfigurationSetResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Get information about an existing configuration set, including the dedicated IP pool
18
23
  * that it's associated with, whether or not it's enabled for sending email, and
19
24
  * more.</p>
@@ -32,6 +37,8 @@ export interface GetConfigurationSetCommandOutput extends GetConfigurationSetRes
32
37
  * const response = await client.send(command);
33
38
  * ```
34
39
  *
40
+ * @param GetConfigurationSetCommandInput - {@link GetConfigurationSetCommandInput}
41
+ * @returns {@link GetConfigurationSetCommandOutput}
35
42
  * @see {@link GetConfigurationSetCommandInput} for command's `input` shape.
36
43
  * @see {@link GetConfigurationSetCommandOutput} for command's `response` shape.
37
44
  * @see {@link PinpointEmailClientResolvedConfig | config} for PinpointEmailClient's `config` shape.
@@ -50,11 +57,20 @@ export interface GetConfigurationSetCommandOutput extends GetConfigurationSetRes
50
57
  export declare class GetConfigurationSetCommand extends $Command<GetConfigurationSetCommandInput, GetConfigurationSetCommandOutput, PinpointEmailClientResolvedConfig> {
51
58
  readonly input: GetConfigurationSetCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: GetConfigurationSetCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointEmailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetConfigurationSetCommandInput, GetConfigurationSetCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetConfigurationSetEventDestinationsRequest, GetConfigurationSetEventDestinationsResponse } from "../models/models_0";
5
5
  import { PinpointEmailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointEmailClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetConfigurationSetEventDestinationsCommand}.
8
10
  */
9
11
  export interface GetConfigurationSetEventDestinationsCommandInput extends GetConfigurationSetEventDestinationsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetConfigurationSetEventDestinationsCommand}.
13
17
  */
14
18
  export interface GetConfigurationSetEventDestinationsCommandOutput extends GetConfigurationSetEventDestinationsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieve a list of event destinations that are associated with a configuration
18
23
  * set.</p>
19
24
  * <p>In Amazon Pinpoint, <i>events</i> include message sends, deliveries, opens,
@@ -31,6 +36,8 @@ export interface GetConfigurationSetEventDestinationsCommandOutput extends GetCo
31
36
  * const response = await client.send(command);
32
37
  * ```
33
38
  *
39
+ * @param GetConfigurationSetEventDestinationsCommandInput - {@link GetConfigurationSetEventDestinationsCommandInput}
40
+ * @returns {@link GetConfigurationSetEventDestinationsCommandOutput}
34
41
  * @see {@link GetConfigurationSetEventDestinationsCommandInput} for command's `input` shape.
35
42
  * @see {@link GetConfigurationSetEventDestinationsCommandOutput} for command's `response` shape.
36
43
  * @see {@link PinpointEmailClientResolvedConfig | config} for PinpointEmailClient's `config` shape.
@@ -49,11 +56,20 @@ export interface GetConfigurationSetEventDestinationsCommandOutput extends GetCo
49
56
  export declare class GetConfigurationSetEventDestinationsCommand extends $Command<GetConfigurationSetEventDestinationsCommandInput, GetConfigurationSetEventDestinationsCommandOutput, PinpointEmailClientResolvedConfig> {
50
57
  readonly input: GetConfigurationSetEventDestinationsCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: GetConfigurationSetEventDestinationsCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointEmailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetConfigurationSetEventDestinationsCommandInput, GetConfigurationSetEventDestinationsCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetDedicatedIpRequest, GetDedicatedIpResponse } from "../models/models_0";
5
5
  import { PinpointEmailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointEmailClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetDedicatedIpCommand}.
8
10
  */
9
11
  export interface GetDedicatedIpCommandInput extends GetDedicatedIpRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetDedicatedIpCommand}.
13
17
  */
14
18
  export interface GetDedicatedIpCommandOutput extends GetDedicatedIpResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Get information about a dedicated IP address, including the name of the dedicated IP
18
23
  * pool that it's associated with, as well information about the automatic warm-up process
19
24
  * for the address.</p>
@@ -27,6 +32,8 @@ export interface GetDedicatedIpCommandOutput extends GetDedicatedIpResponse, __M
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param GetDedicatedIpCommandInput - {@link GetDedicatedIpCommandInput}
36
+ * @returns {@link GetDedicatedIpCommandOutput}
30
37
  * @see {@link GetDedicatedIpCommandInput} for command's `input` shape.
31
38
  * @see {@link GetDedicatedIpCommandOutput} for command's `response` shape.
32
39
  * @see {@link PinpointEmailClientResolvedConfig | config} for PinpointEmailClient's `config` shape.
@@ -45,11 +52,20 @@ export interface GetDedicatedIpCommandOutput extends GetDedicatedIpResponse, __M
45
52
  export declare class GetDedicatedIpCommand extends $Command<GetDedicatedIpCommandInput, GetDedicatedIpCommandOutput, PinpointEmailClientResolvedConfig> {
46
53
  readonly input: GetDedicatedIpCommandInput;
47
54
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
55
+ /**
56
+ * @public
57
+ */
48
58
  constructor(input: GetDedicatedIpCommandInput);
49
59
  /**
50
60
  * @internal
51
61
  */
52
62
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointEmailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetDedicatedIpCommandInput, GetDedicatedIpCommandOutput>;
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 { GetDedicatedIpsRequest, GetDedicatedIpsResponse } from "../models/models_0";
5
5
  import { PinpointEmailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointEmailClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetDedicatedIpsCommand}.
8
10
  */
9
11
  export interface GetDedicatedIpsCommandInput extends GetDedicatedIpsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetDedicatedIpsCommand}.
13
17
  */
14
18
  export interface GetDedicatedIpsCommandOutput extends GetDedicatedIpsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>List the dedicated IP addresses that are associated with your Amazon Pinpoint
18
23
  * account.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface GetDedicatedIpsCommandOutput extends GetDedicatedIpsResponse, _
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param GetDedicatedIpsCommandInput - {@link GetDedicatedIpsCommandInput}
35
+ * @returns {@link GetDedicatedIpsCommandOutput}
29
36
  * @see {@link GetDedicatedIpsCommandInput} for command's `input` shape.
30
37
  * @see {@link GetDedicatedIpsCommandOutput} for command's `response` shape.
31
38
  * @see {@link PinpointEmailClientResolvedConfig | config} for PinpointEmailClient's `config` shape.
@@ -44,11 +51,20 @@ export interface GetDedicatedIpsCommandOutput extends GetDedicatedIpsResponse, _
44
51
  export declare class GetDedicatedIpsCommand extends $Command<GetDedicatedIpsCommandInput, GetDedicatedIpsCommandOutput, PinpointEmailClientResolvedConfig> {
45
52
  readonly input: GetDedicatedIpsCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: GetDedicatedIpsCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointEmailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetDedicatedIpsCommandInput, GetDedicatedIpsCommandOutput>;
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 { GetDeliverabilityDashboardOptionsRequest, GetDeliverabilityDashboardOptionsResponse } from "../models/models_0";
5
5
  import { PinpointEmailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointEmailClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetDeliverabilityDashboardOptionsCommand}.
8
10
  */
9
11
  export interface GetDeliverabilityDashboardOptionsCommandInput extends GetDeliverabilityDashboardOptionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetDeliverabilityDashboardOptionsCommand}.
13
17
  */
14
18
  export interface GetDeliverabilityDashboardOptionsCommandOutput extends GetDeliverabilityDashboardOptionsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account.
18
23
  * When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and
19
24
  * other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the
@@ -31,6 +36,8 @@ export interface GetDeliverabilityDashboardOptionsCommandOutput extends GetDeliv
31
36
  * const response = await client.send(command);
32
37
  * ```
33
38
  *
39
+ * @param GetDeliverabilityDashboardOptionsCommandInput - {@link GetDeliverabilityDashboardOptionsCommandInput}
40
+ * @returns {@link GetDeliverabilityDashboardOptionsCommandOutput}
34
41
  * @see {@link GetDeliverabilityDashboardOptionsCommandInput} for command's `input` shape.
35
42
  * @see {@link GetDeliverabilityDashboardOptionsCommandOutput} for command's `response` shape.
36
43
  * @see {@link PinpointEmailClientResolvedConfig | config} for PinpointEmailClient's `config` shape.
@@ -49,11 +56,20 @@ export interface GetDeliverabilityDashboardOptionsCommandOutput extends GetDeliv
49
56
  export declare class GetDeliverabilityDashboardOptionsCommand extends $Command<GetDeliverabilityDashboardOptionsCommandInput, GetDeliverabilityDashboardOptionsCommandOutput, PinpointEmailClientResolvedConfig> {
50
57
  readonly input: GetDeliverabilityDashboardOptionsCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: GetDeliverabilityDashboardOptionsCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointEmailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetDeliverabilityDashboardOptionsCommandInput, GetDeliverabilityDashboardOptionsCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }