@aws-sdk/client-pinpoint 3.335.0 → 3.335.1

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 (140) hide show
  1. package/CHANGELOG.md +4785 -0
  2. package/dist-types/ts3.4/Pinpoint.d.ts +864 -2091
  3. package/dist-types/ts3.4/PinpointClient.d.ts +284 -846
  4. package/dist-types/ts3.4/commands/CreateAppCommand.d.ts +103 -34
  5. package/dist-types/ts3.4/commands/CreateCampaignCommand.d.ts +833 -37
  6. package/dist-types/ts3.4/commands/CreateEmailTemplateCommand.d.ts +99 -38
  7. package/dist-types/ts3.4/commands/CreateExportJobCommand.d.ts +117 -37
  8. package/dist-types/ts3.4/commands/CreateImportJobCommand.d.ts +125 -37
  9. package/dist-types/ts3.4/commands/CreateInAppTemplateCommand.d.ts +155 -38
  10. package/dist-types/ts3.4/commands/CreateJourneyCommand.d.ts +840 -37
  11. package/dist-types/ts3.4/commands/CreatePushTemplateCommand.d.ts +145 -38
  12. package/dist-types/ts3.4/commands/CreateRecommenderConfigurationCommand.d.ts +117 -41
  13. package/dist-types/ts3.4/commands/CreateSegmentCommand.d.ts +378 -37
  14. package/dist-types/ts3.4/commands/CreateSmsTemplateCommand.d.ts +97 -38
  15. package/dist-types/ts3.4/commands/CreateVoiceTemplateCommand.d.ts +98 -38
  16. package/dist-types/ts3.4/commands/DeleteAdmChannelCommand.d.ts +101 -37
  17. package/dist-types/ts3.4/commands/DeleteApnsChannelCommand.d.ts +103 -38
  18. package/dist-types/ts3.4/commands/DeleteApnsSandboxChannelCommand.d.ts +103 -41
  19. package/dist-types/ts3.4/commands/DeleteApnsVoipChannelCommand.d.ts +103 -41
  20. package/dist-types/ts3.4/commands/DeleteApnsVoipSandboxChannelCommand.d.ts +103 -41
  21. package/dist-types/ts3.4/commands/DeleteAppCommand.d.ts +98 -34
  22. package/dist-types/ts3.4/commands/DeleteBaiduChannelCommand.d.ts +102 -38
  23. package/dist-types/ts3.4/commands/DeleteCampaignCommand.d.ts +470 -37
  24. package/dist-types/ts3.4/commands/DeleteEmailChannelCommand.d.ts +106 -38
  25. package/dist-types/ts3.4/commands/DeleteEmailTemplateCommand.d.ts +94 -38
  26. package/dist-types/ts3.4/commands/DeleteEndpointCommand.d.ts +136 -37
  27. package/dist-types/ts3.4/commands/DeleteEventStreamCommand.d.ts +97 -38
  28. package/dist-types/ts3.4/commands/DeleteGcmChannelCommand.d.ts +102 -37
  29. package/dist-types/ts3.4/commands/DeleteInAppTemplateCommand.d.ts +94 -38
  30. package/dist-types/ts3.4/commands/DeleteJourneyCommand.d.ts +468 -37
  31. package/dist-types/ts3.4/commands/DeletePushTemplateCommand.d.ts +94 -38
  32. package/dist-types/ts3.4/commands/DeleteRecommenderConfigurationCommand.d.ts +105 -41
  33. package/dist-types/ts3.4/commands/DeleteSegmentCommand.d.ts +243 -37
  34. package/dist-types/ts3.4/commands/DeleteSmsChannelCommand.d.ts +105 -37
  35. package/dist-types/ts3.4/commands/DeleteSmsTemplateCommand.d.ts +94 -38
  36. package/dist-types/ts3.4/commands/DeleteUserEndpointsCommand.d.ts +140 -38
  37. package/dist-types/ts3.4/commands/DeleteVoiceChannelCommand.d.ts +101 -38
  38. package/dist-types/ts3.4/commands/DeleteVoiceTemplateCommand.d.ts +94 -38
  39. package/dist-types/ts3.4/commands/GetAdmChannelCommand.d.ts +101 -37
  40. package/dist-types/ts3.4/commands/GetApnsChannelCommand.d.ts +103 -37
  41. package/dist-types/ts3.4/commands/GetApnsSandboxChannelCommand.d.ts +103 -41
  42. package/dist-types/ts3.4/commands/GetApnsVoipChannelCommand.d.ts +103 -38
  43. package/dist-types/ts3.4/commands/GetApnsVoipSandboxChannelCommand.d.ts +103 -41
  44. package/dist-types/ts3.4/commands/GetAppCommand.d.ts +98 -32
  45. package/dist-types/ts3.4/commands/GetApplicationDateRangeKpiCommand.d.ts +121 -41
  46. package/dist-types/ts3.4/commands/GetApplicationSettingsCommand.d.ts +109 -41
  47. package/dist-types/ts3.4/commands/GetAppsCommand.d.ts +104 -34
  48. package/dist-types/ts3.4/commands/GetBaiduChannelCommand.d.ts +102 -37
  49. package/dist-types/ts3.4/commands/GetCampaignActivitiesCommand.d.ts +115 -41
  50. package/dist-types/ts3.4/commands/GetCampaignCommand.d.ts +470 -34
  51. package/dist-types/ts3.4/commands/GetCampaignDateRangeKpiCommand.d.ts +123 -41
  52. package/dist-types/ts3.4/commands/GetCampaignVersionCommand.d.ts +471 -38
  53. package/dist-types/ts3.4/commands/GetCampaignVersionsCommand.d.ts +477 -38
  54. package/dist-types/ts3.4/commands/GetCampaignsCommand.d.ts +476 -34
  55. package/dist-types/ts3.4/commands/GetChannelsCommand.d.ts +104 -34
  56. package/dist-types/ts3.4/commands/GetEmailChannelCommand.d.ts +106 -37
  57. package/dist-types/ts3.4/commands/GetEmailTemplateCommand.d.ts +107 -37
  58. package/dist-types/ts3.4/commands/GetEndpointCommand.d.ts +136 -34
  59. package/dist-types/ts3.4/commands/GetEventStreamCommand.d.ts +97 -37
  60. package/dist-types/ts3.4/commands/GetExportJobCommand.d.ts +112 -34
  61. package/dist-types/ts3.4/commands/GetExportJobsCommand.d.ts +118 -37
  62. package/dist-types/ts3.4/commands/GetGcmChannelCommand.d.ts +102 -37
  63. package/dist-types/ts3.4/commands/GetImportJobCommand.d.ts +116 -34
  64. package/dist-types/ts3.4/commands/GetImportJobsCommand.d.ts +122 -37
  65. package/dist-types/ts3.4/commands/GetInAppMessagesCommand.d.ts +197 -37
  66. package/dist-types/ts3.4/commands/GetInAppTemplateCommand.d.ts +163 -37
  67. package/dist-types/ts3.4/commands/GetJourneyCommand.d.ts +468 -34
  68. package/dist-types/ts3.4/commands/GetJourneyDateRangeKpiCommand.d.ts +123 -41
  69. package/dist-types/ts3.4/commands/GetJourneyExecutionActivityMetricsCommand.d.ts +103 -41
  70. package/dist-types/ts3.4/commands/GetJourneyExecutionMetricsCommand.d.ts +100 -41
  71. package/dist-types/ts3.4/commands/GetJourneyRunExecutionActivityMetricsCommand.d.ts +134 -41
  72. package/dist-types/ts3.4/commands/GetJourneyRunExecutionMetricsCommand.d.ts +130 -41
  73. package/dist-types/ts3.4/commands/GetJourneyRunsCommand.d.ts +135 -37
  74. package/dist-types/ts3.4/commands/GetPushTemplateCommand.d.ts +153 -37
  75. package/dist-types/ts3.4/commands/GetRecommenderConfigurationCommand.d.ts +105 -41
  76. package/dist-types/ts3.4/commands/GetRecommenderConfigurationsCommand.d.ts +111 -41
  77. package/dist-types/ts3.4/commands/GetSegmentCommand.d.ts +243 -34
  78. package/dist-types/ts3.4/commands/GetSegmentExportJobsCommand.d.ts +119 -41
  79. package/dist-types/ts3.4/commands/GetSegmentImportJobsCommand.d.ts +123 -41
  80. package/dist-types/ts3.4/commands/GetSegmentVersionCommand.d.ts +244 -38
  81. package/dist-types/ts3.4/commands/GetSegmentVersionsCommand.d.ts +250 -38
  82. package/dist-types/ts3.4/commands/GetSegmentsCommand.d.ts +249 -34
  83. package/dist-types/ts3.4/commands/GetSmsChannelCommand.d.ts +105 -37
  84. package/dist-types/ts3.4/commands/GetSmsTemplateCommand.d.ts +105 -37
  85. package/dist-types/ts3.4/commands/GetUserEndpointsCommand.d.ts +140 -37
  86. package/dist-types/ts3.4/commands/GetVoiceChannelCommand.d.ts +101 -37
  87. package/dist-types/ts3.4/commands/GetVoiceTemplateCommand.d.ts +106 -37
  88. package/dist-types/ts3.4/commands/ListJourneysCommand.d.ts +474 -34
  89. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +73 -38
  90. package/dist-types/ts3.4/commands/ListTemplateVersionsCommand.d.ts +108 -41
  91. package/dist-types/ts3.4/commands/ListTemplatesCommand.d.ts +104 -37
  92. package/dist-types/ts3.4/commands/PhoneNumberValidateCommand.d.ts +108 -38
  93. package/dist-types/ts3.4/commands/PutEventStreamCommand.d.ts +101 -37
  94. package/dist-types/ts3.4/commands/PutEventsCommand.d.ts +176 -34
  95. package/dist-types/ts3.4/commands/RemoveAttributesCommand.d.ts +102 -37
  96. package/dist-types/ts3.4/commands/SendMessagesCommand.d.ts +313 -34
  97. package/dist-types/ts3.4/commands/SendOTPMessageCommand.d.ts +125 -37
  98. package/dist-types/ts3.4/commands/SendUsersMessagesCommand.d.ts +296 -38
  99. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +72 -32
  100. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +70 -32
  101. package/dist-types/ts3.4/commands/UpdateAdmChannelCommand.d.ts +106 -37
  102. package/dist-types/ts3.4/commands/UpdateApnsChannelCommand.d.ts +113 -38
  103. package/dist-types/ts3.4/commands/UpdateApnsSandboxChannelCommand.d.ts +113 -41
  104. package/dist-types/ts3.4/commands/UpdateApnsVoipChannelCommand.d.ts +113 -41
  105. package/dist-types/ts3.4/commands/UpdateApnsVoipSandboxChannelCommand.d.ts +113 -41
  106. package/dist-types/ts3.4/commands/UpdateApplicationSettingsCommand.d.ts +129 -41
  107. package/dist-types/ts3.4/commands/UpdateBaiduChannelCommand.d.ts +107 -38
  108. package/dist-types/ts3.4/commands/UpdateCampaignCommand.d.ts +834 -37
  109. package/dist-types/ts3.4/commands/UpdateEmailChannelCommand.d.ts +113 -38
  110. package/dist-types/ts3.4/commands/UpdateEmailTemplateCommand.d.ts +106 -38
  111. package/dist-types/ts3.4/commands/UpdateEndpointCommand.d.ts +136 -37
  112. package/dist-types/ts3.4/commands/UpdateEndpointsBatchCommand.d.ts +140 -41
  113. package/dist-types/ts3.4/commands/UpdateGcmChannelCommand.d.ts +106 -37
  114. package/dist-types/ts3.4/commands/UpdateInAppTemplateCommand.d.ts +162 -38
  115. package/dist-types/ts3.4/commands/UpdateJourneyCommand.d.ts +844 -37
  116. package/dist-types/ts3.4/commands/UpdateJourneyStateCommand.d.ts +471 -38
  117. package/dist-types/ts3.4/commands/UpdatePushTemplateCommand.d.ts +152 -38
  118. package/dist-types/ts3.4/commands/UpdateRecommenderConfigurationCommand.d.ts +118 -41
  119. package/dist-types/ts3.4/commands/UpdateSegmentCommand.d.ts +379 -37
  120. package/dist-types/ts3.4/commands/UpdateSmsChannelCommand.d.ts +110 -37
  121. package/dist-types/ts3.4/commands/UpdateSmsTemplateCommand.d.ts +104 -38
  122. package/dist-types/ts3.4/commands/UpdateTemplateActiveVersionCommand.d.ts +97 -41
  123. package/dist-types/ts3.4/commands/UpdateVoiceChannelCommand.d.ts +104 -38
  124. package/dist-types/ts3.4/commands/UpdateVoiceTemplateCommand.d.ts +105 -38
  125. package/dist-types/ts3.4/commands/VerifyOTPMessageCommand.d.ts +97 -37
  126. package/dist-types/ts3.4/commands/index.d.ts +122 -122
  127. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +20 -32
  128. package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +5 -8
  129. package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -2
  130. package/dist-types/ts3.4/index.d.ts +5 -5
  131. package/dist-types/ts3.4/models/PinpointServiceException.d.ts +12 -7
  132. package/dist-types/ts3.4/models/index.d.ts +2 -2
  133. package/dist-types/ts3.4/models/models_0.d.ts +6383 -1896
  134. package/dist-types/ts3.4/models/models_1.d.ts +2807 -915
  135. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +1100 -1469
  136. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +42 -94
  137. package/dist-types/ts3.4/runtimeConfig.d.ts +42 -91
  138. package/dist-types/ts3.4/runtimeConfig.native.d.ts +41 -85
  139. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +18 -18
  140. package/package.json +2 -2
@@ -1,38 +1,99 @@
1
- import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
- import { Command as $Command } from "@aws-sdk/smithy-client";
3
- import {
4
- Handler,
5
- HttpHandlerOptions as __HttpHandlerOptions,
6
- MetadataBearer as __MetadataBearer,
7
- MiddlewareStack,
8
- } from "@aws-sdk/types";
9
- import {
10
- CreateEmailTemplateRequest,
11
- CreateEmailTemplateResponse,
12
- } from "../models/models_0";
13
- import {
14
- PinpointClientResolvedConfig,
15
- ServiceInputTypes,
16
- ServiceOutputTypes,
17
- } from "../PinpointClient";
18
- export interface CreateEmailTemplateCommandInput
19
- extends CreateEmailTemplateRequest {}
20
- export interface CreateEmailTemplateCommandOutput
21
- extends CreateEmailTemplateResponse,
22
- __MetadataBearer {}
23
- export declare class CreateEmailTemplateCommand extends $Command<
24
- CreateEmailTemplateCommandInput,
25
- CreateEmailTemplateCommandOutput,
26
- PinpointClientResolvedConfig
27
- > {
28
- readonly input: CreateEmailTemplateCommandInput;
29
- static getEndpointParameterInstructions(): EndpointParameterInstructions;
30
- constructor(input: CreateEmailTemplateCommandInput);
31
- resolveMiddleware(
32
- clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
33
- configuration: PinpointClientResolvedConfig,
34
- options?: __HttpHandlerOptions
35
- ): Handler<CreateEmailTemplateCommandInput, CreateEmailTemplateCommandOutput>;
36
- private serialize;
37
- private deserialize;
38
- }
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { CreateEmailTemplateRequest, CreateEmailTemplateResponse } from "../models/models_0";
5
+ import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
6
+ /**
7
+ * @public
8
+ *
9
+ * The input for {@link CreateEmailTemplateCommand}.
10
+ */
11
+ export interface CreateEmailTemplateCommandInput extends CreateEmailTemplateRequest {
12
+ }
13
+ /**
14
+ * @public
15
+ *
16
+ * The output of {@link CreateEmailTemplateCommand}.
17
+ */
18
+ export interface CreateEmailTemplateCommandOutput extends CreateEmailTemplateResponse, __MetadataBearer {
19
+ }
20
+ /**
21
+ * @public
22
+ * <p>Creates a message template for messages that are sent through the email channel.</p>
23
+ * @example
24
+ * Use a bare-bones client and the command you need to make an API call.
25
+ * ```javascript
26
+ * import { PinpointClient, CreateEmailTemplateCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
27
+ * // const { PinpointClient, CreateEmailTemplateCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
28
+ * const client = new PinpointClient(config);
29
+ * const input = { // CreateEmailTemplateRequest
30
+ * EmailTemplateRequest: { // EmailTemplateRequest
31
+ * DefaultSubstitutions: "STRING_VALUE",
32
+ * HtmlPart: "STRING_VALUE",
33
+ * RecommenderId: "STRING_VALUE",
34
+ * Subject: "STRING_VALUE",
35
+ * tags: { // MapOf__string
36
+ * "<keys>": "STRING_VALUE",
37
+ * },
38
+ * TemplateDescription: "STRING_VALUE",
39
+ * TextPart: "STRING_VALUE",
40
+ * },
41
+ * TemplateName: "STRING_VALUE", // required
42
+ * };
43
+ * const command = new CreateEmailTemplateCommand(input);
44
+ * const response = await client.send(command);
45
+ * // { // CreateEmailTemplateResponse
46
+ * // CreateTemplateMessageBody: { // CreateTemplateMessageBody
47
+ * // Arn: "STRING_VALUE",
48
+ * // Message: "STRING_VALUE",
49
+ * // RequestID: "STRING_VALUE",
50
+ * // },
51
+ * // };
52
+ *
53
+ * ```
54
+ *
55
+ * @param CreateEmailTemplateCommandInput - {@link CreateEmailTemplateCommandInput}
56
+ * @returns {@link CreateEmailTemplateCommandOutput}
57
+ * @see {@link CreateEmailTemplateCommandInput} for command's `input` shape.
58
+ * @see {@link CreateEmailTemplateCommandOutput} for command's `response` shape.
59
+ * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
60
+ *
61
+ * @throws {@link BadRequestException} (client fault)
62
+ * <p>Provides information about an API request or response.</p>
63
+ *
64
+ * @throws {@link ForbiddenException} (client fault)
65
+ * <p>Provides information about an API request or response.</p>
66
+ *
67
+ * @throws {@link InternalServerErrorException} (server fault)
68
+ * <p>Provides information about an API request or response.</p>
69
+ *
70
+ * @throws {@link MethodNotAllowedException} (client fault)
71
+ * <p>Provides information about an API request or response.</p>
72
+ *
73
+ * @throws {@link TooManyRequestsException} (client fault)
74
+ * <p>Provides information about an API request or response.</p>
75
+ *
76
+ * @throws {@link PinpointServiceException}
77
+ * <p>Base exception class for all service exceptions from Pinpoint service.</p>
78
+ *
79
+ */
80
+ export declare class CreateEmailTemplateCommand extends $Command<CreateEmailTemplateCommandInput, CreateEmailTemplateCommandOutput, PinpointClientResolvedConfig> {
81
+ readonly input: CreateEmailTemplateCommandInput;
82
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
83
+ /**
84
+ * @public
85
+ */
86
+ constructor(input: CreateEmailTemplateCommandInput);
87
+ /**
88
+ * @internal
89
+ */
90
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateEmailTemplateCommandInput, CreateEmailTemplateCommandOutput>;
91
+ /**
92
+ * @internal
93
+ */
94
+ private serialize;
95
+ /**
96
+ * @internal
97
+ */
98
+ private deserialize;
99
+ }
@@ -1,37 +1,117 @@
1
- import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
- import { Command as $Command } from "@aws-sdk/smithy-client";
3
- import {
4
- Handler,
5
- HttpHandlerOptions as __HttpHandlerOptions,
6
- MetadataBearer as __MetadataBearer,
7
- MiddlewareStack,
8
- } from "@aws-sdk/types";
9
- import {
10
- CreateExportJobRequest,
11
- CreateExportJobResponse,
12
- } from "../models/models_0";
13
- import {
14
- PinpointClientResolvedConfig,
15
- ServiceInputTypes,
16
- ServiceOutputTypes,
17
- } from "../PinpointClient";
18
- export interface CreateExportJobCommandInput extends CreateExportJobRequest {}
19
- export interface CreateExportJobCommandOutput
20
- extends CreateExportJobResponse,
21
- __MetadataBearer {}
22
- export declare class CreateExportJobCommand extends $Command<
23
- CreateExportJobCommandInput,
24
- CreateExportJobCommandOutput,
25
- PinpointClientResolvedConfig
26
- > {
27
- readonly input: CreateExportJobCommandInput;
28
- static getEndpointParameterInstructions(): EndpointParameterInstructions;
29
- constructor(input: CreateExportJobCommandInput);
30
- resolveMiddleware(
31
- clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
32
- configuration: PinpointClientResolvedConfig,
33
- options?: __HttpHandlerOptions
34
- ): Handler<CreateExportJobCommandInput, CreateExportJobCommandOutput>;
35
- private serialize;
36
- private deserialize;
37
- }
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { CreateExportJobRequest, CreateExportJobResponse } from "../models/models_0";
5
+ import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
6
+ /**
7
+ * @public
8
+ *
9
+ * The input for {@link CreateExportJobCommand}.
10
+ */
11
+ export interface CreateExportJobCommandInput extends CreateExportJobRequest {
12
+ }
13
+ /**
14
+ * @public
15
+ *
16
+ * The output of {@link CreateExportJobCommand}.
17
+ */
18
+ export interface CreateExportJobCommandOutput extends CreateExportJobResponse, __MetadataBearer {
19
+ }
20
+ /**
21
+ * @public
22
+ * <p>Creates an export job for an application.</p>
23
+ * @example
24
+ * Use a bare-bones client and the command you need to make an API call.
25
+ * ```javascript
26
+ * import { PinpointClient, CreateExportJobCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
27
+ * // const { PinpointClient, CreateExportJobCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
28
+ * const client = new PinpointClient(config);
29
+ * const input = { // CreateExportJobRequest
30
+ * ApplicationId: "STRING_VALUE", // required
31
+ * ExportJobRequest: { // ExportJobRequest
32
+ * RoleArn: "STRING_VALUE", // required
33
+ * S3UrlPrefix: "STRING_VALUE", // required
34
+ * SegmentId: "STRING_VALUE",
35
+ * SegmentVersion: Number("int"),
36
+ * },
37
+ * };
38
+ * const command = new CreateExportJobCommand(input);
39
+ * const response = await client.send(command);
40
+ * // { // CreateExportJobResponse
41
+ * // ExportJobResponse: { // ExportJobResponse
42
+ * // ApplicationId: "STRING_VALUE", // required
43
+ * // CompletedPieces: Number("int"),
44
+ * // CompletionDate: "STRING_VALUE",
45
+ * // CreationDate: "STRING_VALUE", // required
46
+ * // Definition: { // ExportJobResource
47
+ * // RoleArn: "STRING_VALUE", // required
48
+ * // S3UrlPrefix: "STRING_VALUE", // required
49
+ * // SegmentId: "STRING_VALUE",
50
+ * // SegmentVersion: Number("int"),
51
+ * // },
52
+ * // FailedPieces: Number("int"),
53
+ * // Failures: [ // ListOf__string
54
+ * // "STRING_VALUE",
55
+ * // ],
56
+ * // Id: "STRING_VALUE", // required
57
+ * // JobStatus: "CREATED" || "PREPARING_FOR_INITIALIZATION" || "INITIALIZING" || "PROCESSING" || "PENDING_JOB" || "COMPLETING" || "COMPLETED" || "FAILING" || "FAILED", // required
58
+ * // TotalFailures: Number("int"),
59
+ * // TotalPieces: Number("int"),
60
+ * // TotalProcessed: Number("int"),
61
+ * // Type: "STRING_VALUE", // required
62
+ * // },
63
+ * // };
64
+ *
65
+ * ```
66
+ *
67
+ * @param CreateExportJobCommandInput - {@link CreateExportJobCommandInput}
68
+ * @returns {@link CreateExportJobCommandOutput}
69
+ * @see {@link CreateExportJobCommandInput} for command's `input` shape.
70
+ * @see {@link CreateExportJobCommandOutput} for command's `response` shape.
71
+ * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
72
+ *
73
+ * @throws {@link BadRequestException} (client fault)
74
+ * <p>Provides information about an API request or response.</p>
75
+ *
76
+ * @throws {@link ForbiddenException} (client fault)
77
+ * <p>Provides information about an API request or response.</p>
78
+ *
79
+ * @throws {@link InternalServerErrorException} (server fault)
80
+ * <p>Provides information about an API request or response.</p>
81
+ *
82
+ * @throws {@link MethodNotAllowedException} (client fault)
83
+ * <p>Provides information about an API request or response.</p>
84
+ *
85
+ * @throws {@link NotFoundException} (client fault)
86
+ * <p>Provides information about an API request or response.</p>
87
+ *
88
+ * @throws {@link PayloadTooLargeException} (client fault)
89
+ * <p>Provides information about an API request or response.</p>
90
+ *
91
+ * @throws {@link TooManyRequestsException} (client fault)
92
+ * <p>Provides information about an API request or response.</p>
93
+ *
94
+ * @throws {@link PinpointServiceException}
95
+ * <p>Base exception class for all service exceptions from Pinpoint service.</p>
96
+ *
97
+ */
98
+ export declare class CreateExportJobCommand extends $Command<CreateExportJobCommandInput, CreateExportJobCommandOutput, PinpointClientResolvedConfig> {
99
+ readonly input: CreateExportJobCommandInput;
100
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
101
+ /**
102
+ * @public
103
+ */
104
+ constructor(input: CreateExportJobCommandInput);
105
+ /**
106
+ * @internal
107
+ */
108
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateExportJobCommandInput, CreateExportJobCommandOutput>;
109
+ /**
110
+ * @internal
111
+ */
112
+ private serialize;
113
+ /**
114
+ * @internal
115
+ */
116
+ private deserialize;
117
+ }
@@ -1,37 +1,125 @@
1
- import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
- import { Command as $Command } from "@aws-sdk/smithy-client";
3
- import {
4
- Handler,
5
- HttpHandlerOptions as __HttpHandlerOptions,
6
- MetadataBearer as __MetadataBearer,
7
- MiddlewareStack,
8
- } from "@aws-sdk/types";
9
- import {
10
- CreateImportJobRequest,
11
- CreateImportJobResponse,
12
- } from "../models/models_0";
13
- import {
14
- PinpointClientResolvedConfig,
15
- ServiceInputTypes,
16
- ServiceOutputTypes,
17
- } from "../PinpointClient";
18
- export interface CreateImportJobCommandInput extends CreateImportJobRequest {}
19
- export interface CreateImportJobCommandOutput
20
- extends CreateImportJobResponse,
21
- __MetadataBearer {}
22
- export declare class CreateImportJobCommand extends $Command<
23
- CreateImportJobCommandInput,
24
- CreateImportJobCommandOutput,
25
- PinpointClientResolvedConfig
26
- > {
27
- readonly input: CreateImportJobCommandInput;
28
- static getEndpointParameterInstructions(): EndpointParameterInstructions;
29
- constructor(input: CreateImportJobCommandInput);
30
- resolveMiddleware(
31
- clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
32
- configuration: PinpointClientResolvedConfig,
33
- options?: __HttpHandlerOptions
34
- ): Handler<CreateImportJobCommandInput, CreateImportJobCommandOutput>;
35
- private serialize;
36
- private deserialize;
37
- }
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { CreateImportJobRequest, CreateImportJobResponse } from "../models/models_0";
5
+ import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
6
+ /**
7
+ * @public
8
+ *
9
+ * The input for {@link CreateImportJobCommand}.
10
+ */
11
+ export interface CreateImportJobCommandInput extends CreateImportJobRequest {
12
+ }
13
+ /**
14
+ * @public
15
+ *
16
+ * The output of {@link CreateImportJobCommand}.
17
+ */
18
+ export interface CreateImportJobCommandOutput extends CreateImportJobResponse, __MetadataBearer {
19
+ }
20
+ /**
21
+ * @public
22
+ * <p>Creates an import job for an application.</p>
23
+ * @example
24
+ * Use a bare-bones client and the command you need to make an API call.
25
+ * ```javascript
26
+ * import { PinpointClient, CreateImportJobCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
27
+ * // const { PinpointClient, CreateImportJobCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
28
+ * const client = new PinpointClient(config);
29
+ * const input = { // CreateImportJobRequest
30
+ * ApplicationId: "STRING_VALUE", // required
31
+ * ImportJobRequest: { // ImportJobRequest
32
+ * DefineSegment: true || false,
33
+ * ExternalId: "STRING_VALUE",
34
+ * Format: "CSV" || "JSON", // required
35
+ * RegisterEndpoints: true || false,
36
+ * RoleArn: "STRING_VALUE", // required
37
+ * S3Url: "STRING_VALUE", // required
38
+ * SegmentId: "STRING_VALUE",
39
+ * SegmentName: "STRING_VALUE",
40
+ * },
41
+ * };
42
+ * const command = new CreateImportJobCommand(input);
43
+ * const response = await client.send(command);
44
+ * // { // CreateImportJobResponse
45
+ * // ImportJobResponse: { // ImportJobResponse
46
+ * // ApplicationId: "STRING_VALUE", // required
47
+ * // CompletedPieces: Number("int"),
48
+ * // CompletionDate: "STRING_VALUE",
49
+ * // CreationDate: "STRING_VALUE", // required
50
+ * // Definition: { // ImportJobResource
51
+ * // DefineSegment: true || false,
52
+ * // ExternalId: "STRING_VALUE",
53
+ * // Format: "CSV" || "JSON", // required
54
+ * // RegisterEndpoints: true || false,
55
+ * // RoleArn: "STRING_VALUE", // required
56
+ * // S3Url: "STRING_VALUE", // required
57
+ * // SegmentId: "STRING_VALUE",
58
+ * // SegmentName: "STRING_VALUE",
59
+ * // },
60
+ * // FailedPieces: Number("int"),
61
+ * // Failures: [ // ListOf__string
62
+ * // "STRING_VALUE",
63
+ * // ],
64
+ * // Id: "STRING_VALUE", // required
65
+ * // JobStatus: "CREATED" || "PREPARING_FOR_INITIALIZATION" || "INITIALIZING" || "PROCESSING" || "PENDING_JOB" || "COMPLETING" || "COMPLETED" || "FAILING" || "FAILED", // required
66
+ * // TotalFailures: Number("int"),
67
+ * // TotalPieces: Number("int"),
68
+ * // TotalProcessed: Number("int"),
69
+ * // Type: "STRING_VALUE", // required
70
+ * // },
71
+ * // };
72
+ *
73
+ * ```
74
+ *
75
+ * @param CreateImportJobCommandInput - {@link CreateImportJobCommandInput}
76
+ * @returns {@link CreateImportJobCommandOutput}
77
+ * @see {@link CreateImportJobCommandInput} for command's `input` shape.
78
+ * @see {@link CreateImportJobCommandOutput} for command's `response` shape.
79
+ * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
80
+ *
81
+ * @throws {@link BadRequestException} (client fault)
82
+ * <p>Provides information about an API request or response.</p>
83
+ *
84
+ * @throws {@link ForbiddenException} (client fault)
85
+ * <p>Provides information about an API request or response.</p>
86
+ *
87
+ * @throws {@link InternalServerErrorException} (server fault)
88
+ * <p>Provides information about an API request or response.</p>
89
+ *
90
+ * @throws {@link MethodNotAllowedException} (client fault)
91
+ * <p>Provides information about an API request or response.</p>
92
+ *
93
+ * @throws {@link NotFoundException} (client fault)
94
+ * <p>Provides information about an API request or response.</p>
95
+ *
96
+ * @throws {@link PayloadTooLargeException} (client fault)
97
+ * <p>Provides information about an API request or response.</p>
98
+ *
99
+ * @throws {@link TooManyRequestsException} (client fault)
100
+ * <p>Provides information about an API request or response.</p>
101
+ *
102
+ * @throws {@link PinpointServiceException}
103
+ * <p>Base exception class for all service exceptions from Pinpoint service.</p>
104
+ *
105
+ */
106
+ export declare class CreateImportJobCommand extends $Command<CreateImportJobCommandInput, CreateImportJobCommandOutput, PinpointClientResolvedConfig> {
107
+ readonly input: CreateImportJobCommandInput;
108
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
109
+ /**
110
+ * @public
111
+ */
112
+ constructor(input: CreateImportJobCommandInput);
113
+ /**
114
+ * @internal
115
+ */
116
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateImportJobCommandInput, CreateImportJobCommandOutput>;
117
+ /**
118
+ * @internal
119
+ */
120
+ private serialize;
121
+ /**
122
+ * @internal
123
+ */
124
+ private deserialize;
125
+ }
@@ -1,38 +1,155 @@
1
- import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
- import { Command as $Command } from "@aws-sdk/smithy-client";
3
- import {
4
- Handler,
5
- HttpHandlerOptions as __HttpHandlerOptions,
6
- MetadataBearer as __MetadataBearer,
7
- MiddlewareStack,
8
- } from "@aws-sdk/types";
9
- import {
10
- CreateInAppTemplateRequest,
11
- CreateInAppTemplateResponse,
12
- } from "../models/models_0";
13
- import {
14
- PinpointClientResolvedConfig,
15
- ServiceInputTypes,
16
- ServiceOutputTypes,
17
- } from "../PinpointClient";
18
- export interface CreateInAppTemplateCommandInput
19
- extends CreateInAppTemplateRequest {}
20
- export interface CreateInAppTemplateCommandOutput
21
- extends CreateInAppTemplateResponse,
22
- __MetadataBearer {}
23
- export declare class CreateInAppTemplateCommand extends $Command<
24
- CreateInAppTemplateCommandInput,
25
- CreateInAppTemplateCommandOutput,
26
- PinpointClientResolvedConfig
27
- > {
28
- readonly input: CreateInAppTemplateCommandInput;
29
- static getEndpointParameterInstructions(): EndpointParameterInstructions;
30
- constructor(input: CreateInAppTemplateCommandInput);
31
- resolveMiddleware(
32
- clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
33
- configuration: PinpointClientResolvedConfig,
34
- options?: __HttpHandlerOptions
35
- ): Handler<CreateInAppTemplateCommandInput, CreateInAppTemplateCommandOutput>;
36
- private serialize;
37
- private deserialize;
38
- }
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { CreateInAppTemplateRequest, CreateInAppTemplateResponse } from "../models/models_0";
5
+ import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
6
+ /**
7
+ * @public
8
+ *
9
+ * The input for {@link CreateInAppTemplateCommand}.
10
+ */
11
+ export interface CreateInAppTemplateCommandInput extends CreateInAppTemplateRequest {
12
+ }
13
+ /**
14
+ * @public
15
+ *
16
+ * The output of {@link CreateInAppTemplateCommand}.
17
+ */
18
+ export interface CreateInAppTemplateCommandOutput extends CreateInAppTemplateResponse, __MetadataBearer {
19
+ }
20
+ /**
21
+ * @public
22
+ * <p>Creates a new message template for messages using the in-app message channel.</p>
23
+ * @example
24
+ * Use a bare-bones client and the command you need to make an API call.
25
+ * ```javascript
26
+ * import { PinpointClient, CreateInAppTemplateCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
27
+ * // const { PinpointClient, CreateInAppTemplateCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
28
+ * const client = new PinpointClient(config);
29
+ * const input = { // CreateInAppTemplateRequest
30
+ * InAppTemplateRequest: { // InAppTemplateRequest
31
+ * Content: [ // ListOfInAppMessageContent
32
+ * { // InAppMessageContent
33
+ * BackgroundColor: "STRING_VALUE",
34
+ * BodyConfig: { // InAppMessageBodyConfig
35
+ * Alignment: "LEFT" || "CENTER" || "RIGHT", // required
36
+ * Body: "STRING_VALUE", // required
37
+ * TextColor: "STRING_VALUE", // required
38
+ * },
39
+ * HeaderConfig: { // InAppMessageHeaderConfig
40
+ * Alignment: "LEFT" || "CENTER" || "RIGHT", // required
41
+ * Header: "STRING_VALUE", // required
42
+ * TextColor: "STRING_VALUE", // required
43
+ * },
44
+ * ImageUrl: "STRING_VALUE",
45
+ * PrimaryBtn: { // InAppMessageButton
46
+ * Android: { // OverrideButtonConfiguration
47
+ * ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
48
+ * Link: "STRING_VALUE",
49
+ * },
50
+ * DefaultConfig: { // DefaultButtonConfiguration
51
+ * BackgroundColor: "STRING_VALUE",
52
+ * BorderRadius: Number("int"),
53
+ * ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
54
+ * Link: "STRING_VALUE",
55
+ * Text: "STRING_VALUE", // required
56
+ * TextColor: "STRING_VALUE",
57
+ * },
58
+ * IOS: {
59
+ * ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
60
+ * Link: "STRING_VALUE",
61
+ * },
62
+ * Web: {
63
+ * ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
64
+ * Link: "STRING_VALUE",
65
+ * },
66
+ * },
67
+ * SecondaryBtn: {
68
+ * Android: {
69
+ * ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
70
+ * Link: "STRING_VALUE",
71
+ * },
72
+ * DefaultConfig: {
73
+ * BackgroundColor: "STRING_VALUE",
74
+ * BorderRadius: Number("int"),
75
+ * ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
76
+ * Link: "STRING_VALUE",
77
+ * Text: "STRING_VALUE", // required
78
+ * TextColor: "STRING_VALUE",
79
+ * },
80
+ * IOS: {
81
+ * ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
82
+ * Link: "STRING_VALUE",
83
+ * },
84
+ * Web: "<OverrideButtonConfiguration>",
85
+ * },
86
+ * },
87
+ * ],
88
+ * CustomConfig: { // MapOf__string
89
+ * "<keys>": "STRING_VALUE",
90
+ * },
91
+ * Layout: "BOTTOM_BANNER" || "TOP_BANNER" || "OVERLAYS" || "MOBILE_FEED" || "MIDDLE_BANNER" || "CAROUSEL",
92
+ * tags: {
93
+ * "<keys>": "STRING_VALUE",
94
+ * },
95
+ * TemplateDescription: "STRING_VALUE",
96
+ * },
97
+ * TemplateName: "STRING_VALUE", // required
98
+ * };
99
+ * const command = new CreateInAppTemplateCommand(input);
100
+ * const response = await client.send(command);
101
+ * // { // CreateInAppTemplateResponse
102
+ * // TemplateCreateMessageBody: { // TemplateCreateMessageBody
103
+ * // Arn: "STRING_VALUE",
104
+ * // Message: "STRING_VALUE",
105
+ * // RequestID: "STRING_VALUE",
106
+ * // },
107
+ * // };
108
+ *
109
+ * ```
110
+ *
111
+ * @param CreateInAppTemplateCommandInput - {@link CreateInAppTemplateCommandInput}
112
+ * @returns {@link CreateInAppTemplateCommandOutput}
113
+ * @see {@link CreateInAppTemplateCommandInput} for command's `input` shape.
114
+ * @see {@link CreateInAppTemplateCommandOutput} for command's `response` shape.
115
+ * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
116
+ *
117
+ * @throws {@link BadRequestException} (client fault)
118
+ * <p>Provides information about an API request or response.</p>
119
+ *
120
+ * @throws {@link ForbiddenException} (client fault)
121
+ * <p>Provides information about an API request or response.</p>
122
+ *
123
+ * @throws {@link InternalServerErrorException} (server fault)
124
+ * <p>Provides information about an API request or response.</p>
125
+ *
126
+ * @throws {@link MethodNotAllowedException} (client fault)
127
+ * <p>Provides information about an API request or response.</p>
128
+ *
129
+ * @throws {@link TooManyRequestsException} (client fault)
130
+ * <p>Provides information about an API request or response.</p>
131
+ *
132
+ * @throws {@link PinpointServiceException}
133
+ * <p>Base exception class for all service exceptions from Pinpoint service.</p>
134
+ *
135
+ */
136
+ export declare class CreateInAppTemplateCommand extends $Command<CreateInAppTemplateCommandInput, CreateInAppTemplateCommandOutput, PinpointClientResolvedConfig> {
137
+ readonly input: CreateInAppTemplateCommandInput;
138
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
139
+ /**
140
+ * @public
141
+ */
142
+ constructor(input: CreateInAppTemplateCommandInput);
143
+ /**
144
+ * @internal
145
+ */
146
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateInAppTemplateCommandInput, CreateInAppTemplateCommandOutput>;
147
+ /**
148
+ * @internal
149
+ */
150
+ private serialize;
151
+ /**
152
+ * @internal
153
+ */
154
+ private deserialize;
155
+ }