aws-sdk-pinpointsmsvoicev2 1.9.0 → 1.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-pinpointsmsvoicev2/client.rb +1611 -102
- data/lib/aws-sdk-pinpointsmsvoicev2/client_api.rb +1093 -2
- data/lib/aws-sdk-pinpointsmsvoicev2/endpoint_provider.rb +1 -1
- data/lib/aws-sdk-pinpointsmsvoicev2/endpoints.rb +364 -0
- data/lib/aws-sdk-pinpointsmsvoicev2/plugins/endpoints.rb +52 -0
- data/lib/aws-sdk-pinpointsmsvoicev2/types.rb +3230 -510
- data/lib/aws-sdk-pinpointsmsvoicev2.rb +1 -1
- metadata +5 -5
@@ -401,11 +401,11 @@ module Aws::PinpointSMSVoiceV2
|
|
401
401
|
# Associates the specified origination identity with a pool.
|
402
402
|
#
|
403
403
|
# If the origination identity is a phone number and is already
|
404
|
-
# associated with another pool, an
|
404
|
+
# associated with another pool, an error is returned. A sender ID can be
|
405
405
|
# associated with multiple pools.
|
406
406
|
#
|
407
407
|
# If the origination identity configuration doesn't match the pool's
|
408
|
-
# configuration, an
|
408
|
+
# configuration, an error is returned.
|
409
409
|
#
|
410
410
|
# @option params [required, String] :pool_id
|
411
411
|
# The pool to update with the new Identity. This value can be either the
|
@@ -554,6 +554,10 @@ module Aws::PinpointSMSVoiceV2
|
|
554
554
|
# An array of event types that determine which events to log. If "ALL"
|
555
555
|
# is used, then Amazon Pinpoint logs every event type.
|
556
556
|
#
|
557
|
+
# <note markdown="1"> The `TEXT_SENT` event type is not supported.
|
558
|
+
#
|
559
|
+
# </note>
|
560
|
+
#
|
557
561
|
# @option params [Types::CloudWatchLogsDestination] :cloud_watch_logs_destination
|
558
562
|
# An object that contains information about an event destination for
|
559
563
|
# logging to Amazon CloudWatch logs.
|
@@ -626,7 +630,7 @@ module Aws::PinpointSMSVoiceV2
|
|
626
630
|
|
627
631
|
# Creates a new opt-out list.
|
628
632
|
#
|
629
|
-
# If the opt-out list name already exists, an
|
633
|
+
# If the opt-out list name already exists, an error is returned.
|
630
634
|
#
|
631
635
|
# An opt-out list is a list of phone numbers that are opted out, meaning
|
632
636
|
# you can't send SMS or voice messages to them. If end user replies
|
@@ -705,7 +709,7 @@ module Aws::PinpointSMSVoiceV2
|
|
705
709
|
# to false.
|
706
710
|
#
|
707
711
|
# If the origination identity is a phone number and is already
|
708
|
-
# associated with another pool, an
|
712
|
+
# associated with another pool, an error is returned. A sender ID can be
|
709
713
|
# associated with multiple pools.
|
710
714
|
#
|
711
715
|
# @option params [required, String] :origination_identity
|
@@ -748,6 +752,7 @@ module Aws::PinpointSMSVoiceV2
|
|
748
752
|
# * {Types::CreatePoolResult#message_type #message_type} => String
|
749
753
|
# * {Types::CreatePoolResult#two_way_enabled #two_way_enabled} => Boolean
|
750
754
|
# * {Types::CreatePoolResult#two_way_channel_arn #two_way_channel_arn} => String
|
755
|
+
# * {Types::CreatePoolResult#two_way_channel_role #two_way_channel_role} => String
|
751
756
|
# * {Types::CreatePoolResult#self_managed_opt_outs_enabled #self_managed_opt_outs_enabled} => Boolean
|
752
757
|
# * {Types::CreatePoolResult#opt_out_list_name #opt_out_list_name} => String
|
753
758
|
# * {Types::CreatePoolResult#shared_routes_enabled #shared_routes_enabled} => Boolean
|
@@ -779,6 +784,7 @@ module Aws::PinpointSMSVoiceV2
|
|
779
784
|
# resp.message_type #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
|
780
785
|
# resp.two_way_enabled #=> Boolean
|
781
786
|
# resp.two_way_channel_arn #=> String
|
787
|
+
# resp.two_way_channel_role #=> String
|
782
788
|
# resp.self_managed_opt_outs_enabled #=> Boolean
|
783
789
|
# resp.opt_out_list_name #=> String
|
784
790
|
# resp.shared_routes_enabled #=> Boolean
|
@@ -797,6 +803,295 @@ module Aws::PinpointSMSVoiceV2
|
|
797
803
|
req.send_request(options)
|
798
804
|
end
|
799
805
|
|
806
|
+
# Creates a new registration based on the **RegistrationType** field.
|
807
|
+
#
|
808
|
+
# @option params [required, String] :registration_type
|
809
|
+
# The type of registration form to create. The list of
|
810
|
+
# **RegistrationTypes** can be found using the
|
811
|
+
# DescribeRegistrationTypeDefinitions action.
|
812
|
+
#
|
813
|
+
# @option params [Array<Types::Tag>] :tags
|
814
|
+
# An array of tags (key and value pairs) to associate with the
|
815
|
+
# registration.
|
816
|
+
#
|
817
|
+
# @option params [String] :client_token
|
818
|
+
# Unique, case-sensitive identifier that you provide to ensure the
|
819
|
+
# idempotency of the request. If you don't specify a client token, a
|
820
|
+
# randomly generated token is used for the request to ensure
|
821
|
+
# idempotency.
|
822
|
+
#
|
823
|
+
# **A suitable default value is auto-generated.** You should normally
|
824
|
+
# not need to pass this option.**
|
825
|
+
#
|
826
|
+
# @return [Types::CreateRegistrationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
827
|
+
#
|
828
|
+
# * {Types::CreateRegistrationResult#registration_arn #registration_arn} => String
|
829
|
+
# * {Types::CreateRegistrationResult#registration_id #registration_id} => String
|
830
|
+
# * {Types::CreateRegistrationResult#registration_type #registration_type} => String
|
831
|
+
# * {Types::CreateRegistrationResult#registration_status #registration_status} => String
|
832
|
+
# * {Types::CreateRegistrationResult#current_version_number #current_version_number} => Integer
|
833
|
+
# * {Types::CreateRegistrationResult#additional_attributes #additional_attributes} => Hash<String,String>
|
834
|
+
# * {Types::CreateRegistrationResult#tags #tags} => Array<Types::Tag>
|
835
|
+
# * {Types::CreateRegistrationResult#created_timestamp #created_timestamp} => Time
|
836
|
+
#
|
837
|
+
# @example Request syntax with placeholder values
|
838
|
+
#
|
839
|
+
# resp = client.create_registration({
|
840
|
+
# registration_type: "RegistrationType", # required
|
841
|
+
# tags: [
|
842
|
+
# {
|
843
|
+
# key: "TagKey", # required
|
844
|
+
# value: "TagValue", # required
|
845
|
+
# },
|
846
|
+
# ],
|
847
|
+
# client_token: "ClientToken",
|
848
|
+
# })
|
849
|
+
#
|
850
|
+
# @example Response structure
|
851
|
+
#
|
852
|
+
# resp.registration_arn #=> String
|
853
|
+
# resp.registration_id #=> String
|
854
|
+
# resp.registration_type #=> String
|
855
|
+
# resp.registration_status #=> String, one of "CREATED", "SUBMITTED", "REVIEWING", "PROVISIONING", "COMPLETE", "REQUIRES_UPDATES", "CLOSED", "DELETED"
|
856
|
+
# resp.current_version_number #=> Integer
|
857
|
+
# resp.additional_attributes #=> Hash
|
858
|
+
# resp.additional_attributes["String"] #=> String
|
859
|
+
# resp.tags #=> Array
|
860
|
+
# resp.tags[0].key #=> String
|
861
|
+
# resp.tags[0].value #=> String
|
862
|
+
# resp.created_timestamp #=> Time
|
863
|
+
#
|
864
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CreateRegistration AWS API Documentation
|
865
|
+
#
|
866
|
+
# @overload create_registration(params = {})
|
867
|
+
# @param [Hash] params ({})
|
868
|
+
def create_registration(params = {}, options = {})
|
869
|
+
req = build_request(:create_registration, params)
|
870
|
+
req.send_request(options)
|
871
|
+
end
|
872
|
+
|
873
|
+
# Associate the registration with an origination identity such as a
|
874
|
+
# phone number or sender ID.
|
875
|
+
#
|
876
|
+
# @option params [required, String] :registration_id
|
877
|
+
# The unique identifier for the registration.
|
878
|
+
#
|
879
|
+
# @option params [required, String] :resource_id
|
880
|
+
# The unique identifier for the origination identity. For example this
|
881
|
+
# could be a **PhoneNumberId** or **SenderId**.
|
882
|
+
#
|
883
|
+
# @return [Types::CreateRegistrationAssociationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
884
|
+
#
|
885
|
+
# * {Types::CreateRegistrationAssociationResult#registration_arn #registration_arn} => String
|
886
|
+
# * {Types::CreateRegistrationAssociationResult#registration_id #registration_id} => String
|
887
|
+
# * {Types::CreateRegistrationAssociationResult#registration_type #registration_type} => String
|
888
|
+
# * {Types::CreateRegistrationAssociationResult#resource_arn #resource_arn} => String
|
889
|
+
# * {Types::CreateRegistrationAssociationResult#resource_id #resource_id} => String
|
890
|
+
# * {Types::CreateRegistrationAssociationResult#resource_type #resource_type} => String
|
891
|
+
# * {Types::CreateRegistrationAssociationResult#iso_country_code #iso_country_code} => String
|
892
|
+
# * {Types::CreateRegistrationAssociationResult#phone_number #phone_number} => String
|
893
|
+
#
|
894
|
+
# @example Request syntax with placeholder values
|
895
|
+
#
|
896
|
+
# resp = client.create_registration_association({
|
897
|
+
# registration_id: "RegistrationIdOrArn", # required
|
898
|
+
# resource_id: "ResourceIdOrArn", # required
|
899
|
+
# })
|
900
|
+
#
|
901
|
+
# @example Response structure
|
902
|
+
#
|
903
|
+
# resp.registration_arn #=> String
|
904
|
+
# resp.registration_id #=> String
|
905
|
+
# resp.registration_type #=> String
|
906
|
+
# resp.resource_arn #=> String
|
907
|
+
# resp.resource_id #=> String
|
908
|
+
# resp.resource_type #=> String
|
909
|
+
# resp.iso_country_code #=> String
|
910
|
+
# resp.phone_number #=> String
|
911
|
+
#
|
912
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CreateRegistrationAssociation AWS API Documentation
|
913
|
+
#
|
914
|
+
# @overload create_registration_association(params = {})
|
915
|
+
# @param [Hash] params ({})
|
916
|
+
def create_registration_association(params = {}, options = {})
|
917
|
+
req = build_request(:create_registration_association, params)
|
918
|
+
req.send_request(options)
|
919
|
+
end
|
920
|
+
|
921
|
+
# Create a new registration attachment to use for uploading a file or a
|
922
|
+
# URL to a file. The maximum file size is 1MiB and valid file extensions
|
923
|
+
# are PDF, JPEG and PNG. For example, many sender ID registrations
|
924
|
+
# require a signed “letter of authorization” (LOA) to be submitted.
|
925
|
+
#
|
926
|
+
# @option params [String, StringIO, File] :attachment_body
|
927
|
+
# The registration file to upload. The maximum file size is 1MiB and
|
928
|
+
# valid file extensions are PDF, JPEG and PNG.
|
929
|
+
#
|
930
|
+
# @option params [String] :attachment_url
|
931
|
+
# A URL to the required registration file. For example, you can provide
|
932
|
+
# the S3 object URL.
|
933
|
+
#
|
934
|
+
# @option params [Array<Types::Tag>] :tags
|
935
|
+
# An array of tags (key and value pairs) to associate with the
|
936
|
+
# registration attachment.
|
937
|
+
#
|
938
|
+
# @option params [String] :client_token
|
939
|
+
# Unique, case-sensitive identifier that you provide to ensure the
|
940
|
+
# idempotency of the request. If you don't specify a client token, a
|
941
|
+
# randomly generated token is used for the request to ensure
|
942
|
+
# idempotency.
|
943
|
+
#
|
944
|
+
# **A suitable default value is auto-generated.** You should normally
|
945
|
+
# not need to pass this option.**
|
946
|
+
#
|
947
|
+
# @return [Types::CreateRegistrationAttachmentResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
948
|
+
#
|
949
|
+
# * {Types::CreateRegistrationAttachmentResult#registration_attachment_arn #registration_attachment_arn} => String
|
950
|
+
# * {Types::CreateRegistrationAttachmentResult#registration_attachment_id #registration_attachment_id} => String
|
951
|
+
# * {Types::CreateRegistrationAttachmentResult#attachment_status #attachment_status} => String
|
952
|
+
# * {Types::CreateRegistrationAttachmentResult#tags #tags} => Array<Types::Tag>
|
953
|
+
# * {Types::CreateRegistrationAttachmentResult#created_timestamp #created_timestamp} => Time
|
954
|
+
#
|
955
|
+
# @example Request syntax with placeholder values
|
956
|
+
#
|
957
|
+
# resp = client.create_registration_attachment({
|
958
|
+
# attachment_body: "data",
|
959
|
+
# attachment_url: "AttachmentUrl",
|
960
|
+
# tags: [
|
961
|
+
# {
|
962
|
+
# key: "TagKey", # required
|
963
|
+
# value: "TagValue", # required
|
964
|
+
# },
|
965
|
+
# ],
|
966
|
+
# client_token: "ClientToken",
|
967
|
+
# })
|
968
|
+
#
|
969
|
+
# @example Response structure
|
970
|
+
#
|
971
|
+
# resp.registration_attachment_arn #=> String
|
972
|
+
# resp.registration_attachment_id #=> String
|
973
|
+
# resp.attachment_status #=> String, one of "UPLOAD_IN_PROGRESS", "UPLOAD_COMPLETE", "UPLOAD_FAILED", "DELETED"
|
974
|
+
# resp.tags #=> Array
|
975
|
+
# resp.tags[0].key #=> String
|
976
|
+
# resp.tags[0].value #=> String
|
977
|
+
# resp.created_timestamp #=> Time
|
978
|
+
#
|
979
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CreateRegistrationAttachment AWS API Documentation
|
980
|
+
#
|
981
|
+
# @overload create_registration_attachment(params = {})
|
982
|
+
# @param [Hash] params ({})
|
983
|
+
def create_registration_attachment(params = {}, options = {})
|
984
|
+
req = build_request(:create_registration_attachment, params)
|
985
|
+
req.send_request(options)
|
986
|
+
end
|
987
|
+
|
988
|
+
# Create a new version of the registration and increase the
|
989
|
+
# **VersionNumber**. The previous version of the registration becomes
|
990
|
+
# read-only.
|
991
|
+
#
|
992
|
+
# @option params [required, String] :registration_id
|
993
|
+
# The unique identifier for the registration.
|
994
|
+
#
|
995
|
+
# @return [Types::CreateRegistrationVersionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
996
|
+
#
|
997
|
+
# * {Types::CreateRegistrationVersionResult#registration_arn #registration_arn} => String
|
998
|
+
# * {Types::CreateRegistrationVersionResult#registration_id #registration_id} => String
|
999
|
+
# * {Types::CreateRegistrationVersionResult#version_number #version_number} => Integer
|
1000
|
+
# * {Types::CreateRegistrationVersionResult#registration_version_status #registration_version_status} => String
|
1001
|
+
# * {Types::CreateRegistrationVersionResult#registration_version_status_history #registration_version_status_history} => Types::RegistrationVersionStatusHistory
|
1002
|
+
#
|
1003
|
+
# @example Request syntax with placeholder values
|
1004
|
+
#
|
1005
|
+
# resp = client.create_registration_version({
|
1006
|
+
# registration_id: "RegistrationIdOrArn", # required
|
1007
|
+
# })
|
1008
|
+
#
|
1009
|
+
# @example Response structure
|
1010
|
+
#
|
1011
|
+
# resp.registration_arn #=> String
|
1012
|
+
# resp.registration_id #=> String
|
1013
|
+
# resp.version_number #=> Integer
|
1014
|
+
# resp.registration_version_status #=> String, one of "DRAFT", "SUBMITTED", "REVIEWING", "APPROVED", "DISCARDED", "DENIED", "REVOKED", "ARCHIVED"
|
1015
|
+
# resp.registration_version_status_history.draft_timestamp #=> Time
|
1016
|
+
# resp.registration_version_status_history.submitted_timestamp #=> Time
|
1017
|
+
# resp.registration_version_status_history.reviewing_timestamp #=> Time
|
1018
|
+
# resp.registration_version_status_history.approved_timestamp #=> Time
|
1019
|
+
# resp.registration_version_status_history.discarded_timestamp #=> Time
|
1020
|
+
# resp.registration_version_status_history.denied_timestamp #=> Time
|
1021
|
+
# resp.registration_version_status_history.revoked_timestamp #=> Time
|
1022
|
+
# resp.registration_version_status_history.archived_timestamp #=> Time
|
1023
|
+
#
|
1024
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CreateRegistrationVersion AWS API Documentation
|
1025
|
+
#
|
1026
|
+
# @overload create_registration_version(params = {})
|
1027
|
+
# @param [Hash] params ({})
|
1028
|
+
def create_registration_version(params = {}, options = {})
|
1029
|
+
req = build_request(:create_registration_version, params)
|
1030
|
+
req.send_request(options)
|
1031
|
+
end
|
1032
|
+
|
1033
|
+
# You can only send messages to verified destination numbers when your
|
1034
|
+
# account is in the sandbox. You can add up to 10 verified destination
|
1035
|
+
# numbers.
|
1036
|
+
#
|
1037
|
+
# @option params [required, String] :destination_phone_number
|
1038
|
+
# The verified destination phone number, in E.164 format.
|
1039
|
+
#
|
1040
|
+
# @option params [Array<Types::Tag>] :tags
|
1041
|
+
# An array of tags (key and value pairs) to associate with the
|
1042
|
+
# destination number.
|
1043
|
+
#
|
1044
|
+
# @option params [String] :client_token
|
1045
|
+
# Unique, case-sensitive identifier that you provide to ensure the
|
1046
|
+
# idempotency of the request. If you don't specify a client token, a
|
1047
|
+
# randomly generated token is used for the request to ensure
|
1048
|
+
# idempotency.
|
1049
|
+
#
|
1050
|
+
# **A suitable default value is auto-generated.** You should normally
|
1051
|
+
# not need to pass this option.**
|
1052
|
+
#
|
1053
|
+
# @return [Types::CreateVerifiedDestinationNumberResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1054
|
+
#
|
1055
|
+
# * {Types::CreateVerifiedDestinationNumberResult#verified_destination_number_arn #verified_destination_number_arn} => String
|
1056
|
+
# * {Types::CreateVerifiedDestinationNumberResult#verified_destination_number_id #verified_destination_number_id} => String
|
1057
|
+
# * {Types::CreateVerifiedDestinationNumberResult#destination_phone_number #destination_phone_number} => String
|
1058
|
+
# * {Types::CreateVerifiedDestinationNumberResult#status #status} => String
|
1059
|
+
# * {Types::CreateVerifiedDestinationNumberResult#tags #tags} => Array<Types::Tag>
|
1060
|
+
# * {Types::CreateVerifiedDestinationNumberResult#created_timestamp #created_timestamp} => Time
|
1061
|
+
#
|
1062
|
+
# @example Request syntax with placeholder values
|
1063
|
+
#
|
1064
|
+
# resp = client.create_verified_destination_number({
|
1065
|
+
# destination_phone_number: "PhoneNumber", # required
|
1066
|
+
# tags: [
|
1067
|
+
# {
|
1068
|
+
# key: "TagKey", # required
|
1069
|
+
# value: "TagValue", # required
|
1070
|
+
# },
|
1071
|
+
# ],
|
1072
|
+
# client_token: "ClientToken",
|
1073
|
+
# })
|
1074
|
+
#
|
1075
|
+
# @example Response structure
|
1076
|
+
#
|
1077
|
+
# resp.verified_destination_number_arn #=> String
|
1078
|
+
# resp.verified_destination_number_id #=> String
|
1079
|
+
# resp.destination_phone_number #=> String
|
1080
|
+
# resp.status #=> String, one of "PENDING", "VERIFIED"
|
1081
|
+
# resp.tags #=> Array
|
1082
|
+
# resp.tags[0].key #=> String
|
1083
|
+
# resp.tags[0].value #=> String
|
1084
|
+
# resp.created_timestamp #=> Time
|
1085
|
+
#
|
1086
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CreateVerifiedDestinationNumber AWS API Documentation
|
1087
|
+
#
|
1088
|
+
# @overload create_verified_destination_number(params = {})
|
1089
|
+
# @param [Hash] params ({})
|
1090
|
+
def create_verified_destination_number(params = {}, options = {})
|
1091
|
+
req = build_request(:create_verified_destination_number, params)
|
1092
|
+
req.send_request(options)
|
1093
|
+
end
|
1094
|
+
|
800
1095
|
# Deletes an existing configuration set.
|
801
1096
|
#
|
802
1097
|
# A configuration set is a set of rules that you apply to voice and SMS
|
@@ -1041,7 +1336,7 @@ module Aws::PinpointSMSVoiceV2
|
|
1041
1336
|
# opt-out list are deleted.
|
1042
1337
|
#
|
1043
1338
|
# If the specified opt-out list name doesn't exist or is in-use by an
|
1044
|
-
# origination phone number or pool, an
|
1339
|
+
# origination phone number or pool, an error is returned.
|
1045
1340
|
#
|
1046
1341
|
# @option params [required, String] :opt_out_list_name
|
1047
1342
|
# The OptOutListName or OptOutListArn of the OptOutList to delete. You
|
@@ -1081,7 +1376,7 @@ module Aws::PinpointSMSVoiceV2
|
|
1081
1376
|
# Each destination phone number can only be deleted once every 30 days.
|
1082
1377
|
#
|
1083
1378
|
# If the specified destination phone number doesn't exist or if the
|
1084
|
-
# opt-out list doesn't exist, an
|
1379
|
+
# opt-out list doesn't exist, an error is returned.
|
1085
1380
|
#
|
1086
1381
|
# @option params [required, String] :opt_out_list_name
|
1087
1382
|
# The OptOutListName or OptOutListArn to remove the phone number from.
|
@@ -1125,7 +1420,7 @@ module Aws::PinpointSMSVoiceV2
|
|
1125
1420
|
# origination identities from that pool.
|
1126
1421
|
#
|
1127
1422
|
# If the pool status isn't active or if deletion protection is enabled,
|
1128
|
-
# an
|
1423
|
+
# an error is returned.
|
1129
1424
|
#
|
1130
1425
|
# A pool is a collection of phone numbers and SenderIds. A pool can
|
1131
1426
|
# include one or more phone numbers and SenderIds that are associated
|
@@ -1143,6 +1438,7 @@ module Aws::PinpointSMSVoiceV2
|
|
1143
1438
|
# * {Types::DeletePoolResult#message_type #message_type} => String
|
1144
1439
|
# * {Types::DeletePoolResult#two_way_enabled #two_way_enabled} => Boolean
|
1145
1440
|
# * {Types::DeletePoolResult#two_way_channel_arn #two_way_channel_arn} => String
|
1441
|
+
# * {Types::DeletePoolResult#two_way_channel_role #two_way_channel_role} => String
|
1146
1442
|
# * {Types::DeletePoolResult#self_managed_opt_outs_enabled #self_managed_opt_outs_enabled} => Boolean
|
1147
1443
|
# * {Types::DeletePoolResult#opt_out_list_name #opt_out_list_name} => String
|
1148
1444
|
# * {Types::DeletePoolResult#shared_routes_enabled #shared_routes_enabled} => Boolean
|
@@ -1162,6 +1458,7 @@ module Aws::PinpointSMSVoiceV2
|
|
1162
1458
|
# resp.message_type #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
|
1163
1459
|
# resp.two_way_enabled #=> Boolean
|
1164
1460
|
# resp.two_way_channel_arn #=> String
|
1461
|
+
# resp.two_way_channel_role #=> String
|
1165
1462
|
# resp.self_managed_opt_outs_enabled #=> Boolean
|
1166
1463
|
# resp.opt_out_list_name #=> String
|
1167
1464
|
# resp.shared_routes_enabled #=> Boolean
|
@@ -1176,6 +1473,133 @@ module Aws::PinpointSMSVoiceV2
|
|
1176
1473
|
req.send_request(options)
|
1177
1474
|
end
|
1178
1475
|
|
1476
|
+
# Permanently delete an existing registration from your account.
|
1477
|
+
#
|
1478
|
+
# @option params [required, String] :registration_id
|
1479
|
+
# The unique identifier for the registration.
|
1480
|
+
#
|
1481
|
+
# @return [Types::DeleteRegistrationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1482
|
+
#
|
1483
|
+
# * {Types::DeleteRegistrationResult#registration_arn #registration_arn} => String
|
1484
|
+
# * {Types::DeleteRegistrationResult#registration_id #registration_id} => String
|
1485
|
+
# * {Types::DeleteRegistrationResult#registration_type #registration_type} => String
|
1486
|
+
# * {Types::DeleteRegistrationResult#registration_status #registration_status} => String
|
1487
|
+
# * {Types::DeleteRegistrationResult#current_version_number #current_version_number} => Integer
|
1488
|
+
# * {Types::DeleteRegistrationResult#approved_version_number #approved_version_number} => Integer
|
1489
|
+
# * {Types::DeleteRegistrationResult#latest_denied_version_number #latest_denied_version_number} => Integer
|
1490
|
+
# * {Types::DeleteRegistrationResult#additional_attributes #additional_attributes} => Hash<String,String>
|
1491
|
+
# * {Types::DeleteRegistrationResult#created_timestamp #created_timestamp} => Time
|
1492
|
+
#
|
1493
|
+
# @example Request syntax with placeholder values
|
1494
|
+
#
|
1495
|
+
# resp = client.delete_registration({
|
1496
|
+
# registration_id: "RegistrationIdOrArn", # required
|
1497
|
+
# })
|
1498
|
+
#
|
1499
|
+
# @example Response structure
|
1500
|
+
#
|
1501
|
+
# resp.registration_arn #=> String
|
1502
|
+
# resp.registration_id #=> String
|
1503
|
+
# resp.registration_type #=> String
|
1504
|
+
# resp.registration_status #=> String, one of "CREATED", "SUBMITTED", "REVIEWING", "PROVISIONING", "COMPLETE", "REQUIRES_UPDATES", "CLOSED", "DELETED"
|
1505
|
+
# resp.current_version_number #=> Integer
|
1506
|
+
# resp.approved_version_number #=> Integer
|
1507
|
+
# resp.latest_denied_version_number #=> Integer
|
1508
|
+
# resp.additional_attributes #=> Hash
|
1509
|
+
# resp.additional_attributes["String"] #=> String
|
1510
|
+
# resp.created_timestamp #=> Time
|
1511
|
+
#
|
1512
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteRegistration AWS API Documentation
|
1513
|
+
#
|
1514
|
+
# @overload delete_registration(params = {})
|
1515
|
+
# @param [Hash] params ({})
|
1516
|
+
def delete_registration(params = {}, options = {})
|
1517
|
+
req = build_request(:delete_registration, params)
|
1518
|
+
req.send_request(options)
|
1519
|
+
end
|
1520
|
+
|
1521
|
+
# Permanently delete the specified registration attachment.
|
1522
|
+
#
|
1523
|
+
# @option params [required, String] :registration_attachment_id
|
1524
|
+
# The unique identifier for the registration attachment.
|
1525
|
+
#
|
1526
|
+
# @return [Types::DeleteRegistrationAttachmentResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1527
|
+
#
|
1528
|
+
# * {Types::DeleteRegistrationAttachmentResult#registration_attachment_arn #registration_attachment_arn} => String
|
1529
|
+
# * {Types::DeleteRegistrationAttachmentResult#registration_attachment_id #registration_attachment_id} => String
|
1530
|
+
# * {Types::DeleteRegistrationAttachmentResult#attachment_status #attachment_status} => String
|
1531
|
+
# * {Types::DeleteRegistrationAttachmentResult#attachment_upload_error_reason #attachment_upload_error_reason} => String
|
1532
|
+
# * {Types::DeleteRegistrationAttachmentResult#created_timestamp #created_timestamp} => Time
|
1533
|
+
#
|
1534
|
+
# @example Request syntax with placeholder values
|
1535
|
+
#
|
1536
|
+
# resp = client.delete_registration_attachment({
|
1537
|
+
# registration_attachment_id: "RegistrationAttachmentIdOrArn", # required
|
1538
|
+
# })
|
1539
|
+
#
|
1540
|
+
# @example Response structure
|
1541
|
+
#
|
1542
|
+
# resp.registration_attachment_arn #=> String
|
1543
|
+
# resp.registration_attachment_id #=> String
|
1544
|
+
# resp.attachment_status #=> String, one of "UPLOAD_IN_PROGRESS", "UPLOAD_COMPLETE", "UPLOAD_FAILED", "DELETED"
|
1545
|
+
# resp.attachment_upload_error_reason #=> String, one of "INTERNAL_ERROR"
|
1546
|
+
# resp.created_timestamp #=> Time
|
1547
|
+
#
|
1548
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteRegistrationAttachment AWS API Documentation
|
1549
|
+
#
|
1550
|
+
# @overload delete_registration_attachment(params = {})
|
1551
|
+
# @param [Hash] params ({})
|
1552
|
+
def delete_registration_attachment(params = {}, options = {})
|
1553
|
+
req = build_request(:delete_registration_attachment, params)
|
1554
|
+
req.send_request(options)
|
1555
|
+
end
|
1556
|
+
|
1557
|
+
# Delete the value in a registration form field.
|
1558
|
+
#
|
1559
|
+
# @option params [required, String] :registration_id
|
1560
|
+
# The unique identifier for the registration.
|
1561
|
+
#
|
1562
|
+
# @option params [required, String] :field_path
|
1563
|
+
# The path to the registration form field. You can use
|
1564
|
+
# DescribeRegistrationFieldDefinitions for a list of **FieldPaths**.
|
1565
|
+
#
|
1566
|
+
# @return [Types::DeleteRegistrationFieldValueResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1567
|
+
#
|
1568
|
+
# * {Types::DeleteRegistrationFieldValueResult#registration_arn #registration_arn} => String
|
1569
|
+
# * {Types::DeleteRegistrationFieldValueResult#registration_id #registration_id} => String
|
1570
|
+
# * {Types::DeleteRegistrationFieldValueResult#version_number #version_number} => Integer
|
1571
|
+
# * {Types::DeleteRegistrationFieldValueResult#field_path #field_path} => String
|
1572
|
+
# * {Types::DeleteRegistrationFieldValueResult#select_choices #select_choices} => Array<String>
|
1573
|
+
# * {Types::DeleteRegistrationFieldValueResult#text_value #text_value} => String
|
1574
|
+
# * {Types::DeleteRegistrationFieldValueResult#registration_attachment_id #registration_attachment_id} => String
|
1575
|
+
#
|
1576
|
+
# @example Request syntax with placeholder values
|
1577
|
+
#
|
1578
|
+
# resp = client.delete_registration_field_value({
|
1579
|
+
# registration_id: "RegistrationIdOrArn", # required
|
1580
|
+
# field_path: "FieldPath", # required
|
1581
|
+
# })
|
1582
|
+
#
|
1583
|
+
# @example Response structure
|
1584
|
+
#
|
1585
|
+
# resp.registration_arn #=> String
|
1586
|
+
# resp.registration_id #=> String
|
1587
|
+
# resp.version_number #=> Integer
|
1588
|
+
# resp.field_path #=> String
|
1589
|
+
# resp.select_choices #=> Array
|
1590
|
+
# resp.select_choices[0] #=> String
|
1591
|
+
# resp.text_value #=> String
|
1592
|
+
# resp.registration_attachment_id #=> String
|
1593
|
+
#
|
1594
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteRegistrationFieldValue AWS API Documentation
|
1595
|
+
#
|
1596
|
+
# @overload delete_registration_field_value(params = {})
|
1597
|
+
# @param [Hash] params ({})
|
1598
|
+
def delete_registration_field_value(params = {}, options = {})
|
1599
|
+
req = build_request(:delete_registration_field_value, params)
|
1600
|
+
req.send_request(options)
|
1601
|
+
end
|
1602
|
+
|
1179
1603
|
# Deletes an account-level monthly spending limit override for sending
|
1180
1604
|
# text messages. Deleting a spend limit override will set the
|
1181
1605
|
# `EnforcedLimit` to equal the `MaxLimit`, which is controlled by Amazon
|
@@ -1203,6 +1627,40 @@ module Aws::PinpointSMSVoiceV2
|
|
1203
1627
|
req.send_request(options)
|
1204
1628
|
end
|
1205
1629
|
|
1630
|
+
# Delete a verified destination phone number.
|
1631
|
+
#
|
1632
|
+
# @option params [required, String] :verified_destination_number_id
|
1633
|
+
# The unique identifier for the verified destination phone number.
|
1634
|
+
#
|
1635
|
+
# @return [Types::DeleteVerifiedDestinationNumberResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1636
|
+
#
|
1637
|
+
# * {Types::DeleteVerifiedDestinationNumberResult#verified_destination_number_arn #verified_destination_number_arn} => String
|
1638
|
+
# * {Types::DeleteVerifiedDestinationNumberResult#verified_destination_number_id #verified_destination_number_id} => String
|
1639
|
+
# * {Types::DeleteVerifiedDestinationNumberResult#destination_phone_number #destination_phone_number} => String
|
1640
|
+
# * {Types::DeleteVerifiedDestinationNumberResult#created_timestamp #created_timestamp} => Time
|
1641
|
+
#
|
1642
|
+
# @example Request syntax with placeholder values
|
1643
|
+
#
|
1644
|
+
# resp = client.delete_verified_destination_number({
|
1645
|
+
# verified_destination_number_id: "VerifiedDestinationNumberIdOrArn", # required
|
1646
|
+
# })
|
1647
|
+
#
|
1648
|
+
# @example Response structure
|
1649
|
+
#
|
1650
|
+
# resp.verified_destination_number_arn #=> String
|
1651
|
+
# resp.verified_destination_number_id #=> String
|
1652
|
+
# resp.destination_phone_number #=> String
|
1653
|
+
# resp.created_timestamp #=> Time
|
1654
|
+
#
|
1655
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteVerifiedDestinationNumber AWS API Documentation
|
1656
|
+
#
|
1657
|
+
# @overload delete_verified_destination_number(params = {})
|
1658
|
+
# @param [Hash] params ({})
|
1659
|
+
def delete_verified_destination_number(params = {}, options = {})
|
1660
|
+
req = build_request(:delete_verified_destination_number, params)
|
1661
|
+
req.send_request(options)
|
1662
|
+
end
|
1663
|
+
|
1206
1664
|
# Deletes an account level monthly spend limit override for sending
|
1207
1665
|
# voice messages. Deleting a spend limit override sets the
|
1208
1666
|
# `EnforcedLimit` equal to the `MaxLimit`, which is controlled by Amazon
|
@@ -1315,7 +1773,7 @@ module Aws::PinpointSMSVoiceV2
|
|
1315
1773
|
# @example Response structure
|
1316
1774
|
#
|
1317
1775
|
# resp.account_limits #=> Array
|
1318
|
-
# resp.account_limits[0].name #=> String, one of "PHONE_NUMBERS", "POOLS", "CONFIGURATION_SETS", "OPT_OUT_LISTS"
|
1776
|
+
# resp.account_limits[0].name #=> String, one of "PHONE_NUMBERS", "POOLS", "CONFIGURATION_SETS", "OPT_OUT_LISTS", "SENDER_IDS", "REGISTRATIONS", "REGISTRATION_ATTACHMENTS", "VERIFIED_DESTINATION_NUMBERS"
|
1319
1777
|
# resp.account_limits[0].used #=> Integer
|
1320
1778
|
# resp.account_limits[0].max #=> Integer
|
1321
1779
|
# resp.next_token #=> String
|
@@ -1415,7 +1873,7 @@ module Aws::PinpointSMSVoiceV2
|
|
1415
1873
|
# begins with a keyword, Amazon Pinpoint responds with a customizable
|
1416
1874
|
# message.
|
1417
1875
|
#
|
1418
|
-
# If you specify a keyword that isn't valid, an
|
1876
|
+
# If you specify a keyword that isn't valid, an error is returned.
|
1419
1877
|
#
|
1420
1878
|
# @option params [required, String] :origination_identity
|
1421
1879
|
# The origination identity to use such as a PhoneNumberId,
|
@@ -1489,7 +1947,7 @@ module Aws::PinpointSMSVoiceV2
|
|
1489
1947
|
# names or filters, the output includes information for all opt-out
|
1490
1948
|
# lists.
|
1491
1949
|
#
|
1492
|
-
# If you specify an opt-out list name that isn't valid, an
|
1950
|
+
# If you specify an opt-out list name that isn't valid, an error is
|
1493
1951
|
# returned.
|
1494
1952
|
#
|
1495
1953
|
# @option params [Array<String>] :opt_out_list_names
|
@@ -1545,7 +2003,7 @@ module Aws::PinpointSMSVoiceV2
|
|
1545
2003
|
# filters, the output includes information for all opted out destination
|
1546
2004
|
# numbers in your opt-out list.
|
1547
2005
|
#
|
1548
|
-
# If you specify an opted out number that isn't valid, an
|
2006
|
+
# If you specify an opted out number that isn't valid, an error is
|
1549
2007
|
# returned.
|
1550
2008
|
#
|
1551
2009
|
# @option params [required, String] :opt_out_list_name
|
@@ -1618,7 +2076,7 @@ module Aws::PinpointSMSVoiceV2
|
|
1618
2076
|
# criteria. If you don't specify phone number IDs or filters, the
|
1619
2077
|
# output includes information for all phone numbers.
|
1620
2078
|
#
|
1621
|
-
# If you specify a phone number ID that isn't valid, an
|
2079
|
+
# If you specify a phone number ID that isn't valid, an error is
|
1622
2080
|
# returned.
|
1623
2081
|
#
|
1624
2082
|
# @option params [Array<String>] :phone_number_ids
|
@@ -1649,7 +2107,7 @@ module Aws::PinpointSMSVoiceV2
|
|
1649
2107
|
# phone_number_ids: ["PhoneNumberIdOrArn"],
|
1650
2108
|
# filters: [
|
1651
2109
|
# {
|
1652
|
-
# name: "status", # required, accepts 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
|
2110
|
+
# name: "status", # required, accepts 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
|
1653
2111
|
# values: ["FilterValue"], # required
|
1654
2112
|
# },
|
1655
2113
|
# ],
|
@@ -1668,14 +2126,16 @@ module Aws::PinpointSMSVoiceV2
|
|
1668
2126
|
# resp.phone_numbers[0].message_type #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
|
1669
2127
|
# resp.phone_numbers[0].number_capabilities #=> Array
|
1670
2128
|
# resp.phone_numbers[0].number_capabilities[0] #=> String, one of "SMS", "VOICE"
|
1671
|
-
# resp.phone_numbers[0].number_type #=> String, one of "SHORT_CODE", "LONG_CODE", "TOLL_FREE", "TEN_DLC"
|
2129
|
+
# resp.phone_numbers[0].number_type #=> String, one of "SHORT_CODE", "LONG_CODE", "TOLL_FREE", "TEN_DLC", "SIMULATOR"
|
1672
2130
|
# resp.phone_numbers[0].monthly_leasing_price #=> String
|
1673
2131
|
# resp.phone_numbers[0].two_way_enabled #=> Boolean
|
1674
2132
|
# resp.phone_numbers[0].two_way_channel_arn #=> String
|
2133
|
+
# resp.phone_numbers[0].two_way_channel_role #=> String
|
1675
2134
|
# resp.phone_numbers[0].self_managed_opt_outs_enabled #=> Boolean
|
1676
2135
|
# resp.phone_numbers[0].opt_out_list_name #=> String
|
1677
2136
|
# resp.phone_numbers[0].deletion_protection_enabled #=> Boolean
|
1678
2137
|
# resp.phone_numbers[0].pool_id #=> String
|
2138
|
+
# resp.phone_numbers[0].registration_id #=> String
|
1679
2139
|
# resp.phone_numbers[0].created_timestamp #=> Time
|
1680
2140
|
# resp.next_token #=> String
|
1681
2141
|
#
|
@@ -1697,7 +2157,7 @@ module Aws::PinpointSMSVoiceV2
|
|
1697
2157
|
# don't specify pool IDs or filters, the output includes information
|
1698
2158
|
# for all pools.
|
1699
2159
|
#
|
1700
|
-
# If you specify a pool ID that isn't valid, an
|
2160
|
+
# If you specify a pool ID that isn't valid, an error is returned.
|
1701
2161
|
#
|
1702
2162
|
# A pool is a collection of phone numbers and SenderIds. A pool can
|
1703
2163
|
# include one or more phone numbers and SenderIds that are associated
|
@@ -1730,7 +2190,7 @@ module Aws::PinpointSMSVoiceV2
|
|
1730
2190
|
# pool_ids: ["PoolIdOrArn"],
|
1731
2191
|
# filters: [
|
1732
2192
|
# {
|
1733
|
-
# name: "status", # required, accepts status, message-type, two-way-enabled, self-managed-opt-outs-enabled, opt-out-list-name, shared-routes-enabled, deletion-protection-enabled
|
2193
|
+
# name: "status", # required, accepts 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
|
1734
2194
|
# values: ["FilterValue"], # required
|
1735
2195
|
# },
|
1736
2196
|
# ],
|
@@ -1747,6 +2207,7 @@ module Aws::PinpointSMSVoiceV2
|
|
1747
2207
|
# resp.pools[0].message_type #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
|
1748
2208
|
# resp.pools[0].two_way_enabled #=> Boolean
|
1749
2209
|
# resp.pools[0].two_way_channel_arn #=> String
|
2210
|
+
# resp.pools[0].two_way_channel_role #=> String
|
1750
2211
|
# resp.pools[0].self_managed_opt_outs_enabled #=> Boolean
|
1751
2212
|
# resp.pools[0].opt_out_list_name #=> String
|
1752
2213
|
# resp.pools[0].shared_routes_enabled #=> Boolean
|
@@ -1763,22 +2224,16 @@ module Aws::PinpointSMSVoiceV2
|
|
1763
2224
|
req.send_request(options)
|
1764
2225
|
end
|
1765
2226
|
|
1766
|
-
#
|
1767
|
-
# your Amazon Web Services account.
|
1768
|
-
#
|
1769
|
-
# If you specify SenderIds, the output includes information for only the
|
1770
|
-
# specified SenderIds. If you specify filters, the output includes
|
1771
|
-
# information for only those SenderIds that meet the filter criteria. If
|
1772
|
-
# you don't specify SenderIds or filters, the output includes
|
1773
|
-
# information for all SenderIds.
|
1774
|
-
#
|
1775
|
-
# f you specify a sender ID that isn't valid, an Error is returned.
|
2227
|
+
# Retrieves the specified registration attachments or all registration
|
2228
|
+
# attachments associated with your Amazon Web Services account.
|
1776
2229
|
#
|
1777
|
-
# @option params [Array<
|
1778
|
-
#
|
2230
|
+
# @option params [Array<String>] :registration_attachment_ids
|
2231
|
+
# The unique identifier of registration attachments to find. This is an
|
2232
|
+
# array of **RegistrationAttachmentId**.
|
1779
2233
|
#
|
1780
|
-
# @option params [Array<Types::
|
1781
|
-
# An array of
|
2234
|
+
# @option params [Array<Types::RegistrationAttachmentFilter>] :filters
|
2235
|
+
# An array of RegistrationAttachmentFilter objects to filter the
|
2236
|
+
# results.
|
1782
2237
|
#
|
1783
2238
|
# @option params [String] :next_token
|
1784
2239
|
# The token to be used for the next set of paginated results. You don't
|
@@ -1787,25 +2242,20 @@ module Aws::PinpointSMSVoiceV2
|
|
1787
2242
|
# @option params [Integer] :max_results
|
1788
2243
|
# The maximum number of results to return per each request.
|
1789
2244
|
#
|
1790
|
-
# @return [Types::
|
2245
|
+
# @return [Types::DescribeRegistrationAttachmentsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1791
2246
|
#
|
1792
|
-
# * {Types::
|
1793
|
-
# * {Types::
|
2247
|
+
# * {Types::DescribeRegistrationAttachmentsResult#registration_attachments #registration_attachments} => Array<Types::RegistrationAttachmentsInformation>
|
2248
|
+
# * {Types::DescribeRegistrationAttachmentsResult#next_token #next_token} => String
|
1794
2249
|
#
|
1795
2250
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1796
2251
|
#
|
1797
2252
|
# @example Request syntax with placeholder values
|
1798
2253
|
#
|
1799
|
-
# resp = client.
|
1800
|
-
#
|
1801
|
-
# {
|
1802
|
-
# sender_id: "SenderIdOrArn", # required
|
1803
|
-
# iso_country_code: "IsoCountryCode", # required
|
1804
|
-
# },
|
1805
|
-
# ],
|
2254
|
+
# resp = client.describe_registration_attachments({
|
2255
|
+
# registration_attachment_ids: ["RegistrationIdOrArn"],
|
1806
2256
|
# filters: [
|
1807
2257
|
# {
|
1808
|
-
# name: "
|
2258
|
+
# name: "attachment-status", # required, accepts attachment-status
|
1809
2259
|
# values: ["FilterValue"], # required
|
1810
2260
|
# },
|
1811
2261
|
# ],
|
@@ -1815,25 +2265,492 @@ module Aws::PinpointSMSVoiceV2
|
|
1815
2265
|
#
|
1816
2266
|
# @example Response structure
|
1817
2267
|
#
|
1818
|
-
# resp.
|
1819
|
-
# resp.
|
1820
|
-
# resp.
|
1821
|
-
# resp.
|
1822
|
-
# resp.
|
1823
|
-
# resp.
|
1824
|
-
# resp.sender_ids[0].monthly_leasing_price #=> String
|
2268
|
+
# resp.registration_attachments #=> Array
|
2269
|
+
# resp.registration_attachments[0].registration_attachment_arn #=> String
|
2270
|
+
# resp.registration_attachments[0].registration_attachment_id #=> String
|
2271
|
+
# resp.registration_attachments[0].attachment_status #=> String, one of "UPLOAD_IN_PROGRESS", "UPLOAD_COMPLETE", "UPLOAD_FAILED", "DELETED"
|
2272
|
+
# resp.registration_attachments[0].attachment_upload_error_reason #=> String, one of "INTERNAL_ERROR"
|
2273
|
+
# resp.registration_attachments[0].created_timestamp #=> Time
|
1825
2274
|
# resp.next_token #=> String
|
1826
2275
|
#
|
1827
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/
|
2276
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeRegistrationAttachments AWS API Documentation
|
1828
2277
|
#
|
1829
|
-
# @overload
|
2278
|
+
# @overload describe_registration_attachments(params = {})
|
1830
2279
|
# @param [Hash] params ({})
|
1831
|
-
def
|
1832
|
-
req = build_request(:
|
2280
|
+
def describe_registration_attachments(params = {}, options = {})
|
2281
|
+
req = build_request(:describe_registration_attachments, params)
|
1833
2282
|
req.send_request(options)
|
1834
2283
|
end
|
1835
2284
|
|
1836
|
-
#
|
2285
|
+
# Retrieves the specified registration type field definitions. You can
|
2286
|
+
# use DescribeRegistrationFieldDefinitions to view the requirements for
|
2287
|
+
# creating, filling out, and submitting each registration type.
|
2288
|
+
#
|
2289
|
+
# @option params [required, String] :registration_type
|
2290
|
+
# The type of registration form. The list of **RegistrationTypes** can
|
2291
|
+
# be found using the DescribeRegistrationTypeDefinitions action.
|
2292
|
+
#
|
2293
|
+
# @option params [String] :section_path
|
2294
|
+
# The path to the section of the registration.
|
2295
|
+
#
|
2296
|
+
# @option params [Array<String>] :field_paths
|
2297
|
+
# An array of paths to the registration form field.
|
2298
|
+
#
|
2299
|
+
# @option params [String] :next_token
|
2300
|
+
# The token to be used for the next set of paginated results. You don't
|
2301
|
+
# need to supply a value for this field in the initial request.
|
2302
|
+
#
|
2303
|
+
# @option params [Integer] :max_results
|
2304
|
+
# The maximum number of results to return per each request.
|
2305
|
+
#
|
2306
|
+
# @return [Types::DescribeRegistrationFieldDefinitionsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2307
|
+
#
|
2308
|
+
# * {Types::DescribeRegistrationFieldDefinitionsResult#registration_type #registration_type} => String
|
2309
|
+
# * {Types::DescribeRegistrationFieldDefinitionsResult#registration_field_definitions #registration_field_definitions} => Array<Types::RegistrationFieldDefinition>
|
2310
|
+
# * {Types::DescribeRegistrationFieldDefinitionsResult#next_token #next_token} => String
|
2311
|
+
#
|
2312
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2313
|
+
#
|
2314
|
+
# @example Request syntax with placeholder values
|
2315
|
+
#
|
2316
|
+
# resp = client.describe_registration_field_definitions({
|
2317
|
+
# registration_type: "RegistrationType", # required
|
2318
|
+
# section_path: "SectionPath",
|
2319
|
+
# field_paths: ["FieldPath"],
|
2320
|
+
# next_token: "NextToken",
|
2321
|
+
# max_results: 1,
|
2322
|
+
# })
|
2323
|
+
#
|
2324
|
+
# @example Response structure
|
2325
|
+
#
|
2326
|
+
# resp.registration_type #=> String
|
2327
|
+
# resp.registration_field_definitions #=> Array
|
2328
|
+
# resp.registration_field_definitions[0].section_path #=> String
|
2329
|
+
# resp.registration_field_definitions[0].field_path #=> String
|
2330
|
+
# resp.registration_field_definitions[0].field_type #=> String, one of "SELECT", "TEXT", "ATTACHMENT"
|
2331
|
+
# resp.registration_field_definitions[0].field_requirement #=> String, one of "REQUIRED", "CONDITIONAL", "OPTIONAL"
|
2332
|
+
# resp.registration_field_definitions[0].select_validation.min_choices #=> Integer
|
2333
|
+
# resp.registration_field_definitions[0].select_validation.max_choices #=> Integer
|
2334
|
+
# resp.registration_field_definitions[0].select_validation.options #=> Array
|
2335
|
+
# resp.registration_field_definitions[0].select_validation.options[0] #=> String
|
2336
|
+
# resp.registration_field_definitions[0].text_validation.min_length #=> Integer
|
2337
|
+
# resp.registration_field_definitions[0].text_validation.max_length #=> Integer
|
2338
|
+
# resp.registration_field_definitions[0].text_validation.pattern #=> String
|
2339
|
+
# resp.registration_field_definitions[0].display_hints.title #=> String
|
2340
|
+
# resp.registration_field_definitions[0].display_hints.short_description #=> String
|
2341
|
+
# resp.registration_field_definitions[0].display_hints.long_description #=> String
|
2342
|
+
# resp.registration_field_definitions[0].display_hints.documentation_title #=> String
|
2343
|
+
# resp.registration_field_definitions[0].display_hints.documentation_link #=> String
|
2344
|
+
# resp.registration_field_definitions[0].display_hints.select_option_descriptions #=> Array
|
2345
|
+
# resp.registration_field_definitions[0].display_hints.select_option_descriptions[0].option #=> String
|
2346
|
+
# resp.registration_field_definitions[0].display_hints.select_option_descriptions[0].title #=> String
|
2347
|
+
# resp.registration_field_definitions[0].display_hints.select_option_descriptions[0].description #=> String
|
2348
|
+
# resp.registration_field_definitions[0].display_hints.text_validation_description #=> String
|
2349
|
+
# resp.registration_field_definitions[0].display_hints.example_text_value #=> String
|
2350
|
+
# resp.next_token #=> String
|
2351
|
+
#
|
2352
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeRegistrationFieldDefinitions AWS API Documentation
|
2353
|
+
#
|
2354
|
+
# @overload describe_registration_field_definitions(params = {})
|
2355
|
+
# @param [Hash] params ({})
|
2356
|
+
def describe_registration_field_definitions(params = {}, options = {})
|
2357
|
+
req = build_request(:describe_registration_field_definitions, params)
|
2358
|
+
req.send_request(options)
|
2359
|
+
end
|
2360
|
+
|
2361
|
+
# Retrieves the specified registration field values.
|
2362
|
+
#
|
2363
|
+
# @option params [required, String] :registration_id
|
2364
|
+
# The unique identifier for the registration.
|
2365
|
+
#
|
2366
|
+
# @option params [Integer] :version_number
|
2367
|
+
# The version number of the registration.
|
2368
|
+
#
|
2369
|
+
# @option params [String] :section_path
|
2370
|
+
# The path to the section of the registration.
|
2371
|
+
#
|
2372
|
+
# @option params [Array<String>] :field_paths
|
2373
|
+
# An array of paths to the registration form field.
|
2374
|
+
#
|
2375
|
+
# @option params [String] :next_token
|
2376
|
+
# The token to be used for the next set of paginated results. You don't
|
2377
|
+
# need to supply a value for this field in the initial request.
|
2378
|
+
#
|
2379
|
+
# @option params [Integer] :max_results
|
2380
|
+
# The maximum number of results to return per each request.
|
2381
|
+
#
|
2382
|
+
# @return [Types::DescribeRegistrationFieldValuesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2383
|
+
#
|
2384
|
+
# * {Types::DescribeRegistrationFieldValuesResult#registration_arn #registration_arn} => String
|
2385
|
+
# * {Types::DescribeRegistrationFieldValuesResult#registration_id #registration_id} => String
|
2386
|
+
# * {Types::DescribeRegistrationFieldValuesResult#version_number #version_number} => Integer
|
2387
|
+
# * {Types::DescribeRegistrationFieldValuesResult#registration_field_values #registration_field_values} => Array<Types::RegistrationFieldValueInformation>
|
2388
|
+
# * {Types::DescribeRegistrationFieldValuesResult#next_token #next_token} => String
|
2389
|
+
#
|
2390
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2391
|
+
#
|
2392
|
+
# @example Request syntax with placeholder values
|
2393
|
+
#
|
2394
|
+
# resp = client.describe_registration_field_values({
|
2395
|
+
# registration_id: "RegistrationIdOrArn", # required
|
2396
|
+
# version_number: 1,
|
2397
|
+
# section_path: "SectionPath",
|
2398
|
+
# field_paths: ["FieldPath"],
|
2399
|
+
# next_token: "NextToken",
|
2400
|
+
# max_results: 1,
|
2401
|
+
# })
|
2402
|
+
#
|
2403
|
+
# @example Response structure
|
2404
|
+
#
|
2405
|
+
# resp.registration_arn #=> String
|
2406
|
+
# resp.registration_id #=> String
|
2407
|
+
# resp.version_number #=> Integer
|
2408
|
+
# resp.registration_field_values #=> Array
|
2409
|
+
# resp.registration_field_values[0].field_path #=> String
|
2410
|
+
# resp.registration_field_values[0].select_choices #=> Array
|
2411
|
+
# resp.registration_field_values[0].select_choices[0] #=> String
|
2412
|
+
# resp.registration_field_values[0].text_value #=> String
|
2413
|
+
# resp.registration_field_values[0].registration_attachment_id #=> String
|
2414
|
+
# resp.registration_field_values[0].denied_reason #=> String
|
2415
|
+
# resp.next_token #=> String
|
2416
|
+
#
|
2417
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeRegistrationFieldValues AWS API Documentation
|
2418
|
+
#
|
2419
|
+
# @overload describe_registration_field_values(params = {})
|
2420
|
+
# @param [Hash] params ({})
|
2421
|
+
def describe_registration_field_values(params = {}, options = {})
|
2422
|
+
req = build_request(:describe_registration_field_values, params)
|
2423
|
+
req.send_request(options)
|
2424
|
+
end
|
2425
|
+
|
2426
|
+
# Retrieves the specified registration section definitions. You can use
|
2427
|
+
# DescribeRegistrationSectionDefinitions to view the requirements for
|
2428
|
+
# creating, filling out, and submitting each registration type.
|
2429
|
+
#
|
2430
|
+
# @option params [required, String] :registration_type
|
2431
|
+
# The type of registration form. The list of **RegistrationTypes** can
|
2432
|
+
# be found using the DescribeRegistrationTypeDefinitions action.
|
2433
|
+
#
|
2434
|
+
# @option params [Array<String>] :section_paths
|
2435
|
+
# An array of paths for the registration form section.
|
2436
|
+
#
|
2437
|
+
# @option params [String] :next_token
|
2438
|
+
# The token to be used for the next set of paginated results. You don't
|
2439
|
+
# need to supply a value for this field in the initial request.
|
2440
|
+
#
|
2441
|
+
# @option params [Integer] :max_results
|
2442
|
+
# The maximum number of results to return per each request.
|
2443
|
+
#
|
2444
|
+
# @return [Types::DescribeRegistrationSectionDefinitionsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2445
|
+
#
|
2446
|
+
# * {Types::DescribeRegistrationSectionDefinitionsResult#registration_type #registration_type} => String
|
2447
|
+
# * {Types::DescribeRegistrationSectionDefinitionsResult#registration_section_definitions #registration_section_definitions} => Array<Types::RegistrationSectionDefinition>
|
2448
|
+
# * {Types::DescribeRegistrationSectionDefinitionsResult#next_token #next_token} => String
|
2449
|
+
#
|
2450
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2451
|
+
#
|
2452
|
+
# @example Request syntax with placeholder values
|
2453
|
+
#
|
2454
|
+
# resp = client.describe_registration_section_definitions({
|
2455
|
+
# registration_type: "RegistrationType", # required
|
2456
|
+
# section_paths: ["SectionPath"],
|
2457
|
+
# next_token: "NextToken",
|
2458
|
+
# max_results: 1,
|
2459
|
+
# })
|
2460
|
+
#
|
2461
|
+
# @example Response structure
|
2462
|
+
#
|
2463
|
+
# resp.registration_type #=> String
|
2464
|
+
# resp.registration_section_definitions #=> Array
|
2465
|
+
# resp.registration_section_definitions[0].section_path #=> String
|
2466
|
+
# resp.registration_section_definitions[0].display_hints.title #=> String
|
2467
|
+
# resp.registration_section_definitions[0].display_hints.short_description #=> String
|
2468
|
+
# resp.registration_section_definitions[0].display_hints.long_description #=> String
|
2469
|
+
# resp.registration_section_definitions[0].display_hints.documentation_title #=> String
|
2470
|
+
# resp.registration_section_definitions[0].display_hints.documentation_link #=> String
|
2471
|
+
# resp.next_token #=> String
|
2472
|
+
#
|
2473
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeRegistrationSectionDefinitions AWS API Documentation
|
2474
|
+
#
|
2475
|
+
# @overload describe_registration_section_definitions(params = {})
|
2476
|
+
# @param [Hash] params ({})
|
2477
|
+
def describe_registration_section_definitions(params = {}, options = {})
|
2478
|
+
req = build_request(:describe_registration_section_definitions, params)
|
2479
|
+
req.send_request(options)
|
2480
|
+
end
|
2481
|
+
|
2482
|
+
# Retrieves the specified registration type definitions. You can use
|
2483
|
+
# DescribeRegistrationTypeDefinitions to view the requirements for
|
2484
|
+
# creating, filling out, and submitting each registration type.
|
2485
|
+
#
|
2486
|
+
# @option params [Array<String>] :registration_types
|
2487
|
+
# The type of registration form. The list of **RegistrationTypes** can
|
2488
|
+
# be found using the DescribeRegistrationTypeDefinitions action.
|
2489
|
+
#
|
2490
|
+
# @option params [Array<Types::RegistrationTypeFilter>] :filters
|
2491
|
+
# An array of RegistrationFilter objects to filter the results.
|
2492
|
+
#
|
2493
|
+
# @option params [String] :next_token
|
2494
|
+
# The token to be used for the next set of paginated results. You don't
|
2495
|
+
# need to supply a value for this field in the initial request.
|
2496
|
+
#
|
2497
|
+
# @option params [Integer] :max_results
|
2498
|
+
# The maximum number of results to return per each request.
|
2499
|
+
#
|
2500
|
+
# @return [Types::DescribeRegistrationTypeDefinitionsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2501
|
+
#
|
2502
|
+
# * {Types::DescribeRegistrationTypeDefinitionsResult#registration_type_definitions #registration_type_definitions} => Array<Types::RegistrationTypeDefinition>
|
2503
|
+
# * {Types::DescribeRegistrationTypeDefinitionsResult#next_token #next_token} => String
|
2504
|
+
#
|
2505
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2506
|
+
#
|
2507
|
+
# @example Request syntax with placeholder values
|
2508
|
+
#
|
2509
|
+
# resp = client.describe_registration_type_definitions({
|
2510
|
+
# registration_types: ["RegistrationType"],
|
2511
|
+
# filters: [
|
2512
|
+
# {
|
2513
|
+
# name: "supported-association-resource-type", # required, accepts supported-association-resource-type, supported-association-iso-country-code
|
2514
|
+
# values: ["FilterValue"], # required
|
2515
|
+
# },
|
2516
|
+
# ],
|
2517
|
+
# next_token: "NextToken",
|
2518
|
+
# max_results: 1,
|
2519
|
+
# })
|
2520
|
+
#
|
2521
|
+
# @example Response structure
|
2522
|
+
#
|
2523
|
+
# resp.registration_type_definitions #=> Array
|
2524
|
+
# resp.registration_type_definitions[0].registration_type #=> String
|
2525
|
+
# resp.registration_type_definitions[0].supported_associations #=> Array
|
2526
|
+
# resp.registration_type_definitions[0].supported_associations[0].resource_type #=> String
|
2527
|
+
# resp.registration_type_definitions[0].supported_associations[0].iso_country_code #=> String
|
2528
|
+
# resp.registration_type_definitions[0].supported_associations[0].association_behavior #=> String, one of "ASSOCIATE_BEFORE_SUBMIT", "ASSOCIATE_ON_APPROVAL", "ASSOCIATE_AFTER_COMPLETE"
|
2529
|
+
# resp.registration_type_definitions[0].supported_associations[0].disassociation_behavior #=> String, one of "DISASSOCIATE_ALL_CLOSES_REGISTRATION", "DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION", "DELETE_REGISTRATION_DISASSOCIATES"
|
2530
|
+
# resp.registration_type_definitions[0].display_hints.title #=> String
|
2531
|
+
# resp.registration_type_definitions[0].display_hints.short_description #=> String
|
2532
|
+
# resp.registration_type_definitions[0].display_hints.long_description #=> String
|
2533
|
+
# resp.registration_type_definitions[0].display_hints.documentation_title #=> String
|
2534
|
+
# resp.registration_type_definitions[0].display_hints.documentation_link #=> String
|
2535
|
+
# resp.next_token #=> String
|
2536
|
+
#
|
2537
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeRegistrationTypeDefinitions AWS API Documentation
|
2538
|
+
#
|
2539
|
+
# @overload describe_registration_type_definitions(params = {})
|
2540
|
+
# @param [Hash] params ({})
|
2541
|
+
def describe_registration_type_definitions(params = {}, options = {})
|
2542
|
+
req = build_request(:describe_registration_type_definitions, params)
|
2543
|
+
req.send_request(options)
|
2544
|
+
end
|
2545
|
+
|
2546
|
+
# Retrieves the specified registration version.
|
2547
|
+
#
|
2548
|
+
# @option params [required, String] :registration_id
|
2549
|
+
# The unique identifier for the registration.
|
2550
|
+
#
|
2551
|
+
# @option params [Array<Integer>] :version_numbers
|
2552
|
+
# An array of registration version numbers.
|
2553
|
+
#
|
2554
|
+
# @option params [Array<Types::RegistrationVersionFilter>] :filters
|
2555
|
+
# An array of RegistrationVersionFilter objects to filter the results.
|
2556
|
+
#
|
2557
|
+
# @option params [String] :next_token
|
2558
|
+
# The token to be used for the next set of paginated results. You don't
|
2559
|
+
# need to supply a value for this field in the initial request.
|
2560
|
+
#
|
2561
|
+
# @option params [Integer] :max_results
|
2562
|
+
# The maximum number of results to return per each request.
|
2563
|
+
#
|
2564
|
+
# @return [Types::DescribeRegistrationVersionsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2565
|
+
#
|
2566
|
+
# * {Types::DescribeRegistrationVersionsResult#registration_arn #registration_arn} => String
|
2567
|
+
# * {Types::DescribeRegistrationVersionsResult#registration_id #registration_id} => String
|
2568
|
+
# * {Types::DescribeRegistrationVersionsResult#registration_versions #registration_versions} => Array<Types::RegistrationVersionInformation>
|
2569
|
+
# * {Types::DescribeRegistrationVersionsResult#next_token #next_token} => String
|
2570
|
+
#
|
2571
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2572
|
+
#
|
2573
|
+
# @example Request syntax with placeholder values
|
2574
|
+
#
|
2575
|
+
# resp = client.describe_registration_versions({
|
2576
|
+
# registration_id: "RegistrationIdOrArn", # required
|
2577
|
+
# version_numbers: [1],
|
2578
|
+
# filters: [
|
2579
|
+
# {
|
2580
|
+
# name: "registration-version-status", # required, accepts registration-version-status
|
2581
|
+
# values: ["FilterValue"], # required
|
2582
|
+
# },
|
2583
|
+
# ],
|
2584
|
+
# next_token: "NextToken",
|
2585
|
+
# max_results: 1,
|
2586
|
+
# })
|
2587
|
+
#
|
2588
|
+
# @example Response structure
|
2589
|
+
#
|
2590
|
+
# resp.registration_arn #=> String
|
2591
|
+
# resp.registration_id #=> String
|
2592
|
+
# resp.registration_versions #=> Array
|
2593
|
+
# resp.registration_versions[0].version_number #=> Integer
|
2594
|
+
# resp.registration_versions[0].registration_version_status #=> String, one of "DRAFT", "SUBMITTED", "REVIEWING", "APPROVED", "DISCARDED", "DENIED", "REVOKED", "ARCHIVED"
|
2595
|
+
# resp.registration_versions[0].registration_version_status_history.draft_timestamp #=> Time
|
2596
|
+
# resp.registration_versions[0].registration_version_status_history.submitted_timestamp #=> Time
|
2597
|
+
# resp.registration_versions[0].registration_version_status_history.reviewing_timestamp #=> Time
|
2598
|
+
# resp.registration_versions[0].registration_version_status_history.approved_timestamp #=> Time
|
2599
|
+
# resp.registration_versions[0].registration_version_status_history.discarded_timestamp #=> Time
|
2600
|
+
# resp.registration_versions[0].registration_version_status_history.denied_timestamp #=> Time
|
2601
|
+
# resp.registration_versions[0].registration_version_status_history.revoked_timestamp #=> Time
|
2602
|
+
# resp.registration_versions[0].registration_version_status_history.archived_timestamp #=> Time
|
2603
|
+
# resp.registration_versions[0].denied_reasons #=> Array
|
2604
|
+
# resp.registration_versions[0].denied_reasons[0].reason #=> String
|
2605
|
+
# resp.registration_versions[0].denied_reasons[0].short_description #=> String
|
2606
|
+
# resp.registration_versions[0].denied_reasons[0].long_description #=> String
|
2607
|
+
# resp.registration_versions[0].denied_reasons[0].documentation_title #=> String
|
2608
|
+
# resp.registration_versions[0].denied_reasons[0].documentation_link #=> String
|
2609
|
+
# resp.next_token #=> String
|
2610
|
+
#
|
2611
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeRegistrationVersions AWS API Documentation
|
2612
|
+
#
|
2613
|
+
# @overload describe_registration_versions(params = {})
|
2614
|
+
# @param [Hash] params ({})
|
2615
|
+
def describe_registration_versions(params = {}, options = {})
|
2616
|
+
req = build_request(:describe_registration_versions, params)
|
2617
|
+
req.send_request(options)
|
2618
|
+
end
|
2619
|
+
|
2620
|
+
# Retrieves the specified registrations.
|
2621
|
+
#
|
2622
|
+
# @option params [Array<String>] :registration_ids
|
2623
|
+
# An array of unique identifiers for each registration.
|
2624
|
+
#
|
2625
|
+
# @option params [Array<Types::RegistrationFilter>] :filters
|
2626
|
+
# An array of RegistrationFilter objects to filter the results.
|
2627
|
+
#
|
2628
|
+
# @option params [String] :next_token
|
2629
|
+
# The token to be used for the next set of paginated results. You don't
|
2630
|
+
# need to supply a value for this field in the initial request.
|
2631
|
+
#
|
2632
|
+
# @option params [Integer] :max_results
|
2633
|
+
# The maximum number of results to return per each request.
|
2634
|
+
#
|
2635
|
+
# @return [Types::DescribeRegistrationsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2636
|
+
#
|
2637
|
+
# * {Types::DescribeRegistrationsResult#registrations #registrations} => Array<Types::RegistrationInformation>
|
2638
|
+
# * {Types::DescribeRegistrationsResult#next_token #next_token} => String
|
2639
|
+
#
|
2640
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2641
|
+
#
|
2642
|
+
# @example Request syntax with placeholder values
|
2643
|
+
#
|
2644
|
+
# resp = client.describe_registrations({
|
2645
|
+
# registration_ids: ["RegistrationIdOrArn"],
|
2646
|
+
# filters: [
|
2647
|
+
# {
|
2648
|
+
# name: "registration-type", # required, accepts registration-type, registration-status
|
2649
|
+
# values: ["FilterValue"], # required
|
2650
|
+
# },
|
2651
|
+
# ],
|
2652
|
+
# next_token: "NextToken",
|
2653
|
+
# max_results: 1,
|
2654
|
+
# })
|
2655
|
+
#
|
2656
|
+
# @example Response structure
|
2657
|
+
#
|
2658
|
+
# resp.registrations #=> Array
|
2659
|
+
# resp.registrations[0].registration_arn #=> String
|
2660
|
+
# resp.registrations[0].registration_id #=> String
|
2661
|
+
# resp.registrations[0].registration_type #=> String
|
2662
|
+
# resp.registrations[0].registration_status #=> String, one of "CREATED", "SUBMITTED", "REVIEWING", "PROVISIONING", "COMPLETE", "REQUIRES_UPDATES", "CLOSED", "DELETED"
|
2663
|
+
# resp.registrations[0].current_version_number #=> Integer
|
2664
|
+
# resp.registrations[0].approved_version_number #=> Integer
|
2665
|
+
# resp.registrations[0].latest_denied_version_number #=> Integer
|
2666
|
+
# resp.registrations[0].additional_attributes #=> Hash
|
2667
|
+
# resp.registrations[0].additional_attributes["String"] #=> String
|
2668
|
+
# resp.registrations[0].created_timestamp #=> Time
|
2669
|
+
# resp.next_token #=> String
|
2670
|
+
#
|
2671
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeRegistrations AWS API Documentation
|
2672
|
+
#
|
2673
|
+
# @overload describe_registrations(params = {})
|
2674
|
+
# @param [Hash] params ({})
|
2675
|
+
def describe_registrations(params = {}, options = {})
|
2676
|
+
req = build_request(:describe_registrations, params)
|
2677
|
+
req.send_request(options)
|
2678
|
+
end
|
2679
|
+
|
2680
|
+
# Describes the specified SenderIds or all SenderIds associated with
|
2681
|
+
# your Amazon Web Services account.
|
2682
|
+
#
|
2683
|
+
# If you specify SenderIds, the output includes information for only the
|
2684
|
+
# specified SenderIds. If you specify filters, the output includes
|
2685
|
+
# information for only those SenderIds that meet the filter criteria. If
|
2686
|
+
# you don't specify SenderIds or filters, the output includes
|
2687
|
+
# information for all SenderIds.
|
2688
|
+
#
|
2689
|
+
# f you specify a sender ID that isn't valid, an error is returned.
|
2690
|
+
#
|
2691
|
+
# @option params [Array<Types::SenderIdAndCountry>] :sender_ids
|
2692
|
+
# An array of SenderIdAndCountry objects to search for.
|
2693
|
+
#
|
2694
|
+
# @option params [Array<Types::SenderIdFilter>] :filters
|
2695
|
+
# An array of SenderIdFilter objects to filter the results.
|
2696
|
+
#
|
2697
|
+
# @option params [String] :next_token
|
2698
|
+
# The token to be used for the next set of paginated results. You don't
|
2699
|
+
# need to supply a value for this field in the initial request.
|
2700
|
+
#
|
2701
|
+
# @option params [Integer] :max_results
|
2702
|
+
# The maximum number of results to return per each request.
|
2703
|
+
#
|
2704
|
+
# @return [Types::DescribeSenderIdsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2705
|
+
#
|
2706
|
+
# * {Types::DescribeSenderIdsResult#sender_ids #sender_ids} => Array<Types::SenderIdInformation>
|
2707
|
+
# * {Types::DescribeSenderIdsResult#next_token #next_token} => String
|
2708
|
+
#
|
2709
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2710
|
+
#
|
2711
|
+
# @example Request syntax with placeholder values
|
2712
|
+
#
|
2713
|
+
# resp = client.describe_sender_ids({
|
2714
|
+
# sender_ids: [
|
2715
|
+
# {
|
2716
|
+
# sender_id: "SenderIdOrArn", # required
|
2717
|
+
# iso_country_code: "IsoCountryCode", # required
|
2718
|
+
# },
|
2719
|
+
# ],
|
2720
|
+
# filters: [
|
2721
|
+
# {
|
2722
|
+
# name: "sender-id", # required, accepts sender-id, iso-country-code, message-type, deletion-protection-enabled, registered
|
2723
|
+
# values: ["FilterValue"], # required
|
2724
|
+
# },
|
2725
|
+
# ],
|
2726
|
+
# next_token: "NextToken",
|
2727
|
+
# max_results: 1,
|
2728
|
+
# })
|
2729
|
+
#
|
2730
|
+
# @example Response structure
|
2731
|
+
#
|
2732
|
+
# resp.sender_ids #=> Array
|
2733
|
+
# resp.sender_ids[0].sender_id_arn #=> String
|
2734
|
+
# resp.sender_ids[0].sender_id #=> String
|
2735
|
+
# resp.sender_ids[0].iso_country_code #=> String
|
2736
|
+
# resp.sender_ids[0].message_types #=> Array
|
2737
|
+
# resp.sender_ids[0].message_types[0] #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
|
2738
|
+
# resp.sender_ids[0].monthly_leasing_price #=> String
|
2739
|
+
# resp.sender_ids[0].deletion_protection_enabled #=> Boolean
|
2740
|
+
# resp.sender_ids[0].registered #=> Boolean
|
2741
|
+
# resp.sender_ids[0].registration_id #=> String
|
2742
|
+
# resp.next_token #=> String
|
2743
|
+
#
|
2744
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeSenderIds AWS API Documentation
|
2745
|
+
#
|
2746
|
+
# @overload describe_sender_ids(params = {})
|
2747
|
+
# @param [Hash] params ({})
|
2748
|
+
def describe_sender_ids(params = {}, options = {})
|
2749
|
+
req = build_request(:describe_sender_ids, params)
|
2750
|
+
req.send_request(options)
|
2751
|
+
end
|
2752
|
+
|
2753
|
+
# Describes the current Amazon Pinpoint monthly spend limits for sending
|
1837
2754
|
# voice and text messages.
|
1838
2755
|
#
|
1839
2756
|
# When you establish an Amazon Web Services account, the account has
|
@@ -1885,10 +2802,70 @@ module Aws::PinpointSMSVoiceV2
|
|
1885
2802
|
req.send_request(options)
|
1886
2803
|
end
|
1887
2804
|
|
2805
|
+
# Retrieves the specified verified destiona numbers.
|
2806
|
+
#
|
2807
|
+
# @option params [Array<String>] :verified_destination_number_ids
|
2808
|
+
# An array of VerifiedDestinationNumberid to retreive.
|
2809
|
+
#
|
2810
|
+
# @option params [Array<String>] :destination_phone_numbers
|
2811
|
+
# An array of verified destination phone number, in E.164 format.
|
2812
|
+
#
|
2813
|
+
# @option params [Array<Types::VerifiedDestinationNumberFilter>] :filters
|
2814
|
+
# An array of VerifiedDestinationNumberFilter objects to filter the
|
2815
|
+
# results.
|
2816
|
+
#
|
2817
|
+
# @option params [String] :next_token
|
2818
|
+
# The token to be used for the next set of paginated results. You don't
|
2819
|
+
# need to supply a value for this field in the initial request.
|
2820
|
+
#
|
2821
|
+
# @option params [Integer] :max_results
|
2822
|
+
# The maximum number of results to return per each request.
|
2823
|
+
#
|
2824
|
+
# @return [Types::DescribeVerifiedDestinationNumbersResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2825
|
+
#
|
2826
|
+
# * {Types::DescribeVerifiedDestinationNumbersResult#verified_destination_numbers #verified_destination_numbers} => Array<Types::VerifiedDestinationNumberInformation>
|
2827
|
+
# * {Types::DescribeVerifiedDestinationNumbersResult#next_token #next_token} => String
|
2828
|
+
#
|
2829
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2830
|
+
#
|
2831
|
+
# @example Request syntax with placeholder values
|
2832
|
+
#
|
2833
|
+
# resp = client.describe_verified_destination_numbers({
|
2834
|
+
# verified_destination_number_ids: ["VerifiedDestinationNumberIdOrArn"],
|
2835
|
+
# destination_phone_numbers: ["PhoneNumber"],
|
2836
|
+
# filters: [
|
2837
|
+
# {
|
2838
|
+
# name: "status", # required, accepts status
|
2839
|
+
# values: ["FilterValue"], # required
|
2840
|
+
# },
|
2841
|
+
# ],
|
2842
|
+
# next_token: "NextToken",
|
2843
|
+
# max_results: 1,
|
2844
|
+
# })
|
2845
|
+
#
|
2846
|
+
# @example Response structure
|
2847
|
+
#
|
2848
|
+
# resp.verified_destination_numbers #=> Array
|
2849
|
+
# resp.verified_destination_numbers[0].verified_destination_number_arn #=> String
|
2850
|
+
# resp.verified_destination_numbers[0].verified_destination_number_id #=> String
|
2851
|
+
# resp.verified_destination_numbers[0].destination_phone_number #=> String
|
2852
|
+
# resp.verified_destination_numbers[0].status #=> String, one of "PENDING", "VERIFIED"
|
2853
|
+
# resp.verified_destination_numbers[0].created_timestamp #=> Time
|
2854
|
+
# resp.next_token #=> String
|
2855
|
+
#
|
2856
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeVerifiedDestinationNumbers AWS API Documentation
|
2857
|
+
#
|
2858
|
+
# @overload describe_verified_destination_numbers(params = {})
|
2859
|
+
# @param [Hash] params ({})
|
2860
|
+
def describe_verified_destination_numbers(params = {}, options = {})
|
2861
|
+
req = build_request(:describe_verified_destination_numbers, params)
|
2862
|
+
req.send_request(options)
|
2863
|
+
end
|
2864
|
+
|
1888
2865
|
# Removes the specified origination identity from an existing pool.
|
1889
2866
|
#
|
1890
2867
|
# If the origination identity isn't associated with the specified pool,
|
1891
|
-
# an
|
2868
|
+
# an error is returned.
|
1892
2869
|
#
|
1893
2870
|
# @option params [required, String] :pool_id
|
1894
2871
|
# The unique identifier for the pool to disassociate with the
|
@@ -1948,18 +2925,123 @@ module Aws::PinpointSMSVoiceV2
|
|
1948
2925
|
req.send_request(options)
|
1949
2926
|
end
|
1950
2927
|
|
1951
|
-
#
|
1952
|
-
#
|
1953
|
-
#
|
1954
|
-
#
|
2928
|
+
# Discard the current version of the registration.
|
2929
|
+
#
|
2930
|
+
# @option params [required, String] :registration_id
|
2931
|
+
# The unique identifier for the registration.
|
2932
|
+
#
|
2933
|
+
# @return [Types::DiscardRegistrationVersionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2934
|
+
#
|
2935
|
+
# * {Types::DiscardRegistrationVersionResult#registration_arn #registration_arn} => String
|
2936
|
+
# * {Types::DiscardRegistrationVersionResult#registration_id #registration_id} => String
|
2937
|
+
# * {Types::DiscardRegistrationVersionResult#version_number #version_number} => Integer
|
2938
|
+
# * {Types::DiscardRegistrationVersionResult#registration_version_status #registration_version_status} => String
|
2939
|
+
# * {Types::DiscardRegistrationVersionResult#registration_version_status_history #registration_version_status_history} => Types::RegistrationVersionStatusHistory
|
2940
|
+
#
|
2941
|
+
# @example Request syntax with placeholder values
|
2942
|
+
#
|
2943
|
+
# resp = client.discard_registration_version({
|
2944
|
+
# registration_id: "RegistrationIdOrArn", # required
|
2945
|
+
# })
|
2946
|
+
#
|
2947
|
+
# @example Response structure
|
2948
|
+
#
|
2949
|
+
# resp.registration_arn #=> String
|
2950
|
+
# resp.registration_id #=> String
|
2951
|
+
# resp.version_number #=> Integer
|
2952
|
+
# resp.registration_version_status #=> String, one of "DRAFT", "SUBMITTED", "REVIEWING", "APPROVED", "DISCARDED", "DENIED", "REVOKED", "ARCHIVED"
|
2953
|
+
# resp.registration_version_status_history.draft_timestamp #=> Time
|
2954
|
+
# resp.registration_version_status_history.submitted_timestamp #=> Time
|
2955
|
+
# resp.registration_version_status_history.reviewing_timestamp #=> Time
|
2956
|
+
# resp.registration_version_status_history.approved_timestamp #=> Time
|
2957
|
+
# resp.registration_version_status_history.discarded_timestamp #=> Time
|
2958
|
+
# resp.registration_version_status_history.denied_timestamp #=> Time
|
2959
|
+
# resp.registration_version_status_history.revoked_timestamp #=> Time
|
2960
|
+
# resp.registration_version_status_history.archived_timestamp #=> Time
|
2961
|
+
#
|
2962
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DiscardRegistrationVersion AWS API Documentation
|
2963
|
+
#
|
2964
|
+
# @overload discard_registration_version(params = {})
|
2965
|
+
# @param [Hash] params ({})
|
2966
|
+
def discard_registration_version(params = {}, options = {})
|
2967
|
+
req = build_request(:discard_registration_version, params)
|
2968
|
+
req.send_request(options)
|
2969
|
+
end
|
2970
|
+
|
2971
|
+
# Lists all associated origination identities in your pool.
|
2972
|
+
#
|
2973
|
+
# If you specify filters, the output includes information for only those
|
2974
|
+
# origination identities that meet the filter criteria.
|
2975
|
+
#
|
2976
|
+
# @option params [required, String] :pool_id
|
2977
|
+
# The unique identifier for the pool. This value can be either the
|
2978
|
+
# PoolId or PoolArn.
|
2979
|
+
#
|
2980
|
+
# @option params [Array<Types::PoolOriginationIdentitiesFilter>] :filters
|
2981
|
+
# An array of PoolOriginationIdentitiesFilter objects to filter the
|
2982
|
+
# results..
|
2983
|
+
#
|
2984
|
+
# @option params [String] :next_token
|
2985
|
+
# The token to be used for the next set of paginated results. You don't
|
2986
|
+
# need to supply a value for this field in the initial request.
|
2987
|
+
#
|
2988
|
+
# @option params [Integer] :max_results
|
2989
|
+
# The maximum number of results to return per each request.
|
2990
|
+
#
|
2991
|
+
# @return [Types::ListPoolOriginationIdentitiesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2992
|
+
#
|
2993
|
+
# * {Types::ListPoolOriginationIdentitiesResult#pool_arn #pool_arn} => String
|
2994
|
+
# * {Types::ListPoolOriginationIdentitiesResult#pool_id #pool_id} => String
|
2995
|
+
# * {Types::ListPoolOriginationIdentitiesResult#origination_identities #origination_identities} => Array<Types::OriginationIdentityMetadata>
|
2996
|
+
# * {Types::ListPoolOriginationIdentitiesResult#next_token #next_token} => String
|
2997
|
+
#
|
2998
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2999
|
+
#
|
3000
|
+
# @example Request syntax with placeholder values
|
3001
|
+
#
|
3002
|
+
# resp = client.list_pool_origination_identities({
|
3003
|
+
# pool_id: "PoolIdOrArn", # required
|
3004
|
+
# filters: [
|
3005
|
+
# {
|
3006
|
+
# name: "iso-country-code", # required, accepts iso-country-code, number-capability
|
3007
|
+
# values: ["FilterValue"], # required
|
3008
|
+
# },
|
3009
|
+
# ],
|
3010
|
+
# next_token: "NextToken",
|
3011
|
+
# max_results: 1,
|
3012
|
+
# })
|
3013
|
+
#
|
3014
|
+
# @example Response structure
|
3015
|
+
#
|
3016
|
+
# resp.pool_arn #=> String
|
3017
|
+
# resp.pool_id #=> String
|
3018
|
+
# resp.origination_identities #=> Array
|
3019
|
+
# resp.origination_identities[0].origination_identity_arn #=> String
|
3020
|
+
# resp.origination_identities[0].origination_identity #=> String
|
3021
|
+
# resp.origination_identities[0].iso_country_code #=> String
|
3022
|
+
# resp.origination_identities[0].number_capabilities #=> Array
|
3023
|
+
# resp.origination_identities[0].number_capabilities[0] #=> String, one of "SMS", "VOICE"
|
3024
|
+
# resp.origination_identities[0].phone_number #=> String
|
3025
|
+
# resp.next_token #=> String
|
3026
|
+
#
|
3027
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ListPoolOriginationIdentities AWS API Documentation
|
3028
|
+
#
|
3029
|
+
# @overload list_pool_origination_identities(params = {})
|
3030
|
+
# @param [Hash] params ({})
|
3031
|
+
def list_pool_origination_identities(params = {}, options = {})
|
3032
|
+
req = build_request(:list_pool_origination_identities, params)
|
3033
|
+
req.send_request(options)
|
3034
|
+
end
|
3035
|
+
|
3036
|
+
# Retreive all of the origination identies that are associated with a
|
3037
|
+
# registration.
|
1955
3038
|
#
|
1956
|
-
# @option params [required, String] :
|
1957
|
-
# The unique identifier for the
|
1958
|
-
# PoolId or PoolArn.
|
3039
|
+
# @option params [required, String] :registration_id
|
3040
|
+
# The unique identifier for the registration.
|
1959
3041
|
#
|
1960
|
-
# @option params [Array<Types::
|
1961
|
-
# An array of
|
1962
|
-
#
|
3042
|
+
# @option params [Array<Types::RegistrationAssociationFilter>] :filters
|
3043
|
+
# An array of RegistrationAssociationFilter to apply to the results that
|
3044
|
+
# are returned.
|
1963
3045
|
#
|
1964
3046
|
# @option params [String] :next_token
|
1965
3047
|
# The token to be used for the next set of paginated results. You don't
|
@@ -1968,22 +3050,23 @@ module Aws::PinpointSMSVoiceV2
|
|
1968
3050
|
# @option params [Integer] :max_results
|
1969
3051
|
# The maximum number of results to return per each request.
|
1970
3052
|
#
|
1971
|
-
# @return [Types::
|
3053
|
+
# @return [Types::ListRegistrationAssociationsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1972
3054
|
#
|
1973
|
-
# * {Types::
|
1974
|
-
# * {Types::
|
1975
|
-
# * {Types::
|
1976
|
-
# * {Types::
|
3055
|
+
# * {Types::ListRegistrationAssociationsResult#registration_arn #registration_arn} => String
|
3056
|
+
# * {Types::ListRegistrationAssociationsResult#registration_id #registration_id} => String
|
3057
|
+
# * {Types::ListRegistrationAssociationsResult#registration_type #registration_type} => String
|
3058
|
+
# * {Types::ListRegistrationAssociationsResult#registration_associations #registration_associations} => Array<Types::RegistrationAssociationMetadata>
|
3059
|
+
# * {Types::ListRegistrationAssociationsResult#next_token #next_token} => String
|
1977
3060
|
#
|
1978
3061
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1979
3062
|
#
|
1980
3063
|
# @example Request syntax with placeholder values
|
1981
3064
|
#
|
1982
|
-
# resp = client.
|
1983
|
-
#
|
3065
|
+
# resp = client.list_registration_associations({
|
3066
|
+
# registration_id: "RegistrationIdOrArn", # required
|
1984
3067
|
# filters: [
|
1985
3068
|
# {
|
1986
|
-
# name: "
|
3069
|
+
# name: "resource-type", # required, accepts resource-type, iso-country-code
|
1987
3070
|
# values: ["FilterValue"], # required
|
1988
3071
|
# },
|
1989
3072
|
# ],
|
@@ -1993,22 +3076,23 @@ module Aws::PinpointSMSVoiceV2
|
|
1993
3076
|
#
|
1994
3077
|
# @example Response structure
|
1995
3078
|
#
|
1996
|
-
# resp.
|
1997
|
-
# resp.
|
1998
|
-
# resp.
|
1999
|
-
# resp.
|
2000
|
-
# resp.
|
2001
|
-
# resp.
|
2002
|
-
# resp.
|
2003
|
-
# resp.
|
3079
|
+
# resp.registration_arn #=> String
|
3080
|
+
# resp.registration_id #=> String
|
3081
|
+
# resp.registration_type #=> String
|
3082
|
+
# resp.registration_associations #=> Array
|
3083
|
+
# resp.registration_associations[0].resource_arn #=> String
|
3084
|
+
# resp.registration_associations[0].resource_id #=> String
|
3085
|
+
# resp.registration_associations[0].resource_type #=> String
|
3086
|
+
# resp.registration_associations[0].iso_country_code #=> String
|
3087
|
+
# resp.registration_associations[0].phone_number #=> String
|
2004
3088
|
# resp.next_token #=> String
|
2005
3089
|
#
|
2006
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/
|
3090
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ListRegistrationAssociations AWS API Documentation
|
2007
3091
|
#
|
2008
|
-
# @overload
|
3092
|
+
# @overload list_registration_associations(params = {})
|
2009
3093
|
# @param [Hash] params ({})
|
2010
|
-
def
|
2011
|
-
req = build_request(:
|
3094
|
+
def list_registration_associations(params = {}, options = {})
|
3095
|
+
req = build_request(:list_registration_associations, params)
|
2012
3096
|
req.send_request(options)
|
2013
3097
|
end
|
2014
3098
|
|
@@ -2054,7 +3138,7 @@ module Aws::PinpointSMSVoiceV2
|
|
2054
3138
|
# begins with a keyword, Amazon Pinpoint responds with a customizable
|
2055
3139
|
# message.
|
2056
3140
|
#
|
2057
|
-
# If you specify a keyword that isn't valid, an
|
3141
|
+
# If you specify a keyword that isn't valid, an error is returned.
|
2058
3142
|
#
|
2059
3143
|
# @option params [required, String] :origination_identity
|
2060
3144
|
# The origination identity to use such as a PhoneNumberId,
|
@@ -2069,15 +3153,15 @@ module Aws::PinpointSMSVoiceV2
|
|
2069
3153
|
# @option params [required, String] :keyword_message
|
2070
3154
|
# The message associated with the keyword.
|
2071
3155
|
#
|
3156
|
+
# @option params [String] :keyword_action
|
3157
|
+
# The action to perform for the new keyword when it is received.
|
3158
|
+
#
|
2072
3159
|
# * AUTOMATIC\_RESPONSE: A message is sent to the recipient.
|
2073
3160
|
#
|
2074
3161
|
# * OPT\_OUT: Keeps the recipient from receiving future messages.
|
2075
3162
|
#
|
2076
3163
|
# * OPT\_IN: The recipient wants to receive future messages.
|
2077
3164
|
#
|
2078
|
-
# @option params [String] :keyword_action
|
2079
|
-
# The action to perform for the new keyword when it is received.
|
2080
|
-
#
|
2081
3165
|
# @return [Types::PutKeywordResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2082
3166
|
#
|
2083
3167
|
# * {Types::PutKeywordResult#origination_identity_arn #origination_identity_arn} => String
|
@@ -2115,7 +3199,7 @@ module Aws::PinpointSMSVoiceV2
|
|
2115
3199
|
# Creates an opted out destination phone number in the opt-out list.
|
2116
3200
|
#
|
2117
3201
|
# If the destination phone number isn't valid or if the specified
|
2118
|
-
# opt-out list doesn't exist, an
|
3202
|
+
# opt-out list doesn't exist, an error is returned.
|
2119
3203
|
#
|
2120
3204
|
# @option params [required, String] :opt_out_list_name
|
2121
3205
|
# The OptOutListName or OptOutListArn to add the phone number to.
|
@@ -2155,11 +3239,69 @@ module Aws::PinpointSMSVoiceV2
|
|
2155
3239
|
req.send_request(options)
|
2156
3240
|
end
|
2157
3241
|
|
3242
|
+
# Creates or updates a field value for a registration.
|
3243
|
+
#
|
3244
|
+
# @option params [required, String] :registration_id
|
3245
|
+
# The unique identifier for the registration.
|
3246
|
+
#
|
3247
|
+
# @option params [required, String] :field_path
|
3248
|
+
# The path to the registration form field. You can use
|
3249
|
+
# DescribeRegistrationFieldDefinitions for a list of **FieldPaths**.
|
3250
|
+
#
|
3251
|
+
# @option params [Array<String>] :select_choices
|
3252
|
+
# An array of values for the form field.
|
3253
|
+
#
|
3254
|
+
# @option params [String] :text_value
|
3255
|
+
# The text data for a free form field.
|
3256
|
+
#
|
3257
|
+
# @option params [String] :registration_attachment_id
|
3258
|
+
# The unique identifier for the registration attachment.
|
3259
|
+
#
|
3260
|
+
# @return [Types::PutRegistrationFieldValueResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3261
|
+
#
|
3262
|
+
# * {Types::PutRegistrationFieldValueResult#registration_arn #registration_arn} => String
|
3263
|
+
# * {Types::PutRegistrationFieldValueResult#registration_id #registration_id} => String
|
3264
|
+
# * {Types::PutRegistrationFieldValueResult#version_number #version_number} => Integer
|
3265
|
+
# * {Types::PutRegistrationFieldValueResult#field_path #field_path} => String
|
3266
|
+
# * {Types::PutRegistrationFieldValueResult#select_choices #select_choices} => Array<String>
|
3267
|
+
# * {Types::PutRegistrationFieldValueResult#text_value #text_value} => String
|
3268
|
+
# * {Types::PutRegistrationFieldValueResult#registration_attachment_id #registration_attachment_id} => String
|
3269
|
+
#
|
3270
|
+
# @example Request syntax with placeholder values
|
3271
|
+
#
|
3272
|
+
# resp = client.put_registration_field_value({
|
3273
|
+
# registration_id: "RegistrationIdOrArn", # required
|
3274
|
+
# field_path: "FieldPath", # required
|
3275
|
+
# select_choices: ["SelectChoice"],
|
3276
|
+
# text_value: "TextValue",
|
3277
|
+
# registration_attachment_id: "RegistrationAttachmentIdOrArn",
|
3278
|
+
# })
|
3279
|
+
#
|
3280
|
+
# @example Response structure
|
3281
|
+
#
|
3282
|
+
# resp.registration_arn #=> String
|
3283
|
+
# resp.registration_id #=> String
|
3284
|
+
# resp.version_number #=> Integer
|
3285
|
+
# resp.field_path #=> String
|
3286
|
+
# resp.select_choices #=> Array
|
3287
|
+
# resp.select_choices[0] #=> String
|
3288
|
+
# resp.text_value #=> String
|
3289
|
+
# resp.registration_attachment_id #=> String
|
3290
|
+
#
|
3291
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PutRegistrationFieldValue AWS API Documentation
|
3292
|
+
#
|
3293
|
+
# @overload put_registration_field_value(params = {})
|
3294
|
+
# @param [Hash] params ({})
|
3295
|
+
def put_registration_field_value(params = {}, options = {})
|
3296
|
+
req = build_request(:put_registration_field_value, params)
|
3297
|
+
req.send_request(options)
|
3298
|
+
end
|
3299
|
+
|
2158
3300
|
# Releases an existing origination phone number in your account. Once
|
2159
3301
|
# released, a phone number is no longer available for sending messages.
|
2160
3302
|
#
|
2161
3303
|
# If the origination phone number has deletion protection enabled or is
|
2162
|
-
# associated with a pool, an
|
3304
|
+
# associated with a pool, an error is returned.
|
2163
3305
|
#
|
2164
3306
|
# @option params [required, String] :phone_number_id
|
2165
3307
|
# The PhoneNumberId or PhoneNumberArn of the phone number to release.
|
@@ -2179,8 +3321,10 @@ module Aws::PinpointSMSVoiceV2
|
|
2179
3321
|
# * {Types::ReleasePhoneNumberResult#monthly_leasing_price #monthly_leasing_price} => String
|
2180
3322
|
# * {Types::ReleasePhoneNumberResult#two_way_enabled #two_way_enabled} => Boolean
|
2181
3323
|
# * {Types::ReleasePhoneNumberResult#two_way_channel_arn #two_way_channel_arn} => String
|
3324
|
+
# * {Types::ReleasePhoneNumberResult#two_way_channel_role #two_way_channel_role} => String
|
2182
3325
|
# * {Types::ReleasePhoneNumberResult#self_managed_opt_outs_enabled #self_managed_opt_outs_enabled} => Boolean
|
2183
3326
|
# * {Types::ReleasePhoneNumberResult#opt_out_list_name #opt_out_list_name} => String
|
3327
|
+
# * {Types::ReleasePhoneNumberResult#registration_id #registration_id} => String
|
2184
3328
|
# * {Types::ReleasePhoneNumberResult#created_timestamp #created_timestamp} => Time
|
2185
3329
|
#
|
2186
3330
|
# @example Request syntax with placeholder values
|
@@ -2199,12 +3343,14 @@ module Aws::PinpointSMSVoiceV2
|
|
2199
3343
|
# resp.message_type #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
|
2200
3344
|
# resp.number_capabilities #=> Array
|
2201
3345
|
# resp.number_capabilities[0] #=> String, one of "SMS", "VOICE"
|
2202
|
-
# resp.number_type #=> String, one of "SHORT_CODE", "LONG_CODE", "TOLL_FREE", "TEN_DLC"
|
3346
|
+
# resp.number_type #=> String, one of "SHORT_CODE", "LONG_CODE", "TOLL_FREE", "TEN_DLC", "SIMULATOR"
|
2203
3347
|
# resp.monthly_leasing_price #=> String
|
2204
3348
|
# resp.two_way_enabled #=> Boolean
|
2205
3349
|
# resp.two_way_channel_arn #=> String
|
3350
|
+
# resp.two_way_channel_role #=> String
|
2206
3351
|
# resp.self_managed_opt_outs_enabled #=> Boolean
|
2207
3352
|
# resp.opt_out_list_name #=> String
|
3353
|
+
# resp.registration_id #=> String
|
2208
3354
|
# resp.created_timestamp #=> Time
|
2209
3355
|
#
|
2210
3356
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ReleasePhoneNumber AWS API Documentation
|
@@ -2216,6 +3362,52 @@ module Aws::PinpointSMSVoiceV2
|
|
2216
3362
|
req.send_request(options)
|
2217
3363
|
end
|
2218
3364
|
|
3365
|
+
# Releases an existing sender ID in your account.
|
3366
|
+
#
|
3367
|
+
# @option params [required, String] :sender_id
|
3368
|
+
# The sender ID to release.
|
3369
|
+
#
|
3370
|
+
# @option params [required, String] :iso_country_code
|
3371
|
+
# The two-character code, in ISO 3166-1 alpha-2 format, for the country
|
3372
|
+
# or region.
|
3373
|
+
#
|
3374
|
+
# @return [Types::ReleaseSenderIdResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3375
|
+
#
|
3376
|
+
# * {Types::ReleaseSenderIdResult#sender_id_arn #sender_id_arn} => String
|
3377
|
+
# * {Types::ReleaseSenderIdResult#sender_id #sender_id} => String
|
3378
|
+
# * {Types::ReleaseSenderIdResult#iso_country_code #iso_country_code} => String
|
3379
|
+
# * {Types::ReleaseSenderIdResult#message_types #message_types} => Array<String>
|
3380
|
+
# * {Types::ReleaseSenderIdResult#monthly_leasing_price #monthly_leasing_price} => String
|
3381
|
+
# * {Types::ReleaseSenderIdResult#registered #registered} => Boolean
|
3382
|
+
# * {Types::ReleaseSenderIdResult#registration_id #registration_id} => String
|
3383
|
+
#
|
3384
|
+
# @example Request syntax with placeholder values
|
3385
|
+
#
|
3386
|
+
# resp = client.release_sender_id({
|
3387
|
+
# sender_id: "SenderIdOrArn", # required
|
3388
|
+
# iso_country_code: "IsoCountryCode", # required
|
3389
|
+
# })
|
3390
|
+
#
|
3391
|
+
# @example Response structure
|
3392
|
+
#
|
3393
|
+
# resp.sender_id_arn #=> String
|
3394
|
+
# resp.sender_id #=> String
|
3395
|
+
# resp.iso_country_code #=> String
|
3396
|
+
# resp.message_types #=> Array
|
3397
|
+
# resp.message_types[0] #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
|
3398
|
+
# resp.monthly_leasing_price #=> String
|
3399
|
+
# resp.registered #=> Boolean
|
3400
|
+
# resp.registration_id #=> String
|
3401
|
+
#
|
3402
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ReleaseSenderId AWS API Documentation
|
3403
|
+
#
|
3404
|
+
# @overload release_sender_id(params = {})
|
3405
|
+
# @param [Hash] params ({})
|
3406
|
+
def release_sender_id(params = {}, options = {})
|
3407
|
+
req = build_request(:release_sender_id, params)
|
3408
|
+
req.send_request(options)
|
3409
|
+
end
|
3410
|
+
|
2219
3411
|
# Request an origination phone number for use in your account. For more
|
2220
3412
|
# information on phone number request see [ Requesting a number ][1] in
|
2221
3413
|
# the *Amazon Pinpoint User Guide*.
|
@@ -2242,7 +3434,7 @@ module Aws::PinpointSMSVoiceV2
|
|
2242
3434
|
#
|
2243
3435
|
# @option params [String] :opt_out_list_name
|
2244
3436
|
# The name of the OptOutList to associate with the phone number. You can
|
2245
|
-
# use the
|
3437
|
+
# use the OptOutListName or OptOutListArn.
|
2246
3438
|
#
|
2247
3439
|
# @option params [String] :pool_id
|
2248
3440
|
# The pool to associated with the phone number. You can use the PoolId
|
@@ -2282,10 +3474,12 @@ module Aws::PinpointSMSVoiceV2
|
|
2282
3474
|
# * {Types::RequestPhoneNumberResult#monthly_leasing_price #monthly_leasing_price} => String
|
2283
3475
|
# * {Types::RequestPhoneNumberResult#two_way_enabled #two_way_enabled} => Boolean
|
2284
3476
|
# * {Types::RequestPhoneNumberResult#two_way_channel_arn #two_way_channel_arn} => String
|
3477
|
+
# * {Types::RequestPhoneNumberResult#two_way_channel_role #two_way_channel_role} => String
|
2285
3478
|
# * {Types::RequestPhoneNumberResult#self_managed_opt_outs_enabled #self_managed_opt_outs_enabled} => Boolean
|
2286
3479
|
# * {Types::RequestPhoneNumberResult#opt_out_list_name #opt_out_list_name} => String
|
2287
3480
|
# * {Types::RequestPhoneNumberResult#deletion_protection_enabled #deletion_protection_enabled} => Boolean
|
2288
3481
|
# * {Types::RequestPhoneNumberResult#pool_id #pool_id} => String
|
3482
|
+
# * {Types::RequestPhoneNumberResult#registration_id #registration_id} => String
|
2289
3483
|
# * {Types::RequestPhoneNumberResult#tags #tags} => Array<Types::Tag>
|
2290
3484
|
# * {Types::RequestPhoneNumberResult#created_timestamp #created_timestamp} => Time
|
2291
3485
|
#
|
@@ -2295,10 +3489,10 @@ module Aws::PinpointSMSVoiceV2
|
|
2295
3489
|
# iso_country_code: "IsoCountryCode", # required
|
2296
3490
|
# message_type: "TRANSACTIONAL", # required, accepts TRANSACTIONAL, PROMOTIONAL
|
2297
3491
|
# number_capabilities: ["SMS"], # required, accepts SMS, VOICE
|
2298
|
-
# number_type: "LONG_CODE", # required, accepts LONG_CODE, TOLL_FREE, TEN_DLC
|
3492
|
+
# number_type: "LONG_CODE", # required, accepts LONG_CODE, TOLL_FREE, TEN_DLC, SIMULATOR
|
2299
3493
|
# opt_out_list_name: "OptOutListNameOrArn",
|
2300
3494
|
# pool_id: "PoolIdOrArn",
|
2301
|
-
# registration_id: "
|
3495
|
+
# registration_id: "RegistrationIdOrArn",
|
2302
3496
|
# deletion_protection_enabled: false,
|
2303
3497
|
# tags: [
|
2304
3498
|
# {
|
@@ -2319,14 +3513,16 @@ module Aws::PinpointSMSVoiceV2
|
|
2319
3513
|
# resp.message_type #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
|
2320
3514
|
# resp.number_capabilities #=> Array
|
2321
3515
|
# resp.number_capabilities[0] #=> String, one of "SMS", "VOICE"
|
2322
|
-
# resp.number_type #=> String, one of "LONG_CODE", "TOLL_FREE", "TEN_DLC"
|
3516
|
+
# resp.number_type #=> String, one of "LONG_CODE", "TOLL_FREE", "TEN_DLC", "SIMULATOR"
|
2323
3517
|
# resp.monthly_leasing_price #=> String
|
2324
3518
|
# resp.two_way_enabled #=> Boolean
|
2325
3519
|
# resp.two_way_channel_arn #=> String
|
3520
|
+
# resp.two_way_channel_role #=> String
|
2326
3521
|
# resp.self_managed_opt_outs_enabled #=> Boolean
|
2327
3522
|
# resp.opt_out_list_name #=> String
|
2328
3523
|
# resp.deletion_protection_enabled #=> Boolean
|
2329
3524
|
# resp.pool_id #=> String
|
3525
|
+
# resp.registration_id #=> String
|
2330
3526
|
# resp.tags #=> Array
|
2331
3527
|
# resp.tags[0].key #=> String
|
2332
3528
|
# resp.tags[0].value #=> String
|
@@ -2341,6 +3537,160 @@ module Aws::PinpointSMSVoiceV2
|
|
2341
3537
|
req.send_request(options)
|
2342
3538
|
end
|
2343
3539
|
|
3540
|
+
# Request a new sender ID that doesn't require registration.
|
3541
|
+
#
|
3542
|
+
# @option params [required, String] :sender_id
|
3543
|
+
# The sender ID string to request.
|
3544
|
+
#
|
3545
|
+
# @option params [required, String] :iso_country_code
|
3546
|
+
# The two-character code, in ISO 3166-1 alpha-2 format, for the country
|
3547
|
+
# or region.
|
3548
|
+
#
|
3549
|
+
# @option params [Array<String>] :message_types
|
3550
|
+
# The type of message. Valid values are TRANSACTIONAL for messages that
|
3551
|
+
# are critical or time-sensitive and PROMOTIONAL for messages that
|
3552
|
+
# aren't critical or time-sensitive.
|
3553
|
+
#
|
3554
|
+
# @option params [Boolean] :deletion_protection_enabled
|
3555
|
+
# By default this is set to false. When set to true the sender ID can't
|
3556
|
+
# be deleted.
|
3557
|
+
#
|
3558
|
+
# @option params [Array<Types::Tag>] :tags
|
3559
|
+
# An array of tags (key and value pairs) to associate with the sender
|
3560
|
+
# ID.
|
3561
|
+
#
|
3562
|
+
# @option params [String] :client_token
|
3563
|
+
# Unique, case-sensitive identifier that you provide to ensure the
|
3564
|
+
# idempotency of the request. If you don't specify a client token, a
|
3565
|
+
# randomly generated token is used for the request to ensure
|
3566
|
+
# idempotency.
|
3567
|
+
#
|
3568
|
+
# **A suitable default value is auto-generated.** You should normally
|
3569
|
+
# not need to pass this option.**
|
3570
|
+
#
|
3571
|
+
# @return [Types::RequestSenderIdResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3572
|
+
#
|
3573
|
+
# * {Types::RequestSenderIdResult#sender_id_arn #sender_id_arn} => String
|
3574
|
+
# * {Types::RequestSenderIdResult#sender_id #sender_id} => String
|
3575
|
+
# * {Types::RequestSenderIdResult#iso_country_code #iso_country_code} => String
|
3576
|
+
# * {Types::RequestSenderIdResult#message_types #message_types} => Array<String>
|
3577
|
+
# * {Types::RequestSenderIdResult#monthly_leasing_price #monthly_leasing_price} => String
|
3578
|
+
# * {Types::RequestSenderIdResult#deletion_protection_enabled #deletion_protection_enabled} => Boolean
|
3579
|
+
# * {Types::RequestSenderIdResult#registered #registered} => Boolean
|
3580
|
+
# * {Types::RequestSenderIdResult#tags #tags} => Array<Types::Tag>
|
3581
|
+
#
|
3582
|
+
# @example Request syntax with placeholder values
|
3583
|
+
#
|
3584
|
+
# resp = client.request_sender_id({
|
3585
|
+
# sender_id: "SenderId", # required
|
3586
|
+
# iso_country_code: "IsoCountryCode", # required
|
3587
|
+
# message_types: ["TRANSACTIONAL"], # accepts TRANSACTIONAL, PROMOTIONAL
|
3588
|
+
# deletion_protection_enabled: false,
|
3589
|
+
# tags: [
|
3590
|
+
# {
|
3591
|
+
# key: "TagKey", # required
|
3592
|
+
# value: "TagValue", # required
|
3593
|
+
# },
|
3594
|
+
# ],
|
3595
|
+
# client_token: "ClientToken",
|
3596
|
+
# })
|
3597
|
+
#
|
3598
|
+
# @example Response structure
|
3599
|
+
#
|
3600
|
+
# resp.sender_id_arn #=> String
|
3601
|
+
# resp.sender_id #=> String
|
3602
|
+
# resp.iso_country_code #=> String
|
3603
|
+
# resp.message_types #=> Array
|
3604
|
+
# resp.message_types[0] #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
|
3605
|
+
# resp.monthly_leasing_price #=> String
|
3606
|
+
# resp.deletion_protection_enabled #=> Boolean
|
3607
|
+
# resp.registered #=> Boolean
|
3608
|
+
# resp.tags #=> Array
|
3609
|
+
# resp.tags[0].key #=> String
|
3610
|
+
# resp.tags[0].value #=> String
|
3611
|
+
#
|
3612
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/RequestSenderId AWS API Documentation
|
3613
|
+
#
|
3614
|
+
# @overload request_sender_id(params = {})
|
3615
|
+
# @param [Hash] params ({})
|
3616
|
+
def request_sender_id(params = {}, options = {})
|
3617
|
+
req = build_request(:request_sender_id, params)
|
3618
|
+
req.send_request(options)
|
3619
|
+
end
|
3620
|
+
|
3621
|
+
# Before you can send test messages to a verified destination phone
|
3622
|
+
# number you need to opt-in the verified destination phone number.
|
3623
|
+
# Creates a new text message with a verification code and send it to a
|
3624
|
+
# verified destination phone number. Once you have the verification code
|
3625
|
+
# use VerifyDestinationNumber to opt-in the verified destination phone
|
3626
|
+
# number to receive messages.
|
3627
|
+
#
|
3628
|
+
# @option params [required, String] :verified_destination_number_id
|
3629
|
+
# The unique identifier for the verified destination phone number.
|
3630
|
+
#
|
3631
|
+
# @option params [required, String] :verification_channel
|
3632
|
+
# Choose to send the verification code as an SMS or voice message.
|
3633
|
+
#
|
3634
|
+
# @option params [String] :language_code
|
3635
|
+
# Choose the language to use for the message.
|
3636
|
+
#
|
3637
|
+
# @option params [String] :origination_identity
|
3638
|
+
# The origination identity of the message. This can be either the
|
3639
|
+
# PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn,
|
3640
|
+
# PoolId, or PoolArn.
|
3641
|
+
#
|
3642
|
+
# @option params [String] :configuration_set_name
|
3643
|
+
# The name of the configuration set to use. This can be either the
|
3644
|
+
# ConfigurationSetName or ConfigurationSetArn.
|
3645
|
+
#
|
3646
|
+
# @option params [Hash<String,String>] :context
|
3647
|
+
# You can specify custom data in this field. If you do, that data is
|
3648
|
+
# logged to the event destination.
|
3649
|
+
#
|
3650
|
+
# @option params [Hash<String,String>] :destination_country_parameters
|
3651
|
+
# This field is used for any country-specific registration requirements.
|
3652
|
+
# Currently, this setting is only used when you send messages to
|
3653
|
+
# recipients in India using a sender ID. For more information see
|
3654
|
+
# [Special requirements for sending SMS messages to recipients in
|
3655
|
+
# India][1].
|
3656
|
+
#
|
3657
|
+
#
|
3658
|
+
#
|
3659
|
+
# [1]: https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-senderid-india.html
|
3660
|
+
#
|
3661
|
+
# @return [Types::SendDestinationNumberVerificationCodeResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3662
|
+
#
|
3663
|
+
# * {Types::SendDestinationNumberVerificationCodeResult#message_id #message_id} => String
|
3664
|
+
#
|
3665
|
+
# @example Request syntax with placeholder values
|
3666
|
+
#
|
3667
|
+
# resp = client.send_destination_number_verification_code({
|
3668
|
+
# verified_destination_number_id: "VerifiedDestinationNumberIdOrArn", # required
|
3669
|
+
# verification_channel: "TEXT", # required, accepts TEXT, VOICE
|
3670
|
+
# language_code: "DE_DE", # accepts 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
|
3671
|
+
# origination_identity: "VerificationMessageOriginationIdentity",
|
3672
|
+
# configuration_set_name: "ConfigurationSetNameOrArn",
|
3673
|
+
# context: {
|
3674
|
+
# "ContextKey" => "ContextValue",
|
3675
|
+
# },
|
3676
|
+
# destination_country_parameters: {
|
3677
|
+
# "IN_TEMPLATE_ID" => "DestinationCountryParameterValue",
|
3678
|
+
# },
|
3679
|
+
# })
|
3680
|
+
#
|
3681
|
+
# @example Response structure
|
3682
|
+
#
|
3683
|
+
# resp.message_id #=> String
|
3684
|
+
#
|
3685
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SendDestinationNumberVerificationCode AWS API Documentation
|
3686
|
+
#
|
3687
|
+
# @overload send_destination_number_verification_code(params = {})
|
3688
|
+
# @param [Hash] params ({})
|
3689
|
+
def send_destination_number_verification_code(params = {}, options = {})
|
3690
|
+
req = build_request(:send_destination_number_verification_code, params)
|
3691
|
+
req.send_request(options)
|
3692
|
+
end
|
3693
|
+
|
2344
3694
|
# Creates a new text message and sends it to a recipient's phone
|
2345
3695
|
# number.
|
2346
3696
|
#
|
@@ -2366,9 +3716,9 @@ module Aws::PinpointSMSVoiceV2
|
|
2366
3716
|
# The body of the text message.
|
2367
3717
|
#
|
2368
3718
|
# @option params [String] :message_type
|
2369
|
-
# The type of message. Valid values are
|
2370
|
-
#
|
2371
|
-
#
|
3719
|
+
# The type of message. Valid values are for messages that are critical
|
3720
|
+
# or time-sensitive and PROMOTIONAL for messages that aren't critical
|
3721
|
+
# or time-sensitive.
|
2372
3722
|
#
|
2373
3723
|
# @option params [String] :keyword
|
2374
3724
|
# When you register a short code in the US, you must specify a program
|
@@ -2441,7 +3791,7 @@ module Aws::PinpointSMSVoiceV2
|
|
2441
3791
|
req.send_request(options)
|
2442
3792
|
end
|
2443
3793
|
|
2444
|
-
# Allows you to send a request that sends a
|
3794
|
+
# Allows you to send a request that sends a voice message through Amazon
|
2445
3795
|
# Pinpoint. This operation uses [Amazon Polly][1] to convert a text
|
2446
3796
|
# script into a voice message.
|
2447
3797
|
#
|
@@ -2686,6 +4036,49 @@ module Aws::PinpointSMSVoiceV2
|
|
2686
4036
|
req.send_request(options)
|
2687
4037
|
end
|
2688
4038
|
|
4039
|
+
# Submit the specified registration for review and approval.
|
4040
|
+
#
|
4041
|
+
# @option params [required, String] :registration_id
|
4042
|
+
# The unique identifier for the registration.
|
4043
|
+
#
|
4044
|
+
# @return [Types::SubmitRegistrationVersionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4045
|
+
#
|
4046
|
+
# * {Types::SubmitRegistrationVersionResult#registration_arn #registration_arn} => String
|
4047
|
+
# * {Types::SubmitRegistrationVersionResult#registration_id #registration_id} => String
|
4048
|
+
# * {Types::SubmitRegistrationVersionResult#version_number #version_number} => Integer
|
4049
|
+
# * {Types::SubmitRegistrationVersionResult#registration_version_status #registration_version_status} => String
|
4050
|
+
# * {Types::SubmitRegistrationVersionResult#registration_version_status_history #registration_version_status_history} => Types::RegistrationVersionStatusHistory
|
4051
|
+
#
|
4052
|
+
# @example Request syntax with placeholder values
|
4053
|
+
#
|
4054
|
+
# resp = client.submit_registration_version({
|
4055
|
+
# registration_id: "RegistrationIdOrArn", # required
|
4056
|
+
# })
|
4057
|
+
#
|
4058
|
+
# @example Response structure
|
4059
|
+
#
|
4060
|
+
# resp.registration_arn #=> String
|
4061
|
+
# resp.registration_id #=> String
|
4062
|
+
# resp.version_number #=> Integer
|
4063
|
+
# resp.registration_version_status #=> String, one of "DRAFT", "SUBMITTED", "REVIEWING", "APPROVED", "DISCARDED", "DENIED", "REVOKED", "ARCHIVED"
|
4064
|
+
# resp.registration_version_status_history.draft_timestamp #=> Time
|
4065
|
+
# resp.registration_version_status_history.submitted_timestamp #=> Time
|
4066
|
+
# resp.registration_version_status_history.reviewing_timestamp #=> Time
|
4067
|
+
# resp.registration_version_status_history.approved_timestamp #=> Time
|
4068
|
+
# resp.registration_version_status_history.discarded_timestamp #=> Time
|
4069
|
+
# resp.registration_version_status_history.denied_timestamp #=> Time
|
4070
|
+
# resp.registration_version_status_history.revoked_timestamp #=> Time
|
4071
|
+
# resp.registration_version_status_history.archived_timestamp #=> Time
|
4072
|
+
#
|
4073
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SubmitRegistrationVersion AWS API Documentation
|
4074
|
+
#
|
4075
|
+
# @overload submit_registration_version(params = {})
|
4076
|
+
# @param [Hash] params ({})
|
4077
|
+
def submit_registration_version(params = {}, options = {})
|
4078
|
+
req = build_request(:submit_registration_version, params)
|
4079
|
+
req.send_request(options)
|
4080
|
+
end
|
4081
|
+
|
2689
4082
|
# Adds or overwrites only the specified tags for the specified Amazon
|
2690
4083
|
# Pinpoint SMS Voice, version 2 resource. When you specify an existing
|
2691
4084
|
# tag key, the value is overwritten with the new value. Each resource
|
@@ -2784,6 +4177,10 @@ module Aws::PinpointSMSVoiceV2
|
|
2784
4177
|
# @option params [Array<String>] :matching_event_types
|
2785
4178
|
# An array of event types that determine which events to log.
|
2786
4179
|
#
|
4180
|
+
# <note markdown="1"> The `TEXT_SENT` event type is not supported.
|
4181
|
+
#
|
4182
|
+
# </note>
|
4183
|
+
#
|
2787
4184
|
# @option params [Types::CloudWatchLogsDestination] :cloud_watch_logs_destination
|
2788
4185
|
# An object that contains information about an event destination that
|
2789
4186
|
# sends data to CloudWatch Logs.
|
@@ -2850,7 +4247,7 @@ module Aws::PinpointSMSVoiceV2
|
|
2850
4247
|
# change the TwoWayChannelArn, enable or disable self-managed opt-outs,
|
2851
4248
|
# and enable or disable deletion protection.
|
2852
4249
|
#
|
2853
|
-
# If the origination phone number is associated with a pool, an
|
4250
|
+
# If the origination phone number is associated with a pool, an error is
|
2854
4251
|
# returned.
|
2855
4252
|
#
|
2856
4253
|
# @option params [required, String] :phone_number_id
|
@@ -2864,6 +4261,10 @@ module Aws::PinpointSMSVoiceV2
|
|
2864
4261
|
# @option params [String] :two_way_channel_arn
|
2865
4262
|
# The Amazon Resource Name (ARN) of the two way channel.
|
2866
4263
|
#
|
4264
|
+
# @option params [String] :two_way_channel_role
|
4265
|
+
# An optional IAM Role Arn for a service to assume, to be able to post
|
4266
|
+
# inbound SMS messages.
|
4267
|
+
#
|
2867
4268
|
# @option params [Boolean] :self_managed_opt_outs_enabled
|
2868
4269
|
# By default this is set to false. When an end recipient sends a message
|
2869
4270
|
# that begins with HELP or STOP to one of your dedicated numbers, Amazon
|
@@ -2893,9 +4294,11 @@ module Aws::PinpointSMSVoiceV2
|
|
2893
4294
|
# * {Types::UpdatePhoneNumberResult#monthly_leasing_price #monthly_leasing_price} => String
|
2894
4295
|
# * {Types::UpdatePhoneNumberResult#two_way_enabled #two_way_enabled} => Boolean
|
2895
4296
|
# * {Types::UpdatePhoneNumberResult#two_way_channel_arn #two_way_channel_arn} => String
|
4297
|
+
# * {Types::UpdatePhoneNumberResult#two_way_channel_role #two_way_channel_role} => String
|
2896
4298
|
# * {Types::UpdatePhoneNumberResult#self_managed_opt_outs_enabled #self_managed_opt_outs_enabled} => Boolean
|
2897
4299
|
# * {Types::UpdatePhoneNumberResult#opt_out_list_name #opt_out_list_name} => String
|
2898
4300
|
# * {Types::UpdatePhoneNumberResult#deletion_protection_enabled #deletion_protection_enabled} => Boolean
|
4301
|
+
# * {Types::UpdatePhoneNumberResult#registration_id #registration_id} => String
|
2899
4302
|
# * {Types::UpdatePhoneNumberResult#created_timestamp #created_timestamp} => Time
|
2900
4303
|
#
|
2901
4304
|
# @example Request syntax with placeholder values
|
@@ -2904,6 +4307,7 @@ module Aws::PinpointSMSVoiceV2
|
|
2904
4307
|
# phone_number_id: "PhoneNumberIdOrArn", # required
|
2905
4308
|
# two_way_enabled: false,
|
2906
4309
|
# two_way_channel_arn: "TwoWayChannelArn",
|
4310
|
+
# two_way_channel_role: "IamRoleArn",
|
2907
4311
|
# self_managed_opt_outs_enabled: false,
|
2908
4312
|
# opt_out_list_name: "OptOutListNameOrArn",
|
2909
4313
|
# deletion_protection_enabled: false,
|
@@ -2919,13 +4323,15 @@ module Aws::PinpointSMSVoiceV2
|
|
2919
4323
|
# resp.message_type #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
|
2920
4324
|
# resp.number_capabilities #=> Array
|
2921
4325
|
# resp.number_capabilities[0] #=> String, one of "SMS", "VOICE"
|
2922
|
-
# resp.number_type #=> String, one of "SHORT_CODE", "LONG_CODE", "TOLL_FREE", "TEN_DLC"
|
4326
|
+
# resp.number_type #=> String, one of "SHORT_CODE", "LONG_CODE", "TOLL_FREE", "TEN_DLC", "SIMULATOR"
|
2923
4327
|
# resp.monthly_leasing_price #=> String
|
2924
4328
|
# resp.two_way_enabled #=> Boolean
|
2925
4329
|
# resp.two_way_channel_arn #=> String
|
4330
|
+
# resp.two_way_channel_role #=> String
|
2926
4331
|
# resp.self_managed_opt_outs_enabled #=> Boolean
|
2927
4332
|
# resp.opt_out_list_name #=> String
|
2928
4333
|
# resp.deletion_protection_enabled #=> Boolean
|
4334
|
+
# resp.registration_id #=> String
|
2929
4335
|
# resp.created_timestamp #=> Time
|
2930
4336
|
#
|
2931
4337
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/UpdatePhoneNumber AWS API Documentation
|
@@ -2953,6 +4359,10 @@ module Aws::PinpointSMSVoiceV2
|
|
2953
4359
|
# @option params [String] :two_way_channel_arn
|
2954
4360
|
# The Amazon Resource Name (ARN) of the two way channel.
|
2955
4361
|
#
|
4362
|
+
# @option params [String] :two_way_channel_role
|
4363
|
+
# An optional IAM Role Arn for a service to assume, to be able to post
|
4364
|
+
# inbound SMS messages.
|
4365
|
+
#
|
2956
4366
|
# @option params [Boolean] :self_managed_opt_outs_enabled
|
2957
4367
|
# By default this is set to false. When an end recipient sends a message
|
2958
4368
|
# that begins with HELP or STOP to one of your dedicated numbers, Amazon
|
@@ -2979,6 +4389,7 @@ module Aws::PinpointSMSVoiceV2
|
|
2979
4389
|
# * {Types::UpdatePoolResult#message_type #message_type} => String
|
2980
4390
|
# * {Types::UpdatePoolResult#two_way_enabled #two_way_enabled} => Boolean
|
2981
4391
|
# * {Types::UpdatePoolResult#two_way_channel_arn #two_way_channel_arn} => String
|
4392
|
+
# * {Types::UpdatePoolResult#two_way_channel_role #two_way_channel_role} => String
|
2982
4393
|
# * {Types::UpdatePoolResult#self_managed_opt_outs_enabled #self_managed_opt_outs_enabled} => Boolean
|
2983
4394
|
# * {Types::UpdatePoolResult#opt_out_list_name #opt_out_list_name} => String
|
2984
4395
|
# * {Types::UpdatePoolResult#shared_routes_enabled #shared_routes_enabled} => Boolean
|
@@ -2991,6 +4402,7 @@ module Aws::PinpointSMSVoiceV2
|
|
2991
4402
|
# pool_id: "PoolIdOrArn", # required
|
2992
4403
|
# two_way_enabled: false,
|
2993
4404
|
# two_way_channel_arn: "TwoWayChannelArn",
|
4405
|
+
# two_way_channel_role: "IamRoleArn",
|
2994
4406
|
# self_managed_opt_outs_enabled: false,
|
2995
4407
|
# opt_out_list_name: "OptOutListNameOrArn",
|
2996
4408
|
# shared_routes_enabled: false,
|
@@ -3005,6 +4417,7 @@ module Aws::PinpointSMSVoiceV2
|
|
3005
4417
|
# resp.message_type #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
|
3006
4418
|
# resp.two_way_enabled #=> Boolean
|
3007
4419
|
# resp.two_way_channel_arn #=> String
|
4420
|
+
# resp.two_way_channel_role #=> String
|
3008
4421
|
# resp.self_managed_opt_outs_enabled #=> Boolean
|
3009
4422
|
# resp.opt_out_list_name #=> String
|
3010
4423
|
# resp.shared_routes_enabled #=> Boolean
|
@@ -3020,6 +4433,102 @@ module Aws::PinpointSMSVoiceV2
|
|
3020
4433
|
req.send_request(options)
|
3021
4434
|
end
|
3022
4435
|
|
4436
|
+
# Updates the configuration of an existing sender ID.
|
4437
|
+
#
|
4438
|
+
# @option params [required, String] :sender_id
|
4439
|
+
# The sender ID to update.
|
4440
|
+
#
|
4441
|
+
# @option params [required, String] :iso_country_code
|
4442
|
+
# The two-character code, in ISO 3166-1 alpha-2 format, for the country
|
4443
|
+
# or region.
|
4444
|
+
#
|
4445
|
+
# @option params [Boolean] :deletion_protection_enabled
|
4446
|
+
# By default this is set to false. When set to true the sender ID can't
|
4447
|
+
# be deleted.
|
4448
|
+
#
|
4449
|
+
# @return [Types::UpdateSenderIdResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4450
|
+
#
|
4451
|
+
# * {Types::UpdateSenderIdResult#sender_id_arn #sender_id_arn} => String
|
4452
|
+
# * {Types::UpdateSenderIdResult#sender_id #sender_id} => String
|
4453
|
+
# * {Types::UpdateSenderIdResult#iso_country_code #iso_country_code} => String
|
4454
|
+
# * {Types::UpdateSenderIdResult#message_types #message_types} => Array<String>
|
4455
|
+
# * {Types::UpdateSenderIdResult#monthly_leasing_price #monthly_leasing_price} => String
|
4456
|
+
# * {Types::UpdateSenderIdResult#deletion_protection_enabled #deletion_protection_enabled} => Boolean
|
4457
|
+
# * {Types::UpdateSenderIdResult#registered #registered} => Boolean
|
4458
|
+
# * {Types::UpdateSenderIdResult#registration_id #registration_id} => String
|
4459
|
+
#
|
4460
|
+
# @example Request syntax with placeholder values
|
4461
|
+
#
|
4462
|
+
# resp = client.update_sender_id({
|
4463
|
+
# sender_id: "SenderIdOrArn", # required
|
4464
|
+
# iso_country_code: "IsoCountryCode", # required
|
4465
|
+
# deletion_protection_enabled: false,
|
4466
|
+
# })
|
4467
|
+
#
|
4468
|
+
# @example Response structure
|
4469
|
+
#
|
4470
|
+
# resp.sender_id_arn #=> String
|
4471
|
+
# resp.sender_id #=> String
|
4472
|
+
# resp.iso_country_code #=> String
|
4473
|
+
# resp.message_types #=> Array
|
4474
|
+
# resp.message_types[0] #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
|
4475
|
+
# resp.monthly_leasing_price #=> String
|
4476
|
+
# resp.deletion_protection_enabled #=> Boolean
|
4477
|
+
# resp.registered #=> Boolean
|
4478
|
+
# resp.registration_id #=> String
|
4479
|
+
#
|
4480
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/UpdateSenderId AWS API Documentation
|
4481
|
+
#
|
4482
|
+
# @overload update_sender_id(params = {})
|
4483
|
+
# @param [Hash] params ({})
|
4484
|
+
def update_sender_id(params = {}, options = {})
|
4485
|
+
req = build_request(:update_sender_id, params)
|
4486
|
+
req.send_request(options)
|
4487
|
+
end
|
4488
|
+
|
4489
|
+
# Use the verification code that was received by the verified
|
4490
|
+
# destination phone number to opt-in the verified destination phone
|
4491
|
+
# number to receive more messages.
|
4492
|
+
#
|
4493
|
+
# @option params [required, String] :verified_destination_number_id
|
4494
|
+
# The unique identifier for the verififed destination phone number.
|
4495
|
+
#
|
4496
|
+
# @option params [required, String] :verification_code
|
4497
|
+
# The verification code that was received by the verified destination
|
4498
|
+
# phone number.
|
4499
|
+
#
|
4500
|
+
# @return [Types::VerifyDestinationNumberResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4501
|
+
#
|
4502
|
+
# * {Types::VerifyDestinationNumberResult#verified_destination_number_arn #verified_destination_number_arn} => String
|
4503
|
+
# * {Types::VerifyDestinationNumberResult#verified_destination_number_id #verified_destination_number_id} => String
|
4504
|
+
# * {Types::VerifyDestinationNumberResult#destination_phone_number #destination_phone_number} => String
|
4505
|
+
# * {Types::VerifyDestinationNumberResult#status #status} => String
|
4506
|
+
# * {Types::VerifyDestinationNumberResult#created_timestamp #created_timestamp} => Time
|
4507
|
+
#
|
4508
|
+
# @example Request syntax with placeholder values
|
4509
|
+
#
|
4510
|
+
# resp = client.verify_destination_number({
|
4511
|
+
# verified_destination_number_id: "VerifiedDestinationNumberIdOrArn", # required
|
4512
|
+
# verification_code: "VerificationCode", # required
|
4513
|
+
# })
|
4514
|
+
#
|
4515
|
+
# @example Response structure
|
4516
|
+
#
|
4517
|
+
# resp.verified_destination_number_arn #=> String
|
4518
|
+
# resp.verified_destination_number_id #=> String
|
4519
|
+
# resp.destination_phone_number #=> String
|
4520
|
+
# resp.status #=> String, one of "PENDING", "VERIFIED"
|
4521
|
+
# resp.created_timestamp #=> Time
|
4522
|
+
#
|
4523
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/VerifyDestinationNumber AWS API Documentation
|
4524
|
+
#
|
4525
|
+
# @overload verify_destination_number(params = {})
|
4526
|
+
# @param [Hash] params ({})
|
4527
|
+
def verify_destination_number(params = {}, options = {})
|
4528
|
+
req = build_request(:verify_destination_number, params)
|
4529
|
+
req.send_request(options)
|
4530
|
+
end
|
4531
|
+
|
3023
4532
|
# @!endgroup
|
3024
4533
|
|
3025
4534
|
# @param params ({})
|
@@ -3033,7 +4542,7 @@ module Aws::PinpointSMSVoiceV2
|
|
3033
4542
|
params: params,
|
3034
4543
|
config: config)
|
3035
4544
|
context[:gem_name] = 'aws-sdk-pinpointsmsvoicev2'
|
3036
|
-
context[:gem_version] = '1.
|
4545
|
+
context[:gem_version] = '1.11.0'
|
3037
4546
|
Seahorse::Client::Request.new(handlers, context)
|
3038
4547
|
end
|
3039
4548
|
|