cdk-lambda-subminute 2.0.300 → 2.0.302
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.
- package/.jsii +3 -3
- package/lib/cdk-lambda-subminute.js +3 -3
- package/node_modules/aws-sdk/CHANGELOG.md +52 -1
- package/node_modules/aws-sdk/README.md +1 -1
- package/node_modules/aws-sdk/apis/athena-2017-05-18.min.json +6 -0
- package/node_modules/aws-sdk/apis/cloud9-2017-09-23.examples.json +1 -0
- package/node_modules/aws-sdk/apis/cloudformation-2010-05-15.min.json +90 -81
- package/node_modules/aws-sdk/apis/codecatalyst-2022-09-28.min.json +8 -4
- package/node_modules/aws-sdk/apis/codepipeline-2015-07-09.min.json +16 -0
- package/node_modules/aws-sdk/apis/codestar-connections-2019-12-01.min.json +590 -3
- package/node_modules/aws-sdk/apis/codestar-connections-2019-12-01.paginators.json +10 -0
- package/node_modules/aws-sdk/apis/dlm-2018-01-12.min.json +108 -15
- package/node_modules/aws-sdk/apis/ec2-2016-11-15.min.json +1864 -1397
- package/node_modules/aws-sdk/apis/ecr-2015-09-21.min.json +100 -40
- package/node_modules/aws-sdk/apis/elasticmapreduce-2009-03-31.min.json +91 -78
- package/node_modules/aws-sdk/apis/fsx-2018-03-01.min.json +3 -0
- package/node_modules/aws-sdk/apis/glue-2017-03-31.min.json +259 -101
- package/node_modules/aws-sdk/apis/glue-2017-03-31.paginators.json +10 -0
- package/node_modules/aws-sdk/apis/imagebuilder-2019-12-02.min.json +724 -151
- package/node_modules/aws-sdk/apis/imagebuilder-2019-12-02.paginators.json +18 -0
- package/node_modules/aws-sdk/apis/internetmonitor-2021-06-03.min.json +172 -0
- package/node_modules/aws-sdk/apis/internetmonitor-2021-06-03.paginators.json +5 -0
- package/node_modules/aws-sdk/apis/iot-2015-05-28.min.json +60 -50
- package/node_modules/aws-sdk/apis/ivs-realtime-2020-07-14.min.json +578 -33
- package/node_modules/aws-sdk/apis/ivs-realtime-2020-07-14.paginators.json +15 -0
- package/node_modules/aws-sdk/apis/ivschat-2020-07-14.min.json +16 -4
- package/node_modules/aws-sdk/apis/kafka-2018-11-14.min.json +32 -26
- package/node_modules/aws-sdk/apis/lambda-2015-03-31.min.json +69 -51
- package/node_modules/aws-sdk/apis/macie2-2020-01-01.min.json +52 -12
- package/node_modules/aws-sdk/apis/medialive-2017-10-14.min.json +379 -301
- package/node_modules/aws-sdk/apis/metadata.json +3 -3
- package/node_modules/aws-sdk/apis/osis-2022-01-01.min.json +66 -12
- package/node_modules/aws-sdk/apis/pinpoint-sms-voice-v2-2022-03-31.min.json +1426 -59
- package/node_modules/aws-sdk/apis/pinpoint-sms-voice-v2-2022-03-31.paginators.json +54 -0
- package/node_modules/aws-sdk/apis/quicksight-2018-04-01.min.json +909 -335
- package/node_modules/aws-sdk/apis/quicksight-2018-04-01.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/rds-2014-10-31.min.json +233 -217
- package/node_modules/aws-sdk/apis/redshift-2012-12-01.min.json +250 -91
- package/node_modules/aws-sdk/apis/redshift-2012-12-01.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/redshift-serverless-2021-04-21.min.json +39 -38
- package/node_modules/aws-sdk/apis/s3-2006-03-01.examples.json +126 -126
- package/node_modules/aws-sdk/apis/sagemaker-2017-07-24.min.json +977 -974
- package/node_modules/aws-sdk/apis/ssm-2014-11-06.min.json +161 -146
- package/node_modules/aws-sdk/apis/ssm-incidents-2018-05-10.min.json +201 -52
- package/node_modules/aws-sdk/apis/ssm-incidents-2018-05-10.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/sso-admin-2020-07-20.min.json +1121 -73
- package/node_modules/aws-sdk/apis/sso-admin-2020-07-20.paginators.json +52 -0
- package/node_modules/aws-sdk/apis/sso-oidc-2019-06-10.examples.json +228 -0
- package/node_modules/aws-sdk/apis/sso-oidc-2019-06-10.min.json +94 -8
- package/node_modules/aws-sdk/apis/transfer-2018-11-05.min.json +121 -105
- package/node_modules/aws-sdk/apis/trustedadvisor-2022-09-15.min.json +794 -0
- package/node_modules/aws-sdk/apis/trustedadvisor-2022-09-15.paginators.json +40 -0
- package/node_modules/aws-sdk/apis/verifiedpermissions-2021-12-01.min.json +269 -199
- package/node_modules/aws-sdk/apis/wisdom-2020-10-19.min.json +790 -27
- package/node_modules/aws-sdk/apis/wisdom-2020-10-19.paginators.json +18 -0
- package/node_modules/aws-sdk/clients/all.d.ts +1 -1
- package/node_modules/aws-sdk/clients/all.js +2 -2
- package/node_modules/aws-sdk/clients/appmesh.d.ts +2 -2
- package/node_modules/aws-sdk/clients/athena.d.ts +27 -19
- package/node_modules/aws-sdk/clients/cloud9.d.ts +1 -1
- package/node_modules/aws-sdk/clients/cloudformation.d.ts +14 -1
- package/node_modules/aws-sdk/clients/codecatalyst.d.ts +16 -0
- package/node_modules/aws-sdk/clients/codepipeline.d.ts +22 -2
- package/node_modules/aws-sdk/clients/codestarconnections.d.ts +727 -0
- package/node_modules/aws-sdk/clients/connect.d.ts +2 -2
- package/node_modules/aws-sdk/clients/dlm.d.ts +153 -25
- package/node_modules/aws-sdk/clients/ec2.d.ts +582 -23
- package/node_modules/aws-sdk/clients/ecr.d.ts +128 -7
- package/node_modules/aws-sdk/clients/emr.d.ts +80 -43
- package/node_modules/aws-sdk/clients/eventbridge.d.ts +40 -37
- package/node_modules/aws-sdk/clients/fsx.d.ts +7 -3
- package/node_modules/aws-sdk/clients/glue.d.ts +228 -0
- package/node_modules/aws-sdk/clients/imagebuilder.d.ts +776 -60
- package/node_modules/aws-sdk/clients/internetmonitor.d.ts +157 -4
- package/node_modules/aws-sdk/clients/iot.d.ts +23 -6
- package/node_modules/aws-sdk/clients/ivsrealtime.d.ts +593 -6
- package/node_modules/aws-sdk/clients/kafka.d.ts +13 -0
- package/node_modules/aws-sdk/clients/kinesisvideo.d.ts +8 -8
- package/node_modules/aws-sdk/clients/lambda.d.ts +39 -5
- package/node_modules/aws-sdk/clients/macie2.d.ts +54 -16
- package/node_modules/aws-sdk/clients/medialive.d.ts +121 -47
- package/node_modules/aws-sdk/clients/mediapackage.d.ts +2 -2
- package/node_modules/aws-sdk/clients/osis.d.ts +55 -0
- package/node_modules/aws-sdk/clients/pinpointsmsvoicev2.d.ts +1860 -96
- package/node_modules/aws-sdk/clients/polly.d.ts +9 -9
- package/node_modules/aws-sdk/clients/quicksight.d.ts +537 -20
- package/node_modules/aws-sdk/clients/rds.d.ts +31 -4
- package/node_modules/aws-sdk/clients/redshift.d.ts +207 -0
- package/node_modules/aws-sdk/clients/redshiftserverless.d.ts +5 -0
- package/node_modules/aws-sdk/clients/s3.d.ts +2 -2
- package/node_modules/aws-sdk/clients/sagemaker.d.ts +12 -2
- package/node_modules/aws-sdk/clients/ssm.d.ts +38 -8
- package/node_modules/aws-sdk/clients/ssmincidents.d.ts +191 -40
- package/node_modules/aws-sdk/clients/ssoadmin.d.ts +1529 -128
- package/node_modules/aws-sdk/clients/ssooidc.d.ts +99 -16
- package/node_modules/aws-sdk/clients/sts.d.ts +3 -3
- package/node_modules/aws-sdk/clients/transfer.d.ts +25 -1
- package/node_modules/aws-sdk/clients/trustedadvisor.d.ts +918 -0
- package/node_modules/aws-sdk/clients/trustedadvisor.js +18 -0
- package/node_modules/aws-sdk/clients/verifiedpermissions.d.ts +67 -1
- package/node_modules/aws-sdk/clients/wisdom.d.ts +849 -25
- package/node_modules/aws-sdk/dist/aws-sdk-core-react-native.js +2 -2
- package/node_modules/aws-sdk/dist/aws-sdk-react-native.js +1444 -1444
- package/node_modules/aws-sdk/dist/aws-sdk.js +2953 -2158
- package/node_modules/aws-sdk/dist/aws-sdk.min.js +101 -101
- package/node_modules/aws-sdk/lib/config_service_placeholders.d.ts +2 -2
- package/node_modules/aws-sdk/lib/core.js +1 -1
- package/node_modules/aws-sdk/lib/dynamodb/document_client.d.ts +1 -1
- package/node_modules/aws-sdk/lib/dynamodb/document_client.js +1 -1
- package/node_modules/aws-sdk/package.json +1 -1
- package/package.json +5 -5
- package/node_modules/aws-sdk/apis/macie-2017-12-19.min.json +0 -222
- package/node_modules/aws-sdk/apis/macie-2017-12-19.paginators.json +0 -14
- package/node_modules/aws-sdk/clients/macie.d.ts +0 -284
- package/node_modules/aws-sdk/clients/macie.js +0 -18
- /package/node_modules/aws-sdk/apis/{macie-2017-12-19.examples.json → trustedadvisor-2022-09-15.examples.json} +0 -0
@@ -12,11 +12,11 @@ declare class PinpointSMSVoiceV2 extends Service {
|
|
12
12
|
constructor(options?: PinpointSMSVoiceV2.Types.ClientConfiguration)
|
13
13
|
config: Config & PinpointSMSVoiceV2.Types.ClientConfiguration;
|
14
14
|
/**
|
15
|
-
* Associates the specified origination identity with a pool. If the origination identity is a phone number and is already associated with another pool, an
|
15
|
+
* Associates the specified origination identity with a pool. If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools. If the origination identity configuration doesn't match the pool's configuration, an error is returned.
|
16
16
|
*/
|
17
17
|
associateOriginationIdentity(params: PinpointSMSVoiceV2.Types.AssociateOriginationIdentityRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.AssociateOriginationIdentityResult) => void): Request<PinpointSMSVoiceV2.Types.AssociateOriginationIdentityResult, AWSError>;
|
18
18
|
/**
|
19
|
-
* Associates the specified origination identity with a pool. If the origination identity is a phone number and is already associated with another pool, an
|
19
|
+
* Associates the specified origination identity with a pool. If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools. If the origination identity configuration doesn't match the pool's configuration, an error is returned.
|
20
20
|
*/
|
21
21
|
associateOriginationIdentity(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.AssociateOriginationIdentityResult) => void): Request<PinpointSMSVoiceV2.Types.AssociateOriginationIdentityResult, AWSError>;
|
22
22
|
/**
|
@@ -36,21 +36,61 @@ declare class PinpointSMSVoiceV2 extends Service {
|
|
36
36
|
*/
|
37
37
|
createEventDestination(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.CreateEventDestinationResult) => void): Request<PinpointSMSVoiceV2.Types.CreateEventDestinationResult, AWSError>;
|
38
38
|
/**
|
39
|
-
* Creates a new opt-out list. If the opt-out list name already exists, an
|
39
|
+
* Creates a new opt-out list. If the opt-out list name already exists, an error is returned. An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the Amazon Pinpoint User Guide.
|
40
40
|
*/
|
41
41
|
createOptOutList(params: PinpointSMSVoiceV2.Types.CreateOptOutListRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.CreateOptOutListResult) => void): Request<PinpointSMSVoiceV2.Types.CreateOptOutListResult, AWSError>;
|
42
42
|
/**
|
43
|
-
* Creates a new opt-out list. If the opt-out list name already exists, an
|
43
|
+
* Creates a new opt-out list. If the opt-out list name already exists, an error is returned. An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the Amazon Pinpoint User Guide.
|
44
44
|
*/
|
45
45
|
createOptOutList(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.CreateOptOutListResult) => void): Request<PinpointSMSVoiceV2.Types.CreateOptOutListResult, AWSError>;
|
46
46
|
/**
|
47
|
-
* Creates a new pool and associates the specified origination identity to the pool. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account. The new pool inherits its configuration from the specified origination identity. This includes keywords, message type, opt-out list, two-way configuration, and self-managed opt-out configuration. Deletion protection isn't inherited from the origination identity and defaults to false. If the origination identity is a phone number and is already associated with another pool, an
|
47
|
+
* Creates a new pool and associates the specified origination identity to the pool. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account. The new pool inherits its configuration from the specified origination identity. This includes keywords, message type, opt-out list, two-way configuration, and self-managed opt-out configuration. Deletion protection isn't inherited from the origination identity and defaults to false. If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.
|
48
48
|
*/
|
49
49
|
createPool(params: PinpointSMSVoiceV2.Types.CreatePoolRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.CreatePoolResult) => void): Request<PinpointSMSVoiceV2.Types.CreatePoolResult, AWSError>;
|
50
50
|
/**
|
51
|
-
* Creates a new pool and associates the specified origination identity to the pool. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account. The new pool inherits its configuration from the specified origination identity. This includes keywords, message type, opt-out list, two-way configuration, and self-managed opt-out configuration. Deletion protection isn't inherited from the origination identity and defaults to false. If the origination identity is a phone number and is already associated with another pool, an
|
51
|
+
* Creates a new pool and associates the specified origination identity to the pool. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account. The new pool inherits its configuration from the specified origination identity. This includes keywords, message type, opt-out list, two-way configuration, and self-managed opt-out configuration. Deletion protection isn't inherited from the origination identity and defaults to false. If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.
|
52
52
|
*/
|
53
53
|
createPool(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.CreatePoolResult) => void): Request<PinpointSMSVoiceV2.Types.CreatePoolResult, AWSError>;
|
54
|
+
/**
|
55
|
+
* Creates a new registration based on the RegistrationType field.
|
56
|
+
*/
|
57
|
+
createRegistration(params: PinpointSMSVoiceV2.Types.CreateRegistrationRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.CreateRegistrationResult) => void): Request<PinpointSMSVoiceV2.Types.CreateRegistrationResult, AWSError>;
|
58
|
+
/**
|
59
|
+
* Creates a new registration based on the RegistrationType field.
|
60
|
+
*/
|
61
|
+
createRegistration(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.CreateRegistrationResult) => void): Request<PinpointSMSVoiceV2.Types.CreateRegistrationResult, AWSError>;
|
62
|
+
/**
|
63
|
+
* Associate the registration with an origination identity such as a phone number or sender ID.
|
64
|
+
*/
|
65
|
+
createRegistrationAssociation(params: PinpointSMSVoiceV2.Types.CreateRegistrationAssociationRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.CreateRegistrationAssociationResult) => void): Request<PinpointSMSVoiceV2.Types.CreateRegistrationAssociationResult, AWSError>;
|
66
|
+
/**
|
67
|
+
* Associate the registration with an origination identity such as a phone number or sender ID.
|
68
|
+
*/
|
69
|
+
createRegistrationAssociation(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.CreateRegistrationAssociationResult) => void): Request<PinpointSMSVoiceV2.Types.CreateRegistrationAssociationResult, AWSError>;
|
70
|
+
/**
|
71
|
+
* Create a new registration attachment to use for uploading a file or a URL to a file. The maximum file size is 1MiB and valid file extensions are PDF, JPEG and PNG. For example, many sender ID registrations require a signed “letter of authorization” (LOA) to be submitted.
|
72
|
+
*/
|
73
|
+
createRegistrationAttachment(params: PinpointSMSVoiceV2.Types.CreateRegistrationAttachmentRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.CreateRegistrationAttachmentResult) => void): Request<PinpointSMSVoiceV2.Types.CreateRegistrationAttachmentResult, AWSError>;
|
74
|
+
/**
|
75
|
+
* Create a new registration attachment to use for uploading a file or a URL to a file. The maximum file size is 1MiB and valid file extensions are PDF, JPEG and PNG. For example, many sender ID registrations require a signed “letter of authorization” (LOA) to be submitted.
|
76
|
+
*/
|
77
|
+
createRegistrationAttachment(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.CreateRegistrationAttachmentResult) => void): Request<PinpointSMSVoiceV2.Types.CreateRegistrationAttachmentResult, AWSError>;
|
78
|
+
/**
|
79
|
+
* Create a new version of the registration and increase the VersionNumber. The previous version of the registration becomes read-only.
|
80
|
+
*/
|
81
|
+
createRegistrationVersion(params: PinpointSMSVoiceV2.Types.CreateRegistrationVersionRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.CreateRegistrationVersionResult) => void): Request<PinpointSMSVoiceV2.Types.CreateRegistrationVersionResult, AWSError>;
|
82
|
+
/**
|
83
|
+
* Create a new version of the registration and increase the VersionNumber. The previous version of the registration becomes read-only.
|
84
|
+
*/
|
85
|
+
createRegistrationVersion(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.CreateRegistrationVersionResult) => void): Request<PinpointSMSVoiceV2.Types.CreateRegistrationVersionResult, AWSError>;
|
86
|
+
/**
|
87
|
+
* You can only send messages to verified destination numbers when your account is in the sandbox. You can add up to 10 verified destination numbers.
|
88
|
+
*/
|
89
|
+
createVerifiedDestinationNumber(params: PinpointSMSVoiceV2.Types.CreateVerifiedDestinationNumberRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.CreateVerifiedDestinationNumberResult) => void): Request<PinpointSMSVoiceV2.Types.CreateVerifiedDestinationNumberResult, AWSError>;
|
90
|
+
/**
|
91
|
+
* You can only send messages to verified destination numbers when your account is in the sandbox. You can add up to 10 verified destination numbers.
|
92
|
+
*/
|
93
|
+
createVerifiedDestinationNumber(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.CreateVerifiedDestinationNumberResult) => void): Request<PinpointSMSVoiceV2.Types.CreateVerifiedDestinationNumberResult, AWSError>;
|
54
94
|
/**
|
55
95
|
* Deletes an existing configuration set. A configuration set is a set of rules that you apply to voice and SMS messages that you send. In a configuration set, you can specify a destination for specific types of events related to voice and SMS messages.
|
56
96
|
*/
|
@@ -92,29 +132,53 @@ declare class PinpointSMSVoiceV2 extends Service {
|
|
92
132
|
*/
|
93
133
|
deleteKeyword(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteKeywordResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteKeywordResult, AWSError>;
|
94
134
|
/**
|
95
|
-
* Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are deleted. If the specified opt-out list name doesn't exist or is in-use by an origination phone number or pool, an
|
135
|
+
* Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are deleted. If the specified opt-out list name doesn't exist or is in-use by an origination phone number or pool, an error is returned.
|
96
136
|
*/
|
97
137
|
deleteOptOutList(params: PinpointSMSVoiceV2.Types.DeleteOptOutListRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteOptOutListResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteOptOutListResult, AWSError>;
|
98
138
|
/**
|
99
|
-
* Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are deleted. If the specified opt-out list name doesn't exist or is in-use by an origination phone number or pool, an
|
139
|
+
* Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are deleted. If the specified opt-out list name doesn't exist or is in-use by an origination phone number or pool, an error is returned.
|
100
140
|
*/
|
101
141
|
deleteOptOutList(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteOptOutListResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteOptOutListResult, AWSError>;
|
102
142
|
/**
|
103
|
-
* Deletes an existing opted out destination phone number from the specified opt-out list. Each destination phone number can only be deleted once every 30 days. If the specified destination phone number doesn't exist or if the opt-out list doesn't exist, an
|
143
|
+
* Deletes an existing opted out destination phone number from the specified opt-out list. Each destination phone number can only be deleted once every 30 days. If the specified destination phone number doesn't exist or if the opt-out list doesn't exist, an error is returned.
|
104
144
|
*/
|
105
145
|
deleteOptedOutNumber(params: PinpointSMSVoiceV2.Types.DeleteOptedOutNumberRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteOptedOutNumberResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteOptedOutNumberResult, AWSError>;
|
106
146
|
/**
|
107
|
-
* Deletes an existing opted out destination phone number from the specified opt-out list. Each destination phone number can only be deleted once every 30 days. If the specified destination phone number doesn't exist or if the opt-out list doesn't exist, an
|
147
|
+
* Deletes an existing opted out destination phone number from the specified opt-out list. Each destination phone number can only be deleted once every 30 days. If the specified destination phone number doesn't exist or if the opt-out list doesn't exist, an error is returned.
|
108
148
|
*/
|
109
149
|
deleteOptedOutNumber(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteOptedOutNumberResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteOptedOutNumberResult, AWSError>;
|
110
150
|
/**
|
111
|
-
* Deletes an existing pool. Deleting a pool disassociates all origination identities from that pool. If the pool status isn't active or if deletion protection is enabled, an
|
151
|
+
* Deletes an existing pool. Deleting a pool disassociates all origination identities from that pool. If the pool status isn't active or if deletion protection is enabled, an error is returned. A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
|
112
152
|
*/
|
113
153
|
deletePool(params: PinpointSMSVoiceV2.Types.DeletePoolRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeletePoolResult) => void): Request<PinpointSMSVoiceV2.Types.DeletePoolResult, AWSError>;
|
114
154
|
/**
|
115
|
-
* Deletes an existing pool. Deleting a pool disassociates all origination identities from that pool. If the pool status isn't active or if deletion protection is enabled, an
|
155
|
+
* Deletes an existing pool. Deleting a pool disassociates all origination identities from that pool. If the pool status isn't active or if deletion protection is enabled, an error is returned. A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
|
116
156
|
*/
|
117
157
|
deletePool(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeletePoolResult) => void): Request<PinpointSMSVoiceV2.Types.DeletePoolResult, AWSError>;
|
158
|
+
/**
|
159
|
+
* Permanently delete an existing registration from your account.
|
160
|
+
*/
|
161
|
+
deleteRegistration(params: PinpointSMSVoiceV2.Types.DeleteRegistrationRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteRegistrationResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteRegistrationResult, AWSError>;
|
162
|
+
/**
|
163
|
+
* Permanently delete an existing registration from your account.
|
164
|
+
*/
|
165
|
+
deleteRegistration(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteRegistrationResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteRegistrationResult, AWSError>;
|
166
|
+
/**
|
167
|
+
* Permanently delete the specified registration attachment.
|
168
|
+
*/
|
169
|
+
deleteRegistrationAttachment(params: PinpointSMSVoiceV2.Types.DeleteRegistrationAttachmentRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteRegistrationAttachmentResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteRegistrationAttachmentResult, AWSError>;
|
170
|
+
/**
|
171
|
+
* Permanently delete the specified registration attachment.
|
172
|
+
*/
|
173
|
+
deleteRegistrationAttachment(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteRegistrationAttachmentResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteRegistrationAttachmentResult, AWSError>;
|
174
|
+
/**
|
175
|
+
* Delete the value in a registration form field.
|
176
|
+
*/
|
177
|
+
deleteRegistrationFieldValue(params: PinpointSMSVoiceV2.Types.DeleteRegistrationFieldValueRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteRegistrationFieldValueResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteRegistrationFieldValueResult, AWSError>;
|
178
|
+
/**
|
179
|
+
* Delete the value in a registration form field.
|
180
|
+
*/
|
181
|
+
deleteRegistrationFieldValue(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteRegistrationFieldValueResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteRegistrationFieldValueResult, AWSError>;
|
118
182
|
/**
|
119
183
|
* Deletes an account-level monthly spending limit override for sending text messages. Deleting a spend limit override will set the EnforcedLimit to equal the MaxLimit, which is controlled by Amazon Web Services. For more information on spend limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
|
120
184
|
*/
|
@@ -123,6 +187,14 @@ declare class PinpointSMSVoiceV2 extends Service {
|
|
123
187
|
* Deletes an account-level monthly spending limit override for sending text messages. Deleting a spend limit override will set the EnforcedLimit to equal the MaxLimit, which is controlled by Amazon Web Services. For more information on spend limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
|
124
188
|
*/
|
125
189
|
deleteTextMessageSpendLimitOverride(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteTextMessageSpendLimitOverrideResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteTextMessageSpendLimitOverrideResult, AWSError>;
|
190
|
+
/**
|
191
|
+
* Delete a verified destination phone number.
|
192
|
+
*/
|
193
|
+
deleteVerifiedDestinationNumber(params: PinpointSMSVoiceV2.Types.DeleteVerifiedDestinationNumberRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteVerifiedDestinationNumberResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteVerifiedDestinationNumberResult, AWSError>;
|
194
|
+
/**
|
195
|
+
* Delete a verified destination phone number.
|
196
|
+
*/
|
197
|
+
deleteVerifiedDestinationNumber(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteVerifiedDestinationNumberResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteVerifiedDestinationNumberResult, AWSError>;
|
126
198
|
/**
|
127
199
|
* Deletes an account level monthly spend limit override for sending voice messages. Deleting a spend limit override sets the EnforcedLimit equal to the MaxLimit, which is controlled by Amazon Web Services. For more information on spending limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
|
128
200
|
*/
|
@@ -156,51 +228,107 @@ declare class PinpointSMSVoiceV2 extends Service {
|
|
156
228
|
*/
|
157
229
|
describeConfigurationSets(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeConfigurationSetsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeConfigurationSetsResult, AWSError>;
|
158
230
|
/**
|
159
|
-
* Describes the specified keywords or all keywords on your origination phone number or pool. A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message. If you specify a keyword that isn't valid, an
|
231
|
+
* Describes the specified keywords or all keywords on your origination phone number or pool. A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message. If you specify a keyword that isn't valid, an error is returned.
|
160
232
|
*/
|
161
233
|
describeKeywords(params: PinpointSMSVoiceV2.Types.DescribeKeywordsRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeKeywordsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeKeywordsResult, AWSError>;
|
162
234
|
/**
|
163
|
-
* Describes the specified keywords or all keywords on your origination phone number or pool. A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message. If you specify a keyword that isn't valid, an
|
235
|
+
* Describes the specified keywords or all keywords on your origination phone number or pool. A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message. If you specify a keyword that isn't valid, an error is returned.
|
164
236
|
*/
|
165
237
|
describeKeywords(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeKeywordsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeKeywordsResult, AWSError>;
|
166
238
|
/**
|
167
|
-
* Describes the specified opt-out list or all opt-out lists in your account. If you specify opt-out list names, the output includes information for only the specified opt-out lists. Opt-out lists include only those that meet the filter criteria. If you don't specify opt-out list names or filters, the output includes information for all opt-out lists. If you specify an opt-out list name that isn't valid, an
|
239
|
+
* Describes the specified opt-out list or all opt-out lists in your account. If you specify opt-out list names, the output includes information for only the specified opt-out lists. Opt-out lists include only those that meet the filter criteria. If you don't specify opt-out list names or filters, the output includes information for all opt-out lists. If you specify an opt-out list name that isn't valid, an error is returned.
|
168
240
|
*/
|
169
241
|
describeOptOutLists(params: PinpointSMSVoiceV2.Types.DescribeOptOutListsRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeOptOutListsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeOptOutListsResult, AWSError>;
|
170
242
|
/**
|
171
|
-
* Describes the specified opt-out list or all opt-out lists in your account. If you specify opt-out list names, the output includes information for only the specified opt-out lists. Opt-out lists include only those that meet the filter criteria. If you don't specify opt-out list names or filters, the output includes information for all opt-out lists. If you specify an opt-out list name that isn't valid, an
|
243
|
+
* Describes the specified opt-out list or all opt-out lists in your account. If you specify opt-out list names, the output includes information for only the specified opt-out lists. Opt-out lists include only those that meet the filter criteria. If you don't specify opt-out list names or filters, the output includes information for all opt-out lists. If you specify an opt-out list name that isn't valid, an error is returned.
|
172
244
|
*/
|
173
245
|
describeOptOutLists(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeOptOutListsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeOptOutListsResult, AWSError>;
|
174
246
|
/**
|
175
|
-
* Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list. If you specify opted out numbers, the output includes information for only the specified opted out numbers. If you specify filters, the output includes information for only those opted out numbers that meet the filter criteria. If you don't specify opted out numbers or filters, the output includes information for all opted out destination numbers in your opt-out list. If you specify an opted out number that isn't valid, an
|
247
|
+
* Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list. If you specify opted out numbers, the output includes information for only the specified opted out numbers. If you specify filters, the output includes information for only those opted out numbers that meet the filter criteria. If you don't specify opted out numbers or filters, the output includes information for all opted out destination numbers in your opt-out list. If you specify an opted out number that isn't valid, an error is returned.
|
176
248
|
*/
|
177
249
|
describeOptedOutNumbers(params: PinpointSMSVoiceV2.Types.DescribeOptedOutNumbersRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeOptedOutNumbersResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeOptedOutNumbersResult, AWSError>;
|
178
250
|
/**
|
179
|
-
* Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list. If you specify opted out numbers, the output includes information for only the specified opted out numbers. If you specify filters, the output includes information for only those opted out numbers that meet the filter criteria. If you don't specify opted out numbers or filters, the output includes information for all opted out destination numbers in your opt-out list. If you specify an opted out number that isn't valid, an
|
251
|
+
* Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list. If you specify opted out numbers, the output includes information for only the specified opted out numbers. If you specify filters, the output includes information for only those opted out numbers that meet the filter criteria. If you don't specify opted out numbers or filters, the output includes information for all opted out destination numbers in your opt-out list. If you specify an opted out number that isn't valid, an error is returned.
|
180
252
|
*/
|
181
253
|
describeOptedOutNumbers(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeOptedOutNumbersResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeOptedOutNumbersResult, AWSError>;
|
182
254
|
/**
|
183
|
-
* Describes the specified origination phone number, or all the phone numbers in your account. If you specify phone number IDs, the output includes information for only the specified phone numbers. If you specify filters, the output includes information for only those phone numbers that meet the filter criteria. If you don't specify phone number IDs or filters, the output includes information for all phone numbers. If you specify a phone number ID that isn't valid, an
|
255
|
+
* Describes the specified origination phone number, or all the phone numbers in your account. If you specify phone number IDs, the output includes information for only the specified phone numbers. If you specify filters, the output includes information for only those phone numbers that meet the filter criteria. If you don't specify phone number IDs or filters, the output includes information for all phone numbers. If you specify a phone number ID that isn't valid, an error is returned.
|
184
256
|
*/
|
185
257
|
describePhoneNumbers(params: PinpointSMSVoiceV2.Types.DescribePhoneNumbersRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribePhoneNumbersResult) => void): Request<PinpointSMSVoiceV2.Types.DescribePhoneNumbersResult, AWSError>;
|
186
258
|
/**
|
187
|
-
* Describes the specified origination phone number, or all the phone numbers in your account. If you specify phone number IDs, the output includes information for only the specified phone numbers. If you specify filters, the output includes information for only those phone numbers that meet the filter criteria. If you don't specify phone number IDs or filters, the output includes information for all phone numbers. If you specify a phone number ID that isn't valid, an
|
259
|
+
* Describes the specified origination phone number, or all the phone numbers in your account. If you specify phone number IDs, the output includes information for only the specified phone numbers. If you specify filters, the output includes information for only those phone numbers that meet the filter criteria. If you don't specify phone number IDs or filters, the output includes information for all phone numbers. If you specify a phone number ID that isn't valid, an error is returned.
|
188
260
|
*/
|
189
261
|
describePhoneNumbers(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribePhoneNumbersResult) => void): Request<PinpointSMSVoiceV2.Types.DescribePhoneNumbersResult, AWSError>;
|
190
262
|
/**
|
191
|
-
* Retrieves the specified pools or all pools associated with your Amazon Web Services account. If you specify pool IDs, the output includes information for only the specified pools. If you specify filters, the output includes information for only those pools that meet the filter criteria. If you don't specify pool IDs or filters, the output includes information for all pools. If you specify a pool ID that isn't valid, an
|
263
|
+
* Retrieves the specified pools or all pools associated with your Amazon Web Services account. If you specify pool IDs, the output includes information for only the specified pools. If you specify filters, the output includes information for only those pools that meet the filter criteria. If you don't specify pool IDs or filters, the output includes information for all pools. If you specify a pool ID that isn't valid, an error is returned. A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
|
192
264
|
*/
|
193
265
|
describePools(params: PinpointSMSVoiceV2.Types.DescribePoolsRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribePoolsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribePoolsResult, AWSError>;
|
194
266
|
/**
|
195
|
-
* Retrieves the specified pools or all pools associated with your Amazon Web Services account. If you specify pool IDs, the output includes information for only the specified pools. If you specify filters, the output includes information for only those pools that meet the filter criteria. If you don't specify pool IDs or filters, the output includes information for all pools. If you specify a pool ID that isn't valid, an
|
267
|
+
* Retrieves the specified pools or all pools associated with your Amazon Web Services account. If you specify pool IDs, the output includes information for only the specified pools. If you specify filters, the output includes information for only those pools that meet the filter criteria. If you don't specify pool IDs or filters, the output includes information for all pools. If you specify a pool ID that isn't valid, an error is returned. A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
|
196
268
|
*/
|
197
269
|
describePools(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribePoolsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribePoolsResult, AWSError>;
|
198
270
|
/**
|
199
|
-
*
|
271
|
+
* Retrieves the specified registration attachments or all registration attachments associated with your Amazon Web Services account.
|
272
|
+
*/
|
273
|
+
describeRegistrationAttachments(params: PinpointSMSVoiceV2.Types.DescribeRegistrationAttachmentsRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeRegistrationAttachmentsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeRegistrationAttachmentsResult, AWSError>;
|
274
|
+
/**
|
275
|
+
* Retrieves the specified registration attachments or all registration attachments associated with your Amazon Web Services account.
|
276
|
+
*/
|
277
|
+
describeRegistrationAttachments(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeRegistrationAttachmentsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeRegistrationAttachmentsResult, AWSError>;
|
278
|
+
/**
|
279
|
+
* Retrieves the specified registration type field definitions. You can use DescribeRegistrationFieldDefinitions to view the requirements for creating, filling out, and submitting each registration type.
|
280
|
+
*/
|
281
|
+
describeRegistrationFieldDefinitions(params: PinpointSMSVoiceV2.Types.DescribeRegistrationFieldDefinitionsRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeRegistrationFieldDefinitionsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeRegistrationFieldDefinitionsResult, AWSError>;
|
282
|
+
/**
|
283
|
+
* Retrieves the specified registration type field definitions. You can use DescribeRegistrationFieldDefinitions to view the requirements for creating, filling out, and submitting each registration type.
|
284
|
+
*/
|
285
|
+
describeRegistrationFieldDefinitions(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeRegistrationFieldDefinitionsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeRegistrationFieldDefinitionsResult, AWSError>;
|
286
|
+
/**
|
287
|
+
* Retrieves the specified registration field values.
|
288
|
+
*/
|
289
|
+
describeRegistrationFieldValues(params: PinpointSMSVoiceV2.Types.DescribeRegistrationFieldValuesRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeRegistrationFieldValuesResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeRegistrationFieldValuesResult, AWSError>;
|
290
|
+
/**
|
291
|
+
* Retrieves the specified registration field values.
|
292
|
+
*/
|
293
|
+
describeRegistrationFieldValues(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeRegistrationFieldValuesResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeRegistrationFieldValuesResult, AWSError>;
|
294
|
+
/**
|
295
|
+
* Retrieves the specified registration section definitions. You can use DescribeRegistrationSectionDefinitions to view the requirements for creating, filling out, and submitting each registration type.
|
296
|
+
*/
|
297
|
+
describeRegistrationSectionDefinitions(params: PinpointSMSVoiceV2.Types.DescribeRegistrationSectionDefinitionsRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeRegistrationSectionDefinitionsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeRegistrationSectionDefinitionsResult, AWSError>;
|
298
|
+
/**
|
299
|
+
* Retrieves the specified registration section definitions. You can use DescribeRegistrationSectionDefinitions to view the requirements for creating, filling out, and submitting each registration type.
|
300
|
+
*/
|
301
|
+
describeRegistrationSectionDefinitions(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeRegistrationSectionDefinitionsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeRegistrationSectionDefinitionsResult, AWSError>;
|
302
|
+
/**
|
303
|
+
* Retrieves the specified registration type definitions. You can use DescribeRegistrationTypeDefinitions to view the requirements for creating, filling out, and submitting each registration type.
|
304
|
+
*/
|
305
|
+
describeRegistrationTypeDefinitions(params: PinpointSMSVoiceV2.Types.DescribeRegistrationTypeDefinitionsRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeRegistrationTypeDefinitionsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeRegistrationTypeDefinitionsResult, AWSError>;
|
306
|
+
/**
|
307
|
+
* Retrieves the specified registration type definitions. You can use DescribeRegistrationTypeDefinitions to view the requirements for creating, filling out, and submitting each registration type.
|
308
|
+
*/
|
309
|
+
describeRegistrationTypeDefinitions(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeRegistrationTypeDefinitionsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeRegistrationTypeDefinitionsResult, AWSError>;
|
310
|
+
/**
|
311
|
+
* Retrieves the specified registration version.
|
312
|
+
*/
|
313
|
+
describeRegistrationVersions(params: PinpointSMSVoiceV2.Types.DescribeRegistrationVersionsRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeRegistrationVersionsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeRegistrationVersionsResult, AWSError>;
|
314
|
+
/**
|
315
|
+
* Retrieves the specified registration version.
|
316
|
+
*/
|
317
|
+
describeRegistrationVersions(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeRegistrationVersionsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeRegistrationVersionsResult, AWSError>;
|
318
|
+
/**
|
319
|
+
* Retrieves the specified registrations.
|
320
|
+
*/
|
321
|
+
describeRegistrations(params: PinpointSMSVoiceV2.Types.DescribeRegistrationsRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeRegistrationsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeRegistrationsResult, AWSError>;
|
322
|
+
/**
|
323
|
+
* Retrieves the specified registrations.
|
324
|
+
*/
|
325
|
+
describeRegistrations(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeRegistrationsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeRegistrationsResult, AWSError>;
|
326
|
+
/**
|
327
|
+
* Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account. If you specify SenderIds, the output includes information for only the specified SenderIds. If you specify filters, the output includes information for only those SenderIds that meet the filter criteria. If you don't specify SenderIds or filters, the output includes information for all SenderIds. f you specify a sender ID that isn't valid, an error is returned.
|
200
328
|
*/
|
201
329
|
describeSenderIds(params: PinpointSMSVoiceV2.Types.DescribeSenderIdsRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeSenderIdsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeSenderIdsResult, AWSError>;
|
202
330
|
/**
|
203
|
-
* Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account. If you specify SenderIds, the output includes information for only the specified SenderIds. If you specify filters, the output includes information for only those SenderIds that meet the filter criteria. If you don't specify SenderIds or filters, the output includes information for all SenderIds. f you specify a sender ID that isn't valid, an
|
331
|
+
* Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account. If you specify SenderIds, the output includes information for only the specified SenderIds. If you specify filters, the output includes information for only those SenderIds that meet the filter criteria. If you don't specify SenderIds or filters, the output includes information for all SenderIds. f you specify a sender ID that isn't valid, an error is returned.
|
204
332
|
*/
|
205
333
|
describeSenderIds(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeSenderIdsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeSenderIdsResult, AWSError>;
|
206
334
|
/**
|
@@ -212,13 +340,29 @@ declare class PinpointSMSVoiceV2 extends Service {
|
|
212
340
|
*/
|
213
341
|
describeSpendLimits(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeSpendLimitsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeSpendLimitsResult, AWSError>;
|
214
342
|
/**
|
215
|
-
*
|
343
|
+
* Retrieves the specified verified destiona numbers.
|
344
|
+
*/
|
345
|
+
describeVerifiedDestinationNumbers(params: PinpointSMSVoiceV2.Types.DescribeVerifiedDestinationNumbersRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeVerifiedDestinationNumbersResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeVerifiedDestinationNumbersResult, AWSError>;
|
346
|
+
/**
|
347
|
+
* Retrieves the specified verified destiona numbers.
|
348
|
+
*/
|
349
|
+
describeVerifiedDestinationNumbers(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeVerifiedDestinationNumbersResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeVerifiedDestinationNumbersResult, AWSError>;
|
350
|
+
/**
|
351
|
+
* Removes the specified origination identity from an existing pool. If the origination identity isn't associated with the specified pool, an error is returned.
|
216
352
|
*/
|
217
353
|
disassociateOriginationIdentity(params: PinpointSMSVoiceV2.Types.DisassociateOriginationIdentityRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DisassociateOriginationIdentityResult) => void): Request<PinpointSMSVoiceV2.Types.DisassociateOriginationIdentityResult, AWSError>;
|
218
354
|
/**
|
219
|
-
* Removes the specified origination identity from an existing pool. If the origination identity isn't associated with the specified pool, an
|
355
|
+
* Removes the specified origination identity from an existing pool. If the origination identity isn't associated with the specified pool, an error is returned.
|
220
356
|
*/
|
221
357
|
disassociateOriginationIdentity(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DisassociateOriginationIdentityResult) => void): Request<PinpointSMSVoiceV2.Types.DisassociateOriginationIdentityResult, AWSError>;
|
358
|
+
/**
|
359
|
+
* Discard the current version of the registration.
|
360
|
+
*/
|
361
|
+
discardRegistrationVersion(params: PinpointSMSVoiceV2.Types.DiscardRegistrationVersionRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DiscardRegistrationVersionResult) => void): Request<PinpointSMSVoiceV2.Types.DiscardRegistrationVersionResult, AWSError>;
|
362
|
+
/**
|
363
|
+
* Discard the current version of the registration.
|
364
|
+
*/
|
365
|
+
discardRegistrationVersion(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DiscardRegistrationVersionResult) => void): Request<PinpointSMSVoiceV2.Types.DiscardRegistrationVersionResult, AWSError>;
|
222
366
|
/**
|
223
367
|
* Lists all associated origination identities in your pool. If you specify filters, the output includes information for only those origination identities that meet the filter criteria.
|
224
368
|
*/
|
@@ -227,6 +371,14 @@ declare class PinpointSMSVoiceV2 extends Service {
|
|
227
371
|
* Lists all associated origination identities in your pool. If you specify filters, the output includes information for only those origination identities that meet the filter criteria.
|
228
372
|
*/
|
229
373
|
listPoolOriginationIdentities(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.ListPoolOriginationIdentitiesResult) => void): Request<PinpointSMSVoiceV2.Types.ListPoolOriginationIdentitiesResult, AWSError>;
|
374
|
+
/**
|
375
|
+
* Retreive all of the origination identies that are associated with a registration.
|
376
|
+
*/
|
377
|
+
listRegistrationAssociations(params: PinpointSMSVoiceV2.Types.ListRegistrationAssociationsRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.ListRegistrationAssociationsResult) => void): Request<PinpointSMSVoiceV2.Types.ListRegistrationAssociationsResult, AWSError>;
|
378
|
+
/**
|
379
|
+
* Retreive all of the origination identies that are associated with a registration.
|
380
|
+
*/
|
381
|
+
listRegistrationAssociations(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.ListRegistrationAssociationsResult) => void): Request<PinpointSMSVoiceV2.Types.ListRegistrationAssociationsResult, AWSError>;
|
230
382
|
/**
|
231
383
|
* List all tags associated with a resource.
|
232
384
|
*/
|
@@ -236,29 +388,45 @@ declare class PinpointSMSVoiceV2 extends Service {
|
|
236
388
|
*/
|
237
389
|
listTagsForResource(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.ListTagsForResourceResult) => void): Request<PinpointSMSVoiceV2.Types.ListTagsForResourceResult, AWSError>;
|
238
390
|
/**
|
239
|
-
* Creates or updates a keyword configuration on an origination phone number or pool. A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message. If you specify a keyword that isn't valid, an
|
391
|
+
* Creates or updates a keyword configuration on an origination phone number or pool. A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message. If you specify a keyword that isn't valid, an error is returned.
|
240
392
|
*/
|
241
393
|
putKeyword(params: PinpointSMSVoiceV2.Types.PutKeywordRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.PutKeywordResult) => void): Request<PinpointSMSVoiceV2.Types.PutKeywordResult, AWSError>;
|
242
394
|
/**
|
243
|
-
* Creates or updates a keyword configuration on an origination phone number or pool. A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message. If you specify a keyword that isn't valid, an
|
395
|
+
* Creates or updates a keyword configuration on an origination phone number or pool. A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message. If you specify a keyword that isn't valid, an error is returned.
|
244
396
|
*/
|
245
397
|
putKeyword(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.PutKeywordResult) => void): Request<PinpointSMSVoiceV2.Types.PutKeywordResult, AWSError>;
|
246
398
|
/**
|
247
|
-
* Creates an opted out destination phone number in the opt-out list. If the destination phone number isn't valid or if the specified opt-out list doesn't exist, an
|
399
|
+
* Creates an opted out destination phone number in the opt-out list. If the destination phone number isn't valid or if the specified opt-out list doesn't exist, an error is returned.
|
248
400
|
*/
|
249
401
|
putOptedOutNumber(params: PinpointSMSVoiceV2.Types.PutOptedOutNumberRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.PutOptedOutNumberResult) => void): Request<PinpointSMSVoiceV2.Types.PutOptedOutNumberResult, AWSError>;
|
250
402
|
/**
|
251
|
-
* Creates an opted out destination phone number in the opt-out list. If the destination phone number isn't valid or if the specified opt-out list doesn't exist, an
|
403
|
+
* Creates an opted out destination phone number in the opt-out list. If the destination phone number isn't valid or if the specified opt-out list doesn't exist, an error is returned.
|
252
404
|
*/
|
253
405
|
putOptedOutNumber(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.PutOptedOutNumberResult) => void): Request<PinpointSMSVoiceV2.Types.PutOptedOutNumberResult, AWSError>;
|
254
406
|
/**
|
255
|
-
*
|
407
|
+
* Creates or updates a field value for a registration.
|
408
|
+
*/
|
409
|
+
putRegistrationFieldValue(params: PinpointSMSVoiceV2.Types.PutRegistrationFieldValueRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.PutRegistrationFieldValueResult) => void): Request<PinpointSMSVoiceV2.Types.PutRegistrationFieldValueResult, AWSError>;
|
410
|
+
/**
|
411
|
+
* Creates or updates a field value for a registration.
|
412
|
+
*/
|
413
|
+
putRegistrationFieldValue(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.PutRegistrationFieldValueResult) => void): Request<PinpointSMSVoiceV2.Types.PutRegistrationFieldValueResult, AWSError>;
|
414
|
+
/**
|
415
|
+
* Releases an existing origination phone number in your account. Once released, a phone number is no longer available for sending messages. If the origination phone number has deletion protection enabled or is associated with a pool, an error is returned.
|
256
416
|
*/
|
257
417
|
releasePhoneNumber(params: PinpointSMSVoiceV2.Types.ReleasePhoneNumberRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.ReleasePhoneNumberResult) => void): Request<PinpointSMSVoiceV2.Types.ReleasePhoneNumberResult, AWSError>;
|
258
418
|
/**
|
259
|
-
* Releases an existing origination phone number in your account. Once released, a phone number is no longer available for sending messages. If the origination phone number has deletion protection enabled or is associated with a pool, an
|
419
|
+
* Releases an existing origination phone number in your account. Once released, a phone number is no longer available for sending messages. If the origination phone number has deletion protection enabled or is associated with a pool, an error is returned.
|
260
420
|
*/
|
261
421
|
releasePhoneNumber(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.ReleasePhoneNumberResult) => void): Request<PinpointSMSVoiceV2.Types.ReleasePhoneNumberResult, AWSError>;
|
422
|
+
/**
|
423
|
+
* Releases an existing sender ID in your account.
|
424
|
+
*/
|
425
|
+
releaseSenderId(params: PinpointSMSVoiceV2.Types.ReleaseSenderIdRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.ReleaseSenderIdResult) => void): Request<PinpointSMSVoiceV2.Types.ReleaseSenderIdResult, AWSError>;
|
426
|
+
/**
|
427
|
+
* Releases an existing sender ID in your account.
|
428
|
+
*/
|
429
|
+
releaseSenderId(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.ReleaseSenderIdResult) => void): Request<PinpointSMSVoiceV2.Types.ReleaseSenderIdResult, AWSError>;
|
262
430
|
/**
|
263
431
|
* Request an origination phone number for use in your account. For more information on phone number request see Requesting a number in the Amazon Pinpoint User Guide.
|
264
432
|
*/
|
@@ -267,6 +435,22 @@ declare class PinpointSMSVoiceV2 extends Service {
|
|
267
435
|
* Request an origination phone number for use in your account. For more information on phone number request see Requesting a number in the Amazon Pinpoint User Guide.
|
268
436
|
*/
|
269
437
|
requestPhoneNumber(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.RequestPhoneNumberResult) => void): Request<PinpointSMSVoiceV2.Types.RequestPhoneNumberResult, AWSError>;
|
438
|
+
/**
|
439
|
+
* Request a new sender ID that doesn't require registration.
|
440
|
+
*/
|
441
|
+
requestSenderId(params: PinpointSMSVoiceV2.Types.RequestSenderIdRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.RequestSenderIdResult) => void): Request<PinpointSMSVoiceV2.Types.RequestSenderIdResult, AWSError>;
|
442
|
+
/**
|
443
|
+
* Request a new sender ID that doesn't require registration.
|
444
|
+
*/
|
445
|
+
requestSenderId(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.RequestSenderIdResult) => void): Request<PinpointSMSVoiceV2.Types.RequestSenderIdResult, AWSError>;
|
446
|
+
/**
|
447
|
+
* Before you can send test messages to a verified destination phone number you need to opt-in the verified destination phone number. Creates a new text message with a verification code and send it to a verified destination phone number. Once you have the verification code use VerifyDestinationNumber to opt-in the verified destination phone number to receive messages.
|
448
|
+
*/
|
449
|
+
sendDestinationNumberVerificationCode(params: PinpointSMSVoiceV2.Types.SendDestinationNumberVerificationCodeRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.SendDestinationNumberVerificationCodeResult) => void): Request<PinpointSMSVoiceV2.Types.SendDestinationNumberVerificationCodeResult, AWSError>;
|
450
|
+
/**
|
451
|
+
* Before you can send test messages to a verified destination phone number you need to opt-in the verified destination phone number. Creates a new text message with a verification code and send it to a verified destination phone number. Once you have the verification code use VerifyDestinationNumber to opt-in the verified destination phone number to receive messages.
|
452
|
+
*/
|
453
|
+
sendDestinationNumberVerificationCode(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.SendDestinationNumberVerificationCodeResult) => void): Request<PinpointSMSVoiceV2.Types.SendDestinationNumberVerificationCodeResult, AWSError>;
|
270
454
|
/**
|
271
455
|
* Creates a new text message and sends it to a recipient's phone number. SMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit depends on the destination country of your messages, as well as the type of phone number (origination number) that you use to send the message. For more information, see Message Parts per Second (MPS) limits in the Amazon Pinpoint User Guide.
|
272
456
|
*/
|
@@ -276,11 +460,11 @@ declare class PinpointSMSVoiceV2 extends Service {
|
|
276
460
|
*/
|
277
461
|
sendTextMessage(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.SendTextMessageResult) => void): Request<PinpointSMSVoiceV2.Types.SendTextMessageResult, AWSError>;
|
278
462
|
/**
|
279
|
-
* Allows you to send a request that sends a
|
463
|
+
* Allows you to send a request that sends a voice message through Amazon Pinpoint. This operation uses Amazon Polly to convert a text script into a voice message.
|
280
464
|
*/
|
281
465
|
sendVoiceMessage(params: PinpointSMSVoiceV2.Types.SendVoiceMessageRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.SendVoiceMessageResult) => void): Request<PinpointSMSVoiceV2.Types.SendVoiceMessageResult, AWSError>;
|
282
466
|
/**
|
283
|
-
* Allows you to send a request that sends a
|
467
|
+
* Allows you to send a request that sends a voice message through Amazon Pinpoint. This operation uses Amazon Polly to convert a text script into a voice message.
|
284
468
|
*/
|
285
469
|
sendVoiceMessage(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.SendVoiceMessageResult) => void): Request<PinpointSMSVoiceV2.Types.SendVoiceMessageResult, AWSError>;
|
286
470
|
/**
|
@@ -315,6 +499,14 @@ declare class PinpointSMSVoiceV2 extends Service {
|
|
315
499
|
* Sets an account level monthly spend limit override for sending voice messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.
|
316
500
|
*/
|
317
501
|
setVoiceMessageSpendLimitOverride(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.SetVoiceMessageSpendLimitOverrideResult) => void): Request<PinpointSMSVoiceV2.Types.SetVoiceMessageSpendLimitOverrideResult, AWSError>;
|
502
|
+
/**
|
503
|
+
* Submit the specified registration for review and approval.
|
504
|
+
*/
|
505
|
+
submitRegistrationVersion(params: PinpointSMSVoiceV2.Types.SubmitRegistrationVersionRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.SubmitRegistrationVersionResult) => void): Request<PinpointSMSVoiceV2.Types.SubmitRegistrationVersionResult, AWSError>;
|
506
|
+
/**
|
507
|
+
* Submit the specified registration for review and approval.
|
508
|
+
*/
|
509
|
+
submitRegistrationVersion(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.SubmitRegistrationVersionResult) => void): Request<PinpointSMSVoiceV2.Types.SubmitRegistrationVersionResult, AWSError>;
|
318
510
|
/**
|
319
511
|
* Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS Voice, version 2 resource. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.
|
320
512
|
*/
|
@@ -340,11 +532,11 @@ declare class PinpointSMSVoiceV2 extends Service {
|
|
340
532
|
*/
|
341
533
|
updateEventDestination(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.UpdateEventDestinationResult) => void): Request<PinpointSMSVoiceV2.Types.UpdateEventDestinationResult, AWSError>;
|
342
534
|
/**
|
343
|
-
* Updates the configuration of an existing origination phone number. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, and enable or disable deletion protection. If the origination phone number is associated with a pool, an
|
535
|
+
* Updates the configuration of an existing origination phone number. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, and enable or disable deletion protection. If the origination phone number is associated with a pool, an error is returned.
|
344
536
|
*/
|
345
537
|
updatePhoneNumber(params: PinpointSMSVoiceV2.Types.UpdatePhoneNumberRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.UpdatePhoneNumberResult) => void): Request<PinpointSMSVoiceV2.Types.UpdatePhoneNumberResult, AWSError>;
|
346
538
|
/**
|
347
|
-
* Updates the configuration of an existing origination phone number. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, and enable or disable deletion protection. If the origination phone number is associated with a pool, an
|
539
|
+
* Updates the configuration of an existing origination phone number. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, and enable or disable deletion protection. If the origination phone number is associated with a pool, an error is returned.
|
348
540
|
*/
|
349
541
|
updatePhoneNumber(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.UpdatePhoneNumberResult) => void): Request<PinpointSMSVoiceV2.Types.UpdatePhoneNumberResult, AWSError>;
|
350
542
|
/**
|
@@ -355,6 +547,22 @@ declare class PinpointSMSVoiceV2 extends Service {
|
|
355
547
|
* Updates the configuration of an existing pool. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, enable or disable deletion protection, and enable or disable shared routes.
|
356
548
|
*/
|
357
549
|
updatePool(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.UpdatePoolResult) => void): Request<PinpointSMSVoiceV2.Types.UpdatePoolResult, AWSError>;
|
550
|
+
/**
|
551
|
+
* Updates the configuration of an existing sender ID.
|
552
|
+
*/
|
553
|
+
updateSenderId(params: PinpointSMSVoiceV2.Types.UpdateSenderIdRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.UpdateSenderIdResult) => void): Request<PinpointSMSVoiceV2.Types.UpdateSenderIdResult, AWSError>;
|
554
|
+
/**
|
555
|
+
* Updates the configuration of an existing sender ID.
|
556
|
+
*/
|
557
|
+
updateSenderId(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.UpdateSenderIdResult) => void): Request<PinpointSMSVoiceV2.Types.UpdateSenderIdResult, AWSError>;
|
558
|
+
/**
|
559
|
+
* Use the verification code that was received by the verified destination phone number to opt-in the verified destination phone number to receive more messages.
|
560
|
+
*/
|
561
|
+
verifyDestinationNumber(params: PinpointSMSVoiceV2.Types.VerifyDestinationNumberRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.VerifyDestinationNumberResult) => void): Request<PinpointSMSVoiceV2.Types.VerifyDestinationNumberResult, AWSError>;
|
562
|
+
/**
|
563
|
+
* Use the verification code that was received by the verified destination phone number to opt-in the verified destination phone number to receive more messages.
|
564
|
+
*/
|
565
|
+
verifyDestinationNumber(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.VerifyDestinationNumberResult) => void): Request<PinpointSMSVoiceV2.Types.VerifyDestinationNumberResult, AWSError>;
|
358
566
|
}
|
359
567
|
declare namespace PinpointSMSVoiceV2 {
|
360
568
|
export interface AccountAttribute {
|
@@ -384,7 +592,7 @@ declare namespace PinpointSMSVoiceV2 {
|
|
384
592
|
Max: PrimitiveLong;
|
385
593
|
}
|
386
594
|
export type AccountLimitList = AccountLimit[];
|
387
|
-
export type AccountLimitName = "PHONE_NUMBERS"|"POOLS"|"CONFIGURATION_SETS"|"OPT_OUT_LISTS"|string;
|
595
|
+
export type AccountLimitName = "PHONE_NUMBERS"|"POOLS"|"CONFIGURATION_SETS"|"OPT_OUT_LISTS"|"SENDER_IDS"|"REGISTRATIONS"|"REGISTRATION_ATTACHMENTS"|"VERIFIED_DESTINATION_NUMBERS"|string;
|
388
596
|
export type AmazonResourceName = string;
|
389
597
|
export interface AssociateOriginationIdentityRequest {
|
390
598
|
/**
|
@@ -426,6 +634,10 @@ declare namespace PinpointSMSVoiceV2 {
|
|
426
634
|
*/
|
427
635
|
IsoCountryCode?: IsoCountryCode;
|
428
636
|
}
|
637
|
+
export type AttachmentBody = Buffer|Uint8Array|Blob|string;
|
638
|
+
export type AttachmentStatus = "UPLOAD_IN_PROGRESS"|"UPLOAD_COMPLETE"|"UPLOAD_FAILED"|"DELETED"|string;
|
639
|
+
export type AttachmentUploadErrorReason = "INTERNAL_ERROR"|string;
|
640
|
+
export type AttachmentUrl = string;
|
429
641
|
export type Boolean = boolean;
|
430
642
|
export type ClientToken = string;
|
431
643
|
export interface CloudWatchLogsDestination {
|
@@ -525,7 +737,7 @@ declare namespace PinpointSMSVoiceV2 {
|
|
525
737
|
*/
|
526
738
|
EventDestinationName: EventDestinationName;
|
527
739
|
/**
|
528
|
-
* An array of event types that determine which events to log. If "ALL" is used, then Amazon Pinpoint logs every event type.
|
740
|
+
* An array of event types that determine which events to log. If "ALL" is used, then Amazon Pinpoint logs every event type. The TEXT_SENT event type is not supported.
|
529
741
|
*/
|
530
742
|
MatchingEventTypes: EventTypeList;
|
531
743
|
/**
|
@@ -642,6 +854,10 @@ declare namespace PinpointSMSVoiceV2 {
|
|
642
854
|
* The Amazon Resource Name (ARN) of the two way channel.
|
643
855
|
*/
|
644
856
|
TwoWayChannelArn?: TwoWayChannelArn;
|
857
|
+
/**
|
858
|
+
* An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
|
859
|
+
*/
|
860
|
+
TwoWayChannelRole?: IamRoleArn;
|
645
861
|
/**
|
646
862
|
* By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
|
647
863
|
*/
|
@@ -667,6 +883,206 @@ declare namespace PinpointSMSVoiceV2 {
|
|
667
883
|
*/
|
668
884
|
CreatedTimestamp?: Timestamp;
|
669
885
|
}
|
886
|
+
export interface CreateRegistrationAssociationRequest {
|
887
|
+
/**
|
888
|
+
* The unique identifier for the registration.
|
889
|
+
*/
|
890
|
+
RegistrationId: RegistrationIdOrArn;
|
891
|
+
/**
|
892
|
+
* The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.
|
893
|
+
*/
|
894
|
+
ResourceId: ResourceIdOrArn;
|
895
|
+
}
|
896
|
+
export interface CreateRegistrationAssociationResult {
|
897
|
+
/**
|
898
|
+
* The Amazon Resource Name (ARN) for the registration.
|
899
|
+
*/
|
900
|
+
RegistrationArn: String;
|
901
|
+
/**
|
902
|
+
* The unique identifier for the registration.
|
903
|
+
*/
|
904
|
+
RegistrationId: String;
|
905
|
+
/**
|
906
|
+
* The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
|
907
|
+
*/
|
908
|
+
RegistrationType: RegistrationType;
|
909
|
+
/**
|
910
|
+
* The Amazon Resource Name (ARN) of the origination identity that is associated with the registration.
|
911
|
+
*/
|
912
|
+
ResourceArn: String;
|
913
|
+
/**
|
914
|
+
* The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.
|
915
|
+
*/
|
916
|
+
ResourceId: String;
|
917
|
+
/**
|
918
|
+
* The registration type or origination identity type.
|
919
|
+
*/
|
920
|
+
ResourceType: String;
|
921
|
+
/**
|
922
|
+
* The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
|
923
|
+
*/
|
924
|
+
IsoCountryCode?: IsoCountryCode;
|
925
|
+
/**
|
926
|
+
* The phone number associated with the registration in E.164 format.
|
927
|
+
*/
|
928
|
+
PhoneNumber?: PhoneNumber;
|
929
|
+
}
|
930
|
+
export interface CreateRegistrationAttachmentRequest {
|
931
|
+
/**
|
932
|
+
* The registration file to upload. The maximum file size is 1MiB and valid file extensions are PDF, JPEG and PNG.
|
933
|
+
*/
|
934
|
+
AttachmentBody?: AttachmentBody;
|
935
|
+
/**
|
936
|
+
* A URL to the required registration file. For example, you can provide the S3 object URL.
|
937
|
+
*/
|
938
|
+
AttachmentUrl?: AttachmentUrl;
|
939
|
+
/**
|
940
|
+
* An array of tags (key and value pairs) to associate with the registration attachment.
|
941
|
+
*/
|
942
|
+
Tags?: TagList;
|
943
|
+
/**
|
944
|
+
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
|
945
|
+
*/
|
946
|
+
ClientToken?: ClientToken;
|
947
|
+
}
|
948
|
+
export interface CreateRegistrationAttachmentResult {
|
949
|
+
/**
|
950
|
+
* The Amazon Resource Name (ARN) for the registration attachment.
|
951
|
+
*/
|
952
|
+
RegistrationAttachmentArn: String;
|
953
|
+
/**
|
954
|
+
* The unique identifier for the registration attachment.
|
955
|
+
*/
|
956
|
+
RegistrationAttachmentId: String;
|
957
|
+
/**
|
958
|
+
* The status of the registration attachment. UPLOAD_IN_PROGRESS The attachment is being uploaded. UPLOAD_COMPLETE The attachment has been uploaded. UPLOAD_FAILED The attachment failed to uploaded. DELETED The attachment has been deleted..
|
959
|
+
*/
|
960
|
+
AttachmentStatus: AttachmentStatus;
|
961
|
+
/**
|
962
|
+
* An array of tags (key and value pairs) to associate with the registration attachment.
|
963
|
+
*/
|
964
|
+
Tags?: TagList;
|
965
|
+
/**
|
966
|
+
* The time when the registration attachment was created, in UNIX epoch time format.
|
967
|
+
*/
|
968
|
+
CreatedTimestamp: Timestamp;
|
969
|
+
}
|
970
|
+
export interface CreateRegistrationRequest {
|
971
|
+
/**
|
972
|
+
* The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
|
973
|
+
*/
|
974
|
+
RegistrationType: RegistrationType;
|
975
|
+
/**
|
976
|
+
* An array of tags (key and value pairs) to associate with the registration.
|
977
|
+
*/
|
978
|
+
Tags?: TagList;
|
979
|
+
/**
|
980
|
+
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
|
981
|
+
*/
|
982
|
+
ClientToken?: ClientToken;
|
983
|
+
}
|
984
|
+
export interface CreateRegistrationResult {
|
985
|
+
/**
|
986
|
+
* The Amazon Resource Name (ARN) for the registration.
|
987
|
+
*/
|
988
|
+
RegistrationArn: String;
|
989
|
+
/**
|
990
|
+
* The unique identifier for the registration.
|
991
|
+
*/
|
992
|
+
RegistrationId: String;
|
993
|
+
/**
|
994
|
+
* The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
|
995
|
+
*/
|
996
|
+
RegistrationType: RegistrationType;
|
997
|
+
/**
|
998
|
+
* The status of the registration. CREATED: Your registration is created but not submitted. SUBMITTED: Your registration has been submitted and is awaiting review. REVIEWING: Your registration has been accepted and is being reviewed. PROVISIONING: Your registration has been approved and your origination identity is being created. COMPLETE: Your registration has been approved and and your origination identity has been created. REQUIRES_UPDATES: You must fix your registration and resubmit it. CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number. DELETED: The registration has been deleted.
|
999
|
+
*/
|
1000
|
+
RegistrationStatus: RegistrationStatus;
|
1001
|
+
/**
|
1002
|
+
* The current version number of the registration.
|
1003
|
+
*/
|
1004
|
+
CurrentVersionNumber: RegistrationVersionNumber;
|
1005
|
+
/**
|
1006
|
+
* Metadata about a given registration which is specific to that registration type.
|
1007
|
+
*/
|
1008
|
+
AdditionalAttributes?: StringMap;
|
1009
|
+
/**
|
1010
|
+
* An array of tags (key and value pairs) to associate with the registration.
|
1011
|
+
*/
|
1012
|
+
Tags?: TagList;
|
1013
|
+
/**
|
1014
|
+
* The time when the registration was created, in UNIX epoch time format.
|
1015
|
+
*/
|
1016
|
+
CreatedTimestamp: Timestamp;
|
1017
|
+
}
|
1018
|
+
export interface CreateRegistrationVersionRequest {
|
1019
|
+
/**
|
1020
|
+
* The unique identifier for the registration.
|
1021
|
+
*/
|
1022
|
+
RegistrationId: RegistrationIdOrArn;
|
1023
|
+
}
|
1024
|
+
export interface CreateRegistrationVersionResult {
|
1025
|
+
/**
|
1026
|
+
* The Amazon Resource Name (ARN) for the registration.
|
1027
|
+
*/
|
1028
|
+
RegistrationArn: String;
|
1029
|
+
/**
|
1030
|
+
* The unique identifier for the registration.
|
1031
|
+
*/
|
1032
|
+
RegistrationId: String;
|
1033
|
+
/**
|
1034
|
+
* The new version number of the registration.
|
1035
|
+
*/
|
1036
|
+
VersionNumber: RegistrationVersionNumber;
|
1037
|
+
/**
|
1038
|
+
* The status of the registration. DRAFT: The initial status of a registration version after it’s created. SUBMITTED: Your registration has been submitted. REVIEWING: Your registration has been accepted and is being reviewed. APPROVED: Your registration has been approved. DISCARDED: You've abandon this version of their registration to start over with a new version. DENIED: You must fix your registration and resubmit it. REVOKED: Your previously approved registration has been revoked. ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.
|
1039
|
+
*/
|
1040
|
+
RegistrationVersionStatus: RegistrationVersionStatus;
|
1041
|
+
/**
|
1042
|
+
* A RegistrationVersionStatusHistory object that contains timestamps for the registration.
|
1043
|
+
*/
|
1044
|
+
RegistrationVersionStatusHistory: RegistrationVersionStatusHistory;
|
1045
|
+
}
|
1046
|
+
export interface CreateVerifiedDestinationNumberRequest {
|
1047
|
+
/**
|
1048
|
+
* The verified destination phone number, in E.164 format.
|
1049
|
+
*/
|
1050
|
+
DestinationPhoneNumber: PhoneNumber;
|
1051
|
+
/**
|
1052
|
+
* An array of tags (key and value pairs) to associate with the destination number.
|
1053
|
+
*/
|
1054
|
+
Tags?: TagList;
|
1055
|
+
/**
|
1056
|
+
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
|
1057
|
+
*/
|
1058
|
+
ClientToken?: ClientToken;
|
1059
|
+
}
|
1060
|
+
export interface CreateVerifiedDestinationNumberResult {
|
1061
|
+
/**
|
1062
|
+
* The Amazon Resource Name (ARN) for the verified destination phone number.
|
1063
|
+
*/
|
1064
|
+
VerifiedDestinationNumberArn: String;
|
1065
|
+
/**
|
1066
|
+
* The unique identifier for the verified destination phone number.
|
1067
|
+
*/
|
1068
|
+
VerifiedDestinationNumberId: String;
|
1069
|
+
/**
|
1070
|
+
* The verified destination phone number, in E.164 format.
|
1071
|
+
*/
|
1072
|
+
DestinationPhoneNumber: PhoneNumber;
|
1073
|
+
/**
|
1074
|
+
* The status of the verified destination phone number. PENDING: The phone number hasn't been verified yet. VERIFIED: The phone number is verified and can receive messages.
|
1075
|
+
*/
|
1076
|
+
Status: VerificationStatus;
|
1077
|
+
/**
|
1078
|
+
* An array of tags (key and value pairs) to associate with the destination number.
|
1079
|
+
*/
|
1080
|
+
Tags?: TagList;
|
1081
|
+
/**
|
1082
|
+
* The time when the verified phone number was created, in UNIX epoch time format.
|
1083
|
+
*/
|
1084
|
+
CreatedTimestamp: Timestamp;
|
1085
|
+
}
|
670
1086
|
export interface DeleteConfigurationSetRequest {
|
671
1087
|
/**
|
672
1088
|
* The name of the configuration set or the configuration set ARN that you want to delete. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
|
@@ -878,6 +1294,10 @@ declare namespace PinpointSMSVoiceV2 {
|
|
878
1294
|
* The Amazon Resource Name (ARN) of the TwoWayChannel.
|
879
1295
|
*/
|
880
1296
|
TwoWayChannelArn?: TwoWayChannelArn;
|
1297
|
+
/**
|
1298
|
+
* An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
|
1299
|
+
*/
|
1300
|
+
TwoWayChannelRole?: IamRoleArn;
|
881
1301
|
/**
|
882
1302
|
* By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
|
883
1303
|
*/
|
@@ -895,50 +1315,186 @@ declare namespace PinpointSMSVoiceV2 {
|
|
895
1315
|
*/
|
896
1316
|
CreatedTimestamp?: Timestamp;
|
897
1317
|
}
|
898
|
-
export interface
|
899
|
-
}
|
900
|
-
export interface DeleteTextMessageSpendLimitOverrideResult {
|
1318
|
+
export interface DeleteRegistrationAttachmentRequest {
|
901
1319
|
/**
|
902
|
-
* The
|
1320
|
+
* The unique identifier for the registration attachment.
|
903
1321
|
*/
|
904
|
-
|
905
|
-
}
|
906
|
-
export interface DeleteVoiceMessageSpendLimitOverrideRequest {
|
1322
|
+
RegistrationAttachmentId: RegistrationAttachmentIdOrArn;
|
907
1323
|
}
|
908
|
-
export interface
|
1324
|
+
export interface DeleteRegistrationAttachmentResult {
|
909
1325
|
/**
|
910
|
-
* The
|
1326
|
+
* The Amazon Resource Name (ARN) for the registration attachment.
|
911
1327
|
*/
|
912
|
-
|
913
|
-
}
|
914
|
-
export type DeliveryStreamArn = string;
|
915
|
-
export interface DescribeAccountAttributesRequest {
|
1328
|
+
RegistrationAttachmentArn: String;
|
916
1329
|
/**
|
917
|
-
* The
|
1330
|
+
* The unique identifier for the registration attachment.
|
918
1331
|
*/
|
919
|
-
|
1332
|
+
RegistrationAttachmentId: String;
|
920
1333
|
/**
|
921
|
-
* The
|
1334
|
+
* The status of the registration attachment. UPLOAD_IN_PROGRESS The attachment is being uploaded. UPLOAD_COMPLETE The attachment has been uploaded. UPLOAD_FAILED The attachment failed to uploaded. DELETED The attachment has been deleted..
|
922
1335
|
*/
|
923
|
-
|
924
|
-
}
|
925
|
-
export interface DescribeAccountAttributesResult {
|
1336
|
+
AttachmentStatus: AttachmentStatus;
|
926
1337
|
/**
|
927
|
-
*
|
1338
|
+
* The error message if the upload failed.
|
928
1339
|
*/
|
929
|
-
|
1340
|
+
AttachmentUploadErrorReason?: AttachmentUploadErrorReason;
|
930
1341
|
/**
|
931
|
-
* The
|
1342
|
+
* The time when the registration attachment was created, in UNIX epoch time format.
|
932
1343
|
*/
|
933
|
-
|
1344
|
+
CreatedTimestamp: Timestamp;
|
934
1345
|
}
|
935
|
-
export interface
|
1346
|
+
export interface DeleteRegistrationFieldValueRequest {
|
936
1347
|
/**
|
937
|
-
* The
|
1348
|
+
* The unique identifier for the registration.
|
938
1349
|
*/
|
939
|
-
|
1350
|
+
RegistrationId: RegistrationIdOrArn;
|
940
1351
|
/**
|
941
|
-
* The
|
1352
|
+
* The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
|
1353
|
+
*/
|
1354
|
+
FieldPath: FieldPath;
|
1355
|
+
}
|
1356
|
+
export interface DeleteRegistrationFieldValueResult {
|
1357
|
+
/**
|
1358
|
+
* The Amazon Resource Name (ARN) for the registration.
|
1359
|
+
*/
|
1360
|
+
RegistrationArn: String;
|
1361
|
+
/**
|
1362
|
+
* The unique identifier for the registration.
|
1363
|
+
*/
|
1364
|
+
RegistrationId: String;
|
1365
|
+
/**
|
1366
|
+
* The version number of the registration.
|
1367
|
+
*/
|
1368
|
+
VersionNumber: RegistrationVersionNumber;
|
1369
|
+
/**
|
1370
|
+
* The path to the registration form field.
|
1371
|
+
*/
|
1372
|
+
FieldPath: FieldPath;
|
1373
|
+
/**
|
1374
|
+
* An array of values for the form field.
|
1375
|
+
*/
|
1376
|
+
SelectChoices?: SelectChoiceList;
|
1377
|
+
/**
|
1378
|
+
* The text data for a free form field.
|
1379
|
+
*/
|
1380
|
+
TextValue?: TextValue;
|
1381
|
+
/**
|
1382
|
+
* The unique identifier for the registration attachment.
|
1383
|
+
*/
|
1384
|
+
RegistrationAttachmentId?: String;
|
1385
|
+
}
|
1386
|
+
export interface DeleteRegistrationRequest {
|
1387
|
+
/**
|
1388
|
+
* The unique identifier for the registration.
|
1389
|
+
*/
|
1390
|
+
RegistrationId: RegistrationIdOrArn;
|
1391
|
+
}
|
1392
|
+
export interface DeleteRegistrationResult {
|
1393
|
+
/**
|
1394
|
+
* The Amazon Resource Name (ARN) for the registration.
|
1395
|
+
*/
|
1396
|
+
RegistrationArn: String;
|
1397
|
+
/**
|
1398
|
+
* The unique identifier for the registration.
|
1399
|
+
*/
|
1400
|
+
RegistrationId: String;
|
1401
|
+
/**
|
1402
|
+
* The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
|
1403
|
+
*/
|
1404
|
+
RegistrationType: RegistrationType;
|
1405
|
+
/**
|
1406
|
+
* The status of the registration. CREATED: Your registration is created but not submitted. SUBMITTED: Your registration has been submitted and is awaiting review. REVIEWING: Your registration has been accepted and is being reviewed. PROVISIONING: Your registration has been approved and your origination identity is being created. COMPLETE: Your registration has been approved and and your origination identity has been created. REQUIRES_UPDATES: You must fix your registration and resubmit it. CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number. DELETED: The registration has been deleted.
|
1407
|
+
*/
|
1408
|
+
RegistrationStatus: RegistrationStatus;
|
1409
|
+
/**
|
1410
|
+
* The current version number of the registration.
|
1411
|
+
*/
|
1412
|
+
CurrentVersionNumber: RegistrationVersionNumber;
|
1413
|
+
/**
|
1414
|
+
* The version number of the registration that was approved.
|
1415
|
+
*/
|
1416
|
+
ApprovedVersionNumber?: RegistrationVersionNumber;
|
1417
|
+
/**
|
1418
|
+
* The latest version number of the registration that was denied.
|
1419
|
+
*/
|
1420
|
+
LatestDeniedVersionNumber?: RegistrationVersionNumber;
|
1421
|
+
/**
|
1422
|
+
* Metadata about a given registration which is specific to that registration type.
|
1423
|
+
*/
|
1424
|
+
AdditionalAttributes?: StringMap;
|
1425
|
+
/**
|
1426
|
+
* The time when the registration was created, in UNIX epoch time format.
|
1427
|
+
*/
|
1428
|
+
CreatedTimestamp: Timestamp;
|
1429
|
+
}
|
1430
|
+
export interface DeleteTextMessageSpendLimitOverrideRequest {
|
1431
|
+
}
|
1432
|
+
export interface DeleteTextMessageSpendLimitOverrideResult {
|
1433
|
+
/**
|
1434
|
+
* The current monthly limit, in US dollars.
|
1435
|
+
*/
|
1436
|
+
MonthlyLimit?: MonthlyLimit;
|
1437
|
+
}
|
1438
|
+
export interface DeleteVerifiedDestinationNumberRequest {
|
1439
|
+
/**
|
1440
|
+
* The unique identifier for the verified destination phone number.
|
1441
|
+
*/
|
1442
|
+
VerifiedDestinationNumberId: VerifiedDestinationNumberIdOrArn;
|
1443
|
+
}
|
1444
|
+
export interface DeleteVerifiedDestinationNumberResult {
|
1445
|
+
/**
|
1446
|
+
* The Amazon Resource Name (ARN) for the verified destination phone number.
|
1447
|
+
*/
|
1448
|
+
VerifiedDestinationNumberArn: String;
|
1449
|
+
/**
|
1450
|
+
* The unique identifier for the verified destination phone number.
|
1451
|
+
*/
|
1452
|
+
VerifiedDestinationNumberId: String;
|
1453
|
+
/**
|
1454
|
+
* The verified destination phone number, in E.164 format.
|
1455
|
+
*/
|
1456
|
+
DestinationPhoneNumber: PhoneNumber;
|
1457
|
+
/**
|
1458
|
+
* The time when the destination phone number was created, in UNIX epoch time format.
|
1459
|
+
*/
|
1460
|
+
CreatedTimestamp: Timestamp;
|
1461
|
+
}
|
1462
|
+
export interface DeleteVoiceMessageSpendLimitOverrideRequest {
|
1463
|
+
}
|
1464
|
+
export interface DeleteVoiceMessageSpendLimitOverrideResult {
|
1465
|
+
/**
|
1466
|
+
* The current monthly limit, in US dollars.
|
1467
|
+
*/
|
1468
|
+
MonthlyLimit?: MonthlyLimit;
|
1469
|
+
}
|
1470
|
+
export type DeliveryStreamArn = string;
|
1471
|
+
export interface DescribeAccountAttributesRequest {
|
1472
|
+
/**
|
1473
|
+
* The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
|
1474
|
+
*/
|
1475
|
+
NextToken?: NextToken;
|
1476
|
+
/**
|
1477
|
+
* The maximum number of results to return per each request.
|
1478
|
+
*/
|
1479
|
+
MaxResults?: MaxResults;
|
1480
|
+
}
|
1481
|
+
export interface DescribeAccountAttributesResult {
|
1482
|
+
/**
|
1483
|
+
* An array of AccountAttributes objects.
|
1484
|
+
*/
|
1485
|
+
AccountAttributes?: AccountAttributeList;
|
1486
|
+
/**
|
1487
|
+
* The token to be used for the next set of paginated results. If this field is empty then there are no more results.
|
1488
|
+
*/
|
1489
|
+
NextToken?: NextToken;
|
1490
|
+
}
|
1491
|
+
export interface DescribeAccountLimitsRequest {
|
1492
|
+
/**
|
1493
|
+
* The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
|
1494
|
+
*/
|
1495
|
+
NextToken?: NextToken;
|
1496
|
+
/**
|
1497
|
+
* The maximum number of results to return per each request.
|
942
1498
|
*/
|
943
1499
|
MaxResults?: MaxResults;
|
944
1500
|
}
|
@@ -1140,6 +1696,246 @@ declare namespace PinpointSMSVoiceV2 {
|
|
1140
1696
|
*/
|
1141
1697
|
NextToken?: NextToken;
|
1142
1698
|
}
|
1699
|
+
export interface DescribeRegistrationAttachmentsRequest {
|
1700
|
+
/**
|
1701
|
+
* The unique identifier of registration attachments to find. This is an array of RegistrationAttachmentId.
|
1702
|
+
*/
|
1703
|
+
RegistrationAttachmentIds?: RegistrationAttachmentIdList;
|
1704
|
+
/**
|
1705
|
+
* An array of RegistrationAttachmentFilter objects to filter the results.
|
1706
|
+
*/
|
1707
|
+
Filters?: RegistrationAttachmentFilterList;
|
1708
|
+
/**
|
1709
|
+
* The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
|
1710
|
+
*/
|
1711
|
+
NextToken?: NextToken;
|
1712
|
+
/**
|
1713
|
+
* The maximum number of results to return per each request.
|
1714
|
+
*/
|
1715
|
+
MaxResults?: MaxResults;
|
1716
|
+
}
|
1717
|
+
export interface DescribeRegistrationAttachmentsResult {
|
1718
|
+
/**
|
1719
|
+
* An array of RegistrationAttachments objects that contain the details for the requested registration attachments.
|
1720
|
+
*/
|
1721
|
+
RegistrationAttachments: RegistrationAttachmentsInformationList;
|
1722
|
+
/**
|
1723
|
+
* The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
|
1724
|
+
*/
|
1725
|
+
NextToken?: NextToken;
|
1726
|
+
}
|
1727
|
+
export interface DescribeRegistrationFieldDefinitionsRequest {
|
1728
|
+
/**
|
1729
|
+
* The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
|
1730
|
+
*/
|
1731
|
+
RegistrationType: RegistrationType;
|
1732
|
+
/**
|
1733
|
+
* The path to the section of the registration.
|
1734
|
+
*/
|
1735
|
+
SectionPath?: SectionPath;
|
1736
|
+
/**
|
1737
|
+
* An array of paths to the registration form field.
|
1738
|
+
*/
|
1739
|
+
FieldPaths?: FieldPathList;
|
1740
|
+
/**
|
1741
|
+
* The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
|
1742
|
+
*/
|
1743
|
+
NextToken?: NextToken;
|
1744
|
+
/**
|
1745
|
+
* The maximum number of results to return per each request.
|
1746
|
+
*/
|
1747
|
+
MaxResults?: MaxResults;
|
1748
|
+
}
|
1749
|
+
export interface DescribeRegistrationFieldDefinitionsResult {
|
1750
|
+
/**
|
1751
|
+
* The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
|
1752
|
+
*/
|
1753
|
+
RegistrationType: RegistrationType;
|
1754
|
+
/**
|
1755
|
+
* An array of RegistrationFieldDefinitions objects that contain the details for the requested fields.
|
1756
|
+
*/
|
1757
|
+
RegistrationFieldDefinitions: RegistrationFieldDefinitionList;
|
1758
|
+
/**
|
1759
|
+
* The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
|
1760
|
+
*/
|
1761
|
+
NextToken?: NextToken;
|
1762
|
+
}
|
1763
|
+
export interface DescribeRegistrationFieldValuesRequest {
|
1764
|
+
/**
|
1765
|
+
* The unique identifier for the registration.
|
1766
|
+
*/
|
1767
|
+
RegistrationId: RegistrationIdOrArn;
|
1768
|
+
/**
|
1769
|
+
* The version number of the registration.
|
1770
|
+
*/
|
1771
|
+
VersionNumber?: RegistrationVersionNumber;
|
1772
|
+
/**
|
1773
|
+
* The path to the section of the registration.
|
1774
|
+
*/
|
1775
|
+
SectionPath?: SectionPath;
|
1776
|
+
/**
|
1777
|
+
* An array of paths to the registration form field.
|
1778
|
+
*/
|
1779
|
+
FieldPaths?: FieldPathList;
|
1780
|
+
/**
|
1781
|
+
* The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
|
1782
|
+
*/
|
1783
|
+
NextToken?: NextToken;
|
1784
|
+
/**
|
1785
|
+
* The maximum number of results to return per each request.
|
1786
|
+
*/
|
1787
|
+
MaxResults?: MaxResults;
|
1788
|
+
}
|
1789
|
+
export interface DescribeRegistrationFieldValuesResult {
|
1790
|
+
/**
|
1791
|
+
* The Amazon Resource Name (ARN) for the registration.
|
1792
|
+
*/
|
1793
|
+
RegistrationArn: String;
|
1794
|
+
/**
|
1795
|
+
* The unique identifier for the registration.
|
1796
|
+
*/
|
1797
|
+
RegistrationId: String;
|
1798
|
+
/**
|
1799
|
+
* The current version of the registration.
|
1800
|
+
*/
|
1801
|
+
VersionNumber: RegistrationVersionNumber;
|
1802
|
+
/**
|
1803
|
+
* An array of RegistrationFieldValues objects that contain the values for the requested registration.
|
1804
|
+
*/
|
1805
|
+
RegistrationFieldValues: RegistrationFieldValueInformationList;
|
1806
|
+
/**
|
1807
|
+
* The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
|
1808
|
+
*/
|
1809
|
+
NextToken?: NextToken;
|
1810
|
+
}
|
1811
|
+
export interface DescribeRegistrationSectionDefinitionsRequest {
|
1812
|
+
/**
|
1813
|
+
* The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
|
1814
|
+
*/
|
1815
|
+
RegistrationType: RegistrationType;
|
1816
|
+
/**
|
1817
|
+
* An array of paths for the registration form section.
|
1818
|
+
*/
|
1819
|
+
SectionPaths?: SectionPathList;
|
1820
|
+
/**
|
1821
|
+
* The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
|
1822
|
+
*/
|
1823
|
+
NextToken?: NextToken;
|
1824
|
+
/**
|
1825
|
+
* The maximum number of results to return per each request.
|
1826
|
+
*/
|
1827
|
+
MaxResults?: MaxResults;
|
1828
|
+
}
|
1829
|
+
export interface DescribeRegistrationSectionDefinitionsResult {
|
1830
|
+
/**
|
1831
|
+
* The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
|
1832
|
+
*/
|
1833
|
+
RegistrationType: RegistrationType;
|
1834
|
+
/**
|
1835
|
+
* An array of RegistrationSectionDefinition objects.
|
1836
|
+
*/
|
1837
|
+
RegistrationSectionDefinitions: RegistrationSectionDefinitionList;
|
1838
|
+
/**
|
1839
|
+
* The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
|
1840
|
+
*/
|
1841
|
+
NextToken?: NextToken;
|
1842
|
+
}
|
1843
|
+
export interface DescribeRegistrationTypeDefinitionsRequest {
|
1844
|
+
/**
|
1845
|
+
* The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
|
1846
|
+
*/
|
1847
|
+
RegistrationTypes?: RegistrationTypeList;
|
1848
|
+
/**
|
1849
|
+
* An array of RegistrationFilter objects to filter the results.
|
1850
|
+
*/
|
1851
|
+
Filters?: RegistrationTypeFilterList;
|
1852
|
+
/**
|
1853
|
+
* The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
|
1854
|
+
*/
|
1855
|
+
NextToken?: NextToken;
|
1856
|
+
/**
|
1857
|
+
* The maximum number of results to return per each request.
|
1858
|
+
*/
|
1859
|
+
MaxResults?: MaxResults;
|
1860
|
+
}
|
1861
|
+
export interface DescribeRegistrationTypeDefinitionsResult {
|
1862
|
+
/**
|
1863
|
+
* The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
|
1864
|
+
*/
|
1865
|
+
RegistrationTypeDefinitions: RegistrationTypeDefinitionList;
|
1866
|
+
/**
|
1867
|
+
* The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
|
1868
|
+
*/
|
1869
|
+
NextToken?: NextToken;
|
1870
|
+
}
|
1871
|
+
export interface DescribeRegistrationVersionsRequest {
|
1872
|
+
/**
|
1873
|
+
* The unique identifier for the registration.
|
1874
|
+
*/
|
1875
|
+
RegistrationId: RegistrationIdOrArn;
|
1876
|
+
/**
|
1877
|
+
* An array of registration version numbers.
|
1878
|
+
*/
|
1879
|
+
VersionNumbers?: RegistrationVersionNumberList;
|
1880
|
+
/**
|
1881
|
+
* An array of RegistrationVersionFilter objects to filter the results.
|
1882
|
+
*/
|
1883
|
+
Filters?: RegistrationVersionFilterList;
|
1884
|
+
/**
|
1885
|
+
* The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
|
1886
|
+
*/
|
1887
|
+
NextToken?: NextToken;
|
1888
|
+
/**
|
1889
|
+
* The maximum number of results to return per each request.
|
1890
|
+
*/
|
1891
|
+
MaxResults?: MaxResults;
|
1892
|
+
}
|
1893
|
+
export interface DescribeRegistrationVersionsResult {
|
1894
|
+
/**
|
1895
|
+
* The Amazon Resource Name (ARN) for the registration.
|
1896
|
+
*/
|
1897
|
+
RegistrationArn: String;
|
1898
|
+
/**
|
1899
|
+
* The unique identifier for the registration.
|
1900
|
+
*/
|
1901
|
+
RegistrationId: String;
|
1902
|
+
/**
|
1903
|
+
* An array of RegistrationVersions objects.
|
1904
|
+
*/
|
1905
|
+
RegistrationVersions: RegistrationVersionInformationList;
|
1906
|
+
/**
|
1907
|
+
* The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
|
1908
|
+
*/
|
1909
|
+
NextToken?: NextToken;
|
1910
|
+
}
|
1911
|
+
export interface DescribeRegistrationsRequest {
|
1912
|
+
/**
|
1913
|
+
* An array of unique identifiers for each registration.
|
1914
|
+
*/
|
1915
|
+
RegistrationIds?: RegistrationIdList;
|
1916
|
+
/**
|
1917
|
+
* An array of RegistrationFilter objects to filter the results.
|
1918
|
+
*/
|
1919
|
+
Filters?: RegistrationFilterList;
|
1920
|
+
/**
|
1921
|
+
* The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
|
1922
|
+
*/
|
1923
|
+
NextToken?: NextToken;
|
1924
|
+
/**
|
1925
|
+
* The maximum number of results to return per each request.
|
1926
|
+
*/
|
1927
|
+
MaxResults?: MaxResults;
|
1928
|
+
}
|
1929
|
+
export interface DescribeRegistrationsResult {
|
1930
|
+
/**
|
1931
|
+
* An array of RegistrationInformation objects.
|
1932
|
+
*/
|
1933
|
+
Registrations: RegistrationInformationList;
|
1934
|
+
/**
|
1935
|
+
* The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
|
1936
|
+
*/
|
1937
|
+
NextToken?: NextToken;
|
1938
|
+
}
|
1143
1939
|
export interface DescribeSenderIdsRequest {
|
1144
1940
|
/**
|
1145
1941
|
* An array of SenderIdAndCountry objects to search for.
|
@@ -1188,9 +1984,42 @@ declare namespace PinpointSMSVoiceV2 {
|
|
1188
1984
|
*/
|
1189
1985
|
NextToken?: NextToken;
|
1190
1986
|
}
|
1987
|
+
export interface DescribeVerifiedDestinationNumbersRequest {
|
1988
|
+
/**
|
1989
|
+
* An array of VerifiedDestinationNumberid to retreive.
|
1990
|
+
*/
|
1991
|
+
VerifiedDestinationNumberIds?: VerifiedDestinationNumberIdList;
|
1992
|
+
/**
|
1993
|
+
* An array of verified destination phone number, in E.164 format.
|
1994
|
+
*/
|
1995
|
+
DestinationPhoneNumbers?: DestinationPhoneNumberList;
|
1996
|
+
/**
|
1997
|
+
* An array of VerifiedDestinationNumberFilter objects to filter the results.
|
1998
|
+
*/
|
1999
|
+
Filters?: VerifiedDestinationNumberFilterList;
|
2000
|
+
/**
|
2001
|
+
* The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
|
2002
|
+
*/
|
2003
|
+
NextToken?: NextToken;
|
2004
|
+
/**
|
2005
|
+
* The maximum number of results to return per each request.
|
2006
|
+
*/
|
2007
|
+
MaxResults?: MaxResults;
|
2008
|
+
}
|
2009
|
+
export interface DescribeVerifiedDestinationNumbersResult {
|
2010
|
+
/**
|
2011
|
+
* An array of VerifiedDestinationNumberInformation objects
|
2012
|
+
*/
|
2013
|
+
VerifiedDestinationNumbers: VerifiedDestinationNumberInformationList;
|
2014
|
+
/**
|
2015
|
+
* The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
|
2016
|
+
*/
|
2017
|
+
NextToken?: NextToken;
|
2018
|
+
}
|
1191
2019
|
export type DestinationCountryParameterKey = "IN_TEMPLATE_ID"|"IN_ENTITY_ID"|string;
|
1192
2020
|
export type DestinationCountryParameterValue = string;
|
1193
2021
|
export type DestinationCountryParameters = {[key: string]: DestinationCountryParameterValue};
|
2022
|
+
export type DestinationPhoneNumberList = PhoneNumber[];
|
1194
2023
|
export interface DisassociateOriginationIdentityRequest {
|
1195
2024
|
/**
|
1196
2025
|
* The unique identifier for the pool to disassociate with the origination identity. This value can be either the PoolId or PoolArn.
|
@@ -1231,6 +2060,34 @@ declare namespace PinpointSMSVoiceV2 {
|
|
1231
2060
|
*/
|
1232
2061
|
IsoCountryCode?: IsoCountryCode;
|
1233
2062
|
}
|
2063
|
+
export interface DiscardRegistrationVersionRequest {
|
2064
|
+
/**
|
2065
|
+
* The unique identifier for the registration.
|
2066
|
+
*/
|
2067
|
+
RegistrationId: RegistrationIdOrArn;
|
2068
|
+
}
|
2069
|
+
export interface DiscardRegistrationVersionResult {
|
2070
|
+
/**
|
2071
|
+
* The Amazon Resource Name (ARN) for the registration.
|
2072
|
+
*/
|
2073
|
+
RegistrationArn: String;
|
2074
|
+
/**
|
2075
|
+
* The unique identifier for the registration.
|
2076
|
+
*/
|
2077
|
+
RegistrationId: String;
|
2078
|
+
/**
|
2079
|
+
* The version number of the registration.
|
2080
|
+
*/
|
2081
|
+
VersionNumber: RegistrationVersionNumber;
|
2082
|
+
/**
|
2083
|
+
* The status of the registration version. DRAFT: The initial status of a registration version after it’s created. SUBMITTED: Your registration has been submitted. REVIEWING: Your registration has been accepted and is being reviewed. APPROVED: Your registration has been approved. DISCARDED: You've abandon this version of their registration to start over with a new version. DENIED: You must fix your registration and resubmit it. REVOKED: Your previously approved registration has been revoked. ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.
|
2084
|
+
*/
|
2085
|
+
RegistrationVersionStatus: RegistrationVersionStatus;
|
2086
|
+
/**
|
2087
|
+
* The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.
|
2088
|
+
*/
|
2089
|
+
RegistrationVersionStatusHistory: RegistrationVersionStatusHistory;
|
2090
|
+
}
|
1234
2091
|
export interface EventDestination {
|
1235
2092
|
/**
|
1236
2093
|
* The name of the EventDestination.
|
@@ -1241,7 +2098,7 @@ declare namespace PinpointSMSVoiceV2 {
|
|
1241
2098
|
*/
|
1242
2099
|
Enabled: Boolean;
|
1243
2100
|
/**
|
1244
|
-
* An array of event types that determine which events to log.
|
2101
|
+
* An array of event types that determine which events to log. The TEXT_SENT event type is not supported.
|
1245
2102
|
*/
|
1246
2103
|
MatchingEventTypes: EventTypeList;
|
1247
2104
|
/**
|
@@ -1261,9 +2118,14 @@ declare namespace PinpointSMSVoiceV2 {
|
|
1261
2118
|
export type EventDestinationName = string;
|
1262
2119
|
export type EventType = "ALL"|"TEXT_ALL"|"TEXT_SENT"|"TEXT_PENDING"|"TEXT_QUEUED"|"TEXT_SUCCESSFUL"|"TEXT_DELIVERED"|"TEXT_INVALID"|"TEXT_INVALID_MESSAGE"|"TEXT_UNREACHABLE"|"TEXT_CARRIER_UNREACHABLE"|"TEXT_BLOCKED"|"TEXT_CARRIER_BLOCKED"|"TEXT_SPAM"|"TEXT_UNKNOWN"|"TEXT_TTL_EXPIRED"|"VOICE_ALL"|"VOICE_INITIATED"|"VOICE_RINGING"|"VOICE_ANSWERED"|"VOICE_COMPLETED"|"VOICE_BUSY"|"VOICE_NO_ANSWER"|"VOICE_FAILED"|"VOICE_TTL_EXPIRED"|string;
|
1263
2120
|
export type EventTypeList = EventType[];
|
2121
|
+
export type FieldPath = string;
|
2122
|
+
export type FieldPathList = FieldPath[];
|
2123
|
+
export type FieldRequirement = "REQUIRED"|"CONDITIONAL"|"OPTIONAL"|string;
|
2124
|
+
export type FieldType = "SELECT"|"TEXT"|"ATTACHMENT"|string;
|
1264
2125
|
export type FilterValue = string;
|
1265
2126
|
export type FilterValueList = FilterValue[];
|
1266
2127
|
export type IamRoleArn = string;
|
2128
|
+
export type Integer = number;
|
1267
2129
|
export type IsoCountryCode = string;
|
1268
2130
|
export type Keyword = string;
|
1269
2131
|
export type KeywordAction = "AUTOMATIC_RESPONSE"|"OPT_OUT"|"OPT_IN"|string;
|
@@ -1302,19 +2164,56 @@ declare namespace PinpointSMSVoiceV2 {
|
|
1302
2164
|
*/
|
1303
2165
|
IamRoleArn: IamRoleArn;
|
1304
2166
|
/**
|
1305
|
-
* The Amazon Resource Name (ARN) of the delivery stream.
|
2167
|
+
* The Amazon Resource Name (ARN) of the delivery stream.
|
2168
|
+
*/
|
2169
|
+
DeliveryStreamArn: DeliveryStreamArn;
|
2170
|
+
}
|
2171
|
+
export type LanguageCode = "DE_DE"|"EN_GB"|"EN_US"|"ES_419"|"ES_ES"|"FR_CA"|"FR_FR"|"IT_IT"|"JA_JP"|"KO_KR"|"PT_BR"|"ZH_CN"|"ZH_TW"|string;
|
2172
|
+
export interface ListPoolOriginationIdentitiesRequest {
|
2173
|
+
/**
|
2174
|
+
* The unique identifier for the pool. This value can be either the PoolId or PoolArn.
|
2175
|
+
*/
|
2176
|
+
PoolId: PoolIdOrArn;
|
2177
|
+
/**
|
2178
|
+
* An array of PoolOriginationIdentitiesFilter objects to filter the results..
|
2179
|
+
*/
|
2180
|
+
Filters?: PoolOriginationIdentitiesFilterList;
|
2181
|
+
/**
|
2182
|
+
* The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
|
2183
|
+
*/
|
2184
|
+
NextToken?: NextToken;
|
2185
|
+
/**
|
2186
|
+
* The maximum number of results to return per each request.
|
2187
|
+
*/
|
2188
|
+
MaxResults?: MaxResults;
|
2189
|
+
}
|
2190
|
+
export interface ListPoolOriginationIdentitiesResult {
|
2191
|
+
/**
|
2192
|
+
* The Amazon Resource Name (ARN) for the pool.
|
2193
|
+
*/
|
2194
|
+
PoolArn?: String;
|
2195
|
+
/**
|
2196
|
+
* The unique PoolId of the pool.
|
2197
|
+
*/
|
2198
|
+
PoolId?: String;
|
2199
|
+
/**
|
2200
|
+
* An array of any OriginationIdentityMetadata objects.
|
2201
|
+
*/
|
2202
|
+
OriginationIdentities?: OriginationIdentityMetadataList;
|
2203
|
+
/**
|
2204
|
+
* The token to be used for the next set of paginated results. If this field is empty then there are no more results.
|
1306
2205
|
*/
|
1307
|
-
|
2206
|
+
NextToken?: NextToken;
|
1308
2207
|
}
|
1309
|
-
export interface
|
2208
|
+
export interface ListRegistrationAssociationsRequest {
|
1310
2209
|
/**
|
1311
|
-
* The unique identifier for the
|
2210
|
+
* The unique identifier for the registration.
|
1312
2211
|
*/
|
1313
|
-
|
2212
|
+
RegistrationId: RegistrationIdOrArn;
|
1314
2213
|
/**
|
1315
|
-
* An array of
|
2214
|
+
* An array of RegistrationAssociationFilter to apply to the results that are returned.
|
1316
2215
|
*/
|
1317
|
-
Filters?:
|
2216
|
+
Filters?: RegistrationAssociationFilterList;
|
1318
2217
|
/**
|
1319
2218
|
* The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
|
1320
2219
|
*/
|
@@ -1324,21 +2223,25 @@ declare namespace PinpointSMSVoiceV2 {
|
|
1324
2223
|
*/
|
1325
2224
|
MaxResults?: MaxResults;
|
1326
2225
|
}
|
1327
|
-
export interface
|
2226
|
+
export interface ListRegistrationAssociationsResult {
|
1328
2227
|
/**
|
1329
|
-
* The Amazon Resource Name (ARN) for the
|
2228
|
+
* The Amazon Resource Name (ARN) for the registration.
|
1330
2229
|
*/
|
1331
|
-
|
2230
|
+
RegistrationArn: String;
|
1332
2231
|
/**
|
1333
|
-
* The unique
|
2232
|
+
* The unique identifier for the registration.
|
1334
2233
|
*/
|
1335
|
-
|
2234
|
+
RegistrationId: String;
|
1336
2235
|
/**
|
1337
|
-
*
|
2236
|
+
* The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
|
1338
2237
|
*/
|
1339
|
-
|
2238
|
+
RegistrationType: RegistrationType;
|
1340
2239
|
/**
|
1341
|
-
*
|
2240
|
+
* An array of RegistrationAssociationMetadata objects.
|
2241
|
+
*/
|
2242
|
+
RegistrationAssociations: RegistrationAssociationMetadataList;
|
2243
|
+
/**
|
2244
|
+
* The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
|
1342
2245
|
*/
|
1343
2246
|
NextToken?: NextToken;
|
1344
2247
|
}
|
@@ -1369,7 +2272,7 @@ declare namespace PinpointSMSVoiceV2 {
|
|
1369
2272
|
export type NumberCapability = "SMS"|"VOICE"|string;
|
1370
2273
|
export type NumberCapabilityList = NumberCapability[];
|
1371
2274
|
export type NumberStatus = "PENDING"|"ACTIVE"|"ASSOCIATING"|"DISASSOCIATING"|"DELETED"|string;
|
1372
|
-
export type NumberType = "SHORT_CODE"|"LONG_CODE"|"TOLL_FREE"|"TEN_DLC"|string;
|
2275
|
+
export type NumberType = "SHORT_CODE"|"LONG_CODE"|"TOLL_FREE"|"TEN_DLC"|"SIMULATOR"|string;
|
1373
2276
|
export interface OptOutListInformation {
|
1374
2277
|
/**
|
1375
2278
|
* The Amazon Resource Name (ARN) of the OptOutList.
|
@@ -1433,6 +2336,10 @@ declare namespace PinpointSMSVoiceV2 {
|
|
1433
2336
|
* Describes if the origination identity can be used for text messages, voice calls or both.
|
1434
2337
|
*/
|
1435
2338
|
NumberCapabilities: NumberCapabilityList;
|
2339
|
+
/**
|
2340
|
+
* The phone number in E.164 format.
|
2341
|
+
*/
|
2342
|
+
PhoneNumber?: PhoneNumber;
|
1436
2343
|
}
|
1437
2344
|
export type OriginationIdentityMetadataList = OriginationIdentityMetadata[];
|
1438
2345
|
export type PhoneNumber = string;
|
@@ -1447,7 +2354,7 @@ declare namespace PinpointSMSVoiceV2 {
|
|
1447
2354
|
Values: FilterValueList;
|
1448
2355
|
}
|
1449
2356
|
export type PhoneNumberFilterList = PhoneNumberFilter[];
|
1450
|
-
export type PhoneNumberFilterName = "status"|"iso-country-code"|"message-type"|"number-capability"|"number-type"|"two-way-enabled"|"self-managed-opt-outs-enabled"|"opt-out-list-name"|"deletion-protection-enabled"|string;
|
2357
|
+
export type PhoneNumberFilterName = "status"|"iso-country-code"|"message-type"|"number-capability"|"number-type"|"two-way-enabled"|"self-managed-opt-outs-enabled"|"opt-out-list-name"|"deletion-protection-enabled"|"two-way-channel-arn"|string;
|
1451
2358
|
export type PhoneNumberIdList = PhoneNumberIdOrArn[];
|
1452
2359
|
export type PhoneNumberIdOrArn = string;
|
1453
2360
|
export interface PhoneNumberInformation {
|
@@ -1495,6 +2402,10 @@ declare namespace PinpointSMSVoiceV2 {
|
|
1495
2402
|
* The Amazon Resource Name (ARN) of the two way channel.
|
1496
2403
|
*/
|
1497
2404
|
TwoWayChannelArn?: TwoWayChannelArn;
|
2405
|
+
/**
|
2406
|
+
* An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
|
2407
|
+
*/
|
2408
|
+
TwoWayChannelRole?: IamRoleArn;
|
1498
2409
|
/**
|
1499
2410
|
* When set to false an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out request. For more information see Self-managed opt-outs
|
1500
2411
|
*/
|
@@ -1511,6 +2422,10 @@ declare namespace PinpointSMSVoiceV2 {
|
|
1511
2422
|
* The unique identifier of the pool associated with the phone number.
|
1512
2423
|
*/
|
1513
2424
|
PoolId?: String;
|
2425
|
+
/**
|
2426
|
+
* The unique identifier for the registration.
|
2427
|
+
*/
|
2428
|
+
RegistrationId?: String;
|
1514
2429
|
/**
|
1515
2430
|
* The time when the phone number was created, in UNIX epoch time format.
|
1516
2431
|
*/
|
@@ -1530,7 +2445,7 @@ declare namespace PinpointSMSVoiceV2 {
|
|
1530
2445
|
Values: FilterValueList;
|
1531
2446
|
}
|
1532
2447
|
export type PoolFilterList = PoolFilter[];
|
1533
|
-
export type PoolFilterName = "status"|"message-type"|"two-way-enabled"|"self-managed-opt-outs-enabled"|"opt-out-list-name"|"shared-routes-enabled"|"deletion-protection-enabled"|string;
|
2448
|
+
export type PoolFilterName = "status"|"message-type"|"two-way-enabled"|"self-managed-opt-outs-enabled"|"opt-out-list-name"|"shared-routes-enabled"|"deletion-protection-enabled"|"two-way-channel-arn"|string;
|
1534
2449
|
export type PoolIdList = PoolIdOrArn[];
|
1535
2450
|
export type PoolIdOrArn = string;
|
1536
2451
|
export interface PoolInformation {
|
@@ -1558,6 +2473,10 @@ declare namespace PinpointSMSVoiceV2 {
|
|
1558
2473
|
* The Amazon Resource Name (ARN) of the two way channel.
|
1559
2474
|
*/
|
1560
2475
|
TwoWayChannelArn?: TwoWayChannelArn;
|
2476
|
+
/**
|
2477
|
+
* An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
|
2478
|
+
*/
|
2479
|
+
TwoWayChannelRole?: IamRoleArn;
|
1561
2480
|
/**
|
1562
2481
|
* When set to false, an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests. For more information see Self-managed opt-outs
|
1563
2482
|
*/
|
@@ -1605,11 +2524,11 @@ declare namespace PinpointSMSVoiceV2 {
|
|
1605
2524
|
*/
|
1606
2525
|
Keyword: Keyword;
|
1607
2526
|
/**
|
1608
|
-
* The message associated with the keyword.
|
2527
|
+
* The message associated with the keyword.
|
1609
2528
|
*/
|
1610
2529
|
KeywordMessage: KeywordMessage;
|
1611
2530
|
/**
|
1612
|
-
* The action to perform for the new keyword when it is received.
|
2531
|
+
* The action to perform for the new keyword when it is received. AUTOMATIC_RESPONSE: A message is sent to the recipient. OPT_OUT: Keeps the recipient from receiving future messages. OPT_IN: The recipient wants to receive future messages.
|
1613
2532
|
*/
|
1614
2533
|
KeywordAction?: KeywordAction;
|
1615
2534
|
}
|
@@ -1661,13 +2580,455 @@ declare namespace PinpointSMSVoiceV2 {
|
|
1661
2580
|
/**
|
1662
2581
|
* The time that the phone number was added to the OptOutList, in UNIX epoch time format.
|
1663
2582
|
*/
|
1664
|
-
OptedOutTimestamp?: Timestamp;
|
2583
|
+
OptedOutTimestamp?: Timestamp;
|
2584
|
+
/**
|
2585
|
+
* This is true if it was the end user who requested their phone number be removed.
|
2586
|
+
*/
|
2587
|
+
EndUserOptedOut?: PrimitiveBoolean;
|
2588
|
+
}
|
2589
|
+
export interface PutRegistrationFieldValueRequest {
|
2590
|
+
/**
|
2591
|
+
* The unique identifier for the registration.
|
2592
|
+
*/
|
2593
|
+
RegistrationId: RegistrationIdOrArn;
|
2594
|
+
/**
|
2595
|
+
* The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
|
2596
|
+
*/
|
2597
|
+
FieldPath: FieldPath;
|
2598
|
+
/**
|
2599
|
+
* An array of values for the form field.
|
2600
|
+
*/
|
2601
|
+
SelectChoices?: SelectChoiceList;
|
2602
|
+
/**
|
2603
|
+
* The text data for a free form field.
|
2604
|
+
*/
|
2605
|
+
TextValue?: TextValue;
|
2606
|
+
/**
|
2607
|
+
* The unique identifier for the registration attachment.
|
2608
|
+
*/
|
2609
|
+
RegistrationAttachmentId?: RegistrationAttachmentIdOrArn;
|
2610
|
+
}
|
2611
|
+
export interface PutRegistrationFieldValueResult {
|
2612
|
+
/**
|
2613
|
+
* The Amazon Resource Name (ARN) for the registration.
|
2614
|
+
*/
|
2615
|
+
RegistrationArn: String;
|
2616
|
+
/**
|
2617
|
+
* The unique identifier for the registration.
|
2618
|
+
*/
|
2619
|
+
RegistrationId: String;
|
2620
|
+
/**
|
2621
|
+
* The version number of the registration.
|
2622
|
+
*/
|
2623
|
+
VersionNumber: RegistrationVersionNumber;
|
2624
|
+
/**
|
2625
|
+
* The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
|
2626
|
+
*/
|
2627
|
+
FieldPath: FieldPath;
|
2628
|
+
/**
|
2629
|
+
* An array of values for the form field.
|
2630
|
+
*/
|
2631
|
+
SelectChoices?: SelectChoiceList;
|
2632
|
+
/**
|
2633
|
+
* The text data for a free form field.
|
2634
|
+
*/
|
2635
|
+
TextValue?: TextValue;
|
2636
|
+
/**
|
2637
|
+
* The unique identifier for the registration attachment.
|
2638
|
+
*/
|
2639
|
+
RegistrationAttachmentId?: String;
|
2640
|
+
}
|
2641
|
+
export type RegistrationAssociationBehavior = "ASSOCIATE_BEFORE_SUBMIT"|"ASSOCIATE_ON_APPROVAL"|"ASSOCIATE_AFTER_COMPLETE"|string;
|
2642
|
+
export interface RegistrationAssociationFilter {
|
2643
|
+
/**
|
2644
|
+
* The name of the attribute to filter on.
|
2645
|
+
*/
|
2646
|
+
Name: RegistrationAssociationFilterName;
|
2647
|
+
/**
|
2648
|
+
* An array of values to filter for.
|
2649
|
+
*/
|
2650
|
+
Values: FilterValueList;
|
2651
|
+
}
|
2652
|
+
export type RegistrationAssociationFilterList = RegistrationAssociationFilter[];
|
2653
|
+
export type RegistrationAssociationFilterName = "resource-type"|"iso-country-code"|string;
|
2654
|
+
export interface RegistrationAssociationMetadata {
|
2655
|
+
/**
|
2656
|
+
* The Amazon Resource Name (ARN) of the origination identity that is associated with the registration.
|
2657
|
+
*/
|
2658
|
+
ResourceArn: String;
|
2659
|
+
/**
|
2660
|
+
* The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.
|
2661
|
+
*/
|
2662
|
+
ResourceId: String;
|
2663
|
+
/**
|
2664
|
+
* The origination identity type.
|
2665
|
+
*/
|
2666
|
+
ResourceType: String;
|
2667
|
+
/**
|
2668
|
+
* The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
|
2669
|
+
*/
|
2670
|
+
IsoCountryCode?: IsoCountryCode;
|
2671
|
+
/**
|
2672
|
+
* The phone number associated with the registration in E.164 format.
|
2673
|
+
*/
|
2674
|
+
PhoneNumber?: PhoneNumber;
|
2675
|
+
}
|
2676
|
+
export type RegistrationAssociationMetadataList = RegistrationAssociationMetadata[];
|
2677
|
+
export interface RegistrationAttachmentFilter {
|
2678
|
+
/**
|
2679
|
+
* The name of the attribute to filter on.
|
2680
|
+
*/
|
2681
|
+
Name: RegistrationAttachmentFilterName;
|
2682
|
+
/**
|
2683
|
+
* An array of values to filter on.
|
2684
|
+
*/
|
2685
|
+
Values: FilterValueList;
|
2686
|
+
}
|
2687
|
+
export type RegistrationAttachmentFilterList = RegistrationAttachmentFilter[];
|
2688
|
+
export type RegistrationAttachmentFilterName = "attachment-status"|string;
|
2689
|
+
export type RegistrationAttachmentIdList = RegistrationIdOrArn[];
|
2690
|
+
export type RegistrationAttachmentIdOrArn = string;
|
2691
|
+
export interface RegistrationAttachmentsInformation {
|
2692
|
+
/**
|
2693
|
+
* The Amazon Resource Name (ARN) for the registration attachment.
|
2694
|
+
*/
|
2695
|
+
RegistrationAttachmentArn: String;
|
2696
|
+
/**
|
2697
|
+
* The unique identifier for the registration attachment.
|
2698
|
+
*/
|
2699
|
+
RegistrationAttachmentId: String;
|
2700
|
+
/**
|
2701
|
+
* The status of the registration attachment. UPLOAD_IN_PROGRESS The attachment is being uploaded. UPLOAD_COMPLETE The attachment has been uploaded. UPLOAD_FAILED The attachment failed to uploaded. DELETED The attachment has been deleted..
|
2702
|
+
*/
|
2703
|
+
AttachmentStatus: AttachmentStatus;
|
2704
|
+
/**
|
2705
|
+
* A description of why the upload didn't successfully complete.
|
2706
|
+
*/
|
2707
|
+
AttachmentUploadErrorReason?: AttachmentUploadErrorReason;
|
2708
|
+
/**
|
2709
|
+
* The time when the registration attachment was created, in UNIX epoch time format.
|
2710
|
+
*/
|
2711
|
+
CreatedTimestamp: Timestamp;
|
2712
|
+
}
|
2713
|
+
export type RegistrationAttachmentsInformationList = RegistrationAttachmentsInformation[];
|
2714
|
+
export interface RegistrationDeniedReasonInformation {
|
2715
|
+
/**
|
2716
|
+
* The reason a registration was rejected.
|
2717
|
+
*/
|
2718
|
+
Reason: String;
|
2719
|
+
/**
|
2720
|
+
* A short description of the rejection reason.
|
2721
|
+
*/
|
2722
|
+
ShortDescription: String;
|
2723
|
+
/**
|
2724
|
+
* A long description of the rejection reason.
|
2725
|
+
*/
|
2726
|
+
LongDescription?: String;
|
2727
|
+
/**
|
2728
|
+
* The title of the document.
|
2729
|
+
*/
|
2730
|
+
DocumentationTitle?: String;
|
2731
|
+
/**
|
2732
|
+
* The link to the document.
|
2733
|
+
*/
|
2734
|
+
DocumentationLink?: String;
|
2735
|
+
}
|
2736
|
+
export type RegistrationDeniedReasonInformationList = RegistrationDeniedReasonInformation[];
|
2737
|
+
export type RegistrationDisassociationBehavior = "DISASSOCIATE_ALL_CLOSES_REGISTRATION"|"DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION"|"DELETE_REGISTRATION_DISASSOCIATES"|string;
|
2738
|
+
export interface RegistrationFieldDefinition {
|
2739
|
+
/**
|
2740
|
+
* The section path of the field.
|
2741
|
+
*/
|
2742
|
+
SectionPath: SectionPath;
|
2743
|
+
/**
|
2744
|
+
* The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
|
2745
|
+
*/
|
2746
|
+
FieldPath: FieldPath;
|
2747
|
+
/**
|
2748
|
+
* The type of field.
|
2749
|
+
*/
|
2750
|
+
FieldType: FieldType;
|
2751
|
+
/**
|
2752
|
+
* Specifies if the field for the registration form is required, conditional or optional.
|
2753
|
+
*/
|
2754
|
+
FieldRequirement: FieldRequirement;
|
2755
|
+
/**
|
2756
|
+
* The validation rules for a select field.
|
2757
|
+
*/
|
2758
|
+
SelectValidation?: SelectValidation;
|
2759
|
+
/**
|
2760
|
+
* The validation rules for a text field.
|
2761
|
+
*/
|
2762
|
+
TextValidation?: TextValidation;
|
2763
|
+
/**
|
2764
|
+
* An array of RegistrationFieldDisplayHints objects for the field.
|
2765
|
+
*/
|
2766
|
+
DisplayHints: RegistrationFieldDisplayHints;
|
2767
|
+
}
|
2768
|
+
export type RegistrationFieldDefinitionList = RegistrationFieldDefinition[];
|
2769
|
+
export interface RegistrationFieldDisplayHints {
|
2770
|
+
/**
|
2771
|
+
* The title of the display hint.
|
2772
|
+
*/
|
2773
|
+
Title: String;
|
2774
|
+
/**
|
2775
|
+
* A short description of the display hint.
|
2776
|
+
*/
|
2777
|
+
ShortDescription: String;
|
2778
|
+
/**
|
2779
|
+
* A full description of the display hint.
|
2780
|
+
*/
|
2781
|
+
LongDescription?: String;
|
2782
|
+
/**
|
2783
|
+
* The title of the document the display hint is associated with.
|
2784
|
+
*/
|
2785
|
+
DocumentationTitle?: String;
|
2786
|
+
/**
|
2787
|
+
* The link to the document the display hint is associated with.
|
2788
|
+
*/
|
2789
|
+
DocumentationLink?: String;
|
2790
|
+
/**
|
2791
|
+
* An array of SelectOptionDescription objects.
|
2792
|
+
*/
|
2793
|
+
SelectOptionDescriptions?: SelectOptionDescriptionsList;
|
2794
|
+
/**
|
2795
|
+
* The validation rules for the text field.
|
2796
|
+
*/
|
2797
|
+
TextValidationDescription?: String;
|
2798
|
+
/**
|
2799
|
+
* Example text of what the value of a field should contain.
|
2800
|
+
*/
|
2801
|
+
ExampleTextValue?: String;
|
2802
|
+
}
|
2803
|
+
export interface RegistrationFieldValueInformation {
|
2804
|
+
/**
|
2805
|
+
* The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
|
2806
|
+
*/
|
2807
|
+
FieldPath: FieldPath;
|
2808
|
+
/**
|
2809
|
+
* An array of values for the form field.
|
2810
|
+
*/
|
2811
|
+
SelectChoices?: SelectChoiceList;
|
2812
|
+
/**
|
2813
|
+
* The text data for a free form field.
|
2814
|
+
*/
|
2815
|
+
TextValue?: TextValue;
|
2816
|
+
/**
|
2817
|
+
* The unique identifier for the registration attachment.
|
2818
|
+
*/
|
2819
|
+
RegistrationAttachmentId?: RegistrationAttachmentIdOrArn;
|
2820
|
+
/**
|
2821
|
+
* A description of why the registration was denied.
|
2822
|
+
*/
|
2823
|
+
DeniedReason?: String;
|
2824
|
+
}
|
2825
|
+
export type RegistrationFieldValueInformationList = RegistrationFieldValueInformation[];
|
2826
|
+
export interface RegistrationFilter {
|
2827
|
+
/**
|
2828
|
+
* The name of the attribute to filter on.
|
2829
|
+
*/
|
2830
|
+
Name: RegistrationFilterName;
|
2831
|
+
/**
|
2832
|
+
* An array of values to filter on.
|
2833
|
+
*/
|
2834
|
+
Values: FilterValueList;
|
2835
|
+
}
|
2836
|
+
export type RegistrationFilterList = RegistrationFilter[];
|
2837
|
+
export type RegistrationFilterName = "registration-type"|"registration-status"|string;
|
2838
|
+
export type RegistrationIdList = RegistrationIdOrArn[];
|
2839
|
+
export type RegistrationIdOrArn = string;
|
2840
|
+
export interface RegistrationInformation {
|
2841
|
+
/**
|
2842
|
+
* The Amazon Resource Name (ARN) for the registration.
|
2843
|
+
*/
|
2844
|
+
RegistrationArn: String;
|
2845
|
+
/**
|
2846
|
+
* The unique identifier for the registration.
|
2847
|
+
*/
|
2848
|
+
RegistrationId: String;
|
2849
|
+
/**
|
2850
|
+
* The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
|
2851
|
+
*/
|
2852
|
+
RegistrationType: RegistrationType;
|
2853
|
+
/**
|
2854
|
+
* The status of the registration. CREATED: Your registration is created but not submitted. SUBMITTED: Your registration has been submitted and is awaiting review. REVIEWING: Your registration has been accepted and is being reviewed. PROVISIONING: Your registration has been approved and your origination identity is being created. COMPLETE: Your registration has been approved and and your origination identity has been created. REQUIRES_UPDATES: You must fix your registration and resubmit it. CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number. DELETED: The registration has been deleted.
|
2855
|
+
*/
|
2856
|
+
RegistrationStatus: RegistrationStatus;
|
2857
|
+
/**
|
2858
|
+
* The current version number of the registration.
|
2859
|
+
*/
|
2860
|
+
CurrentVersionNumber: RegistrationVersionNumber;
|
2861
|
+
/**
|
2862
|
+
* The version number of the registration that was approved.
|
2863
|
+
*/
|
2864
|
+
ApprovedVersionNumber?: RegistrationVersionNumber;
|
2865
|
+
/**
|
2866
|
+
* The latest version number of the registration that was denied.
|
2867
|
+
*/
|
2868
|
+
LatestDeniedVersionNumber?: RegistrationVersionNumber;
|
2869
|
+
/**
|
2870
|
+
* Metadata about a given registration which is specific to that registration type.
|
2871
|
+
*/
|
2872
|
+
AdditionalAttributes?: StringMap;
|
2873
|
+
/**
|
2874
|
+
* The time when the registration was created, in UNIX epoch time format.
|
2875
|
+
*/
|
2876
|
+
CreatedTimestamp: Timestamp;
|
2877
|
+
}
|
2878
|
+
export type RegistrationInformationList = RegistrationInformation[];
|
2879
|
+
export interface RegistrationSectionDefinition {
|
2880
|
+
/**
|
2881
|
+
* The path to the section of the registration.
|
2882
|
+
*/
|
2883
|
+
SectionPath: SectionPath;
|
2884
|
+
/**
|
2885
|
+
* The path to the section of the registration.
|
2886
|
+
*/
|
2887
|
+
DisplayHints: RegistrationSectionDisplayHints;
|
2888
|
+
}
|
2889
|
+
export type RegistrationSectionDefinitionList = RegistrationSectionDefinition[];
|
2890
|
+
export interface RegistrationSectionDisplayHints {
|
2891
|
+
/**
|
2892
|
+
* The title of the display hint.
|
2893
|
+
*/
|
2894
|
+
Title: String;
|
2895
|
+
/**
|
2896
|
+
* A short description of the display hint.
|
2897
|
+
*/
|
2898
|
+
ShortDescription: String;
|
2899
|
+
/**
|
2900
|
+
* A full description of the display hint.
|
2901
|
+
*/
|
2902
|
+
LongDescription?: String;
|
2903
|
+
/**
|
2904
|
+
* The title of the document the display hint is associated with.
|
2905
|
+
*/
|
2906
|
+
DocumentationTitle?: String;
|
2907
|
+
/**
|
2908
|
+
* The link to the document the display hint is associated with.
|
2909
|
+
*/
|
2910
|
+
DocumentationLink?: String;
|
2911
|
+
}
|
2912
|
+
export type RegistrationStatus = "CREATED"|"SUBMITTED"|"REVIEWING"|"PROVISIONING"|"COMPLETE"|"REQUIRES_UPDATES"|"CLOSED"|"DELETED"|string;
|
2913
|
+
export type RegistrationType = string;
|
2914
|
+
export interface RegistrationTypeDefinition {
|
2915
|
+
/**
|
2916
|
+
* The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
|
2917
|
+
*/
|
2918
|
+
RegistrationType: RegistrationType;
|
2919
|
+
/**
|
2920
|
+
* The supported association behavior for the registration type.
|
2921
|
+
*/
|
2922
|
+
SupportedAssociations?: SupportedAssociationList;
|
2923
|
+
/**
|
2924
|
+
* Provides help information on the registration.
|
2925
|
+
*/
|
2926
|
+
DisplayHints: RegistrationTypeDisplayHints;
|
2927
|
+
}
|
2928
|
+
export type RegistrationTypeDefinitionList = RegistrationTypeDefinition[];
|
2929
|
+
export interface RegistrationTypeDisplayHints {
|
2930
|
+
/**
|
2931
|
+
* The title of the display hint.
|
2932
|
+
*/
|
2933
|
+
Title: String;
|
2934
|
+
/**
|
2935
|
+
* A short description of the display hint.
|
2936
|
+
*/
|
2937
|
+
ShortDescription?: String;
|
2938
|
+
/**
|
2939
|
+
* A full description of the display hint.
|
2940
|
+
*/
|
2941
|
+
LongDescription?: String;
|
2942
|
+
/**
|
2943
|
+
* The title of the document the display hint is associated with.
|
2944
|
+
*/
|
2945
|
+
DocumentationTitle?: String;
|
2946
|
+
/**
|
2947
|
+
* The link to the document the display hint is associated with.
|
2948
|
+
*/
|
2949
|
+
DocumentationLink?: String;
|
2950
|
+
}
|
2951
|
+
export interface RegistrationTypeFilter {
|
2952
|
+
/**
|
2953
|
+
* The name of the attribute to filter on.
|
2954
|
+
*/
|
2955
|
+
Name: RegistrationTypeFilterName;
|
2956
|
+
/**
|
2957
|
+
* An array of values to filter on.
|
2958
|
+
*/
|
2959
|
+
Values: FilterValueList;
|
2960
|
+
}
|
2961
|
+
export type RegistrationTypeFilterList = RegistrationTypeFilter[];
|
2962
|
+
export type RegistrationTypeFilterName = "supported-association-resource-type"|"supported-association-iso-country-code"|string;
|
2963
|
+
export type RegistrationTypeList = RegistrationType[];
|
2964
|
+
export interface RegistrationVersionFilter {
|
2965
|
+
/**
|
2966
|
+
* The name of the attribute to filter on.
|
2967
|
+
*/
|
2968
|
+
Name: RegistrationVersionFilterName;
|
2969
|
+
/**
|
2970
|
+
* An array of values to filter on.
|
2971
|
+
*/
|
2972
|
+
Values: FilterValueList;
|
2973
|
+
}
|
2974
|
+
export type RegistrationVersionFilterList = RegistrationVersionFilter[];
|
2975
|
+
export type RegistrationVersionFilterName = "registration-version-status"|string;
|
2976
|
+
export interface RegistrationVersionInformation {
|
2977
|
+
/**
|
2978
|
+
* The version number of the registration.
|
2979
|
+
*/
|
2980
|
+
VersionNumber: RegistrationVersionNumber;
|
2981
|
+
/**
|
2982
|
+
* The status of the registration. DRAFT: The initial status of a registration version after it’s created. SUBMITTED: Your registration has been submitted. REVIEWING: Your registration has been accepted and is being reviewed. APPROVED: Your registration has been approved. DISCARDED: You've abandon this version of their registration to start over with a new version. DENIED: You must fix your registration and resubmit it. REVOKED: Your previously approved registration has been revoked. ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.
|
2983
|
+
*/
|
2984
|
+
RegistrationVersionStatus: RegistrationVersionStatus;
|
2985
|
+
/**
|
2986
|
+
* The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.
|
2987
|
+
*/
|
2988
|
+
RegistrationVersionStatusHistory: RegistrationVersionStatusHistory;
|
2989
|
+
/**
|
2990
|
+
* An array of RegistrationDeniedReasonInformation objects.
|
2991
|
+
*/
|
2992
|
+
DeniedReasons?: RegistrationDeniedReasonInformationList;
|
2993
|
+
}
|
2994
|
+
export type RegistrationVersionInformationList = RegistrationVersionInformation[];
|
2995
|
+
export type RegistrationVersionNumber = number;
|
2996
|
+
export type RegistrationVersionNumberList = RegistrationVersionNumber[];
|
2997
|
+
export type RegistrationVersionStatus = "DRAFT"|"SUBMITTED"|"REVIEWING"|"APPROVED"|"DISCARDED"|"DENIED"|"REVOKED"|"ARCHIVED"|string;
|
2998
|
+
export interface RegistrationVersionStatusHistory {
|
2999
|
+
/**
|
3000
|
+
* The time when the registration was in the draft state, in UNIX epoch time format.
|
3001
|
+
*/
|
3002
|
+
DraftTimestamp: Timestamp;
|
3003
|
+
/**
|
3004
|
+
* The time when the registration was in the submitted state, in UNIX epoch time format.
|
3005
|
+
*/
|
3006
|
+
SubmittedTimestamp?: Timestamp;
|
3007
|
+
/**
|
3008
|
+
* The time when the registration was in the reviewing state, in UNIX epoch time format.
|
3009
|
+
*/
|
3010
|
+
ReviewingTimestamp?: Timestamp;
|
3011
|
+
/**
|
3012
|
+
* The time when the registration was in the approved state, in UNIX epoch time format.
|
3013
|
+
*/
|
3014
|
+
ApprovedTimestamp?: Timestamp;
|
3015
|
+
/**
|
3016
|
+
* The time when the registration was in the discarded state, in UNIX epoch time format.
|
3017
|
+
*/
|
3018
|
+
DiscardedTimestamp?: Timestamp;
|
3019
|
+
/**
|
3020
|
+
* The time when the registration was in the denied state, in UNIX epoch time format.
|
3021
|
+
*/
|
3022
|
+
DeniedTimestamp?: Timestamp;
|
3023
|
+
/**
|
3024
|
+
* The time when the registration was in the revoked state, in UNIX epoch time format.
|
3025
|
+
*/
|
3026
|
+
RevokedTimestamp?: Timestamp;
|
1665
3027
|
/**
|
1666
|
-
*
|
3028
|
+
* The time when the registration was in the archived state, in UNIX epoch time format.
|
1667
3029
|
*/
|
1668
|
-
|
3030
|
+
ArchivedTimestamp?: Timestamp;
|
1669
3031
|
}
|
1670
|
-
export type RegistrationId = string;
|
1671
3032
|
export interface ReleasePhoneNumberRequest {
|
1672
3033
|
/**
|
1673
3034
|
* The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use DescribePhoneNumbers to get the values for PhoneNumberId and PhoneNumberArn.
|
@@ -1719,6 +3080,10 @@ declare namespace PinpointSMSVoiceV2 {
|
|
1719
3080
|
* The Amazon Resource Name (ARN) of the TwoWayChannel.
|
1720
3081
|
*/
|
1721
3082
|
TwoWayChannelArn?: TwoWayChannelArn;
|
3083
|
+
/**
|
3084
|
+
* An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
|
3085
|
+
*/
|
3086
|
+
TwoWayChannelRole?: IamRoleArn;
|
1722
3087
|
/**
|
1723
3088
|
* By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
|
1724
3089
|
*/
|
@@ -1727,11 +3092,55 @@ declare namespace PinpointSMSVoiceV2 {
|
|
1727
3092
|
* The name of the OptOutList that was associated with the phone number.
|
1728
3093
|
*/
|
1729
3094
|
OptOutListName?: OptOutListName;
|
3095
|
+
/**
|
3096
|
+
* The unique identifier for the registration.
|
3097
|
+
*/
|
3098
|
+
RegistrationId?: String;
|
1730
3099
|
/**
|
1731
3100
|
* The time when the phone number was created, in UNIX epoch time format.
|
1732
3101
|
*/
|
1733
3102
|
CreatedTimestamp?: Timestamp;
|
1734
3103
|
}
|
3104
|
+
export interface ReleaseSenderIdRequest {
|
3105
|
+
/**
|
3106
|
+
* The sender ID to release.
|
3107
|
+
*/
|
3108
|
+
SenderId: SenderIdOrArn;
|
3109
|
+
/**
|
3110
|
+
* The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
|
3111
|
+
*/
|
3112
|
+
IsoCountryCode: IsoCountryCode;
|
3113
|
+
}
|
3114
|
+
export interface ReleaseSenderIdResult {
|
3115
|
+
/**
|
3116
|
+
* The Amazon Resource Name (ARN) associated with the SenderId.
|
3117
|
+
*/
|
3118
|
+
SenderIdArn: String;
|
3119
|
+
/**
|
3120
|
+
* The sender ID that was released.
|
3121
|
+
*/
|
3122
|
+
SenderId: SenderId;
|
3123
|
+
/**
|
3124
|
+
* The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
|
3125
|
+
*/
|
3126
|
+
IsoCountryCode: IsoCountryCode;
|
3127
|
+
/**
|
3128
|
+
* The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
|
3129
|
+
*/
|
3130
|
+
MessageTypes: MessageTypeList;
|
3131
|
+
/**
|
3132
|
+
* The monthly price, in US dollars, to lease the sender ID.
|
3133
|
+
*/
|
3134
|
+
MonthlyLeasingPrice: String;
|
3135
|
+
/**
|
3136
|
+
* True if the sender ID is registered.
|
3137
|
+
*/
|
3138
|
+
Registered: PrimitiveBoolean;
|
3139
|
+
/**
|
3140
|
+
* The unique identifier for the registration.
|
3141
|
+
*/
|
3142
|
+
RegistrationId?: String;
|
3143
|
+
}
|
1735
3144
|
export interface RequestPhoneNumberRequest {
|
1736
3145
|
/**
|
1737
3146
|
* The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
|
@@ -1750,7 +3159,7 @@ declare namespace PinpointSMSVoiceV2 {
|
|
1750
3159
|
*/
|
1751
3160
|
NumberType: RequestableNumberType;
|
1752
3161
|
/**
|
1753
|
-
* The name of the OptOutList to associate with the phone number. You can use the
|
3162
|
+
* The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.
|
1754
3163
|
*/
|
1755
3164
|
OptOutListName?: OptOutListNameOrArn;
|
1756
3165
|
/**
|
@@ -1760,7 +3169,7 @@ declare namespace PinpointSMSVoiceV2 {
|
|
1760
3169
|
/**
|
1761
3170
|
* Use this field to attach your phone number for an external registration process.
|
1762
3171
|
*/
|
1763
|
-
RegistrationId?:
|
3172
|
+
RegistrationId?: RegistrationIdOrArn;
|
1764
3173
|
/**
|
1765
3174
|
* By default this is set to false. When set to true the phone number can't be deleted.
|
1766
3175
|
*/
|
@@ -1819,6 +3228,10 @@ declare namespace PinpointSMSVoiceV2 {
|
|
1819
3228
|
* The ARN used to identify the two way channel.
|
1820
3229
|
*/
|
1821
3230
|
TwoWayChannelArn?: TwoWayChannelArn;
|
3231
|
+
/**
|
3232
|
+
* An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
|
3233
|
+
*/
|
3234
|
+
TwoWayChannelRole?: IamRoleArn;
|
1822
3235
|
/**
|
1823
3236
|
* By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
|
1824
3237
|
*/
|
@@ -1835,6 +3248,10 @@ declare namespace PinpointSMSVoiceV2 {
|
|
1835
3248
|
* The unique identifier of the pool associated with the phone number
|
1836
3249
|
*/
|
1837
3250
|
PoolId?: String;
|
3251
|
+
/**
|
3252
|
+
* The unique identifier for the registration.
|
3253
|
+
*/
|
3254
|
+
RegistrationId?: String;
|
1838
3255
|
/**
|
1839
3256
|
* An array of key and value pair tags that are associated with the phone number.
|
1840
3257
|
*/
|
@@ -1844,7 +3261,137 @@ declare namespace PinpointSMSVoiceV2 {
|
|
1844
3261
|
*/
|
1845
3262
|
CreatedTimestamp?: Timestamp;
|
1846
3263
|
}
|
1847
|
-
export
|
3264
|
+
export interface RequestSenderIdRequest {
|
3265
|
+
/**
|
3266
|
+
* The sender ID string to request.
|
3267
|
+
*/
|
3268
|
+
SenderId: SenderId;
|
3269
|
+
/**
|
3270
|
+
* The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
|
3271
|
+
*/
|
3272
|
+
IsoCountryCode: IsoCountryCode;
|
3273
|
+
/**
|
3274
|
+
* The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
|
3275
|
+
*/
|
3276
|
+
MessageTypes?: MessageTypeList;
|
3277
|
+
/**
|
3278
|
+
* By default this is set to false. When set to true the sender ID can't be deleted.
|
3279
|
+
*/
|
3280
|
+
DeletionProtectionEnabled?: Boolean;
|
3281
|
+
/**
|
3282
|
+
* An array of tags (key and value pairs) to associate with the sender ID.
|
3283
|
+
*/
|
3284
|
+
Tags?: TagList;
|
3285
|
+
/**
|
3286
|
+
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
|
3287
|
+
*/
|
3288
|
+
ClientToken?: ClientToken;
|
3289
|
+
}
|
3290
|
+
export interface RequestSenderIdResult {
|
3291
|
+
/**
|
3292
|
+
* The Amazon Resource Name (ARN) associated with the SenderId.
|
3293
|
+
*/
|
3294
|
+
SenderIdArn: String;
|
3295
|
+
/**
|
3296
|
+
* The sender ID that was requested.
|
3297
|
+
*/
|
3298
|
+
SenderId: SenderId;
|
3299
|
+
/**
|
3300
|
+
* The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
|
3301
|
+
*/
|
3302
|
+
IsoCountryCode: IsoCountryCode;
|
3303
|
+
/**
|
3304
|
+
* The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
|
3305
|
+
*/
|
3306
|
+
MessageTypes: MessageTypeList;
|
3307
|
+
/**
|
3308
|
+
* The monthly price, in US dollars, to lease the sender ID.
|
3309
|
+
*/
|
3310
|
+
MonthlyLeasingPrice: String;
|
3311
|
+
/**
|
3312
|
+
* By default this is set to false. When set to true the sender ID can't be deleted.
|
3313
|
+
*/
|
3314
|
+
DeletionProtectionEnabled: PrimitiveBoolean;
|
3315
|
+
/**
|
3316
|
+
* True if the sender ID is registered.
|
3317
|
+
*/
|
3318
|
+
Registered: PrimitiveBoolean;
|
3319
|
+
/**
|
3320
|
+
* An array of tags (key and value pairs) to associate with the sender ID.
|
3321
|
+
*/
|
3322
|
+
Tags?: TagList;
|
3323
|
+
}
|
3324
|
+
export type RequestableNumberType = "LONG_CODE"|"TOLL_FREE"|"TEN_DLC"|"SIMULATOR"|string;
|
3325
|
+
export type ResourceIdOrArn = string;
|
3326
|
+
export type SectionPath = string;
|
3327
|
+
export type SectionPathList = SectionPath[];
|
3328
|
+
export type SelectChoice = string;
|
3329
|
+
export type SelectChoiceList = SelectChoice[];
|
3330
|
+
export interface SelectOptionDescription {
|
3331
|
+
/**
|
3332
|
+
* The value of the option.
|
3333
|
+
*/
|
3334
|
+
Option: String;
|
3335
|
+
/**
|
3336
|
+
* The title of the select option.
|
3337
|
+
*/
|
3338
|
+
Title?: String;
|
3339
|
+
/**
|
3340
|
+
* A description of the option meaning.
|
3341
|
+
*/
|
3342
|
+
Description?: String;
|
3343
|
+
}
|
3344
|
+
export type SelectOptionDescriptionsList = SelectOptionDescription[];
|
3345
|
+
export interface SelectValidation {
|
3346
|
+
/**
|
3347
|
+
* The minimum number of choices for the select.
|
3348
|
+
*/
|
3349
|
+
MinChoices: Integer;
|
3350
|
+
/**
|
3351
|
+
* The maximum number of choices for the select.
|
3352
|
+
*/
|
3353
|
+
MaxChoices: Integer;
|
3354
|
+
/**
|
3355
|
+
* An array of strings for the possible selection options.
|
3356
|
+
*/
|
3357
|
+
Options: StringList;
|
3358
|
+
}
|
3359
|
+
export interface SendDestinationNumberVerificationCodeRequest {
|
3360
|
+
/**
|
3361
|
+
* The unique identifier for the verified destination phone number.
|
3362
|
+
*/
|
3363
|
+
VerifiedDestinationNumberId: VerifiedDestinationNumberIdOrArn;
|
3364
|
+
/**
|
3365
|
+
* Choose to send the verification code as an SMS or voice message.
|
3366
|
+
*/
|
3367
|
+
VerificationChannel: VerificationChannel;
|
3368
|
+
/**
|
3369
|
+
* Choose the language to use for the message.
|
3370
|
+
*/
|
3371
|
+
LanguageCode?: LanguageCode;
|
3372
|
+
/**
|
3373
|
+
* The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
|
3374
|
+
*/
|
3375
|
+
OriginationIdentity?: VerificationMessageOriginationIdentity;
|
3376
|
+
/**
|
3377
|
+
* The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
|
3378
|
+
*/
|
3379
|
+
ConfigurationSetName?: ConfigurationSetNameOrArn;
|
3380
|
+
/**
|
3381
|
+
* You can specify custom data in this field. If you do, that data is logged to the event destination.
|
3382
|
+
*/
|
3383
|
+
Context?: ContextMap;
|
3384
|
+
/**
|
3385
|
+
* This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.
|
3386
|
+
*/
|
3387
|
+
DestinationCountryParameters?: DestinationCountryParameters;
|
3388
|
+
}
|
3389
|
+
export interface SendDestinationNumberVerificationCodeResult {
|
3390
|
+
/**
|
3391
|
+
* The unique identifier for the message.
|
3392
|
+
*/
|
3393
|
+
MessageId: String;
|
3394
|
+
}
|
1848
3395
|
export interface SendTextMessageRequest {
|
1849
3396
|
/**
|
1850
3397
|
* The destination phone number in E.164 format.
|
@@ -1859,7 +3406,7 @@ declare namespace PinpointSMSVoiceV2 {
|
|
1859
3406
|
*/
|
1860
3407
|
MessageBody?: TextMessageBody;
|
1861
3408
|
/**
|
1862
|
-
* The type of message. Valid values are
|
3409
|
+
* The type of message. Valid values are for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
|
1863
3410
|
*/
|
1864
3411
|
MessageType?: MessageType;
|
1865
3412
|
/**
|
@@ -1967,7 +3514,7 @@ declare namespace PinpointSMSVoiceV2 {
|
|
1967
3514
|
Values: FilterValueList;
|
1968
3515
|
}
|
1969
3516
|
export type SenderIdFilterList = SenderIdFilter[];
|
1970
|
-
export type SenderIdFilterName = "sender-id"|"iso-country-code"|"message-type"|string;
|
3517
|
+
export type SenderIdFilterName = "sender-id"|"iso-country-code"|"message-type"|"deletion-protection-enabled"|"registered"|string;
|
1971
3518
|
export interface SenderIdInformation {
|
1972
3519
|
/**
|
1973
3520
|
* The Amazon Resource Name (ARN) associated with the SenderId.
|
@@ -1989,6 +3536,18 @@ declare namespace PinpointSMSVoiceV2 {
|
|
1989
3536
|
* The monthly leasing price, in US dollars.
|
1990
3537
|
*/
|
1991
3538
|
MonthlyLeasingPrice: String;
|
3539
|
+
/**
|
3540
|
+
* By default this is set to false. When set to true the sender ID can't be deleted.
|
3541
|
+
*/
|
3542
|
+
DeletionProtectionEnabled: PrimitiveBoolean;
|
3543
|
+
/**
|
3544
|
+
* True if the sender ID is registered.
|
3545
|
+
*/
|
3546
|
+
Registered: PrimitiveBoolean;
|
3547
|
+
/**
|
3548
|
+
* The unique identifier for the registration.
|
3549
|
+
*/
|
3550
|
+
RegistrationId?: String;
|
1992
3551
|
}
|
1993
3552
|
export type SenderIdInformationList = SenderIdInformation[];
|
1994
3553
|
export type SenderIdList = SenderIdAndCountry[];
|
@@ -2093,6 +3652,55 @@ declare namespace PinpointSMSVoiceV2 {
|
|
2093
3652
|
export type SpendLimitList = SpendLimit[];
|
2094
3653
|
export type SpendLimitName = "TEXT_MESSAGE_MONTHLY_SPEND_LIMIT"|"VOICE_MESSAGE_MONTHLY_SPEND_LIMIT"|string;
|
2095
3654
|
export type String = string;
|
3655
|
+
export type StringList = String[];
|
3656
|
+
export type StringMap = {[key: string]: String};
|
3657
|
+
export interface SubmitRegistrationVersionRequest {
|
3658
|
+
/**
|
3659
|
+
* The unique identifier for the registration.
|
3660
|
+
*/
|
3661
|
+
RegistrationId: RegistrationIdOrArn;
|
3662
|
+
}
|
3663
|
+
export interface SubmitRegistrationVersionResult {
|
3664
|
+
/**
|
3665
|
+
* The Amazon Resource Name (ARN) for the registration.
|
3666
|
+
*/
|
3667
|
+
RegistrationArn: String;
|
3668
|
+
/**
|
3669
|
+
* The unique identifier for the registration.
|
3670
|
+
*/
|
3671
|
+
RegistrationId: String;
|
3672
|
+
/**
|
3673
|
+
* The version number of the registration.
|
3674
|
+
*/
|
3675
|
+
VersionNumber: RegistrationVersionNumber;
|
3676
|
+
/**
|
3677
|
+
* The status of the registration version. DRAFT: The initial status of a registration version after it’s created. SUBMITTED: Your registration has been submitted. REVIEWING: Your registration has been accepted and is being reviewed. APPROVED: Your registration has been approved. DISCARDED: You've abandon this version of their registration to start over with a new version. DENIED: You must fix your registration and resubmit it. REVOKED: Your previously approved registration has been revoked. ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.
|
3678
|
+
*/
|
3679
|
+
RegistrationVersionStatus: RegistrationVersionStatus;
|
3680
|
+
/**
|
3681
|
+
* The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.
|
3682
|
+
*/
|
3683
|
+
RegistrationVersionStatusHistory: RegistrationVersionStatusHistory;
|
3684
|
+
}
|
3685
|
+
export interface SupportedAssociation {
|
3686
|
+
/**
|
3687
|
+
* Defines the behavior of when an origination identity and registration can be associated with each other.
|
3688
|
+
*/
|
3689
|
+
ResourceType: String;
|
3690
|
+
/**
|
3691
|
+
* The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
|
3692
|
+
*/
|
3693
|
+
IsoCountryCode?: IsoCountryCode;
|
3694
|
+
/**
|
3695
|
+
* The association behavior. ASSOCIATE_BEFORE_SUBMIT The origination identity has to be supplied when creating a registration. ASSOCIATE_ON_APPROVAL This applies to all short code registrations. The short code will be automatically provisioned once the registration is approved. ASSOCIATE_AFTER_COMPLETE This applies to phone number registrations when you must complete a registration first, then associate one or more phone numbers later. For example 10DLC campaigns and long codes.
|
3696
|
+
*/
|
3697
|
+
AssociationBehavior: RegistrationAssociationBehavior;
|
3698
|
+
/**
|
3699
|
+
* The disassociation behavior. DISASSOCIATE_ALL_CLOSES_REGISTRATION All origination identities must be disassociated from the registration before the registration can be closed. DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION All origination identities must be disassociated from the registration before the registration can be deleted. DELETE_REGISTRATION_DISASSOCIATES The registration can be deleted and all origination identities will be disasscoiated.
|
3700
|
+
*/
|
3701
|
+
DisassociationBehavior: RegistrationDisassociationBehavior;
|
3702
|
+
}
|
3703
|
+
export type SupportedAssociationList = SupportedAssociation[];
|
2096
3704
|
export interface Tag {
|
2097
3705
|
/**
|
2098
3706
|
* The key identifier, or name, of the tag.
|
@@ -2121,6 +3729,21 @@ declare namespace PinpointSMSVoiceV2 {
|
|
2121
3729
|
export type TagValue = string;
|
2122
3730
|
export type TextMessageBody = string;
|
2123
3731
|
export type TextMessageOriginationIdentity = string;
|
3732
|
+
export interface TextValidation {
|
3733
|
+
/**
|
3734
|
+
* The minimum number of characters for the text field.
|
3735
|
+
*/
|
3736
|
+
MinLength: Integer;
|
3737
|
+
/**
|
3738
|
+
* The maximum number of characters for the text field.
|
3739
|
+
*/
|
3740
|
+
MaxLength: Integer;
|
3741
|
+
/**
|
3742
|
+
* The regular expression used to validate the text field.
|
3743
|
+
*/
|
3744
|
+
Pattern: String;
|
3745
|
+
}
|
3746
|
+
export type TextValue = string;
|
2124
3747
|
export type TimeToLive = number;
|
2125
3748
|
export type Timestamp = Date;
|
2126
3749
|
export type TwoWayChannelArn = string;
|
@@ -2150,7 +3773,7 @@ declare namespace PinpointSMSVoiceV2 {
|
|
2150
3773
|
*/
|
2151
3774
|
Enabled?: Boolean;
|
2152
3775
|
/**
|
2153
|
-
* An array of event types that determine which events to log.
|
3776
|
+
* An array of event types that determine which events to log. The TEXT_SENT event type is not supported.
|
2154
3777
|
*/
|
2155
3778
|
MatchingEventTypes?: EventTypeList;
|
2156
3779
|
/**
|
@@ -2193,6 +3816,10 @@ declare namespace PinpointSMSVoiceV2 {
|
|
2193
3816
|
* The Amazon Resource Name (ARN) of the two way channel.
|
2194
3817
|
*/
|
2195
3818
|
TwoWayChannelArn?: TwoWayChannelArn;
|
3819
|
+
/**
|
3820
|
+
* An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
|
3821
|
+
*/
|
3822
|
+
TwoWayChannelRole?: IamRoleArn;
|
2196
3823
|
/**
|
2197
3824
|
* By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
|
2198
3825
|
*/
|
@@ -2251,6 +3878,10 @@ declare namespace PinpointSMSVoiceV2 {
|
|
2251
3878
|
* The Amazon Resource Name (ARN) of the two way channel.
|
2252
3879
|
*/
|
2253
3880
|
TwoWayChannelArn?: TwoWayChannelArn;
|
3881
|
+
/**
|
3882
|
+
* An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
|
3883
|
+
*/
|
3884
|
+
TwoWayChannelRole?: IamRoleArn;
|
2254
3885
|
/**
|
2255
3886
|
* This is true if self managed opt-out are enabled.
|
2256
3887
|
*/
|
@@ -2263,6 +3894,10 @@ declare namespace PinpointSMSVoiceV2 {
|
|
2263
3894
|
* When set to true the phone number can't be deleted.
|
2264
3895
|
*/
|
2265
3896
|
DeletionProtectionEnabled?: PrimitiveBoolean;
|
3897
|
+
/**
|
3898
|
+
* The unique identifier for the registration.
|
3899
|
+
*/
|
3900
|
+
RegistrationId?: String;
|
2266
3901
|
/**
|
2267
3902
|
* The time when the phone number was created, in UNIX epoch time format.
|
2268
3903
|
*/
|
@@ -2281,6 +3916,10 @@ declare namespace PinpointSMSVoiceV2 {
|
|
2281
3916
|
* The Amazon Resource Name (ARN) of the two way channel.
|
2282
3917
|
*/
|
2283
3918
|
TwoWayChannelArn?: TwoWayChannelArn;
|
3919
|
+
/**
|
3920
|
+
* An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
|
3921
|
+
*/
|
3922
|
+
TwoWayChannelRole?: IamRoleArn;
|
2284
3923
|
/**
|
2285
3924
|
* By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
|
2286
3925
|
*/
|
@@ -2323,6 +3962,10 @@ declare namespace PinpointSMSVoiceV2 {
|
|
2323
3962
|
* The Amazon Resource Name (ARN) of the two way channel.
|
2324
3963
|
*/
|
2325
3964
|
TwoWayChannelArn?: TwoWayChannelArn;
|
3965
|
+
/**
|
3966
|
+
* An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
|
3967
|
+
*/
|
3968
|
+
TwoWayChannelRole?: IamRoleArn;
|
2326
3969
|
/**
|
2327
3970
|
* When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
|
2328
3971
|
*/
|
@@ -2344,6 +3987,127 @@ declare namespace PinpointSMSVoiceV2 {
|
|
2344
3987
|
*/
|
2345
3988
|
CreatedTimestamp?: Timestamp;
|
2346
3989
|
}
|
3990
|
+
export interface UpdateSenderIdRequest {
|
3991
|
+
/**
|
3992
|
+
* The sender ID to update.
|
3993
|
+
*/
|
3994
|
+
SenderId: SenderIdOrArn;
|
3995
|
+
/**
|
3996
|
+
* The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
|
3997
|
+
*/
|
3998
|
+
IsoCountryCode: IsoCountryCode;
|
3999
|
+
/**
|
4000
|
+
* By default this is set to false. When set to true the sender ID can't be deleted.
|
4001
|
+
*/
|
4002
|
+
DeletionProtectionEnabled?: Boolean;
|
4003
|
+
}
|
4004
|
+
export interface UpdateSenderIdResult {
|
4005
|
+
/**
|
4006
|
+
* The Amazon Resource Name (ARN) associated with the SenderId.
|
4007
|
+
*/
|
4008
|
+
SenderIdArn: String;
|
4009
|
+
/**
|
4010
|
+
* The sender ID that was updated.
|
4011
|
+
*/
|
4012
|
+
SenderId: SenderId;
|
4013
|
+
/**
|
4014
|
+
* The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
|
4015
|
+
*/
|
4016
|
+
IsoCountryCode: IsoCountryCode;
|
4017
|
+
/**
|
4018
|
+
* The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
|
4019
|
+
*/
|
4020
|
+
MessageTypes: MessageTypeList;
|
4021
|
+
/**
|
4022
|
+
* The monthly price, in US dollars, to lease the sender ID.
|
4023
|
+
*/
|
4024
|
+
MonthlyLeasingPrice: String;
|
4025
|
+
/**
|
4026
|
+
* By default this is set to false. When set to true the sender ID can't be deleted.
|
4027
|
+
*/
|
4028
|
+
DeletionProtectionEnabled: PrimitiveBoolean;
|
4029
|
+
/**
|
4030
|
+
* True if the sender ID is registered..
|
4031
|
+
*/
|
4032
|
+
Registered: PrimitiveBoolean;
|
4033
|
+
/**
|
4034
|
+
* The unique identifier for the registration.
|
4035
|
+
*/
|
4036
|
+
RegistrationId?: String;
|
4037
|
+
}
|
4038
|
+
export type VerificationChannel = "TEXT"|"VOICE"|string;
|
4039
|
+
export type VerificationCode = string;
|
4040
|
+
export type VerificationMessageOriginationIdentity = string;
|
4041
|
+
export type VerificationStatus = "PENDING"|"VERIFIED"|string;
|
4042
|
+
export interface VerifiedDestinationNumberFilter {
|
4043
|
+
/**
|
4044
|
+
* The name of the attribute to filter on.
|
4045
|
+
*/
|
4046
|
+
Name: VerifiedDestinationNumberFilterName;
|
4047
|
+
/**
|
4048
|
+
* An array of values to filter on.
|
4049
|
+
*/
|
4050
|
+
Values: FilterValueList;
|
4051
|
+
}
|
4052
|
+
export type VerifiedDestinationNumberFilterList = VerifiedDestinationNumberFilter[];
|
4053
|
+
export type VerifiedDestinationNumberFilterName = "status"|string;
|
4054
|
+
export type VerifiedDestinationNumberIdList = VerifiedDestinationNumberIdOrArn[];
|
4055
|
+
export type VerifiedDestinationNumberIdOrArn = string;
|
4056
|
+
export interface VerifiedDestinationNumberInformation {
|
4057
|
+
/**
|
4058
|
+
* The Amazon Resource Name (ARN) for the verified destination phone number.
|
4059
|
+
*/
|
4060
|
+
VerifiedDestinationNumberArn: String;
|
4061
|
+
/**
|
4062
|
+
* The unique identifier for the verified destination phone number.
|
4063
|
+
*/
|
4064
|
+
VerifiedDestinationNumberId: String;
|
4065
|
+
/**
|
4066
|
+
* The verified destination phone number, in E.164 format.
|
4067
|
+
*/
|
4068
|
+
DestinationPhoneNumber: PhoneNumber;
|
4069
|
+
/**
|
4070
|
+
* The status of the verified destination phone number. PENDING: The phone number hasn't been verified yet. VERIFIED: The phone number is verified and can receive messages.
|
4071
|
+
*/
|
4072
|
+
Status: VerificationStatus;
|
4073
|
+
/**
|
4074
|
+
* The time when the destination phone number was created, in UNIX epoch time format.
|
4075
|
+
*/
|
4076
|
+
CreatedTimestamp: Timestamp;
|
4077
|
+
}
|
4078
|
+
export type VerifiedDestinationNumberInformationList = VerifiedDestinationNumberInformation[];
|
4079
|
+
export interface VerifyDestinationNumberRequest {
|
4080
|
+
/**
|
4081
|
+
* The unique identifier for the verififed destination phone number.
|
4082
|
+
*/
|
4083
|
+
VerifiedDestinationNumberId: VerifiedDestinationNumberIdOrArn;
|
4084
|
+
/**
|
4085
|
+
* The verification code that was received by the verified destination phone number.
|
4086
|
+
*/
|
4087
|
+
VerificationCode: VerificationCode;
|
4088
|
+
}
|
4089
|
+
export interface VerifyDestinationNumberResult {
|
4090
|
+
/**
|
4091
|
+
* The Amazon Resource Name (ARN) for the verified destination phone number.
|
4092
|
+
*/
|
4093
|
+
VerifiedDestinationNumberArn: String;
|
4094
|
+
/**
|
4095
|
+
* The unique identifier for the verified destination phone number.
|
4096
|
+
*/
|
4097
|
+
VerifiedDestinationNumberId: String;
|
4098
|
+
/**
|
4099
|
+
* The phone number in E.164 format.
|
4100
|
+
*/
|
4101
|
+
DestinationPhoneNumber: PhoneNumber;
|
4102
|
+
/**
|
4103
|
+
* The status for being able to send messages to the phone number.
|
4104
|
+
*/
|
4105
|
+
Status: VerificationStatus;
|
4106
|
+
/**
|
4107
|
+
* The time when the destination phone number was created, in UNIX epoch time format.
|
4108
|
+
*/
|
4109
|
+
CreatedTimestamp: Timestamp;
|
4110
|
+
}
|
2347
4111
|
export type VoiceId = "AMY"|"ASTRID"|"BIANCA"|"BRIAN"|"CAMILA"|"CARLA"|"CARMEN"|"CELINE"|"CHANTAL"|"CONCHITA"|"CRISTIANO"|"DORA"|"EMMA"|"ENRIQUE"|"EWA"|"FILIZ"|"GERAINT"|"GIORGIO"|"GWYNETH"|"HANS"|"INES"|"IVY"|"JACEK"|"JAN"|"JOANNA"|"JOEY"|"JUSTIN"|"KARL"|"KENDRA"|"KIMBERLY"|"LEA"|"LIV"|"LOTTE"|"LUCIA"|"LUPE"|"MADS"|"MAJA"|"MARLENE"|"MATHIEU"|"MATTHEW"|"MAXIM"|"MIA"|"MIGUEL"|"MIZUKI"|"NAJA"|"NICOLE"|"PENELOPE"|"RAVEENA"|"RICARDO"|"RUBEN"|"RUSSELL"|"SALLI"|"SEOYEON"|"TAKUMI"|"TATYANA"|"VICKI"|"VITORIA"|"ZEINA"|"ZHIYU"|string;
|
2348
4112
|
export type VoiceMessageBody = string;
|
2349
4113
|
export type VoiceMessageBodyTextType = "TEXT"|"SSML"|string;
|