@aws-sdk/client-pinpoint 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 (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 +29 -29
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetCampaignsRequest, GetCampaignsResponse } from "../models/models_0";
5
5
  import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetCampaignsCommand}.
8
10
  */
9
11
  export interface GetCampaignsCommandInput extends GetCampaignsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetCampaignsCommand}.
13
17
  */
14
18
  export interface GetCampaignsCommandOutput extends GetCampaignsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves information about the status, configuration, and other settings for all the campaigns 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 GetCampaignsCommandOutput extends GetCampaignsResponse, __Metad
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetCampaignsCommandInput - {@link GetCampaignsCommandInput}
34
+ * @returns {@link GetCampaignsCommandOutput}
28
35
  * @see {@link GetCampaignsCommandInput} for command's `input` shape.
29
36
  * @see {@link GetCampaignsCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
@@ -55,11 +62,20 @@ export interface GetCampaignsCommandOutput extends GetCampaignsResponse, __Metad
55
62
  export declare class GetCampaignsCommand extends $Command<GetCampaignsCommandInput, GetCampaignsCommandOutput, PinpointClientResolvedConfig> {
56
63
  readonly input: GetCampaignsCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: GetCampaignsCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetCampaignsCommandInput, GetCampaignsCommandOutput>;
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 { GetChannelsRequest, GetChannelsResponse } from "../models/models_1";
5
5
  import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetChannelsCommand}.
8
10
  */
9
11
  export interface GetChannelsCommandInput extends GetChannelsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetChannelsCommand}.
13
17
  */
14
18
  export interface GetChannelsCommandOutput extends GetChannelsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves information about the history and status of each 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 GetChannelsCommandOutput extends GetChannelsResponse, __Metadat
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetChannelsCommandInput - {@link GetChannelsCommandInput}
34
+ * @returns {@link GetChannelsCommandOutput}
28
35
  * @see {@link GetChannelsCommandInput} for command's `input` shape.
29
36
  * @see {@link GetChannelsCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
@@ -55,11 +62,20 @@ export interface GetChannelsCommandOutput extends GetChannelsResponse, __Metadat
55
62
  export declare class GetChannelsCommand extends $Command<GetChannelsCommandInput, GetChannelsCommandOutput, PinpointClientResolvedConfig> {
56
63
  readonly input: GetChannelsCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: GetChannelsCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetChannelsCommandInput, GetChannelsCommandOutput>;
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 { GetEmailChannelRequest, GetEmailChannelResponse } from "../models/models_1";
5
5
  import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetEmailChannelCommand}.
8
10
  */
9
11
  export interface GetEmailChannelCommandInput extends GetEmailChannelRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetEmailChannelCommand}.
13
17
  */
14
18
  export interface GetEmailChannelCommandOutput extends GetEmailChannelResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves information about the status and settings of the email 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 GetEmailChannelCommandOutput extends GetEmailChannelResponse, _
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetEmailChannelCommandInput - {@link GetEmailChannelCommandInput}
34
+ * @returns {@link GetEmailChannelCommandOutput}
28
35
  * @see {@link GetEmailChannelCommandInput} for command's `input` shape.
29
36
  * @see {@link GetEmailChannelCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
@@ -55,11 +62,20 @@ export interface GetEmailChannelCommandOutput extends GetEmailChannelResponse, _
55
62
  export declare class GetEmailChannelCommand extends $Command<GetEmailChannelCommandInput, GetEmailChannelCommandOutput, PinpointClientResolvedConfig> {
56
63
  readonly input: GetEmailChannelCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: GetEmailChannelCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetEmailChannelCommandInput, GetEmailChannelCommandOutput>;
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 { GetEmailTemplateRequest, GetEmailTemplateResponse } from "../models/models_1";
5
5
  import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetEmailTemplateCommand}.
8
10
  */
9
11
  export interface GetEmailTemplateCommandInput extends GetEmailTemplateRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetEmailTemplateCommand}.
