@aws-sdk/client-pinpoint 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 (125) hide show
  1. package/dist-types/Pinpoint.d.ts +120 -0
  2. package/dist-types/PinpointClient.d.ts +24 -4
  3. package/dist-types/commands/CreateAppCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateCampaignCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateEmailTemplateCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateExportJobCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateImportJobCommand.d.ts +16 -0
  8. package/dist-types/commands/CreateInAppTemplateCommand.d.ts +16 -0
  9. package/dist-types/commands/CreateJourneyCommand.d.ts +16 -0
  10. package/dist-types/commands/CreatePushTemplateCommand.d.ts +16 -0
  11. package/dist-types/commands/CreateRecommenderConfigurationCommand.d.ts +16 -0
  12. package/dist-types/commands/CreateSegmentCommand.d.ts +16 -0
  13. package/dist-types/commands/CreateSmsTemplateCommand.d.ts +16 -0
  14. package/dist-types/commands/CreateVoiceTemplateCommand.d.ts +16 -0
  15. package/dist-types/commands/DeleteAdmChannelCommand.d.ts +16 -0
  16. package/dist-types/commands/DeleteApnsChannelCommand.d.ts +16 -0
  17. package/dist-types/commands/DeleteApnsSandboxChannelCommand.d.ts +16 -0
  18. package/dist-types/commands/DeleteApnsVoipChannelCommand.d.ts +16 -0
  19. package/dist-types/commands/DeleteApnsVoipSandboxChannelCommand.d.ts +16 -0
  20. package/dist-types/commands/DeleteAppCommand.d.ts +16 -0
  21. package/dist-types/commands/DeleteBaiduChannelCommand.d.ts +16 -0
  22. package/dist-types/commands/DeleteCampaignCommand.d.ts +16 -0
  23. package/dist-types/commands/DeleteEmailChannelCommand.d.ts +16 -0
  24. package/dist-types/commands/DeleteEmailTemplateCommand.d.ts +16 -0
  25. package/dist-types/commands/DeleteEndpointCommand.d.ts +16 -0
  26. package/dist-types/commands/DeleteEventStreamCommand.d.ts +16 -0
  27. package/dist-types/commands/DeleteGcmChannelCommand.d.ts +16 -0
  28. package/dist-types/commands/DeleteInAppTemplateCommand.d.ts +16 -0
  29. package/dist-types/commands/DeleteJourneyCommand.d.ts +16 -0
  30. package/dist-types/commands/DeletePushTemplateCommand.d.ts +16 -0
  31. package/dist-types/commands/DeleteRecommenderConfigurationCommand.d.ts +16 -0
  32. package/dist-types/commands/DeleteSegmentCommand.d.ts +16 -0
  33. package/dist-types/commands/DeleteSmsChannelCommand.d.ts +16 -0
  34. package/dist-types/commands/DeleteSmsTemplateCommand.d.ts +16 -0
  35. package/dist-types/commands/DeleteUserEndpointsCommand.d.ts +16 -0
  36. package/dist-types/commands/DeleteVoiceChannelCommand.d.ts +16 -0
  37. package/dist-types/commands/DeleteVoiceTemplateCommand.d.ts +16 -0
  38. package/dist-types/commands/GetAdmChannelCommand.d.ts +16 -0
  39. package/dist-types/commands/GetApnsChannelCommand.d.ts +16 -0
  40. package/dist-types/commands/GetApnsSandboxChannelCommand.d.ts +16 -0
  41. package/dist-types/commands/GetApnsVoipChannelCommand.d.ts +16 -0
  42. package/dist-types/commands/GetApnsVoipSandboxChannelCommand.d.ts +16 -0
  43. package/dist-types/commands/GetAppCommand.d.ts +16 -0
  44. package/dist-types/commands/GetApplicationDateRangeKpiCommand.d.ts +16 -0
  45. package/dist-types/commands/GetApplicationSettingsCommand.d.ts +16 -0
  46. package/dist-types/commands/GetAppsCommand.d.ts +16 -0
  47. package/dist-types/commands/GetBaiduChannelCommand.d.ts +16 -0
  48. package/dist-types/commands/GetCampaignActivitiesCommand.d.ts +16 -0
  49. package/dist-types/commands/GetCampaignCommand.d.ts +16 -0
  50. package/dist-types/commands/GetCampaignDateRangeKpiCommand.d.ts +16 -0
  51. package/dist-types/commands/GetCampaignVersionCommand.d.ts +16 -0
  52. package/dist-types/commands/GetCampaignVersionsCommand.d.ts +16 -0
  53. package/dist-types/commands/GetCampaignsCommand.d.ts +16 -0
  54. package/dist-types/commands/GetChannelsCommand.d.ts +16 -0
  55. package/dist-types/commands/GetEmailChannelCommand.d.ts +16 -0
  56. package/dist-types/commands/GetEmailTemplateCommand.d.ts +16 -0
  57. package/dist-types/commands/GetEndpointCommand.d.ts +16 -0
  58. package/dist-types/commands/GetEventStreamCommand.d.ts +16 -0
  59. package/dist-types/commands/GetExportJobCommand.d.ts +16 -0
  60. package/dist-types/commands/GetExportJobsCommand.d.ts +16 -0
  61. package/dist-types/commands/GetGcmChannelCommand.d.ts +16 -0
  62. package/dist-types/commands/GetImportJobCommand.d.ts +16 -0
  63. package/dist-types/commands/GetImportJobsCommand.d.ts +16 -0
  64. package/dist-types/commands/GetInAppMessagesCommand.d.ts +16 -0
  65. package/dist-types/commands/GetInAppTemplateCommand.d.ts +16 -0
  66. package/dist-types/commands/GetJourneyCommand.d.ts +16 -0
  67. package/dist-types/commands/GetJourneyDateRangeKpiCommand.d.ts +16 -0
  68. package/dist-types/commands/GetJourneyExecutionActivityMetricsCommand.d.ts +16 -0
  69. package/dist-types/commands/GetJourneyExecutionMetricsCommand.d.ts +16 -0
  70. package/dist-types/commands/GetPushTemplateCommand.d.ts +16 -0
  71. package/dist-types/commands/GetRecommenderConfigurationCommand.d.ts +16 -0
  72. package/dist-types/commands/GetRecommenderConfigurationsCommand.d.ts +16 -0
  73. package/dist-types/commands/GetSegmentCommand.d.ts +16 -0
  74. package/dist-types/commands/GetSegmentExportJobsCommand.d.ts +16 -0
  75. package/dist-types/commands/GetSegmentImportJobsCommand.d.ts +16 -0
  76. package/dist-types/commands/GetSegmentVersionCommand.d.ts +16 -0
  77. package/dist-types/commands/GetSegmentVersionsCommand.d.ts +16 -0
  78. package/dist-types/commands/GetSegmentsCommand.d.ts +16 -0
  79. package/dist-types/commands/GetSmsChannelCommand.d.ts +16 -0
  80. package/dist-types/commands/GetSmsTemplateCommand.d.ts +16 -0
  81. package/dist-types/commands/GetUserEndpointsCommand.d.ts +16 -0
  82. package/dist-types/commands/GetVoiceChannelCommand.d.ts +16 -0
  83. package/dist-types/commands/GetVoiceTemplateCommand.d.ts +16 -0
  84. package/dist-types/commands/ListJourneysCommand.d.ts +16 -0
  85. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  86. package/dist-types/commands/ListTemplateVersionsCommand.d.ts +16 -0
  87. package/dist-types/commands/ListTemplatesCommand.d.ts +16 -0
  88. package/dist-types/commands/PhoneNumberValidateCommand.d.ts +16 -0
  89. package/dist-types/commands/PutEventStreamCommand.d.ts +16 -0
  90. package/dist-types/commands/PutEventsCommand.d.ts +16 -0
  91. package/dist-types/commands/RemoveAttributesCommand.d.ts +16 -0
  92. package/dist-types/commands/SendMessagesCommand.d.ts +16 -0
  93. package/dist-types/commands/SendOTPMessageCommand.d.ts +16 -0
  94. package/dist-types/commands/SendUsersMessagesCommand.d.ts +16 -0
  95. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  96. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  97. package/dist-types/commands/UpdateAdmChannelCommand.d.ts +16 -0
  98. package/dist-types/commands/UpdateApnsChannelCommand.d.ts +16 -0
  99. package/dist-types/commands/UpdateApnsSandboxChannelCommand.d.ts +16 -0
  100. package/dist-types/commands/UpdateApnsVoipChannelCommand.d.ts +16 -0
  101. package/dist-types/commands/UpdateApnsVoipSandboxChannelCommand.d.ts +16 -0
  102. package/dist-types/commands/UpdateApplicationSettingsCommand.d.ts +16 -0
  103. package/dist-types/commands/UpdateBaiduChannelCommand.d.ts +16 -0
  104. package/dist-types/commands/UpdateCampaignCommand.d.ts +16 -0
  105. package/dist-types/commands/UpdateEmailChannelCommand.d.ts +16 -0
  106. package/dist-types/commands/UpdateEmailTemplateCommand.d.ts +16 -0
  107. package/dist-types/commands/UpdateEndpointCommand.d.ts +16 -0
  108. package/dist-types/commands/UpdateEndpointsBatchCommand.d.ts +16 -0
  109. package/dist-types/commands/UpdateGcmChannelCommand.d.ts +16 -0
  110. package/dist-types/commands/UpdateInAppTemplateCommand.d.ts +16 -0
  111. package/dist-types/commands/UpdateJourneyCommand.d.ts +16 -0
  112. package/dist-types/commands/UpdateJourneyStateCommand.d.ts +16 -0
  113. package/dist-types/commands/UpdatePushTemplateCommand.d.ts +16 -0
  114. package/dist-types/commands/UpdateRecommenderConfigurationCommand.d.ts +16 -0
  115. package/dist-types/commands/UpdateSegmentCommand.d.ts +16 -0
  116. package/dist-types/commands/UpdateSmsChannelCommand.d.ts +16 -0
  117. package/dist-types/commands/UpdateSmsTemplateCommand.d.ts +16 -0
  118. package/dist-types/commands/UpdateTemplateActiveVersionCommand.d.ts +16 -0
  119. package/dist-types/commands/UpdateVoiceChannelCommand.d.ts +16 -0
  120. package/dist-types/commands/UpdateVoiceTemplateCommand.d.ts +16 -0
  121. package/dist-types/commands/VerifyOTPMessageCommand.d.ts +16 -0
  122. package/dist-types/models/PinpointServiceException.d.ts +2 -0
  123. package/dist-types/models/models_0.d.ts +558 -0
  124. package/dist-types/models/models_1.d.ts +440 -0
  125. package/package.json +3 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetSmsChannelRequest, GetSmsChannelResponse } from "../models/models_1";
5
5
  import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetSmsChannelCommand}.
8
10
  */
9
11
  export interface GetSmsChannelCommandInput extends GetSmsChannelRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetSmsChannelCommand}.
13
17
  */
14
18
  export interface GetSmsChannelCommandOutput extends GetSmsChannelResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves information about the status and settings of the SMS channel for an application.</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 GetSmsChannelCommandOutput extends GetSmsChannelResponse, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetSmsChannelCommandInput - {@link GetSmsChannelCommandInput}
34
+ * @returns {@link GetSmsChannelCommandOutput}
28
35
  * @see {@link GetSmsChannelCommandInput} for command's `input` shape.
29
36
  * @see {@link GetSmsChannelCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
@@ -55,11 +62,20 @@ export interface GetSmsChannelCommandOutput extends GetSmsChannelResponse, __Met
55
62
  export declare class GetSmsChannelCommand extends $Command<GetSmsChannelCommandInput, GetSmsChannelCommandOutput, PinpointClientResolvedConfig> {
56
63
  readonly input: GetSmsChannelCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: GetSmsChannelCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetSmsChannelCommandInput, GetSmsChannelCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetSmsTemplateRequest, GetSmsTemplateResponse } from "../models/models_1";
5
5
  import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetSmsTemplateCommand}.
8
10
  */
9
11
  export interface GetSmsTemplateCommandInput extends GetSmsTemplateRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetSmsTemplateCommand}.
13
17
  */
14
18
  export interface GetSmsTemplateCommandOutput extends GetSmsTemplateResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the content and settings of a message template for messages that are sent through the SMS channel.</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 GetSmsTemplateCommandOutput extends GetSmsTemplateResponse, __M
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetSmsTemplateCommandInput - {@link GetSmsTemplateCommandInput}
34
+ * @returns {@link GetSmsTemplateCommandOutput}
28
35
  * @see {@link GetSmsTemplateCommandInput} for command's `input` shape.
29
36
  * @see {@link GetSmsTemplateCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
@@ -55,11 +62,20 @@ export interface GetSmsTemplateCommandOutput extends GetSmsTemplateResponse, __M
55
62
  export declare class GetSmsTemplateCommand extends $Command<GetSmsTemplateCommandInput, GetSmsTemplateCommandOutput, PinpointClientResolvedConfig> {
56
63
  readonly input: GetSmsTemplateCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: GetSmsTemplateCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetSmsTemplateCommandInput, GetSmsTemplateCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetUserEndpointsRequest, GetUserEndpointsResponse } from "../models/models_1";
5
5
  import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetUserEndpointsCommand}.
8
10
  */
9
11
  export interface GetUserEndpointsCommandInput extends GetUserEndpointsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetUserEndpointsCommand}.
13
17
  */
14
18
  export interface GetUserEndpointsCommandOutput extends GetUserEndpointsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves information about all the endpoints that are associated with a specific user ID.</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 GetUserEndpointsCommandOutput extends GetUserEndpointsResponse,
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetUserEndpointsCommandInput - {@link GetUserEndpointsCommandInput}
34
+ * @returns {@link GetUserEndpointsCommandOutput}
28
35
  * @see {@link GetUserEndpointsCommandInput} for command's `input` shape.
29
36
  * @see {@link GetUserEndpointsCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
@@ -55,11 +62,20 @@ export interface GetUserEndpointsCommandOutput extends GetUserEndpointsResponse,
55
62
  export declare class GetUserEndpointsCommand extends $Command<GetUserEndpointsCommandInput, GetUserEndpointsCommandOutput, PinpointClientResolvedConfig> {
56
63
  readonly input: GetUserEndpointsCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: GetUserEndpointsCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetUserEndpointsCommandInput, GetUserEndpointsCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetVoiceChannelRequest, GetVoiceChannelResponse } from "../models/models_1";
5
5
  import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetVoiceChannelCommand}.
8
10
  */
9
11
  export interface GetVoiceChannelCommandInput extends GetVoiceChannelRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetVoiceChannelCommand}.
13
17
  */
14
18
  export interface GetVoiceChannelCommandOutput extends GetVoiceChannelResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves information about the status and settings of the voice channel for an application.</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 GetVoiceChannelCommandOutput extends GetVoiceChannelResponse, _
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetVoiceChannelCommandInput - {@link GetVoiceChannelCommandInput}
34
+ * @returns {@link GetVoiceChannelCommandOutput}
28
35
  * @see {@link GetVoiceChannelCommandInput} for command's `input` shape.
29
36
  * @see {@link GetVoiceChannelCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
@@ -55,11 +62,20 @@ export interface GetVoiceChannelCommandOutput extends GetVoiceChannelResponse, _
55
62
  export declare class GetVoiceChannelCommand extends $Command<GetVoiceChannelCommandInput, GetVoiceChannelCommandOutput, PinpointClientResolvedConfig> {
56
63
  readonly input: GetVoiceChannelCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: GetVoiceChannelCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetVoiceChannelCommandInput, GetVoiceChannelCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetVoiceTemplateRequest, GetVoiceTemplateResponse } from "../models/models_1";
5
5
  import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetVoiceTemplateCommand}.
8
10
  */
9
11
  export interface GetVoiceTemplateCommandInput extends GetVoiceTemplateRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetVoiceTemplateCommand}.
13
17
  */
14
18
  export interface GetVoiceTemplateCommandOutput extends GetVoiceTemplateResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the content and settings of a message template for messages that are sent through the voice channel.</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 GetVoiceTemplateCommandOutput extends GetVoiceTemplateResponse,
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetVoiceTemplateCommandInput - {@link GetVoiceTemplateCommandInput}
34
+ * @returns {@link GetVoiceTemplateCommandOutput}
28
35
  * @see {@link GetVoiceTemplateCommandInput} for command's `input` shape.
29
36
  * @see {@link GetVoiceTemplateCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
@@ -55,11 +62,20 @@ export interface GetVoiceTemplateCommandOutput extends GetVoiceTemplateResponse,
55
62
  export declare class GetVoiceTemplateCommand extends $Command<GetVoiceTemplateCommandInput, GetVoiceTemplateCommandOutput, PinpointClientResolvedConfig> {
56
63
  readonly input: GetVoiceTemplateCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: GetVoiceTemplateCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetVoiceTemplateCommandInput, GetVoiceTemplateCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListJourneysRequest, ListJourneysResponse } from "../models/models_1";
5
5
  import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListJourneysCommand}.
8
10
  */
9
11
  export interface ListJourneysCommandInput extends ListJourneysRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListJourneysCommand}.
13
17
  */
14
18
  export interface ListJourneysCommandOutput extends ListJourneysResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.</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 ListJourneysCommandOutput extends ListJourneysResponse, __Metad
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListJourneysCommandInput - {@link ListJourneysCommandInput}
34
+ * @returns {@link ListJourneysCommandOutput}
28
35
  * @see {@link ListJourneysCommandInput} for command's `input` shape.
29
36
  * @see {@link ListJourneysCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
@@ -55,11 +62,20 @@ export interface ListJourneysCommandOutput extends ListJourneysResponse, __Metad
55
62
  export declare class ListJourneysCommand extends $Command<ListJourneysCommandInput, ListJourneysCommandOutput, PinpointClientResolvedConfig> {
56
63
  readonly input: ListJourneysCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: ListJourneysCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListJourneysCommandInput, ListJourneysCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_1";
5
5
  import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
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>Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment.</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 ListTagsForResourceCommandOutput extends ListTagsForResourceRes
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
34
+ * @returns {@link ListTagsForResourceCommandOutput}
28
35
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
@@ -34,11 +41,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
34
41
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, PinpointClientResolvedConfig> {
35
42
  readonly input: ListTagsForResourceCommandInput;
36
43
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
44
+ /**
45
+ * @public
46
+ */
37
47
  constructor(input: ListTagsForResourceCommandInput);
38
48
  /**
39
49
  * @internal
40
50
  */
41
51
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
52
+ /**
53
+ * @internal
54
+ */
42
55
  private serialize;
56
+ /**
57
+ * @internal
58
+ */
43
59
  private deserialize;
44
60
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListTemplateVersionsRequest, ListTemplateVersionsResponse } from "../models/models_1";
5
5
  import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListTemplateVersionsCommand}.
8
10
  */
9
11
  export interface ListTemplateVersionsCommandInput extends ListTemplateVersionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListTemplateVersionsCommand}.
13
17
  */
14
18
  export interface ListTemplateVersionsCommandOutput extends ListTemplateVersionsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves information about all the versions of a specific message template.</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 ListTemplateVersionsCommandOutput extends ListTemplateVersionsR
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListTemplateVersionsCommandInput - {@link ListTemplateVersionsCommandInput}
34
+ * @returns {@link ListTemplateVersionsCommandOutput}
28
35
  * @see {@link ListTemplateVersionsCommandInput} for command's `input` shape.
29
36
  * @see {@link ListTemplateVersionsCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
@@ -55,11 +62,20 @@ export interface ListTemplateVersionsCommandOutput extends ListTemplateVersionsR
55
62
  export declare class ListTemplateVersionsCommand extends $Command<ListTemplateVersionsCommandInput, ListTemplateVersionsCommandOutput, PinpointClientResolvedConfig> {
56
63
  readonly input: ListTemplateVersionsCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: ListTemplateVersionsCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTemplateVersionsCommandInput, ListTemplateVersionsCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListTemplatesRequest, ListTemplatesResponse } from "../models/models_1";
5
5
  import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListTemplatesCommand}.
8
10
  */
9
11
  export interface ListTemplatesCommandInput extends ListTemplatesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListTemplatesCommand}.
13
17
  */
14
18
  export interface ListTemplatesCommandOutput extends ListTemplatesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.</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 ListTemplatesCommandOutput extends ListTemplatesResponse, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListTemplatesCommandInput - {@link ListTemplatesCommandInput}
34
+ * @returns {@link ListTemplatesCommandOutput}
28
35
  * @see {@link ListTemplatesCommandInput} for command's `input` shape.
29
36
  * @see {@link ListTemplatesCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
@@ -49,11 +56,20 @@ export interface ListTemplatesCommandOutput extends ListTemplatesResponse, __Met
49
56
  export declare class ListTemplatesCommand extends $Command<ListTemplatesCommandInput, ListTemplatesCommandOutput, PinpointClientResolvedConfig> {
50
57
  readonly input: ListTemplatesCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: ListTemplatesCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTemplatesCommandInput, ListTemplatesCommandOutput>;
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 { PhoneNumberValidateRequest, PhoneNumberValidateResponse } from "../models/models_1";
5
5
  import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PhoneNumberValidateCommand}.
8
10
  */
9
11
  export interface PhoneNumberValidateCommandInput extends PhoneNumberValidateRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PhoneNumberValidateCommand}.
13
17
  */
14
18
  export interface PhoneNumberValidateCommandOutput extends PhoneNumberValidateResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves information about a phone number.</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 PhoneNumberValidateCommandOutput extends PhoneNumberValidateRes
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param PhoneNumberValidateCommandInput - {@link PhoneNumberValidateCommandInput}
34
+ * @returns {@link PhoneNumberValidateCommandOutput}
28
35
  * @see {@link PhoneNumberValidateCommandInput} for command's `input` shape.
29
36
  * @see {@link PhoneNumberValidateCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
@@ -55,11 +62,20 @@ export interface PhoneNumberValidateCommandOutput extends PhoneNumberValidateRes
55
62
  export declare class PhoneNumberValidateCommand extends $Command<PhoneNumberValidateCommandInput, PhoneNumberValidateCommandOutput, PinpointClientResolvedConfig> {
56
63
  readonly input: PhoneNumberValidateCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: PhoneNumberValidateCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PhoneNumberValidateCommandInput, PhoneNumberValidateCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { PutEventStreamRequest, PutEventStreamResponse } from "../models/models_1";
5
5
  import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutEventStreamCommand}.
8
10
  */
9
11
  export interface PutEventStreamCommandInput extends PutEventStreamRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutEventStreamCommand}.
13
17
  */
14
18
  export interface PutEventStreamCommandOutput extends PutEventStreamResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new event stream for an application or updates the settings of an existing event stream for an application.</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 PutEventStreamCommandOutput extends PutEventStreamResponse, __M
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param PutEventStreamCommandInput - {@link PutEventStreamCommandInput}
34
+ * @returns {@link PutEventStreamCommandOutput}
28
35
  * @see {@link PutEventStreamCommandInput} for command's `input` shape.
29
36
  * @see {@link PutEventStreamCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
@@ -55,11 +62,20 @@ export interface PutEventStreamCommandOutput extends PutEventStreamResponse, __M
55
62
  export declare class PutEventStreamCommand extends $Command<PutEventStreamCommandInput, PutEventStreamCommandOutput, PinpointClientResolvedConfig> {
56
63
  readonly input: PutEventStreamCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: PutEventStreamCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutEventStreamCommandInput, PutEventStreamCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { PutEventsRequest, PutEventsResponse } from "../models/models_1";
5
5
  import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutEventsCommand}.
8
10
  */
9
11
  export interface PutEventsCommandInput extends PutEventsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutEventsCommand}.
13
17
  */
14
18
  export interface PutEventsCommandOutput extends PutEventsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with.</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 PutEventsCommandOutput extends PutEventsResponse, __MetadataBea
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param PutEventsCommandInput - {@link PutEventsCommandInput}
34
+ * @returns {@link PutEventsCommandOutput}
28
35
  * @see {@link PutEventsCommandInput} for command's `input` shape.
29
36
  * @see {@link PutEventsCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
@@ -55,11 +62,20 @@ export interface PutEventsCommandOutput extends PutEventsResponse, __MetadataBea
55
62
  export declare class PutEventsCommand extends $Command<PutEventsCommandInput, PutEventsCommandOutput, PinpointClientResolvedConfig> {
56
63
  readonly input: PutEventsCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: PutEventsCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutEventsCommandInput, PutEventsCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { RemoveAttributesRequest, RemoveAttributesResponse } from "../models/models_1";
5
5
  import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link RemoveAttributesCommand}.
8
10
  */
9
11
  export interface RemoveAttributesCommandInput extends RemoveAttributesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link RemoveAttributesCommand}.
13
17
  */
14
18
  export interface RemoveAttributesCommandOutput extends RemoveAttributesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes one or more attributes, of the same attribute type, from all the endpoints that are associated with an application.</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 RemoveAttributesCommandOutput extends RemoveAttributesResponse,
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param RemoveAttributesCommandInput - {@link RemoveAttributesCommandInput}
34
+ * @returns {@link RemoveAttributesCommandOutput}
28
35
  * @see {@link RemoveAttributesCommandInput} for command's `input` shape.
29
36
  * @see {@link RemoveAttributesCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
@@ -55,11 +62,20 @@ export interface RemoveAttributesCommandOutput extends RemoveAttributesResponse,
55
62
  export declare class RemoveAttributesCommand extends $Command<RemoveAttributesCommandInput, RemoveAttributesCommandOutput, PinpointClientResolvedConfig> {
56
63
  readonly input: RemoveAttributesCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: RemoveAttributesCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RemoveAttributesCommandInput, RemoveAttributesCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }