Skip to content

Commit b323af2

Browse files
author
AWS
committed
Amazon Pinpoint Update: Added a One-Time Password (OTP) management feature. You can use the Amazon Pinpoint API to generate OTP codes and send them to your users as SMS messages. Your apps can then call the API to verify the OTP codes that your users input
1 parent badf1c8 commit b323af2

File tree

2 files changed

+250
-0
lines changed

2 files changed

+250
-0
lines changed

‎.changes/next-release/feature-AmazonPinpoint-9e3ad4d.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon Pinpoint",
4+
"contributor": "",
5+
"description": "Added a One-Time Password (OTP) management feature. You can use the Amazon Pinpoint API to generate OTP codes and send them to your users as SMS messages. Your apps can then call the API to verify the OTP codes that your users input"
6+
}

‎services/pinpoint/src/main/resources/codegen-resources/service-2.json

Lines changed: 244 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4075,6 +4075,52 @@
40754075
],
40764076
"documentation": "<p>Creates and sends a direct message.</p>"
40774077
},
4078+
"SendOTPMessage": {
4079+
"name": "SendOTPMessage",
4080+
"http": {
4081+
"method": "POST",
4082+
"requestUri": "/v1/apps/{application-id}/otp",
4083+
"responseCode": 200
4084+
},
4085+
"input": {
4086+
"shape": "SendOTPMessageRequest"
4087+
},
4088+
"output": {
4089+
"shape": "SendOTPMessageResponse",
4090+
"documentation": "<p>200 response</p>"
4091+
},
4092+
"errors": [
4093+
{
4094+
"shape": "BadRequestException",
4095+
"documentation": "<p>400 response</p>"
4096+
},
4097+
{
4098+
"shape": "InternalServerErrorException",
4099+
"documentation": "<p>500 response</p>"
4100+
},
4101+
{
4102+
"shape": "PayloadTooLargeException",
4103+
"documentation": "<p>413 response</p>"
4104+
},
4105+
{
4106+
"shape": "ForbiddenException",
4107+
"documentation": "<p>403 response</p>"
4108+
},
4109+
{
4110+
"shape": "NotFoundException",
4111+
"documentation": "<p>404 response</p>"
4112+
},
4113+
{
4114+
"shape": "MethodNotAllowedException",
4115+
"documentation": "<p>405 response</p>"
4116+
},
4117+
{
4118+
"shape": "TooManyRequestsException",
4119+
"documentation": "<p>429 response</p>"
4120+
}
4121+
],
4122+
"documentation": "<p>Send an OTP message</p>"
4123+
},
40784124
"SendUsersMessages": {
40794125
"name": "SendUsersMessages",
40804126
"http": {
@@ -5254,6 +5300,52 @@
52545300
}
52555301
],
52565302
"documentation": "<p>Updates an existing message template for messages that are sent through the voice channel.</p>"
5303+
},
5304+
"VerifyOTPMessage": {
5305+
"name": "VerifyOTPMessage",
5306+
"http": {
5307+
"method": "POST",
5308+
"requestUri": "/v1/apps/{application-id}/verify-otp",
5309+
"responseCode": 200
5310+
},
5311+
"input": {
5312+
"shape": "VerifyOTPMessageRequest"
5313+
},
5314+
"output": {
5315+
"shape": "VerifyOTPMessageResponse",
5316+
"documentation": "<p>200 response</p>"
5317+
},
5318+
"errors": [
5319+
{
5320+
"shape": "BadRequestException",
5321+
"documentation": "<p>400 response</p>"
5322+
},
5323+
{
5324+
"shape": "InternalServerErrorException",
5325+
"documentation": "<p>500 response</p>"
5326+
},
5327+
{
5328+
"shape": "PayloadTooLargeException",
5329+
"documentation": "<p>413 response</p>"
5330+
},
5331+
{
5332+
"shape": "ForbiddenException",
5333+
"documentation": "<p>403 response</p>"
5334+
},
5335+
{
5336+
"shape": "NotFoundException",
5337+
"documentation": "<p>404 response</p>"
5338+
},
5339+
{
5340+
"shape": "MethodNotAllowedException",
5341+
"documentation": "<p>405 response</p>"
5342+
},
5343+
{
5344+
"shape": "TooManyRequestsException",
5345+
"documentation": "<p>429 response</p>"
5346+
}
5347+
],
5348+
"documentation": "<p>Verify an OTP</p>"
52575349
}
52585350
},
52595351
"shapes": {
@@ -13521,6 +13613,94 @@
1352113613
],
1352213614
"payload": "MessageResponse"
1352313615
},
13616+
"SendOTPMessageRequest": {
13617+
"type": "structure",
13618+
"members": {
13619+
"ApplicationId": {
13620+
"shape": "__string",
13621+
"location": "uri",
13622+
"locationName": "application-id",
13623+
"documentation": "<p>The unique ID of your Amazon Pinpoint application.</p>"
13624+
},
13625+
"SendOTPMessageRequestParameters": {
13626+
"shape": "SendOTPMessageRequestParameters"
13627+
}
13628+
},
13629+
"required": [
13630+
"ApplicationId",
13631+
"SendOTPMessageRequestParameters"
13632+
],
13633+
"payload": "SendOTPMessageRequestParameters"
13634+
},
13635+
"SendOTPMessageRequestParameters": {
13636+
"type": "structure",
13637+
"members": {
13638+
"AllowedAttempts": {
13639+
"shape": "__integer",
13640+
"documentation": "<p>The attempts allowed to validate an OTP.</p>"
13641+
},
13642+
"BrandName": {
13643+
"shape": "__string",
13644+
"documentation": "<p>The brand name that will be substituted into the OTP message body. Should be owned by calling AWS account.</p>"
13645+
},
13646+
"Channel": {
13647+
"shape": "__string",
13648+
"documentation": "<p>Channel type for the OTP message. Supported values: [SMS].</p>"
13649+
},
13650+
"CodeLength": {
13651+
"shape": "__integer",
13652+
"documentation": "<p>The number of characters in the generated OTP.</p>"
13653+
},
13654+
"DestinationIdentity": {
13655+
"shape": "__string",
13656+
"documentation": "<p>The destination identity to send OTP to.</p>"
13657+
},
13658+
"EntityId": {
13659+
"shape": "__string",
13660+
"documentation": "<p>A unique Entity ID received from DLT after entity registration is approved.</p>"
13661+
},
13662+
"Language": {
13663+
"shape": "__string",
13664+
"documentation": "<p>The language to be used for the outgoing message body containing the OTP.</p>"
13665+
},
13666+
"OriginationIdentity": {
13667+
"shape": "__string",
13668+
"documentation": "<p>The origination identity used to send OTP from.</p>"
13669+
},
13670+
"ReferenceId": {
13671+
"shape": "__string",
13672+
"documentation": "<p>Developer-specified reference identifier. Required to match during OTP verification.</p>"
13673+
},
13674+
"TemplateId": {
13675+
"shape": "__string",
13676+
"documentation": "<p>A unique Template ID received from DLT after entity registration is approved.</p>"
13677+
},
13678+
"ValidityPeriod": {
13679+
"shape": "__integer",
13680+
"documentation": "<p>The time in minutes before the OTP is no longer valid.</p>"
13681+
}
13682+
},
13683+
"documentation": "<p>Send OTP message request parameters.</p>",
13684+
"required": [
13685+
"BrandName",
13686+
"ReferenceId",
13687+
"Channel",
13688+
"DestinationIdentity",
13689+
"OriginationIdentity"
13690+
]
13691+
},
13692+
"SendOTPMessageResponse": {
13693+
"type": "structure",
13694+
"members": {
13695+
"MessageResponse": {
13696+
"shape": "MessageResponse"
13697+
}
13698+
},
13699+
"required": [
13700+
"MessageResponse"
13701+
],
13702+
"payload": "MessageResponse"
13703+
},
1352413704
"SendUsersMessageRequest": {
1352513705
"type": "structure",
1352613706
"members": {
@@ -14966,6 +15146,70 @@
1496615146
],
1496715147
"payload": "MessageBody"
1496815148
},
15149+
"VerificationResponse": {
15150+
"type": "structure",
15151+
"members": {
15152+
"Valid": {
15153+
"shape": "__boolean",
15154+
"documentation": "<p>Specifies whether the OTP is valid or not.</p>"
15155+
}
15156+
},
15157+
"documentation": "<p>Verify OTP Message Response.</p>"
15158+
},
15159+
"VerifyOTPMessageRequest": {
15160+
"type": "structure",
15161+
"members": {
15162+
"ApplicationId": {
15163+
"shape": "__string",
15164+
"location": "uri",
15165+
"locationName": "application-id",
15166+
"documentation": "<p>The unique ID of your Amazon Pinpoint application.</p>"
15167+
},
15168+
"VerifyOTPMessageRequestParameters": {
15169+
"shape": "VerifyOTPMessageRequestParameters"
15170+
}
15171+
},
15172+
"required": [
15173+
"ApplicationId",
15174+
"VerifyOTPMessageRequestParameters"
15175+
],
15176+
"payload": "VerifyOTPMessageRequestParameters"
15177+
},
15178+
"VerifyOTPMessageRequestParameters": {
15179+
"type": "structure",
15180+
"members": {
15181+
"DestinationIdentity": {
15182+
"shape": "__string",
15183+
"documentation": "<p>The destination identity to send OTP to.</p>"
15184+
},
15185+
"Otp": {
15186+
"shape": "__string",
15187+
"documentation": "<p>The OTP the end user provided for verification.</p>"
15188+
},
15189+
"ReferenceId": {
15190+
"shape": "__string",
15191+
"documentation": "<p>The reference identifier provided when the OTP was previously sent.</p>"
15192+
}
15193+
},
15194+
"documentation": "<p>Verify OTP message request.</p>",
15195+
"required": [
15196+
"ReferenceId",
15197+
"Otp",
15198+
"DestinationIdentity"
15199+
]
15200+
},
15201+
"VerifyOTPMessageResponse": {
15202+
"type": "structure",
15203+
"members": {
15204+
"VerificationResponse": {
15205+
"shape": "VerificationResponse"
15206+
}
15207+
},
15208+
"required": [
15209+
"VerificationResponse"
15210+
],
15211+
"payload": "VerificationResponse"
15212+
},
1496915213
"VoiceChannelRequest": {
1497015214
"type": "structure",
1497115215
"members": {

0 commit comments

Comments
 (0)