13
17
  */
14
18
  export interface GetEmailTemplateCommandOutput extends GetEmailTemplateResponse, __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 email 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 GetEmailTemplateCommandOutput extends GetEmailTemplateResponse,
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetEmailTemplateCommandInput - {@link GetEmailTemplateCommandInput}
34
+ * @returns {@link GetEmailTemplateCommandOutput}
28
35
  * @see {@link GetEmailTemplateCommandInput} for command's `input` shape.
29
36
  * @see {@link GetEmailTemplateCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
@@ -55,11 +62,20 @@ export interface GetEmailTemplateCommandOutput extends GetEmailTemplateResponse,
55
62
  export declare class GetEmailTemplateCommand extends $Command<GetEmailTemplateCommandInput, GetEmailTemplateCommandOutput, PinpointClientResolvedConfig> {
56
63
  readonly input: GetEmailTemplateCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: GetEmailTemplateCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetEmailTemplateCommandInput, GetEmailTemplateCommandOutput>;
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 { GetEndpointRequest, GetEndpointResponse } from "../models/models_1";
5
5
  import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetEndpointCommand}.
8
10
  */
9
11
  export interface GetEndpointCommandInput extends GetEndpointRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetEndpointCommand}.
13
17
  */
14
18
  export interface GetEndpointCommandOutput extends GetEndpointResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves information about the settings and attributes of a specific endpoint 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 GetEndpointCommandOutput extends GetEndpointResponse, __Metadat
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetEndpointCommandInput - {@link GetEndpointCommandInput}
34
+ * @returns {@link GetEndpointCommandOutput}
28
35
  * @see {@link GetEndpointCommandInput} for command's `input` shape.
29
36
  * @see {@link GetEndpointCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
@@ -55,11 +62,20 @@ export interface GetEndpointCommandOutput extends GetEndpointResponse, __Metadat
55
62
  export declare class GetEndpointCommand extends $Command<GetEndpointCommandInput, GetEndpointCommandOutput, PinpointClientResolvedConfig> {
56
63
  readonly input: GetEndpointCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: GetEndpointCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetEndpointCommandInput, GetEndpointCommandOutput>;
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 { GetEventStreamRequest, GetEventStreamResponse } from "../models/models_1";
5
5
  import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetEventStreamCommand}.
8
10
  */
9
11
  export interface GetEventStreamCommandInput extends GetEventStreamRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetEventStreamCommand}.
13
17
  */
14
18
  export interface GetEventStreamCommandOutput extends GetEventStreamResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves information about the event stream settings 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 GetEventStreamCommandOutput extends GetEventStreamResponse, __M
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetEventStreamCommandInput - {@link GetEventStreamCommandInput}
34
+ * @returns {@link GetEventStreamCommandOutput}
28
35
  * @see {@link GetEventStreamCommandInput} for command's `input` shape.
29
36
  * @see {@link GetEventStreamCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
@@ -55,11 +62,20 @@ export interface GetEventStreamCommandOutput extends GetEventStreamResponse, __M
55
62
  export declare class GetEventStreamCommand extends $Command<GetEventStreamCommandInput, GetEventStreamCommandOutput, PinpointClientResolvedConfig> {
56
63
  readonly input: GetEventStreamCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: GetEventStreamCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetEventStreamCommandInput, GetEventStreamCommandOutput>;
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 { GetExportJobRequest, GetExportJobResponse } from "../models/models_1";
5
5
  import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetExportJobCommand}.
8
10
  */
9
11
  export interface GetExportJobCommandInput extends GetExportJobRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetExportJobCommand}.
13
17
  */
14
18
  export interface GetExportJobCommandOutput extends GetExportJobResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves information about the status and settings of a specific export job 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 GetExportJobCommandOutput extends GetExportJobResponse, __Metad
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetExportJobCommandInput - {@link GetExportJobCommandInput}
34
+ * @returns {@link GetExportJobCommandOutput}
28
35
  * @see {@link GetExportJobCommandInput} for command's `input` shape.
29
36
  * @see {@link GetExportJobCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
@@ -55,11 +62,20 @@ export interface GetExportJobCommandOutput extends GetExportJobResponse, __Metad
55
62
  export declare class GetExportJobCommand extends $Command<GetExportJobCommandInput, GetExportJobCommandOutput, PinpointClientResolvedConfig> {
56
63
  readonly input: GetExportJobCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: GetExportJobCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetExportJobCommandInput, GetExportJobCommandOutput>;
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 { GetExportJobsRequest, GetExportJobsResponse } from "../models/models_1";
5
5
  import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetExportJobsCommand}.
8
10
  */
9
11
  export interface GetExportJobsCommandInput extends GetExportJobsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetExportJobsCommand}.
13
17
  */
14
18
  export interface GetExportJobsCommandOutput extends GetExportJobsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves information about the status and settings of all the export jobs 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 GetExportJobsCommandOutput extends GetExportJobsResponse, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetExportJobsCommandInput - {@link GetExportJobsCommandInput}
34
+ * @returns {@link GetExportJobsCommandOutput}
28
35
  * @see {@link GetExportJobsCommandInput} for command's `input` shape.
29
36
  * @see {@link GetExportJobsCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
@@ -55,11 +62,20 @@ export interface GetExportJobsCommandOutput extends GetExportJobsResponse, __Met
55
62
  export declare class GetExportJobsCommand extends $Command<GetExportJobsCommandInput, GetExportJobsCommandOutput, PinpointClientResolvedConfig> {
56
63
  readonly input: GetExportJobsCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: GetExportJobsCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetExportJobsCommandInput, GetExportJobsCommandOutput>;
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 { GetGcmChannelRequest, GetGcmChannelResponse } from "../models/models_1";
5
5
  import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetGcmChannelCommand}.
8
10
  */
9
11
  export interface GetGcmChannelCommandInput extends GetGcmChannelRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetGcmChannelCommand}.
13
17
  */
14
18
  export interface GetGcmChannelCommandOutput extends GetGcmChannelResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves information about the status and settings of the GCM 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 GetGcmChannelCommandOutput extends GetGcmChannelResponse, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetGcmChannelCommandInput - {@link GetGcmChannelCommandInput}
34
+ * @returns {@link GetGcmChannelCommandOutput}
28
35
  * @see {@link GetGcmChannelCommandInput} for command's `input` shape.
29
36
  * @see {@link GetGcmChannelCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
@@ -55,11 +62,20 @@ export interface GetGcmChannelCommandOutput extends GetGcmChannelResponse, __Met
55
62
  export declare class GetGcmChannelCommand extends $Command<GetGcmChannelCommandInput, GetGcmChannelCommandOutput, PinpointClientResolvedConfig> {
56
63
  readonly input: GetGcmChannelCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: GetGcmChannelCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetGcmChannelCommandInput, GetGcmChannelCommandOutput>;
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 { GetImportJobRequest, GetImportJobResponse } from "../models/models_1";
5
5
  import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetImportJobCommand}.
8
10
  */
9
11
  export interface GetImportJobCommandInput extends GetImportJobRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetImportJobCommand}.
13
17
  */
14
18
  export interface GetImportJobCommandOutput extends GetImportJobResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves information about the status and settings of a specific import job 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 GetImportJobCommandOutput extends GetImportJobResponse, __Metad
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetImportJobCommandInput - {@link GetImportJobCommandInput}
34
+ * @returns {@link GetImportJobCommandOutput}
28
35
  * @see {@link GetImportJobCommandInput} for command's `input` shape.
29
36
  * @see {@link GetImportJobCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
@@ -55,11 +62,20 @@ export interface GetImportJobCommandOutput extends GetImportJobResponse, __Metad
55
62
  export declare class GetImportJobCommand extends $Command<GetImportJobCommandInput, GetImportJobCommandOutput, PinpointClientResolvedConfig> {
56
63
  readonly input: GetImportJobCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: GetImportJobCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetImportJobCommandInput, GetImportJobCommandOutput>;
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 { GetImportJobsRequest, GetImportJobsResponse } from "../models/models_1";
5
5
  import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetImportJobsCommand}.
8
10
  */
9
11
  export interface GetImportJobsCommandInput extends GetImportJobsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetImportJobsCommand}.
13
17
  */
14
18
  export interface GetImportJobsCommandOutput extends GetImportJobsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves information about the status and settings of all the import jobs 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 GetImportJobsCommandOutput extends GetImportJobsResponse, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetImportJobsCommandInput - {@link GetImportJobsCommandInput}
34
+ * @returns {@link GetImportJobsCommandOutput}
28
35
  * @see {@link GetImportJobsCommandInput} for command's `input` shape.
29
36
  * @see {@link GetImportJobsCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
@@ -55,11 +62,20 @@ export interface GetImportJobsCommandOutput extends GetImportJobsResponse, __Met
55
62
  export declare class GetImportJobsCommand extends $Command<GetImportJobsCommandInput, GetImportJobsCommandOutput, PinpointClientResolvedConfig> {
56
63
  readonly input: GetImportJobsCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: GetImportJobsCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetImportJobsCommandInput, GetImportJobsCommandOutput>;
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 { GetInAppMessagesRequest, GetInAppMessagesResponse } from "../models/models_1";
5
5
  import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetInAppMessagesCommand}.
8
10
  */
9
11
  export interface GetInAppMessagesCommandInput extends GetInAppMessagesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetInAppMessagesCommand}.
13
17
  */
14
18
  export interface GetInAppMessagesCommandOutput extends GetInAppMessagesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the in-app messages targeted for the provided endpoint 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 GetInAppMessagesCommandOutput extends GetInAppMessagesResponse,
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetInAppMessagesCommandInput - {@link GetInAppMessagesCommandInput}
34
+ * @returns {@link GetInAppMessagesCommandOutput}
28
35
  * @see {@link GetInAppMessagesCommandInput} for command's `input` shape.
29
36
  * @see {@link GetInAppMessagesCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
@@ -55,11 +62,20 @@ export interface GetInAppMessagesCommandOutput extends GetInAppMessagesResponse,
55
62
  export declare class GetInAppMessagesCommand extends $Command<GetInAppMessagesCommandInput, GetInAppMessagesCommandOutput, PinpointClientResolvedConfig> {
56
63
  readonly input: GetInAppMessagesCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: GetInAppMessagesCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetInAppMessagesCommandInput, GetInAppMessagesCommandOutput>;
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 { GetInAppTemplateRequest, GetInAppTemplateResponse } from "../models/models_1";
5
5
  import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetInAppTemplateCommand}.
8
10
  */
9
11
  export interface GetInAppTemplateCommandInput extends GetInAppTemplateRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetInAppTemplateCommand}.
13
17
  */
14
18
  export interface GetInAppTemplateCommandOutput extends GetInAppTemplateResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the content and settings of a message template for messages sent through the in-app 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 GetInAppTemplateCommandOutput extends GetInAppTemplateResponse,
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetInAppTemplateCommandInput - {@link GetInAppTemplateCommandInput}
34
+ * @returns {@link GetInAppTemplateCommandOutput}
28
35
  * @see {@link GetInAppTemplateCommandInput} for command's `input` shape.
29
36
  * @see {@link GetInAppTemplateCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
@@ -55,11 +62,20 @@ export interface GetInAppTemplateCommandOutput extends GetInAppTemplateResponse,
55
62
  export declare class GetInAppTemplateCommand extends $Command<GetInAppTemplateCommandInput, GetInAppTemplateCommandOutput, PinpointClientResolvedConfig> {
56
63
  readonly input: GetInAppTemplateCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: GetInAppTemplateCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetInAppTemplateCommandInput, GetInAppTemplateCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }