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.
@@ -348,6 +348,10 @@ module Aws::PinpointSMSVoiceV2
348
348
  # @!attribute [rw] matching_event_types
349
349
  # An array of event types that determine which events to log. If
350
350
  # "ALL" is used, then Amazon Pinpoint logs every event type.
351
+ #
352
+ # <note markdown="1"> The `TEXT_SENT` event type is not supported.
353
+ #
354
+ # </note>
351
355
  # @return [Array<String>]
352
356
  #
353
357
  # @!attribute [rw] cloud_watch_logs_destination
@@ -555,6 +559,11 @@ module Aws::PinpointSMSVoiceV2
555
559
  # The Amazon Resource Name (ARN) of the two way channel.
556
560
  # @return [String]
557
561
  #
562
+ # @!attribute [rw] two_way_channel_role
563
+ # An optional IAM Role Arn for a service to assume, to be able to post
564
+ # inbound SMS messages.
565
+ # @return [String]
566
+ #
558
567
  # @!attribute [rw] self_managed_opt_outs_enabled
559
568
  # By default this is set to false. When an end recipient sends a
560
569
  # message that begins with HELP or STOP to one of your dedicated
@@ -598,6 +607,7 @@ module Aws::PinpointSMSVoiceV2
598
607
  :message_type,
599
608
  :two_way_enabled,
600
609
  :two_way_channel_arn,
610
+ :two_way_channel_role,
601
611
  :self_managed_opt_outs_enabled,
602
612
  :opt_out_list_name,
603
613
  :shared_routes_enabled,
@@ -608,6 +618,409 @@ module Aws::PinpointSMSVoiceV2
608
618
  include Aws::Structure
609
619
  end
610
620
 
621
+ # @!attribute [rw] registration_id
622
+ # The unique identifier for the registration.
623
+ # @return [String]
624
+ #
625
+ # @!attribute [rw] resource_id
626
+ # The unique identifier for the origination identity. For example this
627
+ # could be a **PhoneNumberId** or **SenderId**.
628
+ # @return [String]
629
+ #
630
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CreateRegistrationAssociationRequest AWS API Documentation
631
+ #
632
+ class CreateRegistrationAssociationRequest < Struct.new(
633
+ :registration_id,
634
+ :resource_id)
635
+ SENSITIVE = []
636
+ include Aws::Structure
637
+ end
638
+
639
+ # @!attribute [rw] registration_arn
640
+ # The Amazon Resource Name (ARN) for the registration.
641
+ # @return [String]
642
+ #
643
+ # @!attribute [rw] registration_id
644
+ # The unique identifier for the registration.
645
+ # @return [String]
646
+ #
647
+ # @!attribute [rw] registration_type
648
+ # The type of registration form. The list of **RegistrationTypes** can
649
+ # be found using the DescribeRegistrationTypeDefinitions action.
650
+ # @return [String]
651
+ #
652
+ # @!attribute [rw] resource_arn
653
+ # The Amazon Resource Name (ARN) of the origination identity that is
654
+ # associated with the registration.
655
+ # @return [String]
656
+ #
657
+ # @!attribute [rw] resource_id
658
+ # The unique identifier for the origination identity. For example this
659
+ # could be a **PhoneNumberId** or **SenderId**.
660
+ # @return [String]
661
+ #
662
+ # @!attribute [rw] resource_type
663
+ # The registration type or origination identity type.
664
+ # @return [String]
665
+ #
666
+ # @!attribute [rw] iso_country_code
667
+ # The two-character code, in ISO 3166-1 alpha-2 format, for the
668
+ # country or region.
669
+ # @return [String]
670
+ #
671
+ # @!attribute [rw] phone_number
672
+ # The phone number associated with the registration in E.164 format.
673
+ # @return [String]
674
+ #
675
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CreateRegistrationAssociationResult AWS API Documentation
676
+ #
677
+ class CreateRegistrationAssociationResult < Struct.new(
678
+ :registration_arn,
679
+ :registration_id,
680
+ :registration_type,
681
+ :resource_arn,
682
+ :resource_id,
683
+ :resource_type,
684
+ :iso_country_code,
685
+ :phone_number)
686
+ SENSITIVE = []
687
+ include Aws::Structure
688
+ end
689
+
690
+ # @!attribute [rw] attachment_body
691
+ # The registration file to upload. The maximum file size is 1MiB and
692
+ # valid file extensions are PDF, JPEG and PNG.
693
+ # @return [String]
694
+ #
695
+ # @!attribute [rw] attachment_url
696
+ # A URL to the required registration file. For example, you can
697
+ # provide the S3 object URL.
698
+ # @return [String]
699
+ #
700
+ # @!attribute [rw] tags
701
+ # An array of tags (key and value pairs) to associate with the
702
+ # registration attachment.
703
+ # @return [Array<Types::Tag>]
704
+ #
705
+ # @!attribute [rw] client_token
706
+ # Unique, case-sensitive identifier that you provide to ensure the
707
+ # idempotency of the request. If you don't specify a client token, a
708
+ # randomly generated token is used for the request to ensure
709
+ # idempotency.
710
+ #
711
+ # **A suitable default value is auto-generated.** You should normally
712
+ # not need to pass this option.
713
+ # @return [String]
714
+ #
715
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CreateRegistrationAttachmentRequest AWS API Documentation
716
+ #
717
+ class CreateRegistrationAttachmentRequest < Struct.new(
718
+ :attachment_body,
719
+ :attachment_url,
720
+ :tags,
721
+ :client_token)
722
+ SENSITIVE = []
723
+ include Aws::Structure
724
+ end
725
+
726
+ # @!attribute [rw] registration_attachment_arn
727
+ # The Amazon Resource Name (ARN) for the registration attachment.
728
+ # @return [String]
729
+ #
730
+ # @!attribute [rw] registration_attachment_id
731
+ # The unique identifier for the registration attachment.
732
+ # @return [String]
733
+ #
734
+ # @!attribute [rw] attachment_status
735
+ # The status of the registration attachment.
736
+ #
737
+ # * `UPLOAD_IN_PROGRESS` The attachment is being uploaded.
738
+ #
739
+ # * `UPLOAD_COMPLETE` The attachment has been uploaded.
740
+ #
741
+ # * `UPLOAD_FAILED` The attachment failed to uploaded.
742
+ #
743
+ # * `DELETED` The attachment has been deleted..
744
+ # @return [String]
745
+ #
746
+ # @!attribute [rw] tags
747
+ # An array of tags (key and value pairs) to associate with the
748
+ # registration attachment.
749
+ # @return [Array<Types::Tag>]
750
+ #
751
+ # @!attribute [rw] created_timestamp
752
+ # The time when the registration attachment was created, in [UNIX
753
+ # epoch time][1] format.
754
+ #
755
+ #
756
+ #
757
+ # [1]: https://www.epochconverter.com/
758
+ # @return [Time]
759
+ #
760
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CreateRegistrationAttachmentResult AWS API Documentation
761
+ #
762
+ class CreateRegistrationAttachmentResult < Struct.new(
763
+ :registration_attachment_arn,
764
+ :registration_attachment_id,
765
+ :attachment_status,
766
+ :tags,
767
+ :created_timestamp)
768
+ SENSITIVE = []
769
+ include Aws::Structure
770
+ end
771
+
772
+ # @!attribute [rw] registration_type
773
+ # The type of registration form to create. The list of
774
+ # **RegistrationTypes** can be found using the
775
+ # DescribeRegistrationTypeDefinitions action.
776
+ # @return [String]
777
+ #
778
+ # @!attribute [rw] tags
779
+ # An array of tags (key and value pairs) to associate with the
780
+ # registration.
781
+ # @return [Array<Types::Tag>]
782
+ #
783
+ # @!attribute [rw] client_token
784
+ # Unique, case-sensitive identifier that you provide to ensure the
785
+ # idempotency of the request. If you don't specify a client token, a
786
+ # randomly generated token is used for the request to ensure
787
+ # idempotency.
788
+ #
789
+ # **A suitable default value is auto-generated.** You should normally
790
+ # not need to pass this option.
791
+ # @return [String]
792
+ #
793
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CreateRegistrationRequest AWS API Documentation
794
+ #
795
+ class CreateRegistrationRequest < Struct.new(
796
+ :registration_type,
797
+ :tags,
798
+ :client_token)
799
+ SENSITIVE = []
800
+ include Aws::Structure
801
+ end
802
+
803
+ # @!attribute [rw] registration_arn
804
+ # The Amazon Resource Name (ARN) for the registration.
805
+ # @return [String]
806
+ #
807
+ # @!attribute [rw] registration_id
808
+ # The unique identifier for the registration.
809
+ # @return [String]
810
+ #
811
+ # @!attribute [rw] registration_type
812
+ # The type of registration form to create. The list of
813
+ # **RegistrationTypes** can be found using the
814
+ # DescribeRegistrationTypeDefinitions action.
815
+ # @return [String]
816
+ #
817
+ # @!attribute [rw] registration_status
818
+ # The status of the registration.
819
+ #
820
+ # * `CREATED`: Your registration is created but not submitted.
821
+ #
822
+ # * `SUBMITTED`: Your registration has been submitted and is awaiting
823
+ # review.
824
+ #
825
+ # * `REVIEWING`: Your registration has been accepted and is being
826
+ # reviewed.
827
+ #
828
+ # * `PROVISIONING`: Your registration has been approved and your
829
+ # origination identity is being created.
830
+ #
831
+ # * `COMPLETE`: Your registration has been approved and and your
832
+ # origination identity has been created.
833
+ #
834
+ # * `REQUIRES_UPDATES`: You must fix your registration and resubmit
835
+ # it.
836
+ #
837
+ # * `CLOSED`: The phone number or sender ID has been deleted and you
838
+ # must also delete the registration for the number.
839
+ #
840
+ # * `DELETED`: The registration has been deleted.
841
+ # @return [String]
842
+ #
843
+ # @!attribute [rw] current_version_number
844
+ # The current version number of the registration.
845
+ # @return [Integer]
846
+ #
847
+ # @!attribute [rw] additional_attributes
848
+ # Metadata about a given registration which is specific to that
849
+ # registration type.
850
+ # @return [Hash<String,String>]
851
+ #
852
+ # @!attribute [rw] tags
853
+ # An array of tags (key and value pairs) to associate with the
854
+ # registration.
855
+ # @return [Array<Types::Tag>]
856
+ #
857
+ # @!attribute [rw] created_timestamp
858
+ # The time when the registration was created, in [UNIX epoch time][1]
859
+ # format.
860
+ #
861
+ #
862
+ #
863
+ # [1]: https://www.epochconverter.com/
864
+ # @return [Time]
865
+ #
866
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CreateRegistrationResult AWS API Documentation
867
+ #
868
+ class CreateRegistrationResult < Struct.new(
869
+ :registration_arn,
870
+ :registration_id,
871
+ :registration_type,
872
+ :registration_status,
873
+ :current_version_number,
874
+ :additional_attributes,
875
+ :tags,
876
+ :created_timestamp)
877
+ SENSITIVE = []
878
+ include Aws::Structure
879
+ end
880
+
881
+ # @!attribute [rw] registration_id
882
+ # The unique identifier for the registration.
883
+ # @return [String]
884
+ #
885
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CreateRegistrationVersionRequest AWS API Documentation
886
+ #
887
+ class CreateRegistrationVersionRequest < Struct.new(
888
+ :registration_id)
889
+ SENSITIVE = []
890
+ include Aws::Structure
891
+ end
892
+
893
+ # @!attribute [rw] registration_arn
894
+ # The Amazon Resource Name (ARN) for the registration.
895
+ # @return [String]
896
+ #
897
+ # @!attribute [rw] registration_id
898
+ # The unique identifier for the registration.
899
+ # @return [String]
900
+ #
901
+ # @!attribute [rw] version_number
902
+ # The new version number of the registration.
903
+ # @return [Integer]
904
+ #
905
+ # @!attribute [rw] registration_version_status
906
+ # The status of the registration.
907
+ #
908
+ # * `DRAFT`: The initial status of a registration version after it’s
909
+ # created.
910
+ #
911
+ # * `SUBMITTED`: Your registration has been submitted.
912
+ #
913
+ # * `REVIEWING`: Your registration has been accepted and is being
914
+ # reviewed.
915
+ #
916
+ # * `APPROVED`: Your registration has been approved.
917
+ #
918
+ # * `DISCARDED`: You've abandon this version of their registration to
919
+ # start over with a new version.
920
+ #
921
+ # * `DENIED`: You must fix your registration and resubmit it.
922
+ #
923
+ # * `REVOKED`: Your previously approved registration has been revoked.
924
+ #
925
+ # * `ARCHIVED`: Your previously approved registration version moves
926
+ # into this status when a more recently submitted version is
927
+ # approved.
928
+ # @return [String]
929
+ #
930
+ # @!attribute [rw] registration_version_status_history
931
+ # A **RegistrationVersionStatusHistory** object that contains
932
+ # timestamps for the registration.
933
+ # @return [Types::RegistrationVersionStatusHistory]
934
+ #
935
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CreateRegistrationVersionResult AWS API Documentation
936
+ #
937
+ class CreateRegistrationVersionResult < Struct.new(
938
+ :registration_arn,
939
+ :registration_id,
940
+ :version_number,
941
+ :registration_version_status,
942
+ :registration_version_status_history)
943
+ SENSITIVE = []
944
+ include Aws::Structure
945
+ end
946
+
947
+ # @!attribute [rw] destination_phone_number
948
+ # The verified destination phone number, in E.164 format.
949
+ # @return [String]
950
+ #
951
+ # @!attribute [rw] tags
952
+ # An array of tags (key and value pairs) to associate with the
953
+ # destination number.
954
+ # @return [Array<Types::Tag>]
955
+ #
956
+ # @!attribute [rw] client_token
957
+ # Unique, case-sensitive identifier that you provide to ensure the
958
+ # idempotency of the request. If you don't specify a client token, a
959
+ # randomly generated token is used for the request to ensure
960
+ # idempotency.
961
+ #
962
+ # **A suitable default value is auto-generated.** You should normally
963
+ # not need to pass this option.
964
+ # @return [String]
965
+ #
966
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CreateVerifiedDestinationNumberRequest AWS API Documentation
967
+ #
968
+ class CreateVerifiedDestinationNumberRequest < Struct.new(
969
+ :destination_phone_number,
970
+ :tags,
971
+ :client_token)
972
+ SENSITIVE = []
973
+ include Aws::Structure
974
+ end
975
+
976
+ # @!attribute [rw] verified_destination_number_arn
977
+ # The Amazon Resource Name (ARN) for the verified destination phone
978
+ # number.
979
+ # @return [String]
980
+ #
981
+ # @!attribute [rw] verified_destination_number_id
982
+ # The unique identifier for the verified destination phone number.
983
+ # @return [String]
984
+ #
985
+ # @!attribute [rw] destination_phone_number
986
+ # The verified destination phone number, in E.164 format.
987
+ # @return [String]
988
+ #
989
+ # @!attribute [rw] status
990
+ # The status of the verified destination phone number.
991
+ #
992
+ # * `PENDING`: The phone number hasn't been verified yet.
993
+ #
994
+ # * `VERIFIED`: The phone number is verified and can receive messages.
995
+ # @return [String]
996
+ #
997
+ # @!attribute [rw] tags
998
+ # An array of tags (key and value pairs) to associate with the
999
+ # destination number.
1000
+ # @return [Array<Types::Tag>]
1001
+ #
1002
+ # @!attribute [rw] created_timestamp
1003
+ # The time when the verified phone number was created, in [UNIX epoch
1004
+ # time][1] format.
1005
+ #
1006
+ #
1007
+ #
1008
+ # [1]: https://www.epochconverter.com/
1009
+ # @return [Time]
1010
+ #
1011
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CreateVerifiedDestinationNumberResult AWS API Documentation
1012
+ #
1013
+ class CreateVerifiedDestinationNumberResult < Struct.new(
1014
+ :verified_destination_number_arn,
1015
+ :verified_destination_number_id,
1016
+ :destination_phone_number,
1017
+ :status,
1018
+ :tags,
1019
+ :created_timestamp)
1020
+ SENSITIVE = []
1021
+ include Aws::Structure
1022
+ end
1023
+
611
1024
  # @!attribute [rw] configuration_set_name
612
1025
  # The name of the configuration set or the configuration set ARN that
613
1026
  # you want to delete. The ConfigurationSetName and ConfigurationSetArn
@@ -975,6 +1388,11 @@ module Aws::PinpointSMSVoiceV2
975
1388
  # The Amazon Resource Name (ARN) of the TwoWayChannel.
976
1389
  # @return [String]
977
1390
  #
1391
+ # @!attribute [rw] two_way_channel_role
1392
+ # An optional IAM Role Arn for a service to assume, to be able to post
1393
+ # inbound SMS messages.
1394
+ # @return [String]
1395
+ #
978
1396
  # @!attribute [rw] self_managed_opt_outs_enabled
979
1397
  # By default this is set to false. When an end recipient sends a
980
1398
  # message that begins with HELP or STOP to one of your dedicated
@@ -1010,6 +1428,7 @@ module Aws::PinpointSMSVoiceV2
1010
1428
  :message_type,
1011
1429
  :two_way_enabled,
1012
1430
  :two_way_channel_arn,
1431
+ :two_way_channel_role,
1013
1432
  :self_managed_opt_outs_enabled,
1014
1433
  :opt_out_list_name,
1015
1434
  :shared_routes_enabled,
@@ -1018,7 +1437,217 @@ module Aws::PinpointSMSVoiceV2
1018
1437
  include Aws::Structure
1019
1438
  end
1020
1439
 
1021
- # @api private
1440
+ # @!attribute [rw] registration_attachment_id
1441
+ # The unique identifier for the registration attachment.
1442
+ # @return [String]
1443
+ #
1444
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteRegistrationAttachmentRequest AWS API Documentation
1445
+ #
1446
+ class DeleteRegistrationAttachmentRequest < Struct.new(
1447
+ :registration_attachment_id)
1448
+ SENSITIVE = []
1449
+ include Aws::Structure
1450
+ end
1451
+
1452
+ # @!attribute [rw] registration_attachment_arn
1453
+ # The Amazon Resource Name (ARN) for the registration attachment.
1454
+ # @return [String]
1455
+ #
1456
+ # @!attribute [rw] registration_attachment_id
1457
+ # The unique identifier for the registration attachment.
1458
+ # @return [String]
1459
+ #
1460
+ # @!attribute [rw] attachment_status
1461
+ # The status of the registration attachment.
1462
+ #
1463
+ # * `UPLOAD_IN_PROGRESS` The attachment is being uploaded.
1464
+ #
1465
+ # * `UPLOAD_COMPLETE` The attachment has been uploaded.
1466
+ #
1467
+ # * `UPLOAD_FAILED` The attachment failed to uploaded.
1468
+ #
1469
+ # * `DELETED` The attachment has been deleted..
1470
+ # @return [String]
1471
+ #
1472
+ # @!attribute [rw] attachment_upload_error_reason
1473
+ # The error message if the upload failed.
1474
+ # @return [String]
1475
+ #
1476
+ # @!attribute [rw] created_timestamp
1477
+ # The time when the registration attachment was created, in [UNIX
1478
+ # epoch time][1] format.
1479
+ #
1480
+ #
1481
+ #
1482
+ # [1]: https://www.epochconverter.com/
1483
+ # @return [Time]
1484
+ #
1485
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteRegistrationAttachmentResult AWS API Documentation
1486
+ #
1487
+ class DeleteRegistrationAttachmentResult < Struct.new(
1488
+ :registration_attachment_arn,
1489
+ :registration_attachment_id,
1490
+ :attachment_status,
1491
+ :attachment_upload_error_reason,
1492
+ :created_timestamp)
1493
+ SENSITIVE = []
1494
+ include Aws::Structure
1495
+ end
1496
+
1497
+ # @!attribute [rw] registration_id
1498
+ # The unique identifier for the registration.
1499
+ # @return [String]
1500
+ #
1501
+ # @!attribute [rw] field_path
1502
+ # The path to the registration form field. You can use
1503
+ # DescribeRegistrationFieldDefinitions for a list of **FieldPaths**.
1504
+ # @return [String]
1505
+ #
1506
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteRegistrationFieldValueRequest AWS API Documentation
1507
+ #
1508
+ class DeleteRegistrationFieldValueRequest < Struct.new(
1509
+ :registration_id,
1510
+ :field_path)
1511
+ SENSITIVE = []
1512
+ include Aws::Structure
1513
+ end
1514
+
1515
+ # @!attribute [rw] registration_arn
1516
+ # The Amazon Resource Name (ARN) for the registration.
1517
+ # @return [String]
1518
+ #
1519
+ # @!attribute [rw] registration_id
1520
+ # The unique identifier for the registration.
1521
+ # @return [String]
1522
+ #
1523
+ # @!attribute [rw] version_number
1524
+ # The version number of the registration.
1525
+ # @return [Integer]
1526
+ #
1527
+ # @!attribute [rw] field_path
1528
+ # The path to the registration form field.
1529
+ # @return [String]
1530
+ #
1531
+ # @!attribute [rw] select_choices
1532
+ # An array of values for the form field.
1533
+ # @return [Array<String>]
1534
+ #
1535
+ # @!attribute [rw] text_value
1536
+ # The text data for a free form field.
1537
+ # @return [String]
1538
+ #
1539
+ # @!attribute [rw] registration_attachment_id
1540
+ # The unique identifier for the registration attachment.
1541
+ # @return [String]
1542
+ #
1543
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteRegistrationFieldValueResult AWS API Documentation
1544
+ #
1545
+ class DeleteRegistrationFieldValueResult < Struct.new(
1546
+ :registration_arn,
1547
+ :registration_id,
1548
+ :version_number,
1549
+ :field_path,
1550
+ :select_choices,
1551
+ :text_value,
1552
+ :registration_attachment_id)
1553
+ SENSITIVE = []
1554
+ include Aws::Structure
1555
+ end
1556
+
1557
+ # @!attribute [rw] registration_id
1558
+ # The unique identifier for the registration.
1559
+ # @return [String]
1560
+ #
1561
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteRegistrationRequest AWS API Documentation
1562
+ #
1563
+ class DeleteRegistrationRequest < Struct.new(
1564
+ :registration_id)
1565
+ SENSITIVE = []
1566
+ include Aws::Structure
1567
+ end
1568
+
1569
+ # @!attribute [rw] registration_arn
1570
+ # The Amazon Resource Name (ARN) for the registration.
1571
+ # @return [String]
1572
+ #
1573
+ # @!attribute [rw] registration_id
1574
+ # The unique identifier for the registration.
1575
+ # @return [String]
1576
+ #
1577
+ # @!attribute [rw] registration_type
1578
+ # The type of registration form. The list of **RegistrationTypes** can
1579
+ # be found using the DescribeRegistrationTypeDefinitions action.
1580
+ # @return [String]
1581
+ #
1582
+ # @!attribute [rw] registration_status
1583
+ # The status of the registration.
1584
+ #
1585
+ # * `CREATED`: Your registration is created but not submitted.
1586
+ #
1587
+ # * `SUBMITTED`: Your registration has been submitted and is awaiting
1588
+ # review.
1589
+ #
1590
+ # * `REVIEWING`: Your registration has been accepted and is being
1591
+ # reviewed.
1592
+ #
1593
+ # * `PROVISIONING`: Your registration has been approved and your
1594
+ # origination identity is being created.
1595
+ #
1596
+ # * `COMPLETE`: Your registration has been approved and and your
1597
+ # origination identity has been created.
1598
+ #
1599
+ # * `REQUIRES_UPDATES`: You must fix your registration and resubmit
1600
+ # it.
1601
+ #
1602
+ # * `CLOSED`: The phone number or sender ID has been deleted and you
1603
+ # must also delete the registration for the number.
1604
+ #
1605
+ # * `DELETED`: The registration has been deleted.
1606
+ # @return [String]
1607
+ #
1608
+ # @!attribute [rw] current_version_number
1609
+ # The current version number of the registration.
1610
+ # @return [Integer]
1611
+ #
1612
+ # @!attribute [rw] approved_version_number
1613
+ # The version number of the registration that was approved.
1614
+ # @return [Integer]
1615
+ #
1616
+ # @!attribute [rw] latest_denied_version_number
1617
+ # The latest version number of the registration that was denied.
1618
+ # @return [Integer]
1619
+ #
1620
+ # @!attribute [rw] additional_attributes
1621
+ # Metadata about a given registration which is specific to that
1622
+ # registration type.
1623
+ # @return [Hash<String,String>]
1624
+ #
1625
+ # @!attribute [rw] created_timestamp
1626
+ # The time when the registration was created, in [UNIX epoch time][1]
1627
+ # format.
1628
+ #
1629
+ #
1630
+ #
1631
+ # [1]: https://www.epochconverter.com/
1632
+ # @return [Time]
1633
+ #
1634
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteRegistrationResult AWS API Documentation
1635
+ #
1636
+ class DeleteRegistrationResult < Struct.new(
1637
+ :registration_arn,
1638
+ :registration_id,
1639
+ :registration_type,
1640
+ :registration_status,
1641
+ :current_version_number,
1642
+ :approved_version_number,
1643
+ :latest_denied_version_number,
1644
+ :additional_attributes,
1645
+ :created_timestamp)
1646
+ SENSITIVE = []
1647
+ include Aws::Structure
1648
+ end
1649
+
1650
+ # @api private
1022
1651
  #
1023
1652
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteTextMessageSpendLimitOverrideRequest AWS API Documentation
1024
1653
  #
@@ -1036,6 +1665,51 @@ module Aws::PinpointSMSVoiceV2
1036
1665
  include Aws::Structure
1037
1666
  end
1038
1667
 
1668
+ # @!attribute [rw] verified_destination_number_id
1669
+ # The unique identifier for the verified destination phone number.
1670
+ # @return [String]
1671
+ #
1672
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteVerifiedDestinationNumberRequest AWS API Documentation
1673
+ #
1674
+ class DeleteVerifiedDestinationNumberRequest < Struct.new(
1675
+ :verified_destination_number_id)
1676
+ SENSITIVE = []
1677
+ include Aws::Structure
1678
+ end
1679
+
1680
+ # @!attribute [rw] verified_destination_number_arn
1681
+ # The Amazon Resource Name (ARN) for the verified destination phone
1682
+ # number.
1683
+ # @return [String]
1684
+ #
1685
+ # @!attribute [rw] verified_destination_number_id
1686
+ # The unique identifier for the verified destination phone number.
1687
+ # @return [String]
1688
+ #
1689
+ # @!attribute [rw] destination_phone_number
1690
+ # The verified destination phone number, in E.164 format.
1691
+ # @return [String]
1692
+ #
1693
+ # @!attribute [rw] created_timestamp
1694
+ # The time when the destination phone number was created, in [UNIX
1695
+ # epoch time][1] format.
1696
+ #
1697
+ #
1698
+ #
1699
+ # [1]: https://www.epochconverter.com/
1700
+ # @return [Time]
1701
+ #
1702
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteVerifiedDestinationNumberResult AWS API Documentation
1703
+ #
1704
+ class DeleteVerifiedDestinationNumberResult < Struct.new(
1705
+ :verified_destination_number_arn,
1706
+ :verified_destination_number_id,
1707
+ :destination_phone_number,
1708
+ :created_timestamp)
1709
+ SENSITIVE = []
1710
+ include Aws::Structure
1711
+ end
1712
+
1039
1713
  # @api private
1040
1714
  #
1041
1715
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteVoiceMessageSpendLimitOverrideRequest AWS API Documentation
@@ -1444,13 +2118,15 @@ module Aws::PinpointSMSVoiceV2
1444
2118
  include Aws::Structure
1445
2119
  end
1446
2120
 
1447
- # @!attribute [rw] sender_ids
1448
- # An array of SenderIdAndCountry objects to search for.
1449
- # @return [Array<Types::SenderIdAndCountry>]
2121
+ # @!attribute [rw] registration_attachment_ids
2122
+ # The unique identifier of registration attachments to find. This is
2123
+ # an array of **RegistrationAttachmentId**.
2124
+ # @return [Array<String>]
1450
2125
  #
1451
2126
  # @!attribute [rw] filters
1452
- # An array of SenderIdFilter objects to filter the results.
1453
- # @return [Array<Types::SenderIdFilter>]
2127
+ # An array of RegistrationAttachmentFilter objects to filter the
2128
+ # results.
2129
+ # @return [Array<Types::RegistrationAttachmentFilter>]
1454
2130
  #
1455
2131
  # @!attribute [rw] next_token
1456
2132
  # The token to be used for the next set of paginated results. You
@@ -1461,10 +2137,10 @@ module Aws::PinpointSMSVoiceV2
1461
2137
  # The maximum number of results to return per each request.
1462
2138
  # @return [Integer]
1463
2139
  #
1464
- # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeSenderIdsRequest AWS API Documentation
2140
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeRegistrationAttachmentsRequest AWS API Documentation
1465
2141
  #
1466
- class DescribeSenderIdsRequest < Struct.new(
1467
- :sender_ids,
2142
+ class DescribeRegistrationAttachmentsRequest < Struct.new(
2143
+ :registration_attachment_ids,
1468
2144
  :filters,
1469
2145
  :next_token,
1470
2146
  :max_results)
@@ -1472,25 +2148,38 @@ module Aws::PinpointSMSVoiceV2
1472
2148
  include Aws::Structure
1473
2149
  end
1474
2150
 
1475
- # @!attribute [rw] sender_ids
1476
- # An array of SernderIdInformation objects that contain the details
1477
- # for the requested SenderIds.
1478
- # @return [Array<Types::SenderIdInformation>]
2151
+ # @!attribute [rw] registration_attachments
2152
+ # An array of **RegistrationAttachments** objects that contain the
2153
+ # details for the requested registration attachments.
2154
+ # @return [Array<Types::RegistrationAttachmentsInformation>]
1479
2155
  #
1480
2156
  # @!attribute [rw] next_token
1481
- # The token to be used for the next set of paginated results. If this
1482
- # field is empty then there are no more results.
2157
+ # The token to be used for the next set of paginated results. You
2158
+ # don't need to supply a value for this field in the initial request.
1483
2159
  # @return [String]
1484
2160
  #
1485
- # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeSenderIdsResult AWS API Documentation
2161
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeRegistrationAttachmentsResult AWS API Documentation
1486
2162
  #
1487
- class DescribeSenderIdsResult < Struct.new(
1488
- :sender_ids,
2163
+ class DescribeRegistrationAttachmentsResult < Struct.new(
2164
+ :registration_attachments,
1489
2165
  :next_token)
1490
2166
  SENSITIVE = []
1491
2167
  include Aws::Structure
1492
2168
  end
1493
2169
 
2170
+ # @!attribute [rw] registration_type
2171
+ # The type of registration form. The list of **RegistrationTypes** can
2172
+ # be found using the DescribeRegistrationTypeDefinitions action.
2173
+ # @return [String]
2174
+ #
2175
+ # @!attribute [rw] section_path
2176
+ # The path to the section of the registration.
2177
+ # @return [String]
2178
+ #
2179
+ # @!attribute [rw] field_paths
2180
+ # An array of paths to the registration form field.
2181
+ # @return [Array<String>]
2182
+ #
1494
2183
  # @!attribute [rw] next_token
1495
2184
  # The token to be used for the next set of paginated results. You
1496
2185
  # don't need to supply a value for this field in the initial request.
@@ -1500,252 +2189,227 @@ module Aws::PinpointSMSVoiceV2
1500
2189
  # The maximum number of results to return per each request.
1501
2190
  # @return [Integer]
1502
2191
  #
1503
- # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeSpendLimitsRequest AWS API Documentation
2192
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeRegistrationFieldDefinitionsRequest AWS API Documentation
1504
2193
  #
1505
- class DescribeSpendLimitsRequest < Struct.new(
2194
+ class DescribeRegistrationFieldDefinitionsRequest < Struct.new(
2195
+ :registration_type,
2196
+ :section_path,
2197
+ :field_paths,
1506
2198
  :next_token,
1507
2199
  :max_results)
1508
2200
  SENSITIVE = []
1509
2201
  include Aws::Structure
1510
2202
  end
1511
2203
 
1512
- # @!attribute [rw] spend_limits
1513
- # An array of SpendLimit objects that contain the details for the
1514
- # requested spend limits.
1515
- # @return [Array<Types::SpendLimit>]
2204
+ # @!attribute [rw] registration_type
2205
+ # The type of registration form. The list of **RegistrationTypes** can
2206
+ # be found using the DescribeRegistrationTypeDefinitions action.
2207
+ # @return [String]
2208
+ #
2209
+ # @!attribute [rw] registration_field_definitions
2210
+ # An array of RegistrationFieldDefinitions objects that contain the
2211
+ # details for the requested fields.
2212
+ # @return [Array<Types::RegistrationFieldDefinition>]
1516
2213
  #
1517
2214
  # @!attribute [rw] next_token
1518
- # The token to be used for the next set of paginated results. If this
1519
- # field is empty then there are no more results.
2215
+ # The token to be used for the next set of paginated results. You
2216
+ # don't need to supply a value for this field in the initial request.
1520
2217
  # @return [String]
1521
2218
  #
1522
- # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeSpendLimitsResult AWS API Documentation
2219
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeRegistrationFieldDefinitionsResult AWS API Documentation
1523
2220
  #
1524
- class DescribeSpendLimitsResult < Struct.new(
1525
- :spend_limits,
2221
+ class DescribeRegistrationFieldDefinitionsResult < Struct.new(
2222
+ :registration_type,
2223
+ :registration_field_definitions,
1526
2224
  :next_token)
1527
2225
  SENSITIVE = []
1528
2226
  include Aws::Structure
1529
2227
  end
1530
2228
 
1531
- # @!attribute [rw] pool_id
1532
- # The unique identifier for the pool to disassociate with the
1533
- # origination identity. This value can be either the PoolId or
1534
- # PoolArn.
2229
+ # @!attribute [rw] registration_id
2230
+ # The unique identifier for the registration.
1535
2231
  # @return [String]
1536
2232
  #
1537
- # @!attribute [rw] origination_identity
1538
- # The origination identity to use such as a PhoneNumberId,
1539
- # PhoneNumberArn, SenderId or SenderIdArn. You can use
1540
- # DescribePhoneNumbers find the values for PhoneNumberId and
1541
- # PhoneNumberArn, or use DescribeSenderIds to get the values for
1542
- # SenderId and SenderIdArn.
1543
- # @return [String]
2233
+ # @!attribute [rw] version_number
2234
+ # The version number of the registration.
2235
+ # @return [Integer]
1544
2236
  #
1545
- # @!attribute [rw] iso_country_code
1546
- # The two-character code, in ISO 3166-1 alpha-2 format, for the
1547
- # country or region.
2237
+ # @!attribute [rw] section_path
2238
+ # The path to the section of the registration.
1548
2239
  # @return [String]
1549
2240
  #
1550
- # @!attribute [rw] client_token
1551
- # Unique, case-sensitive identifier you provide to ensure the
1552
- # idempotency of the request. If you don't specify a client token, a
1553
- # randomly generated token is used for the request to ensure
1554
- # idempotency.
2241
+ # @!attribute [rw] field_paths
2242
+ # An array of paths to the registration form field.
2243
+ # @return [Array<String>]
1555
2244
  #
1556
- # **A suitable default value is auto-generated.** You should normally
1557
- # not need to pass this option.
2245
+ # @!attribute [rw] next_token
2246
+ # The token to be used for the next set of paginated results. You
2247
+ # don't need to supply a value for this field in the initial request.
1558
2248
  # @return [String]
1559
2249
  #
1560
- # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DisassociateOriginationIdentityRequest AWS API Documentation
2250
+ # @!attribute [rw] max_results
2251
+ # The maximum number of results to return per each request.
2252
+ # @return [Integer]
1561
2253
  #
1562
- class DisassociateOriginationIdentityRequest < Struct.new(
1563
- :pool_id,
1564
- :origination_identity,
1565
- :iso_country_code,
1566
- :client_token)
2254
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeRegistrationFieldValuesRequest AWS API Documentation
2255
+ #
2256
+ class DescribeRegistrationFieldValuesRequest < Struct.new(
2257
+ :registration_id,
2258
+ :version_number,
2259
+ :section_path,
2260
+ :field_paths,
2261
+ :next_token,
2262
+ :max_results)
1567
2263
  SENSITIVE = []
1568
2264
  include Aws::Structure
1569
2265
  end
1570
2266
 
1571
- # @!attribute [rw] pool_arn
1572
- # The Amazon Resource Name (ARN) of the pool.
2267
+ # @!attribute [rw] registration_arn
2268
+ # The Amazon Resource Name (ARN) for the registration.
1573
2269
  # @return [String]
1574
2270
  #
1575
- # @!attribute [rw] pool_id
1576
- # The PoolId of the pool no longer associated with the origination
1577
- # identity.
2271
+ # @!attribute [rw] registration_id
2272
+ # The unique identifier for the registration.
1578
2273
  # @return [String]
1579
2274
  #
1580
- # @!attribute [rw] origination_identity_arn
1581
- # The PhoneNumberArn or SenderIdArn of the origination identity.
1582
- # @return [String]
2275
+ # @!attribute [rw] version_number
2276
+ # The current version of the registration.
2277
+ # @return [Integer]
1583
2278
  #
1584
- # @!attribute [rw] origination_identity
1585
- # The PhoneNumberId or SenderId of the origination identity.
1586
- # @return [String]
2279
+ # @!attribute [rw] registration_field_values
2280
+ # An array of RegistrationFieldValues objects that contain the values
2281
+ # for the requested registration.
2282
+ # @return [Array<Types::RegistrationFieldValueInformation>]
1587
2283
  #
1588
- # @!attribute [rw] iso_country_code
1589
- # The two-character code, in ISO 3166-1 alpha-2 format, for the
1590
- # country or region.
2284
+ # @!attribute [rw] next_token
2285
+ # The token to be used for the next set of paginated results. You
2286
+ # don't need to supply a value for this field in the initial request.
1591
2287
  # @return [String]
1592
2288
  #
1593
- # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DisassociateOriginationIdentityResult AWS API Documentation
2289
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeRegistrationFieldValuesResult AWS API Documentation
1594
2290
  #
1595
- class DisassociateOriginationIdentityResult < Struct.new(
1596
- :pool_arn,
1597
- :pool_id,
1598
- :origination_identity_arn,
1599
- :origination_identity,
1600
- :iso_country_code)
2291
+ class DescribeRegistrationFieldValuesResult < Struct.new(
2292
+ :registration_arn,
2293
+ :registration_id,
2294
+ :version_number,
2295
+ :registration_field_values,
2296
+ :next_token)
1601
2297
  SENSITIVE = []
1602
2298
  include Aws::Structure
1603
2299
  end
1604
2300
 
1605
- # Contains information about an event destination.
2301
+ # @!attribute [rw] registration_type
2302
+ # The type of registration form. The list of **RegistrationTypes** can
2303
+ # be found using the DescribeRegistrationTypeDefinitions action.
2304
+ # @return [String]
1606
2305
  #
1607
- # Event destinations are associated with configuration sets, which
1608
- # enable you to publish message sending events to Amazon CloudWatch,
1609
- # Amazon Kinesis Data Firehose, or Amazon SNS.
1610
- #
1611
- # @!attribute [rw] event_destination_name
1612
- # The name of the EventDestination.
1613
- # @return [String]
1614
- #
1615
- # @!attribute [rw] enabled
1616
- # When set to true events will be logged.
1617
- # @return [Boolean]
1618
- #
1619
- # @!attribute [rw] matching_event_types
1620
- # An array of event types that determine which events to log.
2306
+ # @!attribute [rw] section_paths
2307
+ # An array of paths for the registration form section.
1621
2308
  # @return [Array<String>]
1622
2309
  #
1623
- # @!attribute [rw] cloud_watch_logs_destination
1624
- # An object that contains information about an event destination that
1625
- # sends logging events to Amazon CloudWatch logs.
1626
- # @return [Types::CloudWatchLogsDestination]
1627
- #
1628
- # @!attribute [rw] kinesis_firehose_destination
1629
- # An object that contains information about an event destination for
1630
- # logging to Amazon Kinesis Data Firehose.
1631
- # @return [Types::KinesisFirehoseDestination]
2310
+ # @!attribute [rw] next_token
2311
+ # The token to be used for the next set of paginated results. You
2312
+ # don't need to supply a value for this field in the initial request.
2313
+ # @return [String]
1632
2314
  #
1633
- # @!attribute [rw] sns_destination
1634
- # An object that contains information about an event destination that
1635
- # sends logging events to Amazon SNS.
1636
- # @return [Types::SnsDestination]
2315
+ # @!attribute [rw] max_results
2316
+ # The maximum number of results to return per each request.
2317
+ # @return [Integer]
1637
2318
  #
1638
- # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/EventDestination AWS API Documentation
2319
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeRegistrationSectionDefinitionsRequest AWS API Documentation
1639
2320
  #
1640
- class EventDestination < Struct.new(
1641
- :event_destination_name,
1642
- :enabled,
1643
- :matching_event_types,
1644
- :cloud_watch_logs_destination,
1645
- :kinesis_firehose_destination,
1646
- :sns_destination)
2321
+ class DescribeRegistrationSectionDefinitionsRequest < Struct.new(
2322
+ :registration_type,
2323
+ :section_paths,
2324
+ :next_token,
2325
+ :max_results)
1647
2326
  SENSITIVE = []
1648
2327
  include Aws::Structure
1649
2328
  end
1650
2329
 
1651
- # The API encountered an unexpected error and couldn't complete the
1652
- # request. You might be able to successfully issue the request again in
1653
- # the future.
1654
- #
1655
- # @!attribute [rw] message
1656
- # @return [String]
1657
- #
1658
- # @!attribute [rw] request_id
1659
- # The unique identifier of the request.
2330
+ # @!attribute [rw] registration_type
2331
+ # The type of registration form. The list of **RegistrationTypes** can
2332
+ # be found using the DescribeRegistrationTypeDefinitions action.
1660
2333
  # @return [String]
1661
2334
  #
1662
- # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/InternalServerException AWS API Documentation
1663
- #
1664
- class InternalServerException < Struct.new(
1665
- :message,
1666
- :request_id)
1667
- SENSITIVE = []
1668
- include Aws::Structure
1669
- end
1670
-
1671
- # The information for keywords that meet a specified criteria.
2335
+ # @!attribute [rw] registration_section_definitions
2336
+ # An array of RegistrationSectionDefinition objects.
2337
+ # @return [Array<Types::RegistrationSectionDefinition>]
1672
2338
  #
1673
- # @!attribute [rw] name
1674
- # The name of the attribute to filter on.
2339
+ # @!attribute [rw] next_token
2340
+ # The token to be used for the next set of paginated results. You
2341
+ # don't need to supply a value for this field in the initial request.
1675
2342
  # @return [String]
1676
2343
  #
1677
- # @!attribute [rw] values
1678
- # An array values to filter for.
1679
- # @return [Array<String>]
1680
- #
1681
- # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/KeywordFilter AWS API Documentation
2344
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeRegistrationSectionDefinitionsResult AWS API Documentation
1682
2345
  #
1683
- class KeywordFilter < Struct.new(
1684
- :name,
1685
- :values)
2346
+ class DescribeRegistrationSectionDefinitionsResult < Struct.new(
2347
+ :registration_type,
2348
+ :registration_section_definitions,
2349
+ :next_token)
1686
2350
  SENSITIVE = []
1687
2351
  include Aws::Structure
1688
2352
  end
1689
2353
 
1690
- # The information for all keywords in a pool.
2354
+ # @!attribute [rw] registration_types
2355
+ # The type of registration form. The list of **RegistrationTypes** can
2356
+ # be found using the DescribeRegistrationTypeDefinitions action.
2357
+ # @return [Array<String>]
1691
2358
  #
1692
- # @!attribute [rw] keyword
1693
- # The keyword as a string.
1694
- # @return [String]
2359
+ # @!attribute [rw] filters
2360
+ # An array of RegistrationFilter objects to filter the results.
2361
+ # @return [Array<Types::RegistrationTypeFilter>]
1695
2362
  #
1696
- # @!attribute [rw] keyword_message
1697
- # A custom message that can be used with the keyword.
2363
+ # @!attribute [rw] next_token
2364
+ # The token to be used for the next set of paginated results. You
2365
+ # don't need to supply a value for this field in the initial request.
1698
2366
  # @return [String]
1699
2367
  #
1700
- # @!attribute [rw] keyword_action
1701
- # The action to perform for the keyword.
1702
- # @return [String]
2368
+ # @!attribute [rw] max_results
2369
+ # The maximum number of results to return per each request.
2370
+ # @return [Integer]
1703
2371
  #
1704
- # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/KeywordInformation AWS API Documentation
2372
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeRegistrationTypeDefinitionsRequest AWS API Documentation
1705
2373
  #
1706
- class KeywordInformation < Struct.new(
1707
- :keyword,
1708
- :keyword_message,
1709
- :keyword_action)
2374
+ class DescribeRegistrationTypeDefinitionsRequest < Struct.new(
2375
+ :registration_types,
2376
+ :filters,
2377
+ :next_token,
2378
+ :max_results)
1710
2379
  SENSITIVE = []
1711
2380
  include Aws::Structure
1712
2381
  end
1713
2382
 
1714
- # Contains the delivery stream Amazon Resource Name (ARN), and the ARN
1715
- # of the Identity and Access Management (IAM) role associated with an
1716
- # Kinesis Data Firehose event destination.
1717
- #
1718
- # Event destinations, such as Kinesis Data Firehose, are associated with
1719
- # configuration sets, which enable you to publish message sending
1720
- # events.
1721
- #
1722
- # @!attribute [rw] iam_role_arn
1723
- # The ARN of an Amazon Identity and Access Management (IAM) role that
1724
- # is able to write event data to an Amazon Firehose destination.
1725
- # @return [String]
2383
+ # @!attribute [rw] registration_type_definitions
2384
+ # The type of registration form. The list of **RegistrationTypes** can
2385
+ # be found using the DescribeRegistrationTypeDefinitions action.
2386
+ # @return [Array<Types::RegistrationTypeDefinition>]
1726
2387
  #
1727
- # @!attribute [rw] delivery_stream_arn
1728
- # The Amazon Resource Name (ARN) of the delivery stream.
2388
+ # @!attribute [rw] next_token
2389
+ # The token to be used for the next set of paginated results. You
2390
+ # don't need to supply a value for this field in the initial request.
1729
2391
  # @return [String]
1730
2392
  #
1731
- # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/KinesisFirehoseDestination AWS API Documentation
2393
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeRegistrationTypeDefinitionsResult AWS API Documentation
1732
2394
  #
1733
- class KinesisFirehoseDestination < Struct.new(
1734
- :iam_role_arn,
1735
- :delivery_stream_arn)
2395
+ class DescribeRegistrationTypeDefinitionsResult < Struct.new(
2396
+ :registration_type_definitions,
2397
+ :next_token)
1736
2398
  SENSITIVE = []
1737
2399
  include Aws::Structure
1738
2400
  end
1739
2401
 
1740
- # @!attribute [rw] pool_id
1741
- # The unique identifier for the pool. This value can be either the
1742
- # PoolId or PoolArn.
2402
+ # @!attribute [rw] registration_id
2403
+ # The unique identifier for the registration.
1743
2404
  # @return [String]
1744
2405
  #
2406
+ # @!attribute [rw] version_numbers
2407
+ # An array of registration version numbers.
2408
+ # @return [Array<Integer>]
2409
+ #
1745
2410
  # @!attribute [rw] filters
1746
- # An array of PoolOriginationIdentitiesFilter objects to filter the
1747
- # results..
1748
- # @return [Array<Types::PoolOriginationIdentitiesFilter>]
2411
+ # An array of RegistrationVersionFilter objects to filter the results.
2412
+ # @return [Array<Types::RegistrationVersionFilter>]
1749
2413
  #
1750
2414
  # @!attribute [rw] next_token
1751
2415
  # The token to be used for the next set of paginated results. You
@@ -1756,10 +2420,11 @@ module Aws::PinpointSMSVoiceV2
1756
2420
  # The maximum number of results to return per each request.
1757
2421
  # @return [Integer]
1758
2422
  #
1759
- # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ListPoolOriginationIdentitiesRequest AWS API Documentation
2423
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeRegistrationVersionsRequest AWS API Documentation
1760
2424
  #
1761
- class ListPoolOriginationIdentitiesRequest < Struct.new(
1762
- :pool_id,
2425
+ class DescribeRegistrationVersionsRequest < Struct.new(
2426
+ :registration_id,
2427
+ :version_numbers,
1763
2428
  :filters,
1764
2429
  :next_token,
1765
2430
  :max_results)
@@ -1767,134 +2432,1151 @@ module Aws::PinpointSMSVoiceV2
1767
2432
  include Aws::Structure
1768
2433
  end
1769
2434
 
1770
- # @!attribute [rw] pool_arn
1771
- # The Amazon Resource Name (ARN) for the pool.
2435
+ # @!attribute [rw] registration_arn
2436
+ # The Amazon Resource Name (ARN) for the registration.
1772
2437
  # @return [String]
1773
2438
  #
1774
- # @!attribute [rw] pool_id
1775
- # The unique PoolId of the pool.
2439
+ # @!attribute [rw] registration_id
2440
+ # The unique identifier for the registration.
1776
2441
  # @return [String]
1777
2442
  #
1778
- # @!attribute [rw] origination_identities
1779
- # An array of any OriginationIdentityMetadata objects.
1780
- # @return [Array<Types::OriginationIdentityMetadata>]
2443
+ # @!attribute [rw] registration_versions
2444
+ # An array of RegistrationVersions objects.
2445
+ # @return [Array<Types::RegistrationVersionInformation>]
1781
2446
  #
1782
2447
  # @!attribute [rw] next_token
1783
- # The token to be used for the next set of paginated results. If this
1784
- # field is empty then there are no more results.
2448
+ # The token to be used for the next set of paginated results. You
2449
+ # don't need to supply a value for this field in the initial request.
1785
2450
  # @return [String]
1786
2451
  #
1787
- # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ListPoolOriginationIdentitiesResult AWS API Documentation
2452
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeRegistrationVersionsResult AWS API Documentation
1788
2453
  #
1789
- class ListPoolOriginationIdentitiesResult < Struct.new(
1790
- :pool_arn,
1791
- :pool_id,
1792
- :origination_identities,
2454
+ class DescribeRegistrationVersionsResult < Struct.new(
2455
+ :registration_arn,
2456
+ :registration_id,
2457
+ :registration_versions,
1793
2458
  :next_token)
1794
2459
  SENSITIVE = []
1795
2460
  include Aws::Structure
1796
2461
  end
1797
2462
 
1798
- # @!attribute [rw] resource_arn
1799
- # The Amazon Resource Name (ARN) of the resource to query for.
2463
+ # @!attribute [rw] registration_ids
2464
+ # An array of unique identifiers for each registration.
2465
+ # @return [Array<String>]
2466
+ #
2467
+ # @!attribute [rw] filters
2468
+ # An array of RegistrationFilter objects to filter the results.
2469
+ # @return [Array<Types::RegistrationFilter>]
2470
+ #
2471
+ # @!attribute [rw] next_token
2472
+ # The token to be used for the next set of paginated results. You
2473
+ # don't need to supply a value for this field in the initial request.
1800
2474
  # @return [String]
1801
2475
  #
1802
- # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ListTagsForResourceRequest AWS API Documentation
2476
+ # @!attribute [rw] max_results
2477
+ # The maximum number of results to return per each request.
2478
+ # @return [Integer]
1803
2479
  #
1804
- class ListTagsForResourceRequest < Struct.new(
1805
- :resource_arn)
2480
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeRegistrationsRequest AWS API Documentation
2481
+ #
2482
+ class DescribeRegistrationsRequest < Struct.new(
2483
+ :registration_ids,
2484
+ :filters,
2485
+ :next_token,
2486
+ :max_results)
1806
2487
  SENSITIVE = []
1807
2488
  include Aws::Structure
1808
2489
  end
1809
2490
 
1810
- # @!attribute [rw] resource_arn
1811
- # The ARN of the resource.
1812
- # @return [String]
2491
+ # @!attribute [rw] registrations
2492
+ # An array of RegistrationInformation objects.
2493
+ # @return [Array<Types::RegistrationInformation>]
1813
2494
  #
1814
- # @!attribute [rw] tags
1815
- # An array of key and value pair tags that are associated with the
1816
- # resource.
1817
- # @return [Array<Types::Tag>]
2495
+ # @!attribute [rw] next_token
2496
+ # The token to be used for the next set of paginated results. You
2497
+ # don't need to supply a value for this field in the initial request.
2498
+ # @return [String]
1818
2499
  #
1819
- # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ListTagsForResourceResult AWS API Documentation
2500
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeRegistrationsResult AWS API Documentation
1820
2501
  #
1821
- class ListTagsForResourceResult < Struct.new(
1822
- :resource_arn,
1823
- :tags)
2502
+ class DescribeRegistrationsResult < Struct.new(
2503
+ :registrations,
2504
+ :next_token)
1824
2505
  SENSITIVE = []
1825
2506
  include Aws::Structure
1826
2507
  end
1827
2508
 
1828
- # The information for all OptOutList in an Amazon Web Services account.
2509
+ # @!attribute [rw] sender_ids
2510
+ # An array of SenderIdAndCountry objects to search for.
2511
+ # @return [Array<Types::SenderIdAndCountry>]
1829
2512
  #
1830
- # @!attribute [rw] opt_out_list_arn
1831
- # The Amazon Resource Name (ARN) of the OptOutList.
1832
- # @return [String]
2513
+ # @!attribute [rw] filters
2514
+ # An array of SenderIdFilter objects to filter the results.
2515
+ # @return [Array<Types::SenderIdFilter>]
1833
2516
  #
1834
- # @!attribute [rw] opt_out_list_name
1835
- # The name of the OptOutList.
2517
+ # @!attribute [rw] next_token
2518
+ # The token to be used for the next set of paginated results. You
2519
+ # don't need to supply a value for this field in the initial request.
1836
2520
  # @return [String]
1837
2521
  #
1838
- # @!attribute [rw] created_timestamp
1839
- # The time when the OutOutList was created, in [UNIX epoch time][1]
1840
- # format.
1841
- #
1842
- #
1843
- #
1844
- # [1]: https://www.epochconverter.com/
1845
- # @return [Time]
2522
+ # @!attribute [rw] max_results
2523
+ # The maximum number of results to return per each request.
2524
+ # @return [Integer]
1846
2525
  #
1847
- # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/OptOutListInformation AWS API Documentation
2526
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeSenderIdsRequest AWS API Documentation
1848
2527
  #
1849
- class OptOutListInformation < Struct.new(
1850
- :opt_out_list_arn,
1851
- :opt_out_list_name,
1852
- :created_timestamp)
2528
+ class DescribeSenderIdsRequest < Struct.new(
2529
+ :sender_ids,
2530
+ :filters,
2531
+ :next_token,
2532
+ :max_results)
1853
2533
  SENSITIVE = []
1854
2534
  include Aws::Structure
1855
2535
  end
1856
2536
 
1857
- # The information for opted out numbers that meet a specified criteria.
2537
+ # @!attribute [rw] sender_ids
2538
+ # An array of SernderIdInformation objects that contain the details
2539
+ # for the requested SenderIds.
2540
+ # @return [Array<Types::SenderIdInformation>]
1858
2541
  #
1859
- # @!attribute [rw] name
1860
- # The name of the attribute to filter on.
2542
+ # @!attribute [rw] next_token
2543
+ # The token to be used for the next set of paginated results. If this
2544
+ # field is empty then there are no more results.
1861
2545
  # @return [String]
1862
2546
  #
1863
- # @!attribute [rw] values
1864
- # An array of values to filter for.
1865
- # @return [Array<String>]
1866
- #
1867
- # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/OptedOutFilter AWS API Documentation
2547
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeSenderIdsResult AWS API Documentation
1868
2548
  #
1869
- class OptedOutFilter < Struct.new(
1870
- :name,
1871
- :values)
2549
+ class DescribeSenderIdsResult < Struct.new(
2550
+ :sender_ids,
2551
+ :next_token)
1872
2552
  SENSITIVE = []
1873
2553
  include Aws::Structure
1874
2554
  end
1875
2555
 
1876
- # The information for an opted out number in an Amazon Web Services
1877
- # account.
1878
- #
1879
- # @!attribute [rw] opted_out_number
1880
- # The phone number that is opted out.
2556
+ # @!attribute [rw] next_token
2557
+ # The token to be used for the next set of paginated results. You
2558
+ # don't need to supply a value for this field in the initial request.
1881
2559
  # @return [String]
1882
2560
  #
1883
- # @!attribute [rw] opted_out_timestamp
1884
- # The time that the op tout occurred, in [UNIX epoch time][1] format.
1885
- #
2561
+ # @!attribute [rw] max_results
2562
+ # The maximum number of results to return per each request.
2563
+ # @return [Integer]
2564
+ #
2565
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeSpendLimitsRequest AWS API Documentation
2566
+ #
2567
+ class DescribeSpendLimitsRequest < Struct.new(
2568
+ :next_token,
2569
+ :max_results)
2570
+ SENSITIVE = []
2571
+ include Aws::Structure
2572
+ end
2573
+
2574
+ # @!attribute [rw] spend_limits
2575
+ # An array of SpendLimit objects that contain the details for the
2576
+ # requested spend limits.
2577
+ # @return [Array<Types::SpendLimit>]
2578
+ #
2579
+ # @!attribute [rw] next_token
2580
+ # The token to be used for the next set of paginated results. If this
2581
+ # field is empty then there are no more results.
2582
+ # @return [String]
2583
+ #
2584
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeSpendLimitsResult AWS API Documentation
2585
+ #
2586
+ class DescribeSpendLimitsResult < Struct.new(
2587
+ :spend_limits,
2588
+ :next_token)
2589
+ SENSITIVE = []
2590
+ include Aws::Structure
2591
+ end
2592
+
2593
+ # @!attribute [rw] verified_destination_number_ids
2594
+ # An array of VerifiedDestinationNumberid to retreive.
2595
+ # @return [Array<String>]
2596
+ #
2597
+ # @!attribute [rw] destination_phone_numbers
2598
+ # An array of verified destination phone number, in E.164 format.
2599
+ # @return [Array<String>]
2600
+ #
2601
+ # @!attribute [rw] filters
2602
+ # An array of VerifiedDestinationNumberFilter objects to filter the
2603
+ # results.
2604
+ # @return [Array<Types::VerifiedDestinationNumberFilter>]
2605
+ #
2606
+ # @!attribute [rw] next_token
2607
+ # The token to be used for the next set of paginated results. You
2608
+ # don't need to supply a value for this field in the initial request.
2609
+ # @return [String]
2610
+ #
2611
+ # @!attribute [rw] max_results
2612
+ # The maximum number of results to return per each request.
2613
+ # @return [Integer]
2614
+ #
2615
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeVerifiedDestinationNumbersRequest AWS API Documentation
2616
+ #
2617
+ class DescribeVerifiedDestinationNumbersRequest < Struct.new(
2618
+ :verified_destination_number_ids,
2619
+ :destination_phone_numbers,
2620
+ :filters,
2621
+ :next_token,
2622
+ :max_results)
2623
+ SENSITIVE = []
2624
+ include Aws::Structure
2625
+ end
2626
+
2627
+ # @!attribute [rw] verified_destination_numbers
2628
+ # An array of VerifiedDestinationNumberInformation objects
2629
+ # @return [Array<Types::VerifiedDestinationNumberInformation>]
2630
+ #
2631
+ # @!attribute [rw] next_token
2632
+ # The token to be used for the next set of paginated results. You
2633
+ # don't need to supply a value for this field in the initial request.
2634
+ # @return [String]
2635
+ #
2636
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeVerifiedDestinationNumbersResult AWS API Documentation
2637
+ #
2638
+ class DescribeVerifiedDestinationNumbersResult < Struct.new(
2639
+ :verified_destination_numbers,
2640
+ :next_token)
2641
+ SENSITIVE = []
2642
+ include Aws::Structure
2643
+ end
2644
+
2645
+ # @!attribute [rw] pool_id
2646
+ # The unique identifier for the pool to disassociate with the
2647
+ # origination identity. This value can be either the PoolId or
2648
+ # PoolArn.
2649
+ # @return [String]
2650
+ #
2651
+ # @!attribute [rw] origination_identity
2652
+ # The origination identity to use such as a PhoneNumberId,
2653
+ # PhoneNumberArn, SenderId or SenderIdArn. You can use
2654
+ # DescribePhoneNumbers find the values for PhoneNumberId and
2655
+ # PhoneNumberArn, or use DescribeSenderIds to get the values for
2656
+ # SenderId and SenderIdArn.
2657
+ # @return [String]
2658
+ #
2659
+ # @!attribute [rw] iso_country_code
2660
+ # The two-character code, in ISO 3166-1 alpha-2 format, for the
2661
+ # country or region.
2662
+ # @return [String]
2663
+ #
2664
+ # @!attribute [rw] client_token
2665
+ # Unique, case-sensitive identifier you provide to ensure the
2666
+ # idempotency of the request. If you don't specify a client token, a
2667
+ # randomly generated token is used for the request to ensure
2668
+ # idempotency.
2669
+ #
2670
+ # **A suitable default value is auto-generated.** You should normally
2671
+ # not need to pass this option.
2672
+ # @return [String]
2673
+ #
2674
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DisassociateOriginationIdentityRequest AWS API Documentation
2675
+ #
2676
+ class DisassociateOriginationIdentityRequest < Struct.new(
2677
+ :pool_id,
2678
+ :origination_identity,
2679
+ :iso_country_code,
2680
+ :client_token)
2681
+ SENSITIVE = []
2682
+ include Aws::Structure
2683
+ end
2684
+
2685
+ # @!attribute [rw] pool_arn
2686
+ # The Amazon Resource Name (ARN) of the pool.
2687
+ # @return [String]
2688
+ #
2689
+ # @!attribute [rw] pool_id
2690
+ # The PoolId of the pool no longer associated with the origination
2691
+ # identity.
2692
+ # @return [String]
2693
+ #
2694
+ # @!attribute [rw] origination_identity_arn
2695
+ # The PhoneNumberArn or SenderIdArn of the origination identity.
2696
+ # @return [String]
2697
+ #
2698
+ # @!attribute [rw] origination_identity
2699
+ # The PhoneNumberId or SenderId of the origination identity.
2700
+ # @return [String]
2701
+ #
2702
+ # @!attribute [rw] iso_country_code
2703
+ # The two-character code, in ISO 3166-1 alpha-2 format, for the
2704
+ # country or region.
2705
+ # @return [String]
2706
+ #
2707
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DisassociateOriginationIdentityResult AWS API Documentation
2708
+ #
2709
+ class DisassociateOriginationIdentityResult < Struct.new(
2710
+ :pool_arn,
2711
+ :pool_id,
2712
+ :origination_identity_arn,
2713
+ :origination_identity,
2714
+ :iso_country_code)
2715
+ SENSITIVE = []
2716
+ include Aws::Structure
2717
+ end
2718
+
2719
+ # @!attribute [rw] registration_id
2720
+ # The unique identifier for the registration.
2721
+ # @return [String]
2722
+ #
2723
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DiscardRegistrationVersionRequest AWS API Documentation
2724
+ #
2725
+ class DiscardRegistrationVersionRequest < Struct.new(
2726
+ :registration_id)
2727
+ SENSITIVE = []
2728
+ include Aws::Structure
2729
+ end
2730
+
2731
+ # @!attribute [rw] registration_arn
2732
+ # The Amazon Resource Name (ARN) for the registration.
2733
+ # @return [String]
2734
+ #
2735
+ # @!attribute [rw] registration_id
2736
+ # The unique identifier for the registration.
2737
+ # @return [String]
2738
+ #
2739
+ # @!attribute [rw] version_number
2740
+ # The version number of the registration.
2741
+ # @return [Integer]
2742
+ #
2743
+ # @!attribute [rw] registration_version_status
2744
+ # The status of the registration version.
2745
+ #
2746
+ # * `DRAFT`: The initial status of a registration version after it’s
2747
+ # created.
2748
+ #
2749
+ # * `SUBMITTED`: Your registration has been submitted.
2750
+ #
2751
+ # * `REVIEWING`: Your registration has been accepted and is being
2752
+ # reviewed.
2753
+ #
2754
+ # * `APPROVED`: Your registration has been approved.
2755
+ #
2756
+ # * `DISCARDED`: You've abandon this version of their registration to
2757
+ # start over with a new version.
2758
+ #
2759
+ # * `DENIED`: You must fix your registration and resubmit it.
2760
+ #
2761
+ # * `REVOKED`: Your previously approved registration has been revoked.
2762
+ #
2763
+ # * `ARCHIVED`: Your previously approved registration version moves
2764
+ # into this status when a more recently submitted version is
2765
+ # approved.
2766
+ # @return [String]
2767
+ #
2768
+ # @!attribute [rw] registration_version_status_history
2769
+ # The **RegistrationVersionStatusHistory** object contains the time
2770
+ # stamps for when the reservations status changes.
2771
+ # @return [Types::RegistrationVersionStatusHistory]
2772
+ #
2773
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DiscardRegistrationVersionResult AWS API Documentation
2774
+ #
2775
+ class DiscardRegistrationVersionResult < Struct.new(
2776
+ :registration_arn,
2777
+ :registration_id,
2778
+ :version_number,
2779
+ :registration_version_status,
2780
+ :registration_version_status_history)
2781
+ SENSITIVE = []
2782
+ include Aws::Structure
2783
+ end
2784
+
2785
+ # Contains information about an event destination.
2786
+ #
2787
+ # Event destinations are associated with configuration sets, which
2788
+ # enable you to publish message sending events to CloudWatch, Kinesis
2789
+ # Data Firehose,or Amazon SNS.
2790
+ #
2791
+ # @!attribute [rw] event_destination_name
2792
+ # The name of the EventDestination.
2793
+ # @return [String]
2794
+ #
2795
+ # @!attribute [rw] enabled
2796
+ # When set to true events will be logged.
2797
+ # @return [Boolean]
2798
+ #
2799
+ # @!attribute [rw] matching_event_types
2800
+ # An array of event types that determine which events to log.
2801
+ #
2802
+ # <note markdown="1"> The `TEXT_SENT` event type is not supported.
2803
+ #
2804
+ # </note>
2805
+ # @return [Array<String>]
2806
+ #
2807
+ # @!attribute [rw] cloud_watch_logs_destination
2808
+ # An object that contains information about an event destination that
2809
+ # sends logging events to Amazon CloudWatch logs.
2810
+ # @return [Types::CloudWatchLogsDestination]
2811
+ #
2812
+ # @!attribute [rw] kinesis_firehose_destination
2813
+ # An object that contains information about an event destination for
2814
+ # logging to Amazon Kinesis Data Firehose.
2815
+ # @return [Types::KinesisFirehoseDestination]
2816
+ #
2817
+ # @!attribute [rw] sns_destination
2818
+ # An object that contains information about an event destination that
2819
+ # sends logging events to Amazon SNS.
2820
+ # @return [Types::SnsDestination]
2821
+ #
2822
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/EventDestination AWS API Documentation
2823
+ #
2824
+ class EventDestination < Struct.new(
2825
+ :event_destination_name,
2826
+ :enabled,
2827
+ :matching_event_types,
2828
+ :cloud_watch_logs_destination,
2829
+ :kinesis_firehose_destination,
2830
+ :sns_destination)
2831
+ SENSITIVE = []
2832
+ include Aws::Structure
2833
+ end
2834
+
2835
+ # The API encountered an unexpected error and couldn't complete the
2836
+ # request. You might be able to successfully issue the request again in
2837
+ # the future.
2838
+ #
2839
+ # @!attribute [rw] message
2840
+ # @return [String]
2841
+ #
2842
+ # @!attribute [rw] request_id
2843
+ # The unique identifier of the request.
2844
+ # @return [String]
2845
+ #
2846
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/InternalServerException AWS API Documentation
2847
+ #
2848
+ class InternalServerException < Struct.new(
2849
+ :message,
2850
+ :request_id)
2851
+ SENSITIVE = []
2852
+ include Aws::Structure
2853
+ end
2854
+
2855
+ # The information for keywords that meet a specified criteria.
2856
+ #
2857
+ # @!attribute [rw] name
2858
+ # The name of the attribute to filter on.
2859
+ # @return [String]
2860
+ #
2861
+ # @!attribute [rw] values
2862
+ # An array values to filter for.
2863
+ # @return [Array<String>]
2864
+ #
2865
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/KeywordFilter AWS API Documentation
2866
+ #
2867
+ class KeywordFilter < Struct.new(
2868
+ :name,
2869
+ :values)
2870
+ SENSITIVE = []
2871
+ include Aws::Structure
2872
+ end
2873
+
2874
+ # The information for all keywords in a pool.
2875
+ #
2876
+ # @!attribute [rw] keyword
2877
+ # The keyword as a string.
2878
+ # @return [String]
2879
+ #
2880
+ # @!attribute [rw] keyword_message
2881
+ # A custom message that can be used with the keyword.
2882
+ # @return [String]
2883
+ #
2884
+ # @!attribute [rw] keyword_action
2885
+ # The action to perform for the keyword.
2886
+ # @return [String]
2887
+ #
2888
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/KeywordInformation AWS API Documentation
2889
+ #
2890
+ class KeywordInformation < Struct.new(
2891
+ :keyword,
2892
+ :keyword_message,
2893
+ :keyword_action)
2894
+ SENSITIVE = []
2895
+ include Aws::Structure
2896
+ end
2897
+
2898
+ # Contains the delivery stream Amazon Resource Name (ARN), and the ARN
2899
+ # of the Identity and Access Management (IAM) role associated with an
2900
+ # Kinesis Data Firehose event destination.
2901
+ #
2902
+ # Event destinations, such as Kinesis Data Firehose, are associated with
2903
+ # configuration sets, which enable you to publish message sending
2904
+ # events.
2905
+ #
2906
+ # @!attribute [rw] iam_role_arn
2907
+ # The ARN of an Amazon Identity and Access Management (IAM) role that
2908
+ # is able to write event data to an Amazon Firehose destination.
2909
+ # @return [String]
2910
+ #
2911
+ # @!attribute [rw] delivery_stream_arn
2912
+ # The Amazon Resource Name (ARN) of the delivery stream.
2913
+ # @return [String]
2914
+ #
2915
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/KinesisFirehoseDestination AWS API Documentation
2916
+ #
2917
+ class KinesisFirehoseDestination < Struct.new(
2918
+ :iam_role_arn,
2919
+ :delivery_stream_arn)
2920
+ SENSITIVE = []
2921
+ include Aws::Structure
2922
+ end
2923
+
2924
+ # @!attribute [rw] pool_id
2925
+ # The unique identifier for the pool. This value can be either the
2926
+ # PoolId or PoolArn.
2927
+ # @return [String]
2928
+ #
2929
+ # @!attribute [rw] filters
2930
+ # An array of PoolOriginationIdentitiesFilter objects to filter the
2931
+ # results..
2932
+ # @return [Array<Types::PoolOriginationIdentitiesFilter>]
2933
+ #
2934
+ # @!attribute [rw] next_token
2935
+ # The token to be used for the next set of paginated results. You
2936
+ # don't need to supply a value for this field in the initial request.
2937
+ # @return [String]
2938
+ #
2939
+ # @!attribute [rw] max_results
2940
+ # The maximum number of results to return per each request.
2941
+ # @return [Integer]
2942
+ #
2943
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ListPoolOriginationIdentitiesRequest AWS API Documentation
2944
+ #
2945
+ class ListPoolOriginationIdentitiesRequest < Struct.new(
2946
+ :pool_id,
2947
+ :filters,
2948
+ :next_token,
2949
+ :max_results)
2950
+ SENSITIVE = []
2951
+ include Aws::Structure
2952
+ end
2953
+
2954
+ # @!attribute [rw] pool_arn
2955
+ # The Amazon Resource Name (ARN) for the pool.
2956
+ # @return [String]
2957
+ #
2958
+ # @!attribute [rw] pool_id
2959
+ # The unique PoolId of the pool.
2960
+ # @return [String]
2961
+ #
2962
+ # @!attribute [rw] origination_identities
2963
+ # An array of any OriginationIdentityMetadata objects.
2964
+ # @return [Array<Types::OriginationIdentityMetadata>]
2965
+ #
2966
+ # @!attribute [rw] next_token
2967
+ # The token to be used for the next set of paginated results. If this
2968
+ # field is empty then there are no more results.
2969
+ # @return [String]
2970
+ #
2971
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ListPoolOriginationIdentitiesResult AWS API Documentation
2972
+ #
2973
+ class ListPoolOriginationIdentitiesResult < Struct.new(
2974
+ :pool_arn,
2975
+ :pool_id,
2976
+ :origination_identities,
2977
+ :next_token)
2978
+ SENSITIVE = []
2979
+ include Aws::Structure
2980
+ end
2981
+
2982
+ # @!attribute [rw] registration_id
2983
+ # The unique identifier for the registration.
2984
+ # @return [String]
2985
+ #
2986
+ # @!attribute [rw] filters
2987
+ # An array of RegistrationAssociationFilter to apply to the results
2988
+ # that are returned.
2989
+ # @return [Array<Types::RegistrationAssociationFilter>]
2990
+ #
2991
+ # @!attribute [rw] next_token
2992
+ # The token to be used for the next set of paginated results. You
2993
+ # don't need to supply a value for this field in the initial request.
2994
+ # @return [String]
2995
+ #
2996
+ # @!attribute [rw] max_results
2997
+ # The maximum number of results to return per each request.
2998
+ # @return [Integer]
2999
+ #
3000
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ListRegistrationAssociationsRequest AWS API Documentation
3001
+ #
3002
+ class ListRegistrationAssociationsRequest < Struct.new(
3003
+ :registration_id,
3004
+ :filters,
3005
+ :next_token,
3006
+ :max_results)
3007
+ SENSITIVE = []
3008
+ include Aws::Structure
3009
+ end
3010
+
3011
+ # @!attribute [rw] registration_arn
3012
+ # The Amazon Resource Name (ARN) for the registration.
3013
+ # @return [String]
3014
+ #
3015
+ # @!attribute [rw] registration_id
3016
+ # The unique identifier for the registration.
3017
+ # @return [String]
3018
+ #
3019
+ # @!attribute [rw] registration_type
3020
+ # The type of registration form. The list of **RegistrationTypes** can
3021
+ # be found using the DescribeRegistrationTypeDefinitions action.
3022
+ # @return [String]
3023
+ #
3024
+ # @!attribute [rw] registration_associations
3025
+ # An array of RegistrationAssociationMetadata objects.
3026
+ # @return [Array<Types::RegistrationAssociationMetadata>]
3027
+ #
3028
+ # @!attribute [rw] next_token
3029
+ # The token to be used for the next set of paginated results. You
3030
+ # don't need to supply a value for this field in the initial request.
3031
+ # @return [String]
3032
+ #
3033
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ListRegistrationAssociationsResult AWS API Documentation
3034
+ #
3035
+ class ListRegistrationAssociationsResult < Struct.new(
3036
+ :registration_arn,
3037
+ :registration_id,
3038
+ :registration_type,
3039
+ :registration_associations,
3040
+ :next_token)
3041
+ SENSITIVE = []
3042
+ include Aws::Structure
3043
+ end
3044
+
3045
+ # @!attribute [rw] resource_arn
3046
+ # The Amazon Resource Name (ARN) of the resource to query for.
3047
+ # @return [String]
3048
+ #
3049
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ListTagsForResourceRequest AWS API Documentation
3050
+ #
3051
+ class ListTagsForResourceRequest < Struct.new(
3052
+ :resource_arn)
3053
+ SENSITIVE = []
3054
+ include Aws::Structure
3055
+ end
3056
+
3057
+ # @!attribute [rw] resource_arn
3058
+ # The ARN of the resource.
3059
+ # @return [String]
3060
+ #
3061
+ # @!attribute [rw] tags
3062
+ # An array of key and value pair tags that are associated with the
3063
+ # resource.
3064
+ # @return [Array<Types::Tag>]
3065
+ #
3066
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ListTagsForResourceResult AWS API Documentation
3067
+ #
3068
+ class ListTagsForResourceResult < Struct.new(
3069
+ :resource_arn,
3070
+ :tags)
3071
+ SENSITIVE = []
3072
+ include Aws::Structure
3073
+ end
3074
+
3075
+ # The information for all OptOutList in an Amazon Web Services account.
3076
+ #
3077
+ # @!attribute [rw] opt_out_list_arn
3078
+ # The Amazon Resource Name (ARN) of the OptOutList.
3079
+ # @return [String]
3080
+ #
3081
+ # @!attribute [rw] opt_out_list_name
3082
+ # The name of the OptOutList.
3083
+ # @return [String]
3084
+ #
3085
+ # @!attribute [rw] created_timestamp
3086
+ # The time when the OutOutList was created, in [UNIX epoch time][1]
3087
+ # format.
3088
+ #
3089
+ #
3090
+ #
3091
+ # [1]: https://www.epochconverter.com/
3092
+ # @return [Time]
3093
+ #
3094
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/OptOutListInformation AWS API Documentation
3095
+ #
3096
+ class OptOutListInformation < Struct.new(
3097
+ :opt_out_list_arn,
3098
+ :opt_out_list_name,
3099
+ :created_timestamp)
3100
+ SENSITIVE = []
3101
+ include Aws::Structure
3102
+ end
3103
+
3104
+ # The information for opted out numbers that meet a specified criteria.
3105
+ #
3106
+ # @!attribute [rw] name
3107
+ # The name of the attribute to filter on.
3108
+ # @return [String]
3109
+ #
3110
+ # @!attribute [rw] values
3111
+ # An array of values to filter for.
3112
+ # @return [Array<String>]
3113
+ #
3114
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/OptedOutFilter AWS API Documentation
3115
+ #
3116
+ class OptedOutFilter < Struct.new(
3117
+ :name,
3118
+ :values)
3119
+ SENSITIVE = []
3120
+ include Aws::Structure
3121
+ end
3122
+
3123
+ # The information for an opted out number in an Amazon Web Services
3124
+ # account.
3125
+ #
3126
+ # @!attribute [rw] opted_out_number
3127
+ # The phone number that is opted out.
3128
+ # @return [String]
3129
+ #
3130
+ # @!attribute [rw] opted_out_timestamp
3131
+ # The time that the op tout occurred, in [UNIX epoch time][1] format.
3132
+ #
3133
+ #
3134
+ #
3135
+ # [1]: https://www.epochconverter.com/
3136
+ # @return [Time]
3137
+ #
3138
+ # @!attribute [rw] end_user_opted_out
3139
+ # This is set to true if it was the end recipient that opted out.
3140
+ # @return [Boolean]
3141
+ #
3142
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/OptedOutNumberInformation AWS API Documentation
3143
+ #
3144
+ class OptedOutNumberInformation < Struct.new(
3145
+ :opted_out_number,
3146
+ :opted_out_timestamp,
3147
+ :end_user_opted_out)
3148
+ SENSITIVE = []
3149
+ include Aws::Structure
3150
+ end
3151
+
3152
+ # The metadata for an origination identity associated with a pool.
3153
+ #
3154
+ # @!attribute [rw] origination_identity_arn
3155
+ # The Amazon Resource Name (ARN) associated with the origination
3156
+ # identity.
3157
+ # @return [String]
3158
+ #
3159
+ # @!attribute [rw] origination_identity
3160
+ # The unique identifier of the origination identity.
3161
+ # @return [String]
3162
+ #
3163
+ # @!attribute [rw] iso_country_code
3164
+ # The two-character code, in ISO 3166-1 alpha-2 format, for the
3165
+ # country or region.
3166
+ # @return [String]
3167
+ #
3168
+ # @!attribute [rw] number_capabilities
3169
+ # Describes if the origination identity can be used for text messages,
3170
+ # voice calls or both.
3171
+ # @return [Array<String>]
3172
+ #
3173
+ # @!attribute [rw] phone_number
3174
+ # The phone number in E.164 format.
3175
+ # @return [String]
3176
+ #
3177
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/OriginationIdentityMetadata AWS API Documentation
3178
+ #
3179
+ class OriginationIdentityMetadata < Struct.new(
3180
+ :origination_identity_arn,
3181
+ :origination_identity,
3182
+ :iso_country_code,
3183
+ :number_capabilities,
3184
+ :phone_number)
3185
+ SENSITIVE = []
3186
+ include Aws::Structure
3187
+ end
3188
+
3189
+ # The information for a phone number that meets a specified criteria.
3190
+ #
3191
+ # @!attribute [rw] name
3192
+ # The name of the attribute to filter on.
3193
+ # @return [String]
3194
+ #
3195
+ # @!attribute [rw] values
3196
+ # An array values to filter for.
3197
+ # @return [Array<String>]
3198
+ #
3199
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PhoneNumberFilter AWS API Documentation
3200
+ #
3201
+ class PhoneNumberFilter < Struct.new(
3202
+ :name,
3203
+ :values)
3204
+ SENSITIVE = []
3205
+ include Aws::Structure
3206
+ end
3207
+
3208
+ # The information for a phone number, in E.164 format, in an Amazon Web
3209
+ # Services account.
3210
+ #
3211
+ # @!attribute [rw] phone_number_arn
3212
+ # The Amazon Resource Name (ARN) associated with the phone number.
3213
+ # @return [String]
3214
+ #
3215
+ # @!attribute [rw] phone_number_id
3216
+ # The unique identifier for the phone number.
3217
+ # @return [String]
3218
+ #
3219
+ # @!attribute [rw] phone_number
3220
+ # The phone number in E.164 format.
3221
+ # @return [String]
3222
+ #
3223
+ # @!attribute [rw] status
3224
+ # The current status of the phone number.
3225
+ # @return [String]
3226
+ #
3227
+ # @!attribute [rw] iso_country_code
3228
+ # The two-character code, in ISO 3166-1 alpha-2 format, for the
3229
+ # country or region.
3230
+ # @return [String]
3231
+ #
3232
+ # @!attribute [rw] message_type
3233
+ # The type of message. Valid values are TRANSACTIONAL for messages
3234
+ # that are critical or time-sensitive and PROMOTIONAL for messages
3235
+ # that aren't critical or time-sensitive.
3236
+ # @return [String]
3237
+ #
3238
+ # @!attribute [rw] number_capabilities
3239
+ # Describes if the origination identity can be used for text messages,
3240
+ # voice calls or both.
3241
+ # @return [Array<String>]
3242
+ #
3243
+ # @!attribute [rw] number_type
3244
+ # The type of phone number.
3245
+ # @return [String]
3246
+ #
3247
+ # @!attribute [rw] monthly_leasing_price
3248
+ # The price, in US dollars, to lease the phone number.
3249
+ # @return [String]
3250
+ #
3251
+ # @!attribute [rw] two_way_enabled
3252
+ # By default this is set to false. When set to true you can receive
3253
+ # incoming text messages from your end recipients using the
3254
+ # TwoWayChannelArn.
3255
+ # @return [Boolean]
3256
+ #
3257
+ # @!attribute [rw] two_way_channel_arn
3258
+ # The Amazon Resource Name (ARN) of the two way channel.
3259
+ # @return [String]
3260
+ #
3261
+ # @!attribute [rw] two_way_channel_role
3262
+ # An optional IAM Role Arn for a service to assume, to be able to post
3263
+ # inbound SMS messages.
3264
+ # @return [String]
3265
+ #
3266
+ # @!attribute [rw] self_managed_opt_outs_enabled
3267
+ # When set to false an end recipient sends a message that begins with
3268
+ # HELP or STOP to one of your dedicated numbers, Amazon Pinpoint
3269
+ # automatically replies with a customizable message and adds the end
3270
+ # recipient to the OptOutList. When set to true you're responsible
3271
+ # for responding to HELP and STOP requests. You're also responsible
3272
+ # for tracking and honoring opt-out request. For more information see
3273
+ # [Self-managed opt-outs][1]
3274
+ #
3275
+ #
3276
+ #
3277
+ # [1]: https://docs.aws.amazon.com/pinpoint/latest/userguide/settings-sms-managing.html#settings-account-sms-self-managed-opt-out
3278
+ # @return [Boolean]
3279
+ #
3280
+ # @!attribute [rw] opt_out_list_name
3281
+ # The name of the OptOutList associated with the phone number.
3282
+ # @return [String]
3283
+ #
3284
+ # @!attribute [rw] deletion_protection_enabled
3285
+ # When set to true the phone number can't be deleted.
3286
+ # @return [Boolean]
3287
+ #
3288
+ # @!attribute [rw] pool_id
3289
+ # The unique identifier of the pool associated with the phone number.
3290
+ # @return [String]
3291
+ #
3292
+ # @!attribute [rw] registration_id
3293
+ # The unique identifier for the registration.
3294
+ # @return [String]
3295
+ #
3296
+ # @!attribute [rw] created_timestamp
3297
+ # The time when the phone number was created, in [UNIX epoch time][1]
3298
+ # format.
3299
+ #
3300
+ #
3301
+ #
3302
+ # [1]: https://www.epochconverter.com/
3303
+ # @return [Time]
3304
+ #
3305
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PhoneNumberInformation AWS API Documentation
3306
+ #
3307
+ class PhoneNumberInformation < Struct.new(
3308
+ :phone_number_arn,
3309
+ :phone_number_id,
3310
+ :phone_number,
3311
+ :status,
3312
+ :iso_country_code,
3313
+ :message_type,
3314
+ :number_capabilities,
3315
+ :number_type,
3316
+ :monthly_leasing_price,
3317
+ :two_way_enabled,
3318
+ :two_way_channel_arn,
3319
+ :two_way_channel_role,
3320
+ :self_managed_opt_outs_enabled,
3321
+ :opt_out_list_name,
3322
+ :deletion_protection_enabled,
3323
+ :pool_id,
3324
+ :registration_id,
3325
+ :created_timestamp)
3326
+ SENSITIVE = []
3327
+ include Aws::Structure
3328
+ end
3329
+
3330
+ # The information for a pool that meets a specified criteria.
3331
+ #
3332
+ # @!attribute [rw] name
3333
+ # The name of the attribute to filter on.
3334
+ # @return [String]
3335
+ #
3336
+ # @!attribute [rw] values
3337
+ # An array values to filter for.
3338
+ # @return [Array<String>]
3339
+ #
3340
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PoolFilter AWS API Documentation
3341
+ #
3342
+ class PoolFilter < Struct.new(
3343
+ :name,
3344
+ :values)
3345
+ SENSITIVE = []
3346
+ include Aws::Structure
3347
+ end
3348
+
3349
+ # The information for a pool in an Amazon Web Services account.
3350
+ #
3351
+ # @!attribute [rw] pool_arn
3352
+ # The Amazon Resource Name (ARN) for the pool.
3353
+ # @return [String]
3354
+ #
3355
+ # @!attribute [rw] pool_id
3356
+ # The unique identifier for the pool.
3357
+ # @return [String]
3358
+ #
3359
+ # @!attribute [rw] status
3360
+ # The current status of the pool.
3361
+ # @return [String]
3362
+ #
3363
+ # @!attribute [rw] message_type
3364
+ # The type of message. Valid values are TRANSACTIONAL for messages
3365
+ # that are critical or time-sensitive and PROMOTIONAL for messages
3366
+ # that aren't critical or time-sensitive.
3367
+ # @return [String]
3368
+ #
3369
+ # @!attribute [rw] two_way_enabled
3370
+ # When set to true you can receive incoming text messages from your
3371
+ # end recipients using the TwoWayChannelArn.
3372
+ # @return [Boolean]
3373
+ #
3374
+ # @!attribute [rw] two_way_channel_arn
3375
+ # The Amazon Resource Name (ARN) of the two way channel.
3376
+ # @return [String]
3377
+ #
3378
+ # @!attribute [rw] two_way_channel_role
3379
+ # An optional IAM Role Arn for a service to assume, to be able to post
3380
+ # inbound SMS messages.
3381
+ # @return [String]
3382
+ #
3383
+ # @!attribute [rw] self_managed_opt_outs_enabled
3384
+ # When set to false, an end recipient sends a message that begins with
3385
+ # HELP or STOP to one of your dedicated numbers, Amazon Pinpoint
3386
+ # automatically replies with a customizable message and adds the end
3387
+ # recipient to the OptOutList. When set to true you're responsible
3388
+ # for responding to HELP and STOP requests. You're also responsible
3389
+ # for tracking and honoring opt-out requests. For more information see
3390
+ # [Self-managed opt-outs][1]
3391
+ #
3392
+ #
3393
+ #
3394
+ # [1]: https://docs.aws.amazon.com/pinpoint/latest/userguide/settings-sms-managing.html#settings-account-sms-self-managed-opt-out
3395
+ # @return [Boolean]
3396
+ #
3397
+ # @!attribute [rw] opt_out_list_name
3398
+ # The name of the OptOutList associated with the pool.
3399
+ # @return [String]
3400
+ #
3401
+ # @!attribute [rw] shared_routes_enabled
3402
+ # Allows you to enable shared routes on your pool.
3403
+ #
3404
+ # By default, this is set to `False`. If you set this value to `True`,
3405
+ # your messages are sent using phone numbers or sender IDs (depending
3406
+ # on the country) that are shared with other Amazon Pinpoint users. In
3407
+ # some countries, such as the United States, senders aren't allowed
3408
+ # to use shared routes and must use a dedicated phone number or short
3409
+ # code.
3410
+ # @return [Boolean]
3411
+ #
3412
+ # @!attribute [rw] deletion_protection_enabled
3413
+ # When set to true the pool can't be deleted.
3414
+ # @return [Boolean]
3415
+ #
3416
+ # @!attribute [rw] created_timestamp
3417
+ # The time when the pool was created, in [UNIX epoch time][1] format.
3418
+ #
3419
+ #
3420
+ #
3421
+ # [1]: https://www.epochconverter.com/
3422
+ # @return [Time]
3423
+ #
3424
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PoolInformation AWS API Documentation
3425
+ #
3426
+ class PoolInformation < Struct.new(
3427
+ :pool_arn,
3428
+ :pool_id,
3429
+ :status,
3430
+ :message_type,
3431
+ :two_way_enabled,
3432
+ :two_way_channel_arn,
3433
+ :two_way_channel_role,
3434
+ :self_managed_opt_outs_enabled,
3435
+ :opt_out_list_name,
3436
+ :shared_routes_enabled,
3437
+ :deletion_protection_enabled,
3438
+ :created_timestamp)
3439
+ SENSITIVE = []
3440
+ include Aws::Structure
3441
+ end
3442
+
3443
+ # Information about origination identities associated with a pool that
3444
+ # meets a specified criteria.
3445
+ #
3446
+ # @!attribute [rw] name
3447
+ # The name of the attribute to filter on.
3448
+ # @return [String]
3449
+ #
3450
+ # @!attribute [rw] values
3451
+ # An array values to filter for.
3452
+ # @return [Array<String>]
3453
+ #
3454
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PoolOriginationIdentitiesFilter AWS API Documentation
3455
+ #
3456
+ class PoolOriginationIdentitiesFilter < Struct.new(
3457
+ :name,
3458
+ :values)
3459
+ SENSITIVE = []
3460
+ include Aws::Structure
3461
+ end
3462
+
3463
+ # @!attribute [rw] origination_identity
3464
+ # The origination identity to use such as a PhoneNumberId,
3465
+ # PhoneNumberArn, SenderId or SenderIdArn. You can use
3466
+ # DescribePhoneNumbers get the values for PhoneNumberId and
3467
+ # PhoneNumberArn while DescribeSenderIds can be used to get the values
3468
+ # for SenderId and SenderIdArn.
3469
+ # @return [String]
3470
+ #
3471
+ # @!attribute [rw] keyword
3472
+ # The new keyword to add.
3473
+ # @return [String]
3474
+ #
3475
+ # @!attribute [rw] keyword_message
3476
+ # The message associated with the keyword.
3477
+ # @return [String]
3478
+ #
3479
+ # @!attribute [rw] keyword_action
3480
+ # The action to perform for the new keyword when it is received.
3481
+ #
3482
+ # * AUTOMATIC\_RESPONSE: A message is sent to the recipient.
3483
+ #
3484
+ # * OPT\_OUT: Keeps the recipient from receiving future messages.
3485
+ #
3486
+ # * OPT\_IN: The recipient wants to receive future messages.
3487
+ # @return [String]
3488
+ #
3489
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PutKeywordRequest AWS API Documentation
3490
+ #
3491
+ class PutKeywordRequest < Struct.new(
3492
+ :origination_identity,
3493
+ :keyword,
3494
+ :keyword_message,
3495
+ :keyword_action)
3496
+ SENSITIVE = []
3497
+ include Aws::Structure
3498
+ end
3499
+
3500
+ # @!attribute [rw] origination_identity_arn
3501
+ # The PhoneNumberArn or PoolArn that the keyword was associated with.
3502
+ # @return [String]
3503
+ #
3504
+ # @!attribute [rw] origination_identity
3505
+ # The PhoneNumberId or PoolId that the keyword was associated with.
3506
+ # @return [String]
3507
+ #
3508
+ # @!attribute [rw] keyword
3509
+ # The keyword that was added.
3510
+ # @return [String]
3511
+ #
3512
+ # @!attribute [rw] keyword_message
3513
+ # The message associated with the keyword.
3514
+ # @return [String]
3515
+ #
3516
+ # @!attribute [rw] keyword_action
3517
+ # The action to perform when the keyword is used.
3518
+ # @return [String]
3519
+ #
3520
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PutKeywordResult AWS API Documentation
3521
+ #
3522
+ class PutKeywordResult < Struct.new(
3523
+ :origination_identity_arn,
3524
+ :origination_identity,
3525
+ :keyword,
3526
+ :keyword_message,
3527
+ :keyword_action)
3528
+ SENSITIVE = []
3529
+ include Aws::Structure
3530
+ end
3531
+
3532
+ # @!attribute [rw] opt_out_list_name
3533
+ # The OptOutListName or OptOutListArn to add the phone number to.
3534
+ # @return [String]
3535
+ #
3536
+ # @!attribute [rw] opted_out_number
3537
+ # The phone number to add to the OptOutList in E.164 format.
3538
+ # @return [String]
3539
+ #
3540
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PutOptedOutNumberRequest AWS API Documentation
3541
+ #
3542
+ class PutOptedOutNumberRequest < Struct.new(
3543
+ :opt_out_list_name,
3544
+ :opted_out_number)
3545
+ SENSITIVE = []
3546
+ include Aws::Structure
3547
+ end
3548
+
3549
+ # @!attribute [rw] opt_out_list_arn
3550
+ # The OptOutListArn that the phone number was removed from.
3551
+ # @return [String]
3552
+ #
3553
+ # @!attribute [rw] opt_out_list_name
3554
+ # The OptOutListName that the phone number was removed from.
3555
+ # @return [String]
3556
+ #
3557
+ # @!attribute [rw] opted_out_number
3558
+ # The phone number that was added to the OptOutList.
3559
+ # @return [String]
3560
+ #
3561
+ # @!attribute [rw] opted_out_timestamp
3562
+ # The time that the phone number was added to the OptOutList, in [UNIX
3563
+ # epoch time][1] format.
3564
+ #
1886
3565
  #
1887
3566
  #
1888
3567
  # [1]: https://www.epochconverter.com/
1889
3568
  # @return [Time]
1890
3569
  #
1891
3570
  # @!attribute [rw] end_user_opted_out
1892
- # This is set to true if it was the end recipient that opted out.
3571
+ # This is true if it was the end user who requested their phone number
3572
+ # be removed.
1893
3573
  # @return [Boolean]
1894
3574
  #
1895
- # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/OptedOutNumberInformation AWS API Documentation
3575
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PutOptedOutNumberResult AWS API Documentation
1896
3576
  #
1897
- class OptedOutNumberInformation < Struct.new(
3577
+ class PutOptedOutNumberResult < Struct.new(
3578
+ :opt_out_list_arn,
3579
+ :opt_out_list_name,
1898
3580
  :opted_out_number,
1899
3581
  :opted_out_timestamp,
1900
3582
  :end_user_opted_out)
@@ -1902,15 +3584,117 @@ module Aws::PinpointSMSVoiceV2
1902
3584
  include Aws::Structure
1903
3585
  end
1904
3586
 
1905
- # The metadata for an origination identity associated with a pool.
3587
+ # @!attribute [rw] registration_id
3588
+ # The unique identifier for the registration.
3589
+ # @return [String]
1906
3590
  #
1907
- # @!attribute [rw] origination_identity_arn
1908
- # The Amazon Resource Name (ARN) associated with the origination
1909
- # identity.
3591
+ # @!attribute [rw] field_path
3592
+ # The path to the registration form field. You can use
3593
+ # DescribeRegistrationFieldDefinitions for a list of **FieldPaths**.
1910
3594
  # @return [String]
1911
3595
  #
1912
- # @!attribute [rw] origination_identity
1913
- # The unique identifier of the origination identity.
3596
+ # @!attribute [rw] select_choices
3597
+ # An array of values for the form field.
3598
+ # @return [Array<String>]
3599
+ #
3600
+ # @!attribute [rw] text_value
3601
+ # The text data for a free form field.
3602
+ # @return [String]
3603
+ #
3604
+ # @!attribute [rw] registration_attachment_id
3605
+ # The unique identifier for the registration attachment.
3606
+ # @return [String]
3607
+ #
3608
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PutRegistrationFieldValueRequest AWS API Documentation
3609
+ #
3610
+ class PutRegistrationFieldValueRequest < Struct.new(
3611
+ :registration_id,
3612
+ :field_path,
3613
+ :select_choices,
3614
+ :text_value,
3615
+ :registration_attachment_id)
3616
+ SENSITIVE = []
3617
+ include Aws::Structure
3618
+ end
3619
+
3620
+ # @!attribute [rw] registration_arn
3621
+ # The Amazon Resource Name (ARN) for the registration.
3622
+ # @return [String]
3623
+ #
3624
+ # @!attribute [rw] registration_id
3625
+ # The unique identifier for the registration.
3626
+ # @return [String]
3627
+ #
3628
+ # @!attribute [rw] version_number
3629
+ # The version number of the registration.
3630
+ # @return [Integer]
3631
+ #
3632
+ # @!attribute [rw] field_path
3633
+ # The path to the registration form field. You can use
3634
+ # DescribeRegistrationFieldDefinitions for a list of **FieldPaths**.
3635
+ # @return [String]
3636
+ #
3637
+ # @!attribute [rw] select_choices
3638
+ # An array of values for the form field.
3639
+ # @return [Array<String>]
3640
+ #
3641
+ # @!attribute [rw] text_value
3642
+ # The text data for a free form field.
3643
+ # @return [String]
3644
+ #
3645
+ # @!attribute [rw] registration_attachment_id
3646
+ # The unique identifier for the registration attachment.
3647
+ # @return [String]
3648
+ #
3649
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PutRegistrationFieldValueResult AWS API Documentation
3650
+ #
3651
+ class PutRegistrationFieldValueResult < Struct.new(
3652
+ :registration_arn,
3653
+ :registration_id,
3654
+ :version_number,
3655
+ :field_path,
3656
+ :select_choices,
3657
+ :text_value,
3658
+ :registration_attachment_id)
3659
+ SENSITIVE = []
3660
+ include Aws::Structure
3661
+ end
3662
+
3663
+ # The filter definition for filtering registrations that meets a
3664
+ # specified criteria.
3665
+ #
3666
+ # @!attribute [rw] name
3667
+ # The name of the attribute to filter on.
3668
+ # @return [String]
3669
+ #
3670
+ # @!attribute [rw] values
3671
+ # An array of values to filter for.
3672
+ # @return [Array<String>]
3673
+ #
3674
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/RegistrationAssociationFilter AWS API Documentation
3675
+ #
3676
+ class RegistrationAssociationFilter < Struct.new(
3677
+ :name,
3678
+ :values)
3679
+ SENSITIVE = []
3680
+ include Aws::Structure
3681
+ end
3682
+
3683
+ # Metadata for the origination identity that is associated with the
3684
+ # registration.
3685
+ #
3686
+ # @!attribute [rw] resource_arn
3687
+ # The Amazon Resource Name (ARN) of the origination identity that is
3688
+ # associated with the registration.
3689
+ # @return [String]
3690
+ #
3691
+ # @!attribute [rw] resource_id
3692
+ # The unique identifier for the origination identity. For example this
3693
+ # could be a **PhoneNumberId** or **SenderId**.
3694
+ # @return [String]
3695
+ #
3696
+ # @!attribute [rw] resource_type
3697
+ # The origination identity type.
1914
3698
  # @return [String]
1915
3699
  #
1916
3700
  # @!attribute [rw] iso_country_code
@@ -1918,121 +3702,333 @@ module Aws::PinpointSMSVoiceV2
1918
3702
  # country or region.
1919
3703
  # @return [String]
1920
3704
  #
1921
- # @!attribute [rw] number_capabilities
1922
- # Describes if the origination identity can be used for text messages,
1923
- # voice calls or both.
1924
- # @return [Array<String>]
3705
+ # @!attribute [rw] phone_number
3706
+ # The phone number associated with the registration in E.164 format.
3707
+ # @return [String]
1925
3708
  #
1926
- # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/OriginationIdentityMetadata AWS API Documentation
3709
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/RegistrationAssociationMetadata AWS API Documentation
1927
3710
  #
1928
- class OriginationIdentityMetadata < Struct.new(
1929
- :origination_identity_arn,
1930
- :origination_identity,
3711
+ class RegistrationAssociationMetadata < Struct.new(
3712
+ :resource_arn,
3713
+ :resource_id,
3714
+ :resource_type,
1931
3715
  :iso_country_code,
1932
- :number_capabilities)
3716
+ :phone_number)
1933
3717
  SENSITIVE = []
1934
3718
  include Aws::Structure
1935
3719
  end
1936
3720
 
1937
- # The information for a phone number that meets a specified criteria.
3721
+ # The filter definition for filtering registration attachments that
3722
+ # meets a specified criteria.
1938
3723
  #
1939
3724
  # @!attribute [rw] name
1940
3725
  # The name of the attribute to filter on.
1941
3726
  # @return [String]
1942
3727
  #
1943
3728
  # @!attribute [rw] values
1944
- # An array values to filter for.
3729
+ # An array of values to filter on.
1945
3730
  # @return [Array<String>]
1946
3731
  #
1947
- # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PhoneNumberFilter AWS API Documentation
3732
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/RegistrationAttachmentFilter AWS API Documentation
1948
3733
  #
1949
- class PhoneNumberFilter < Struct.new(
3734
+ class RegistrationAttachmentFilter < Struct.new(
1950
3735
  :name,
1951
3736
  :values)
1952
3737
  SENSITIVE = []
1953
3738
  include Aws::Structure
1954
3739
  end
1955
3740
 
1956
- # The information for a phone number in an Amazon Web Services account.
3741
+ # Provides information on the specified registration attachments.
1957
3742
  #
1958
- # @!attribute [rw] phone_number_arn
1959
- # The Amazon Resource Name (ARN) associated with the phone number.
3743
+ # @!attribute [rw] registration_attachment_arn
3744
+ # The Amazon Resource Name (ARN) for the registration attachment.
1960
3745
  # @return [String]
1961
3746
  #
1962
- # @!attribute [rw] phone_number_id
1963
- # The unique identifier for the phone number.
3747
+ # @!attribute [rw] registration_attachment_id
3748
+ # The unique identifier for the registration attachment.
1964
3749
  # @return [String]
1965
3750
  #
1966
- # @!attribute [rw] phone_number
1967
- # The phone number in E.164 format.
3751
+ # @!attribute [rw] attachment_status
3752
+ # The status of the registration attachment.
3753
+ #
3754
+ # * `UPLOAD_IN_PROGRESS` The attachment is being uploaded.
3755
+ #
3756
+ # * `UPLOAD_COMPLETE` The attachment has been uploaded.
3757
+ #
3758
+ # * `UPLOAD_FAILED` The attachment failed to uploaded.
3759
+ #
3760
+ # * `DELETED` The attachment has been deleted..
1968
3761
  # @return [String]
1969
3762
  #
1970
- # @!attribute [rw] status
1971
- # The current status of the phone number.
3763
+ # @!attribute [rw] attachment_upload_error_reason
3764
+ # A description of why the upload didn't successfully complete.
1972
3765
  # @return [String]
1973
3766
  #
1974
- # @!attribute [rw] iso_country_code
1975
- # The two-character code, in ISO 3166-1 alpha-2 format, for the
1976
- # country or region.
3767
+ # @!attribute [rw] created_timestamp
3768
+ # The time when the registration attachment was created, in [UNIX
3769
+ # epoch time][1] format.
3770
+ #
3771
+ #
3772
+ #
3773
+ # [1]: https://www.epochconverter.com/
3774
+ # @return [Time]
3775
+ #
3776
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/RegistrationAttachmentsInformation AWS API Documentation
3777
+ #
3778
+ class RegistrationAttachmentsInformation < Struct.new(
3779
+ :registration_attachment_arn,
3780
+ :registration_attachment_id,
3781
+ :attachment_status,
3782
+ :attachment_upload_error_reason,
3783
+ :created_timestamp)
3784
+ SENSITIVE = []
3785
+ include Aws::Structure
3786
+ end
3787
+
3788
+ # Provides the reason a registration was rejected.
3789
+ #
3790
+ # @!attribute [rw] reason
3791
+ # The reason a registration was rejected.
1977
3792
  # @return [String]
1978
3793
  #
1979
- # @!attribute [rw] message_type
1980
- # The type of message. Valid values are TRANSACTIONAL for messages
1981
- # that are critical or time-sensitive and PROMOTIONAL for messages
1982
- # that aren't critical or time-sensitive.
3794
+ # @!attribute [rw] short_description
3795
+ # A short description of the rejection reason.
3796
+ # @return [String]
3797
+ #
3798
+ # @!attribute [rw] long_description
3799
+ # A long description of the rejection reason.
3800
+ # @return [String]
3801
+ #
3802
+ # @!attribute [rw] documentation_title
3803
+ # The title of the document.
3804
+ # @return [String]
3805
+ #
3806
+ # @!attribute [rw] documentation_link
3807
+ # The link to the document.
3808
+ # @return [String]
3809
+ #
3810
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/RegistrationDeniedReasonInformation AWS API Documentation
3811
+ #
3812
+ class RegistrationDeniedReasonInformation < Struct.new(
3813
+ :reason,
3814
+ :short_description,
3815
+ :long_description,
3816
+ :documentation_title,
3817
+ :documentation_link)
3818
+ SENSITIVE = []
3819
+ include Aws::Structure
3820
+ end
3821
+
3822
+ # Provides a description of the specified field.
3823
+ #
3824
+ # @!attribute [rw] section_path
3825
+ # The section path of the field.
3826
+ # @return [String]
3827
+ #
3828
+ # @!attribute [rw] field_path
3829
+ # The path to the registration form field. You can use
3830
+ # DescribeRegistrationFieldDefinitions for a list of **FieldPaths**.
1983
3831
  # @return [String]
1984
3832
  #
1985
- # @!attribute [rw] number_capabilities
1986
- # Describes if the origination identity can be used for text messages,
1987
- # voice calls or both.
1988
- # @return [Array<String>]
3833
+ # @!attribute [rw] field_type
3834
+ # The type of field.
3835
+ # @return [String]
3836
+ #
3837
+ # @!attribute [rw] field_requirement
3838
+ # Specifies if the field for the registration form is required,
3839
+ # conditional or optional.
3840
+ # @return [String]
3841
+ #
3842
+ # @!attribute [rw] select_validation
3843
+ # The validation rules for a select field.
3844
+ # @return [Types::SelectValidation]
3845
+ #
3846
+ # @!attribute [rw] text_validation
3847
+ # The validation rules for a text field.
3848
+ # @return [Types::TextValidation]
3849
+ #
3850
+ # @!attribute [rw] display_hints
3851
+ # An array of RegistrationFieldDisplayHints objects for the field.
3852
+ # @return [Types::RegistrationFieldDisplayHints]
3853
+ #
3854
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/RegistrationFieldDefinition AWS API Documentation
3855
+ #
3856
+ class RegistrationFieldDefinition < Struct.new(
3857
+ :section_path,
3858
+ :field_path,
3859
+ :field_type,
3860
+ :field_requirement,
3861
+ :select_validation,
3862
+ :text_validation,
3863
+ :display_hints)
3864
+ SENSITIVE = []
3865
+ include Aws::Structure
3866
+ end
3867
+
3868
+ # Provides help information on the registration field.
3869
+ #
3870
+ # @!attribute [rw] title
3871
+ # The title of the display hint.
3872
+ # @return [String]
3873
+ #
3874
+ # @!attribute [rw] short_description
3875
+ # A short description of the display hint.
3876
+ # @return [String]
3877
+ #
3878
+ # @!attribute [rw] long_description
3879
+ # A full description of the display hint.
3880
+ # @return [String]
3881
+ #
3882
+ # @!attribute [rw] documentation_title
3883
+ # The title of the document the display hint is associated with.
3884
+ # @return [String]
3885
+ #
3886
+ # @!attribute [rw] documentation_link
3887
+ # The link to the document the display hint is associated with.
3888
+ # @return [String]
3889
+ #
3890
+ # @!attribute [rw] select_option_descriptions
3891
+ # An array of SelectOptionDescription objects.
3892
+ # @return [Array<Types::SelectOptionDescription>]
3893
+ #
3894
+ # @!attribute [rw] text_validation_description
3895
+ # The validation rules for the text field.
3896
+ # @return [String]
3897
+ #
3898
+ # @!attribute [rw] example_text_value
3899
+ # Example text of what the value of a field should contain.
3900
+ # @return [String]
3901
+ #
3902
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/RegistrationFieldDisplayHints AWS API Documentation
3903
+ #
3904
+ class RegistrationFieldDisplayHints < Struct.new(
3905
+ :title,
3906
+ :short_description,
3907
+ :long_description,
3908
+ :documentation_title,
3909
+ :documentation_link,
3910
+ :select_option_descriptions,
3911
+ :text_validation_description,
3912
+ :example_text_value)
3913
+ SENSITIVE = []
3914
+ include Aws::Structure
3915
+ end
3916
+
3917
+ # Provides the values of the specified field.
3918
+ #
3919
+ # @!attribute [rw] field_path
3920
+ # The path to the registration form field. You can use
3921
+ # DescribeRegistrationFieldDefinitions for a list of **FieldPaths**.
3922
+ # @return [String]
3923
+ #
3924
+ # @!attribute [rw] select_choices
3925
+ # An array of values for the form field.
3926
+ # @return [Array<String>]
3927
+ #
3928
+ # @!attribute [rw] text_value
3929
+ # The text data for a free form field.
3930
+ # @return [String]
3931
+ #
3932
+ # @!attribute [rw] registration_attachment_id
3933
+ # The unique identifier for the registration attachment.
3934
+ # @return [String]
3935
+ #
3936
+ # @!attribute [rw] denied_reason
3937
+ # A description of why the registration was denied.
3938
+ # @return [String]
3939
+ #
3940
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/RegistrationFieldValueInformation AWS API Documentation
3941
+ #
3942
+ class RegistrationFieldValueInformation < Struct.new(
3943
+ :field_path,
3944
+ :select_choices,
3945
+ :text_value,
3946
+ :registration_attachment_id,
3947
+ :denied_reason)
3948
+ SENSITIVE = []
3949
+ include Aws::Structure
3950
+ end
3951
+
3952
+ # The filter definition for filtering registrations that meets a
3953
+ # specified criteria.
3954
+ #
3955
+ # @!attribute [rw] name
3956
+ # The name of the attribute to filter on.
3957
+ # @return [String]
3958
+ #
3959
+ # @!attribute [rw] values
3960
+ # An array of values to filter on.
3961
+ # @return [Array<String>]
3962
+ #
3963
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/RegistrationFilter AWS API Documentation
3964
+ #
3965
+ class RegistrationFilter < Struct.new(
3966
+ :name,
3967
+ :values)
3968
+ SENSITIVE = []
3969
+ include Aws::Structure
3970
+ end
3971
+
3972
+ # Provides information about the requested registration.
3973
+ #
3974
+ # @!attribute [rw] registration_arn
3975
+ # The Amazon Resource Name (ARN) for the registration.
3976
+ # @return [String]
1989
3977
  #
1990
- # @!attribute [rw] number_type
1991
- # The type of phone number.
3978
+ # @!attribute [rw] registration_id
3979
+ # The unique identifier for the registration.
1992
3980
  # @return [String]
1993
3981
  #
1994
- # @!attribute [rw] monthly_leasing_price
1995
- # The price, in US dollars, to lease the phone number.
3982
+ # @!attribute [rw] registration_type
3983
+ # The type of registration form. The list of **RegistrationTypes** can
3984
+ # be found using the DescribeRegistrationTypeDefinitions action.
1996
3985
  # @return [String]
1997
3986
  #
1998
- # @!attribute [rw] two_way_enabled
1999
- # By default this is set to false. When set to true you can receive
2000
- # incoming text messages from your end recipients using the
2001
- # TwoWayChannelArn.
2002
- # @return [Boolean]
3987
+ # @!attribute [rw] registration_status
3988
+ # The status of the registration.
2003
3989
  #
2004
- # @!attribute [rw] two_way_channel_arn
2005
- # The Amazon Resource Name (ARN) of the two way channel.
2006
- # @return [String]
3990
+ # * `CREATED`: Your registration is created but not submitted.
2007
3991
  #
2008
- # @!attribute [rw] self_managed_opt_outs_enabled
2009
- # When set to false an end recipient sends a message that begins with
2010
- # HELP or STOP to one of your dedicated numbers, Amazon Pinpoint
2011
- # automatically replies with a customizable message and adds the end
2012
- # recipient to the OptOutList. When set to true you're responsible
2013
- # for responding to HELP and STOP requests. You're also responsible
2014
- # for tracking and honoring opt-out request. For more information see
2015
- # [Self-managed opt-outs][1]
3992
+ # * `SUBMITTED`: Your registration has been submitted and is awaiting
3993
+ # review.
2016
3994
  #
3995
+ # * `REVIEWING`: Your registration has been accepted and is being
3996
+ # reviewed.
2017
3997
  #
3998
+ # * `PROVISIONING`: Your registration has been approved and your
3999
+ # origination identity is being created.
2018
4000
  #
2019
- # [1]: https://docs.aws.amazon.com/pinpoint/latest/userguide/settings-sms-managing.html#settings-account-sms-self-managed-opt-out
2020
- # @return [Boolean]
4001
+ # * `COMPLETE`: Your registration has been approved and and your
4002
+ # origination identity has been created.
2021
4003
  #
2022
- # @!attribute [rw] opt_out_list_name
2023
- # The name of the OptOutList associated with the phone number.
2024
- # @return [String]
4004
+ # * `REQUIRES_UPDATES`: You must fix your registration and resubmit
4005
+ # it.
2025
4006
  #
2026
- # @!attribute [rw] deletion_protection_enabled
2027
- # When set to true the phone number can't be deleted.
2028
- # @return [Boolean]
4007
+ # * `CLOSED`: The phone number or sender ID has been deleted and you
4008
+ # must also delete the registration for the number.
2029
4009
  #
2030
- # @!attribute [rw] pool_id
2031
- # The unique identifier of the pool associated with the phone number.
4010
+ # * `DELETED`: The registration has been deleted.
2032
4011
  # @return [String]
2033
4012
  #
4013
+ # @!attribute [rw] current_version_number
4014
+ # The current version number of the registration.
4015
+ # @return [Integer]
4016
+ #
4017
+ # @!attribute [rw] approved_version_number
4018
+ # The version number of the registration that was approved.
4019
+ # @return [Integer]
4020
+ #
4021
+ # @!attribute [rw] latest_denied_version_number
4022
+ # The latest version number of the registration that was denied.
4023
+ # @return [Integer]
4024
+ #
4025
+ # @!attribute [rw] additional_attributes
4026
+ # Metadata about a given registration which is specific to that
4027
+ # registration type.
4028
+ # @return [Hash<String,String>]
4029
+ #
2034
4030
  # @!attribute [rw] created_timestamp
2035
- # The time when the phone number was created, in [UNIX epoch time][1]
4031
+ # The time when the registration was created, in [UNIX epoch time][1]
2036
4032
  # format.
2037
4033
  #
2038
4034
  #
@@ -2040,256 +4036,284 @@ module Aws::PinpointSMSVoiceV2
2040
4036
  # [1]: https://www.epochconverter.com/
2041
4037
  # @return [Time]
2042
4038
  #
2043
- # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PhoneNumberInformation AWS API Documentation
4039
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/RegistrationInformation AWS API Documentation
2044
4040
  #
2045
- class PhoneNumberInformation < Struct.new(
2046
- :phone_number_arn,
2047
- :phone_number_id,
2048
- :phone_number,
2049
- :status,
2050
- :iso_country_code,
2051
- :message_type,
2052
- :number_capabilities,
2053
- :number_type,
2054
- :monthly_leasing_price,
2055
- :two_way_enabled,
2056
- :two_way_channel_arn,
2057
- :self_managed_opt_outs_enabled,
2058
- :opt_out_list_name,
2059
- :deletion_protection_enabled,
2060
- :pool_id,
4041
+ class RegistrationInformation < Struct.new(
4042
+ :registration_arn,
4043
+ :registration_id,
4044
+ :registration_type,
4045
+ :registration_status,
4046
+ :current_version_number,
4047
+ :approved_version_number,
4048
+ :latest_denied_version_number,
4049
+ :additional_attributes,
2061
4050
  :created_timestamp)
2062
4051
  SENSITIVE = []
2063
4052
  include Aws::Structure
2064
4053
  end
2065
4054
 
2066
- # The information for a pool that meets a specified criteria.
4055
+ # Provides information on the specified section definition.
2067
4056
  #
2068
- # @!attribute [rw] name
2069
- # The name of the attribute to filter on.
4057
+ # @!attribute [rw] section_path
4058
+ # The path to the section of the registration.
2070
4059
  # @return [String]
2071
4060
  #
2072
- # @!attribute [rw] values
2073
- # An array values to filter for.
2074
- # @return [Array<String>]
4061
+ # @!attribute [rw] display_hints
4062
+ # The path to the section of the registration.
4063
+ # @return [Types::RegistrationSectionDisplayHints]
2075
4064
  #
2076
- # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PoolFilter AWS API Documentation
4065
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/RegistrationSectionDefinition AWS API Documentation
2077
4066
  #
2078
- class PoolFilter < Struct.new(
2079
- :name,
2080
- :values)
4067
+ class RegistrationSectionDefinition < Struct.new(
4068
+ :section_path,
4069
+ :display_hints)
2081
4070
  SENSITIVE = []
2082
4071
  include Aws::Structure
2083
4072
  end
2084
4073
 
2085
- # The information for a pool in an Amazon Web Services account.
4074
+ # Provides help information on the registration section.
2086
4075
  #
2087
- # @!attribute [rw] pool_arn
2088
- # The Amazon Resource Name (ARN) for the pool.
4076
+ # @!attribute [rw] title
4077
+ # The title of the display hint.
2089
4078
  # @return [String]
2090
4079
  #
2091
- # @!attribute [rw] pool_id
2092
- # The unique identifier for the pool.
4080
+ # @!attribute [rw] short_description
4081
+ # A short description of the display hint.
2093
4082
  # @return [String]
2094
4083
  #
2095
- # @!attribute [rw] status
2096
- # The current status of the pool.
4084
+ # @!attribute [rw] long_description
4085
+ # A full description of the display hint.
2097
4086
  # @return [String]
2098
4087
  #
2099
- # @!attribute [rw] message_type
2100
- # The type of message. Valid values are TRANSACTIONAL for messages
2101
- # that are critical or time-sensitive and PROMOTIONAL for messages
2102
- # that aren't critical or time-sensitive.
4088
+ # @!attribute [rw] documentation_title
4089
+ # The title of the document the display hint is associated with.
2103
4090
  # @return [String]
2104
4091
  #
2105
- # @!attribute [rw] two_way_enabled
2106
- # When set to true you can receive incoming text messages from your
2107
- # end recipients using the TwoWayChannelArn.
2108
- # @return [Boolean]
4092
+ # @!attribute [rw] documentation_link
4093
+ # The link to the document the display hint is associated with.
4094
+ # @return [String]
2109
4095
  #
2110
- # @!attribute [rw] two_way_channel_arn
2111
- # The Amazon Resource Name (ARN) of the two way channel.
4096
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/RegistrationSectionDisplayHints AWS API Documentation
4097
+ #
4098
+ class RegistrationSectionDisplayHints < Struct.new(
4099
+ :title,
4100
+ :short_description,
4101
+ :long_description,
4102
+ :documentation_title,
4103
+ :documentation_link)
4104
+ SENSITIVE = []
4105
+ include Aws::Structure
4106
+ end
4107
+
4108
+ # Provides information on the supported registration type.
4109
+ #
4110
+ # @!attribute [rw] registration_type
4111
+ # The type of registration form. The list of **RegistrationTypes** can
4112
+ # be found using the DescribeRegistrationTypeDefinitions action.
2112
4113
  # @return [String]
2113
4114
  #
2114
- # @!attribute [rw] self_managed_opt_outs_enabled
2115
- # When set to false, an end recipient sends a message that begins with
2116
- # HELP or STOP to one of your dedicated numbers, Amazon Pinpoint
2117
- # automatically replies with a customizable message and adds the end
2118
- # recipient to the OptOutList. When set to true you're responsible
2119
- # for responding to HELP and STOP requests. You're also responsible
2120
- # for tracking and honoring opt-out requests. For more information see
2121
- # [Self-managed opt-outs][1]
4115
+ # @!attribute [rw] supported_associations
4116
+ # The supported association behavior for the registration type.
4117
+ # @return [Array<Types::SupportedAssociation>]
2122
4118
  #
4119
+ # @!attribute [rw] display_hints
4120
+ # Provides help information on the registration.
4121
+ # @return [Types::RegistrationTypeDisplayHints]
2123
4122
  #
4123
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/RegistrationTypeDefinition AWS API Documentation
2124
4124
  #
2125
- # [1]: https://docs.aws.amazon.com/pinpoint/latest/userguide/settings-sms-managing.html#settings-account-sms-self-managed-opt-out
2126
- # @return [Boolean]
4125
+ class RegistrationTypeDefinition < Struct.new(
4126
+ :registration_type,
4127
+ :supported_associations,
4128
+ :display_hints)
4129
+ SENSITIVE = []
4130
+ include Aws::Structure
4131
+ end
4132
+
4133
+ # Provides help information on the registration type.
2127
4134
  #
2128
- # @!attribute [rw] opt_out_list_name
2129
- # The name of the OptOutList associated with the pool.
4135
+ # @!attribute [rw] title
4136
+ # The title of the display hint.
2130
4137
  # @return [String]
2131
4138
  #
2132
- # @!attribute [rw] shared_routes_enabled
2133
- # Allows you to enable shared routes on your pool.
4139
+ # @!attribute [rw] short_description
4140
+ # A short description of the display hint.
4141
+ # @return [String]
2134
4142
  #
2135
- # By default, this is set to `False`. If you set this value to `True`,
2136
- # your messages are sent using phone numbers or sender IDs (depending
2137
- # on the country) that are shared with other Amazon Pinpoint users. In
2138
- # some countries, such as the United States, senders aren't allowed
2139
- # to use shared routes and must use a dedicated phone number or short
2140
- # code.
2141
- # @return [Boolean]
4143
+ # @!attribute [rw] long_description
4144
+ # A full description of the display hint.
4145
+ # @return [String]
2142
4146
  #
2143
- # @!attribute [rw] deletion_protection_enabled
2144
- # When set to true the pool can't be deleted.
2145
- # @return [Boolean]
4147
+ # @!attribute [rw] documentation_title
4148
+ # The title of the document the display hint is associated with.
4149
+ # @return [String]
2146
4150
  #
2147
- # @!attribute [rw] created_timestamp
2148
- # The time when the pool was created, in [UNIX epoch time][1] format.
4151
+ # @!attribute [rw] documentation_link
4152
+ # The link to the document the display hint is associated with.
4153
+ # @return [String]
2149
4154
  #
4155
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/RegistrationTypeDisplayHints AWS API Documentation
2150
4156
  #
4157
+ class RegistrationTypeDisplayHints < Struct.new(
4158
+ :title,
4159
+ :short_description,
4160
+ :long_description,
4161
+ :documentation_title,
4162
+ :documentation_link)
4163
+ SENSITIVE = []
4164
+ include Aws::Structure
4165
+ end
4166
+
4167
+ # The filter definition for filtering registration types that meets a
4168
+ # specified criteria.
2151
4169
  #
2152
- # [1]: https://www.epochconverter.com/
2153
- # @return [Time]
4170
+ # @!attribute [rw] name
4171
+ # The name of the attribute to filter on.
4172
+ # @return [String]
2154
4173
  #
2155
- # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PoolInformation AWS API Documentation
4174
+ # @!attribute [rw] values
4175
+ # An array of values to filter on.
4176
+ # @return [Array<String>]
2156
4177
  #
2157
- class PoolInformation < Struct.new(
2158
- :pool_arn,
2159
- :pool_id,
2160
- :status,
2161
- :message_type,
2162
- :two_way_enabled,
2163
- :two_way_channel_arn,
2164
- :self_managed_opt_outs_enabled,
2165
- :opt_out_list_name,
2166
- :shared_routes_enabled,
2167
- :deletion_protection_enabled,
2168
- :created_timestamp)
4178
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/RegistrationTypeFilter AWS API Documentation
4179
+ #
4180
+ class RegistrationTypeFilter < Struct.new(
4181
+ :name,
4182
+ :values)
2169
4183
  SENSITIVE = []
2170
4184
  include Aws::Structure
2171
4185
  end
2172
4186
 
2173
- # Information about origination identities associated with a pool that
2174
- # meets a specified criteria.
4187
+ # The filter definition for filtering registration versions that meets a
4188
+ # specified criteria.
2175
4189
  #
2176
4190
  # @!attribute [rw] name
2177
4191
  # The name of the attribute to filter on.
2178
4192
  # @return [String]
2179
4193
  #
2180
4194
  # @!attribute [rw] values
2181
- # An array values to filter for.
4195
+ # An array of values to filter on.
2182
4196
  # @return [Array<String>]
2183
4197
  #
2184
- # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PoolOriginationIdentitiesFilter AWS API Documentation
4198
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/RegistrationVersionFilter AWS API Documentation
2185
4199
  #
2186
- class PoolOriginationIdentitiesFilter < Struct.new(
4200
+ class RegistrationVersionFilter < Struct.new(
2187
4201
  :name,
2188
4202
  :values)
2189
4203
  SENSITIVE = []
2190
4204
  include Aws::Structure
2191
4205
  end
2192
4206
 
2193
- # @!attribute [rw] origination_identity
2194
- # The origination identity to use such as a PhoneNumberId,
2195
- # PhoneNumberArn, SenderId or SenderIdArn. You can use
2196
- # DescribePhoneNumbers get the values for PhoneNumberId and
2197
- # PhoneNumberArn while DescribeSenderIds can be used to get the values
2198
- # for SenderId and SenderIdArn.
2199
- # @return [String]
4207
+ # Provides information about the specified version of the registration.
2200
4208
  #
2201
- # @!attribute [rw] keyword
2202
- # The new keyword to add.
2203
- # @return [String]
4209
+ # @!attribute [rw] version_number
4210
+ # The version number of the registration.
4211
+ # @return [Integer]
2204
4212
  #
2205
- # @!attribute [rw] keyword_message
2206
- # The message associated with the keyword.
4213
+ # @!attribute [rw] registration_version_status
4214
+ # The status of the registration.
2207
4215
  #
2208
- # * AUTOMATIC\_RESPONSE: A message is sent to the recipient.
4216
+ # * `DRAFT`: The initial status of a registration version after it’s
4217
+ # created.
2209
4218
  #
2210
- # * OPT\_OUT: Keeps the recipient from receiving future messages.
4219
+ # * `SUBMITTED`: Your registration has been submitted.
2211
4220
  #
2212
- # * OPT\_IN: The recipient wants to receive future messages.
2213
- # @return [String]
4221
+ # * `REVIEWING`: Your registration has been accepted and is being
4222
+ # reviewed.
2214
4223
  #
2215
- # @!attribute [rw] keyword_action
2216
- # The action to perform for the new keyword when it is received.
2217
- # @return [String]
4224
+ # * `APPROVED`: Your registration has been approved.
2218
4225
  #
2219
- # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PutKeywordRequest AWS API Documentation
4226
+ # * `DISCARDED`: You've abandon this version of their registration to
4227
+ # start over with a new version.
2220
4228
  #
2221
- class PutKeywordRequest < Struct.new(
2222
- :origination_identity,
2223
- :keyword,
2224
- :keyword_message,
2225
- :keyword_action)
2226
- SENSITIVE = []
2227
- include Aws::Structure
2228
- end
2229
-
2230
- # @!attribute [rw] origination_identity_arn
2231
- # The PhoneNumberArn or PoolArn that the keyword was associated with.
2232
- # @return [String]
4229
+ # * `DENIED`: You must fix your registration and resubmit it.
2233
4230
  #
2234
- # @!attribute [rw] origination_identity
2235
- # The PhoneNumberId or PoolId that the keyword was associated with.
2236
- # @return [String]
4231
+ # * `REVOKED`: Your previously approved registration has been revoked.
2237
4232
  #
2238
- # @!attribute [rw] keyword
2239
- # The keyword that was added.
4233
+ # * `ARCHIVED`: Your previously approved registration version moves
4234
+ # into this status when a more recently submitted version is
4235
+ # approved.
2240
4236
  # @return [String]
2241
4237
  #
2242
- # @!attribute [rw] keyword_message
2243
- # The message associated with the keyword.
2244
- # @return [String]
4238
+ # @!attribute [rw] registration_version_status_history
4239
+ # The **RegistrationVersionStatusHistory** object contains the time
4240
+ # stamps for when the reservations status changes.
4241
+ # @return [Types::RegistrationVersionStatusHistory]
2245
4242
  #
2246
- # @!attribute [rw] keyword_action
2247
- # The action to perform when the keyword is used.
2248
- # @return [String]
4243
+ # @!attribute [rw] denied_reasons
4244
+ # An array of RegistrationDeniedReasonInformation objects.
4245
+ # @return [Array<Types::RegistrationDeniedReasonInformation>]
2249
4246
  #
2250
- # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PutKeywordResult AWS API Documentation
4247
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/RegistrationVersionInformation AWS API Documentation
2251
4248
  #
2252
- class PutKeywordResult < Struct.new(
2253
- :origination_identity_arn,
2254
- :origination_identity,
2255
- :keyword,
2256
- :keyword_message,
2257
- :keyword_action)
4249
+ class RegistrationVersionInformation < Struct.new(
4250
+ :version_number,
4251
+ :registration_version_status,
4252
+ :registration_version_status_history,
4253
+ :denied_reasons)
2258
4254
  SENSITIVE = []
2259
4255
  include Aws::Structure
2260
4256
  end
2261
4257
 
2262
- # @!attribute [rw] opt_out_list_name
2263
- # The OptOutListName or OptOutListArn to add the phone number to.
2264
- # @return [String]
4258
+ # The **RegistrationVersionStatusHistory** object contains the time
4259
+ # stamps for when the reservations status changes.
2265
4260
  #
2266
- # @!attribute [rw] opted_out_number
2267
- # The phone number to add to the OptOutList in E.164 format.
2268
- # @return [String]
4261
+ # @!attribute [rw] draft_timestamp
4262
+ # The time when the registration was in the draft state, in [UNIX
4263
+ # epoch time][1] format.
2269
4264
  #
2270
- # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PutOptedOutNumberRequest AWS API Documentation
2271
4265
  #
2272
- class PutOptedOutNumberRequest < Struct.new(
2273
- :opt_out_list_name,
2274
- :opted_out_number)
2275
- SENSITIVE = []
2276
- include Aws::Structure
2277
- end
2278
-
2279
- # @!attribute [rw] opt_out_list_arn
2280
- # The OptOutListArn that the phone number was removed from.
2281
- # @return [String]
2282
4266
  #
2283
- # @!attribute [rw] opt_out_list_name
2284
- # The OptOutListName that the phone number was removed from.
2285
- # @return [String]
4267
+ # [1]: https://www.epochconverter.com/
4268
+ # @return [Time]
4269
+ #
4270
+ # @!attribute [rw] submitted_timestamp
4271
+ # The time when the registration was in the submitted state, in [UNIX
4272
+ # epoch time][1] format.
4273
+ #
4274
+ #
4275
+ #
4276
+ # [1]: https://www.epochconverter.com/
4277
+ # @return [Time]
4278
+ #
4279
+ # @!attribute [rw] reviewing_timestamp
4280
+ # The time when the registration was in the reviewing state, in [UNIX
4281
+ # epoch time][1] format.
4282
+ #
4283
+ #
4284
+ #
4285
+ # [1]: https://www.epochconverter.com/
4286
+ # @return [Time]
4287
+ #
4288
+ # @!attribute [rw] approved_timestamp
4289
+ # The time when the registration was in the approved state, in [UNIX
4290
+ # epoch time][1] format.
4291
+ #
4292
+ #
4293
+ #
4294
+ # [1]: https://www.epochconverter.com/
4295
+ # @return [Time]
4296
+ #
4297
+ # @!attribute [rw] discarded_timestamp
4298
+ # The time when the registration was in the discarded state, in [UNIX
4299
+ # epoch time][1] format.
4300
+ #
4301
+ #
4302
+ #
4303
+ # [1]: https://www.epochconverter.com/
4304
+ # @return [Time]
4305
+ #
4306
+ # @!attribute [rw] denied_timestamp
4307
+ # The time when the registration was in the denied state, in [UNIX
4308
+ # epoch time][1] format.
4309
+ #
4310
+ #
2286
4311
  #
2287
- # @!attribute [rw] opted_out_number
2288
- # The phone number that was added to the OptOutList.
2289
- # @return [String]
4312
+ # [1]: https://www.epochconverter.com/
4313
+ # @return [Time]
2290
4314
  #
2291
- # @!attribute [rw] opted_out_timestamp
2292
- # The time that the phone number was added to the OptOutList, in [UNIX
4315
+ # @!attribute [rw] revoked_timestamp
4316
+ # The time when the registration was in the revoked state, in [UNIX
2293
4317
  # epoch time][1] format.
2294
4318
  #
2295
4319
  #
@@ -2297,19 +4321,26 @@ module Aws::PinpointSMSVoiceV2
2297
4321
  # [1]: https://www.epochconverter.com/
2298
4322
  # @return [Time]
2299
4323
  #
2300
- # @!attribute [rw] end_user_opted_out
2301
- # This is true if it was the end user who requested their phone number
2302
- # be removed.
2303
- # @return [Boolean]
4324
+ # @!attribute [rw] archived_timestamp
4325
+ # The time when the registration was in the archived state, in [UNIX
4326
+ # epoch time][1] format.
2304
4327
  #
2305
- # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PutOptedOutNumberResult AWS API Documentation
2306
4328
  #
2307
- class PutOptedOutNumberResult < Struct.new(
2308
- :opt_out_list_arn,
2309
- :opt_out_list_name,
2310
- :opted_out_number,
2311
- :opted_out_timestamp,
2312
- :end_user_opted_out)
4329
+ #
4330
+ # [1]: https://www.epochconverter.com/
4331
+ # @return [Time]
4332
+ #
4333
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/RegistrationVersionStatusHistory AWS API Documentation
4334
+ #
4335
+ class RegistrationVersionStatusHistory < Struct.new(
4336
+ :draft_timestamp,
4337
+ :submitted_timestamp,
4338
+ :reviewing_timestamp,
4339
+ :approved_timestamp,
4340
+ :discarded_timestamp,
4341
+ :denied_timestamp,
4342
+ :revoked_timestamp,
4343
+ :archived_timestamp)
2313
4344
  SENSITIVE = []
2314
4345
  include Aws::Structure
2315
4346
  end
@@ -2375,6 +4406,11 @@ module Aws::PinpointSMSVoiceV2
2375
4406
  # The Amazon Resource Name (ARN) of the TwoWayChannel.
2376
4407
  # @return [String]
2377
4408
  #
4409
+ # @!attribute [rw] two_way_channel_role
4410
+ # An optional IAM Role Arn for a service to assume, to be able to post
4411
+ # inbound SMS messages.
4412
+ # @return [String]
4413
+ #
2378
4414
  # @!attribute [rw] self_managed_opt_outs_enabled
2379
4415
  # By default this is set to false. When an end recipient sends a
2380
4416
  # message that begins with HELP or STOP to one of your dedicated
@@ -2389,6 +4425,10 @@ module Aws::PinpointSMSVoiceV2
2389
4425
  # number.
2390
4426
  # @return [String]
2391
4427
  #
4428
+ # @!attribute [rw] registration_id
4429
+ # The unique identifier for the registration.
4430
+ # @return [String]
4431
+ #
2392
4432
  # @!attribute [rw] created_timestamp
2393
4433
  # The time when the phone number was created, in [UNIX epoch time][1]
2394
4434
  # format.
@@ -2412,13 +4452,78 @@ module Aws::PinpointSMSVoiceV2
2412
4452
  :monthly_leasing_price,
2413
4453
  :two_way_enabled,
2414
4454
  :two_way_channel_arn,
4455
+ :two_way_channel_role,
2415
4456
  :self_managed_opt_outs_enabled,
2416
4457
  :opt_out_list_name,
4458
+ :registration_id,
2417
4459
  :created_timestamp)
2418
4460
  SENSITIVE = []
2419
4461
  include Aws::Structure
2420
4462
  end
2421
4463
 
4464
+ # @!attribute [rw] sender_id
4465
+ # The sender ID to release.
4466
+ # @return [String]
4467
+ #
4468
+ # @!attribute [rw] iso_country_code
4469
+ # The two-character code, in ISO 3166-1 alpha-2 format, for the
4470
+ # country or region.
4471
+ # @return [String]
4472
+ #
4473
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ReleaseSenderIdRequest AWS API Documentation
4474
+ #
4475
+ class ReleaseSenderIdRequest < Struct.new(
4476
+ :sender_id,
4477
+ :iso_country_code)
4478
+ SENSITIVE = []
4479
+ include Aws::Structure
4480
+ end
4481
+
4482
+ # @!attribute [rw] sender_id_arn
4483
+ # The Amazon Resource Name (ARN) associated with the SenderId.
4484
+ # @return [String]
4485
+ #
4486
+ # @!attribute [rw] sender_id
4487
+ # The sender ID that was released.
4488
+ # @return [String]
4489
+ #
4490
+ # @!attribute [rw] iso_country_code
4491
+ # The two-character code, in ISO 3166-1 alpha-2 format, for the
4492
+ # country or region.
4493
+ # @return [String]
4494
+ #
4495
+ # @!attribute [rw] message_types
4496
+ # The type of message. Valid values are TRANSACTIONAL for messages
4497
+ # that are critical or time-sensitive and PROMOTIONAL for messages
4498
+ # that aren't critical or time-sensitive.
4499
+ # @return [Array<String>]
4500
+ #
4501
+ # @!attribute [rw] monthly_leasing_price
4502
+ # The monthly price, in US dollars, to lease the sender ID.
4503
+ # @return [String]
4504
+ #
4505
+ # @!attribute [rw] registered
4506
+ # True if the sender ID is registered.
4507
+ # @return [Boolean]
4508
+ #
4509
+ # @!attribute [rw] registration_id
4510
+ # The unique identifier for the registration.
4511
+ # @return [String]
4512
+ #
4513
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ReleaseSenderIdResult AWS API Documentation
4514
+ #
4515
+ class ReleaseSenderIdResult < Struct.new(
4516
+ :sender_id_arn,
4517
+ :sender_id,
4518
+ :iso_country_code,
4519
+ :message_types,
4520
+ :monthly_leasing_price,
4521
+ :registered,
4522
+ :registration_id)
4523
+ SENSITIVE = []
4524
+ include Aws::Structure
4525
+ end
4526
+
2422
4527
  # @!attribute [rw] iso_country_code
2423
4528
  # The two-character code, in ISO 3166-1 alpha-2 format, for the
2424
4529
  # country or region.
@@ -2441,7 +4546,7 @@ module Aws::PinpointSMSVoiceV2
2441
4546
  #
2442
4547
  # @!attribute [rw] opt_out_list_name
2443
4548
  # The name of the OptOutList to associate with the phone number. You
2444
- # can use the OutOutListName or OptPutListArn.
4549
+ # can use the OptOutListName or OptOutListArn.
2445
4550
  # @return [String]
2446
4551
  #
2447
4552
  # @!attribute [rw] pool_id
@@ -2540,6 +4645,11 @@ module Aws::PinpointSMSVoiceV2
2540
4645
  # The ARN used to identify the two way channel.
2541
4646
  # @return [String]
2542
4647
  #
4648
+ # @!attribute [rw] two_way_channel_role
4649
+ # An optional IAM Role Arn for a service to assume, to be able to post
4650
+ # inbound SMS messages.
4651
+ # @return [String]
4652
+ #
2543
4653
  # @!attribute [rw] self_managed_opt_outs_enabled
2544
4654
  # By default this is set to false. When an end recipient sends a
2545
4655
  # message that begins with HELP or STOP to one of your dedicated
@@ -2563,6 +4673,10 @@ module Aws::PinpointSMSVoiceV2
2563
4673
  # The unique identifier of the pool associated with the phone number
2564
4674
  # @return [String]
2565
4675
  #
4676
+ # @!attribute [rw] registration_id
4677
+ # The unique identifier for the registration.
4678
+ # @return [String]
4679
+ #
2566
4680
  # @!attribute [rw] tags
2567
4681
  # An array of key and value pair tags that are associated with the
2568
4682
  # phone number.
@@ -2591,16 +4705,118 @@ module Aws::PinpointSMSVoiceV2
2591
4705
  :monthly_leasing_price,
2592
4706
  :two_way_enabled,
2593
4707
  :two_way_channel_arn,
4708
+ :two_way_channel_role,
2594
4709
  :self_managed_opt_outs_enabled,
2595
4710
  :opt_out_list_name,
2596
4711
  :deletion_protection_enabled,
2597
4712
  :pool_id,
4713
+ :registration_id,
2598
4714
  :tags,
2599
4715
  :created_timestamp)
2600
4716
  SENSITIVE = []
2601
4717
  include Aws::Structure
2602
4718
  end
2603
4719
 
4720
+ # @!attribute [rw] sender_id
4721
+ # The sender ID string to request.
4722
+ # @return [String]
4723
+ #
4724
+ # @!attribute [rw] iso_country_code
4725
+ # The two-character code, in ISO 3166-1 alpha-2 format, for the
4726
+ # country or region.
4727
+ # @return [String]
4728
+ #
4729
+ # @!attribute [rw] message_types
4730
+ # The type of message. Valid values are TRANSACTIONAL for messages
4731
+ # that are critical or time-sensitive and PROMOTIONAL for messages
4732
+ # that aren't critical or time-sensitive.
4733
+ # @return [Array<String>]
4734
+ #
4735
+ # @!attribute [rw] deletion_protection_enabled
4736
+ # By default this is set to false. When set to true the sender ID
4737
+ # can't be deleted.
4738
+ # @return [Boolean]
4739
+ #
4740
+ # @!attribute [rw] tags
4741
+ # An array of tags (key and value pairs) to associate with the sender
4742
+ # ID.
4743
+ # @return [Array<Types::Tag>]
4744
+ #
4745
+ # @!attribute [rw] client_token
4746
+ # Unique, case-sensitive identifier that you provide to ensure the
4747
+ # idempotency of the request. If you don't specify a client token, a
4748
+ # randomly generated token is used for the request to ensure
4749
+ # idempotency.
4750
+ #
4751
+ # **A suitable default value is auto-generated.** You should normally
4752
+ # not need to pass this option.
4753
+ # @return [String]
4754
+ #
4755
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/RequestSenderIdRequest AWS API Documentation
4756
+ #
4757
+ class RequestSenderIdRequest < Struct.new(
4758
+ :sender_id,
4759
+ :iso_country_code,
4760
+ :message_types,
4761
+ :deletion_protection_enabled,
4762
+ :tags,
4763
+ :client_token)
4764
+ SENSITIVE = []
4765
+ include Aws::Structure
4766
+ end
4767
+
4768
+ # @!attribute [rw] sender_id_arn
4769
+ # The Amazon Resource Name (ARN) associated with the SenderId.
4770
+ # @return [String]
4771
+ #
4772
+ # @!attribute [rw] sender_id
4773
+ # The sender ID that was requested.
4774
+ # @return [String]
4775
+ #
4776
+ # @!attribute [rw] iso_country_code
4777
+ # The two-character code, in ISO 3166-1 alpha-2 format, for the
4778
+ # country or region.
4779
+ # @return [String]
4780
+ #
4781
+ # @!attribute [rw] message_types
4782
+ # The type of message. Valid values are TRANSACTIONAL for messages
4783
+ # that are critical or time-sensitive and PROMOTIONAL for messages
4784
+ # that aren't critical or time-sensitive.
4785
+ # @return [Array<String>]
4786
+ #
4787
+ # @!attribute [rw] monthly_leasing_price
4788
+ # The monthly price, in US dollars, to lease the sender ID.
4789
+ # @return [String]
4790
+ #
4791
+ # @!attribute [rw] deletion_protection_enabled
4792
+ # By default this is set to false. When set to true the sender ID
4793
+ # can't be deleted.
4794
+ # @return [Boolean]
4795
+ #
4796
+ # @!attribute [rw] registered
4797
+ # True if the sender ID is registered.
4798
+ # @return [Boolean]
4799
+ #
4800
+ # @!attribute [rw] tags
4801
+ # An array of tags (key and value pairs) to associate with the sender
4802
+ # ID.
4803
+ # @return [Array<Types::Tag>]
4804
+ #
4805
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/RequestSenderIdResult AWS API Documentation
4806
+ #
4807
+ class RequestSenderIdResult < Struct.new(
4808
+ :sender_id_arn,
4809
+ :sender_id,
4810
+ :iso_country_code,
4811
+ :message_types,
4812
+ :monthly_leasing_price,
4813
+ :deletion_protection_enabled,
4814
+ :registered,
4815
+ :tags)
4816
+ SENSITIVE = []
4817
+ include Aws::Structure
4818
+ end
4819
+
2604
4820
  # A requested resource couldn't be found.
2605
4821
  #
2606
4822
  # @!attribute [rw] message
@@ -2614,12 +4830,126 @@ module Aws::PinpointSMSVoiceV2
2614
4830
  # The unique identifier of the resource.
2615
4831
  # @return [String]
2616
4832
  #
2617
- # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ResourceNotFoundException AWS API Documentation
4833
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ResourceNotFoundException AWS API Documentation
4834
+ #
4835
+ class ResourceNotFoundException < Struct.new(
4836
+ :message,
4837
+ :resource_type,
4838
+ :resource_id)
4839
+ SENSITIVE = []
4840
+ include Aws::Structure
4841
+ end
4842
+
4843
+ # A description of each select option.
4844
+ #
4845
+ # @!attribute [rw] option
4846
+ # The value of the option.
4847
+ # @return [String]
4848
+ #
4849
+ # @!attribute [rw] title
4850
+ # The title of the select option.
4851
+ # @return [String]
4852
+ #
4853
+ # @!attribute [rw] description
4854
+ # A description of the option meaning.
4855
+ # @return [String]
4856
+ #
4857
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SelectOptionDescription AWS API Documentation
4858
+ #
4859
+ class SelectOptionDescription < Struct.new(
4860
+ :option,
4861
+ :title,
4862
+ :description)
4863
+ SENSITIVE = []
4864
+ include Aws::Structure
4865
+ end
4866
+
4867
+ # Validation rules for a select field.
4868
+ #
4869
+ # @!attribute [rw] min_choices
4870
+ # The minimum number of choices for the select.
4871
+ # @return [Integer]
4872
+ #
4873
+ # @!attribute [rw] max_choices
4874
+ # The maximum number of choices for the select.
4875
+ # @return [Integer]
4876
+ #
4877
+ # @!attribute [rw] options
4878
+ # An array of strings for the possible selection options.
4879
+ # @return [Array<String>]
4880
+ #
4881
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SelectValidation AWS API Documentation
4882
+ #
4883
+ class SelectValidation < Struct.new(
4884
+ :min_choices,
4885
+ :max_choices,
4886
+ :options)
4887
+ SENSITIVE = []
4888
+ include Aws::Structure
4889
+ end
4890
+
4891
+ # @!attribute [rw] verified_destination_number_id
4892
+ # The unique identifier for the verified destination phone number.
4893
+ # @return [String]
4894
+ #
4895
+ # @!attribute [rw] verification_channel
4896
+ # Choose to send the verification code as an SMS or voice message.
4897
+ # @return [String]
4898
+ #
4899
+ # @!attribute [rw] language_code
4900
+ # Choose the language to use for the message.
4901
+ # @return [String]
4902
+ #
4903
+ # @!attribute [rw] origination_identity
4904
+ # The origination identity of the message. This can be either the
4905
+ # PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn,
4906
+ # PoolId, or PoolArn.
4907
+ # @return [String]
4908
+ #
4909
+ # @!attribute [rw] configuration_set_name
4910
+ # The name of the configuration set to use. This can be either the
4911
+ # ConfigurationSetName or ConfigurationSetArn.
4912
+ # @return [String]
4913
+ #
4914
+ # @!attribute [rw] context
4915
+ # You can specify custom data in this field. If you do, that data is
4916
+ # logged to the event destination.
4917
+ # @return [Hash<String,String>]
4918
+ #
4919
+ # @!attribute [rw] destination_country_parameters
4920
+ # This field is used for any country-specific registration
4921
+ # requirements. Currently, this setting is only used when you send
4922
+ # messages to recipients in India using a sender ID. For more
4923
+ # information see [Special requirements for sending SMS messages to
4924
+ # recipients in India][1].
4925
+ #
4926
+ #
4927
+ #
4928
+ # [1]: https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-senderid-india.html
4929
+ # @return [Hash<String,String>]
4930
+ #
4931
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SendDestinationNumberVerificationCodeRequest AWS API Documentation
4932
+ #
4933
+ class SendDestinationNumberVerificationCodeRequest < Struct.new(
4934
+ :verified_destination_number_id,
4935
+ :verification_channel,
4936
+ :language_code,
4937
+ :origination_identity,
4938
+ :configuration_set_name,
4939
+ :context,
4940
+ :destination_country_parameters)
4941
+ SENSITIVE = []
4942
+ include Aws::Structure
4943
+ end
4944
+
4945
+ # @!attribute [rw] message_id
4946
+ # The unique identifier for the message.
4947
+ # @return [String]
4948
+ #
4949
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SendDestinationNumberVerificationCodeResult AWS API Documentation
2618
4950
  #
2619
- class ResourceNotFoundException < Struct.new(
2620
- :message,
2621
- :resource_type,
2622
- :resource_id)
4951
+ class SendDestinationNumberVerificationCodeResult < Struct.new(
4952
+ :message_id)
2623
4953
  SENSITIVE = []
2624
4954
  include Aws::Structure
2625
4955
  end
@@ -2639,9 +4969,9 @@ module Aws::PinpointSMSVoiceV2
2639
4969
  # @return [String]
2640
4970
  #
2641
4971
  # @!attribute [rw] message_type
2642
- # The type of message. Valid values are TRANSACTIONAL for messages
2643
- # that are critical or time-sensitive and PROMOTIONAL for messages
2644
- # that aren't critical or time-sensitive.
4972
+ # The type of message. Valid values are for messages that are critical
4973
+ # or time-sensitive and PROMOTIONAL for messages that aren't critical
4974
+ # or time-sensitive.
2645
4975
  # @return [String]
2646
4976
  #
2647
4977
  # @!attribute [rw] keyword
@@ -2877,6 +5207,19 @@ module Aws::PinpointSMSVoiceV2
2877
5207
  # The monthly leasing price, in US dollars.
2878
5208
  # @return [String]
2879
5209
  #
5210
+ # @!attribute [rw] deletion_protection_enabled
5211
+ # By default this is set to false. When set to true the sender ID
5212
+ # can't be deleted.
5213
+ # @return [Boolean]
5214
+ #
5215
+ # @!attribute [rw] registered
5216
+ # True if the sender ID is registered.
5217
+ # @return [Boolean]
5218
+ #
5219
+ # @!attribute [rw] registration_id
5220
+ # The unique identifier for the registration.
5221
+ # @return [String]
5222
+ #
2880
5223
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SenderIdInformation AWS API Documentation
2881
5224
  #
2882
5225
  class SenderIdInformation < Struct.new(
@@ -2884,7 +5227,10 @@ module Aws::PinpointSMSVoiceV2
2884
5227
  :sender_id,
2885
5228
  :iso_country_code,
2886
5229
  :message_types,
2887
- :monthly_leasing_price)
5230
+ :monthly_leasing_price,
5231
+ :deletion_protection_enabled,
5232
+ :registered,
5233
+ :registration_id)
2888
5234
  SENSITIVE = []
2889
5235
  include Aws::Structure
2890
5236
  end
@@ -3102,6 +5448,127 @@ module Aws::PinpointSMSVoiceV2
3102
5448
  include Aws::Structure
3103
5449
  end
3104
5450
 
5451
+ # @!attribute [rw] registration_id
5452
+ # The unique identifier for the registration.
5453
+ # @return [String]
5454
+ #
5455
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SubmitRegistrationVersionRequest AWS API Documentation
5456
+ #
5457
+ class SubmitRegistrationVersionRequest < Struct.new(
5458
+ :registration_id)
5459
+ SENSITIVE = []
5460
+ include Aws::Structure
5461
+ end
5462
+
5463
+ # @!attribute [rw] registration_arn
5464
+ # The Amazon Resource Name (ARN) for the registration.
5465
+ # @return [String]
5466
+ #
5467
+ # @!attribute [rw] registration_id
5468
+ # The unique identifier for the registration.
5469
+ # @return [String]
5470
+ #
5471
+ # @!attribute [rw] version_number
5472
+ # The version number of the registration.
5473
+ # @return [Integer]
5474
+ #
5475
+ # @!attribute [rw] registration_version_status
5476
+ # The status of the registration version.
5477
+ #
5478
+ # * `DRAFT`: The initial status of a registration version after it’s
5479
+ # created.
5480
+ #
5481
+ # * `SUBMITTED`: Your registration has been submitted.
5482
+ #
5483
+ # * `REVIEWING`: Your registration has been accepted and is being
5484
+ # reviewed.
5485
+ #
5486
+ # * `APPROVED`: Your registration has been approved.
5487
+ #
5488
+ # * `DISCARDED`: You've abandon this version of their registration to
5489
+ # start over with a new version.
5490
+ #
5491
+ # * `DENIED`: You must fix your registration and resubmit it.
5492
+ #
5493
+ # * `REVOKED`: Your previously approved registration has been revoked.
5494
+ #
5495
+ # * `ARCHIVED`: Your previously approved registration version moves
5496
+ # into this status when a more recently submitted version is
5497
+ # approved.
5498
+ # @return [String]
5499
+ #
5500
+ # @!attribute [rw] registration_version_status_history
5501
+ # The **RegistrationVersionStatusHistory** object contains the time
5502
+ # stamps for when the reservations status changes.
5503
+ # @return [Types::RegistrationVersionStatusHistory]
5504
+ #
5505
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SubmitRegistrationVersionResult AWS API Documentation
5506
+ #
5507
+ class SubmitRegistrationVersionResult < Struct.new(
5508
+ :registration_arn,
5509
+ :registration_id,
5510
+ :version_number,
5511
+ :registration_version_status,
5512
+ :registration_version_status_history)
5513
+ SENSITIVE = []
5514
+ include Aws::Structure
5515
+ end
5516
+
5517
+ # The processing rules for when a registration can be associated with an
5518
+ # origination identity and disassociated from an origination identity.
5519
+ #
5520
+ # @!attribute [rw] resource_type
5521
+ # Defines the behavior of when an origination identity and
5522
+ # registration can be associated with each other.
5523
+ # @return [String]
5524
+ #
5525
+ # @!attribute [rw] iso_country_code
5526
+ # The two-character code, in ISO 3166-1 alpha-2 format, for the
5527
+ # country or region.
5528
+ # @return [String]
5529
+ #
5530
+ # @!attribute [rw] association_behavior
5531
+ # The association behavior.
5532
+ #
5533
+ # * `ASSOCIATE_BEFORE_SUBMIT` The origination identity has to be
5534
+ # supplied when creating a registration.
5535
+ #
5536
+ # * `ASSOCIATE_ON_APPROVAL` This applies to all short code
5537
+ # registrations. The short code will be automatically provisioned
5538
+ # once the registration is approved.
5539
+ #
5540
+ # * `ASSOCIATE_AFTER_COMPLETE` This applies to phone number
5541
+ # registrations when you must complete a registration first, then
5542
+ # associate one or more phone numbers later. For example 10DLC
5543
+ # campaigns and long codes.
5544
+ # @return [String]
5545
+ #
5546
+ # @!attribute [rw] disassociation_behavior
5547
+ # The disassociation behavior.
5548
+ #
5549
+ # * `DISASSOCIATE_ALL_CLOSES_REGISTRATION` All origination identities
5550
+ # must be disassociated from the registration before the
5551
+ # registration can be closed.
5552
+ #
5553
+ # * `DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION` All origination
5554
+ # identities must be disassociated from the registration before the
5555
+ # registration can be deleted.
5556
+ #
5557
+ # * `DELETE_REGISTRATION_DISASSOCIATES` The registration can be
5558
+ # deleted and all origination identities will be disasscoiated.
5559
+ # @return [String]
5560
+ #
5561
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SupportedAssociation AWS API Documentation
5562
+ #
5563
+ class SupportedAssociation < Struct.new(
5564
+ :resource_type,
5565
+ :iso_country_code,
5566
+ :association_behavior,
5567
+ :disassociation_behavior)
5568
+ SENSITIVE = []
5569
+ include Aws::Structure
5570
+ end
5571
+
3105
5572
  # The list of tags to be added to the specified topic.
3106
5573
  #
3107
5574
  # @!attribute [rw] key
@@ -3143,6 +5610,30 @@ module Aws::PinpointSMSVoiceV2
3143
5610
  #
3144
5611
  class TagResourceResult < Aws::EmptyStructure; end
3145
5612
 
5613
+ # Validation rules for a text field.
5614
+ #
5615
+ # @!attribute [rw] min_length
5616
+ # The minimum number of characters for the text field.
5617
+ # @return [Integer]
5618
+ #
5619
+ # @!attribute [rw] max_length
5620
+ # The maximum number of characters for the text field.
5621
+ # @return [Integer]
5622
+ #
5623
+ # @!attribute [rw] pattern
5624
+ # The regular expression used to validate the text field.
5625
+ # @return [String]
5626
+ #
5627
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/TextValidation AWS API Documentation
5628
+ #
5629
+ class TextValidation < Struct.new(
5630
+ :min_length,
5631
+ :max_length,
5632
+ :pattern)
5633
+ SENSITIVE = []
5634
+ include Aws::Structure
5635
+ end
5636
+
3146
5637
  # An error that occurred because too many requests were sent during a
3147
5638
  # certain amount of time.
3148
5639
  #
@@ -3194,6 +5685,10 @@ module Aws::PinpointSMSVoiceV2
3194
5685
  #
3195
5686
  # @!attribute [rw] matching_event_types
3196
5687
  # An array of event types that determine which events to log.
5688
+ #
5689
+ # <note markdown="1"> The `TEXT_SENT` event type is not supported.
5690
+ #
5691
+ # </note>
3197
5692
  # @return [Array<String>]
3198
5693
  #
3199
5694
  # @!attribute [rw] cloud_watch_logs_destination
@@ -3263,6 +5758,11 @@ module Aws::PinpointSMSVoiceV2
3263
5758
  # The Amazon Resource Name (ARN) of the two way channel.
3264
5759
  # @return [String]
3265
5760
  #
5761
+ # @!attribute [rw] two_way_channel_role
5762
+ # An optional IAM Role Arn for a service to assume, to be able to post
5763
+ # inbound SMS messages.
5764
+ # @return [String]
5765
+ #
3266
5766
  # @!attribute [rw] self_managed_opt_outs_enabled
3267
5767
  # By default this is set to false. When an end recipient sends a
3268
5768
  # message that begins with HELP or STOP to one of your dedicated
@@ -3288,6 +5788,7 @@ module Aws::PinpointSMSVoiceV2
3288
5788
  :phone_number_id,
3289
5789
  :two_way_enabled,
3290
5790
  :two_way_channel_arn,
5791
+ :two_way_channel_role,
3291
5792
  :self_managed_opt_outs_enabled,
3292
5793
  :opt_out_list_name,
3293
5794
  :deletion_protection_enabled)
@@ -3344,6 +5845,11 @@ module Aws::PinpointSMSVoiceV2
3344
5845
  # The Amazon Resource Name (ARN) of the two way channel.
3345
5846
  # @return [String]
3346
5847
  #
5848
+ # @!attribute [rw] two_way_channel_role
5849
+ # An optional IAM Role Arn for a service to assume, to be able to post
5850
+ # inbound SMS messages.
5851
+ # @return [String]
5852
+ #
3347
5853
  # @!attribute [rw] self_managed_opt_outs_enabled
3348
5854
  # This is true if self managed opt-out are enabled.
3349
5855
  # @return [Boolean]
@@ -3356,6 +5862,10 @@ module Aws::PinpointSMSVoiceV2
3356
5862
  # When set to true the phone number can't be deleted.
3357
5863
  # @return [Boolean]
3358
5864
  #
5865
+ # @!attribute [rw] registration_id
5866
+ # The unique identifier for the registration.
5867
+ # @return [String]
5868
+ #
3359
5869
  # @!attribute [rw] created_timestamp
3360
5870
  # The time when the phone number was created, in [UNIX epoch time][1]
3361
5871
  # format.
@@ -3379,9 +5889,11 @@ module Aws::PinpointSMSVoiceV2
3379
5889
  :monthly_leasing_price,
3380
5890
  :two_way_enabled,
3381
5891
  :two_way_channel_arn,
5892
+ :two_way_channel_role,
3382
5893
  :self_managed_opt_outs_enabled,
3383
5894
  :opt_out_list_name,
3384
5895
  :deletion_protection_enabled,
5896
+ :registration_id,
3385
5897
  :created_timestamp)
3386
5898
  SENSITIVE = []
3387
5899
  include Aws::Structure
@@ -3401,6 +5913,11 @@ module Aws::PinpointSMSVoiceV2
3401
5913
  # The Amazon Resource Name (ARN) of the two way channel.
3402
5914
  # @return [String]
3403
5915
  #
5916
+ # @!attribute [rw] two_way_channel_role
5917
+ # An optional IAM Role Arn for a service to assume, to be able to post
5918
+ # inbound SMS messages.
5919
+ # @return [String]
5920
+ #
3404
5921
  # @!attribute [rw] self_managed_opt_outs_enabled
3405
5922
  # By default this is set to false. When an end recipient sends a
3406
5923
  # message that begins with HELP or STOP to one of your dedicated
@@ -3429,6 +5946,7 @@ module Aws::PinpointSMSVoiceV2
3429
5946
  :pool_id,
3430
5947
  :two_way_enabled,
3431
5948
  :two_way_channel_arn,
5949
+ :two_way_channel_role,
3432
5950
  :self_managed_opt_outs_enabled,
3433
5951
  :opt_out_list_name,
3434
5952
  :shared_routes_enabled,
@@ -3462,6 +5980,11 @@ module Aws::PinpointSMSVoiceV2
3462
5980
  # The Amazon Resource Name (ARN) of the two way channel.
3463
5981
  # @return [String]
3464
5982
  #
5983
+ # @!attribute [rw] two_way_channel_role
5984
+ # An optional IAM Role Arn for a service to assume, to be able to post
5985
+ # inbound SMS messages.
5986
+ # @return [String]
5987
+ #
3465
5988
  # @!attribute [rw] self_managed_opt_outs_enabled
3466
5989
  # When an end recipient sends a message that begins with HELP or STOP
3467
5990
  # to one of your dedicated numbers, Amazon Pinpoint automatically
@@ -3500,6 +6023,7 @@ module Aws::PinpointSMSVoiceV2
3500
6023
  :message_type,
3501
6024
  :two_way_enabled,
3502
6025
  :two_way_channel_arn,
6026
+ :two_way_channel_role,
3503
6027
  :self_managed_opt_outs_enabled,
3504
6028
  :opt_out_list_name,
3505
6029
  :shared_routes_enabled,
@@ -3509,6 +6033,81 @@ module Aws::PinpointSMSVoiceV2
3509
6033
  include Aws::Structure
3510
6034
  end
3511
6035
 
6036
+ # @!attribute [rw] sender_id
6037
+ # The sender ID to update.
6038
+ # @return [String]
6039
+ #
6040
+ # @!attribute [rw] iso_country_code
6041
+ # The two-character code, in ISO 3166-1 alpha-2 format, for the
6042
+ # country or region.
6043
+ # @return [String]
6044
+ #
6045
+ # @!attribute [rw] deletion_protection_enabled
6046
+ # By default this is set to false. When set to true the sender ID
6047
+ # can't be deleted.
6048
+ # @return [Boolean]
6049
+ #
6050
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/UpdateSenderIdRequest AWS API Documentation
6051
+ #
6052
+ class UpdateSenderIdRequest < Struct.new(
6053
+ :sender_id,
6054
+ :iso_country_code,
6055
+ :deletion_protection_enabled)
6056
+ SENSITIVE = []
6057
+ include Aws::Structure
6058
+ end
6059
+
6060
+ # @!attribute [rw] sender_id_arn
6061
+ # The Amazon Resource Name (ARN) associated with the SenderId.
6062
+ # @return [String]
6063
+ #
6064
+ # @!attribute [rw] sender_id
6065
+ # The sender ID that was updated.
6066
+ # @return [String]
6067
+ #
6068
+ # @!attribute [rw] iso_country_code
6069
+ # The two-character code, in ISO 3166-1 alpha-2 format, for the
6070
+ # country or region.
6071
+ # @return [String]
6072
+ #
6073
+ # @!attribute [rw] message_types
6074
+ # The type of message. Valid values are TRANSACTIONAL for messages
6075
+ # that are critical or time-sensitive and PROMOTIONAL for messages
6076
+ # that aren't critical or time-sensitive.
6077
+ # @return [Array<String>]
6078
+ #
6079
+ # @!attribute [rw] monthly_leasing_price
6080
+ # The monthly price, in US dollars, to lease the sender ID.
6081
+ # @return [String]
6082
+ #
6083
+ # @!attribute [rw] deletion_protection_enabled
6084
+ # By default this is set to false. When set to true the sender ID
6085
+ # can't be deleted.
6086
+ # @return [Boolean]
6087
+ #
6088
+ # @!attribute [rw] registered
6089
+ # True if the sender ID is registered..
6090
+ # @return [Boolean]
6091
+ #
6092
+ # @!attribute [rw] registration_id
6093
+ # The unique identifier for the registration.
6094
+ # @return [String]
6095
+ #
6096
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/UpdateSenderIdResult AWS API Documentation
6097
+ #
6098
+ class UpdateSenderIdResult < Struct.new(
6099
+ :sender_id_arn,
6100
+ :sender_id,
6101
+ :iso_country_code,
6102
+ :message_types,
6103
+ :monthly_leasing_price,
6104
+ :deletion_protection_enabled,
6105
+ :registered,
6106
+ :registration_id)
6107
+ SENSITIVE = []
6108
+ include Aws::Structure
6109
+ end
6110
+
3512
6111
  # A validation exception for a field.
3513
6112
  #
3514
6113
  # @!attribute [rw] message
@@ -3552,5 +6151,126 @@ module Aws::PinpointSMSVoiceV2
3552
6151
  include Aws::Structure
3553
6152
  end
3554
6153
 
6154
+ # The filter definition for filtering verified destination phone numbers
6155
+ # that meets a specified criteria.
6156
+ #
6157
+ # @!attribute [rw] name
6158
+ # The name of the attribute to filter on.
6159
+ # @return [String]
6160
+ #
6161
+ # @!attribute [rw] values
6162
+ # An array of values to filter on.
6163
+ # @return [Array<String>]
6164
+ #
6165
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/VerifiedDestinationNumberFilter AWS API Documentation
6166
+ #
6167
+ class VerifiedDestinationNumberFilter < Struct.new(
6168
+ :name,
6169
+ :values)
6170
+ SENSITIVE = []
6171
+ include Aws::Structure
6172
+ end
6173
+
6174
+ # Provides information about the requested verified destintion phone
6175
+ # number.
6176
+ #
6177
+ # @!attribute [rw] verified_destination_number_arn
6178
+ # The Amazon Resource Name (ARN) for the verified destination phone
6179
+ # number.
6180
+ # @return [String]
6181
+ #
6182
+ # @!attribute [rw] verified_destination_number_id
6183
+ # The unique identifier for the verified destination phone number.
6184
+ # @return [String]
6185
+ #
6186
+ # @!attribute [rw] destination_phone_number
6187
+ # The verified destination phone number, in E.164 format.
6188
+ # @return [String]
6189
+ #
6190
+ # @!attribute [rw] status
6191
+ # The status of the verified destination phone number.
6192
+ #
6193
+ # * `PENDING`: The phone number hasn't been verified yet.
6194
+ #
6195
+ # * `VERIFIED`: The phone number is verified and can receive messages.
6196
+ # @return [String]
6197
+ #
6198
+ # @!attribute [rw] created_timestamp
6199
+ # The time when the destination phone number was created, in [UNIX
6200
+ # epoch time][1] format.
6201
+ #
6202
+ #
6203
+ #
6204
+ # [1]: https://www.epochconverter.com/
6205
+ # @return [Time]
6206
+ #
6207
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/VerifiedDestinationNumberInformation AWS API Documentation
6208
+ #
6209
+ class VerifiedDestinationNumberInformation < Struct.new(
6210
+ :verified_destination_number_arn,
6211
+ :verified_destination_number_id,
6212
+ :destination_phone_number,
6213
+ :status,
6214
+ :created_timestamp)
6215
+ SENSITIVE = []
6216
+ include Aws::Structure
6217
+ end
6218
+
6219
+ # @!attribute [rw] verified_destination_number_id
6220
+ # The unique identifier for the verififed destination phone number.
6221
+ # @return [String]
6222
+ #
6223
+ # @!attribute [rw] verification_code
6224
+ # The verification code that was received by the verified destination
6225
+ # phone number.
6226
+ # @return [String]
6227
+ #
6228
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/VerifyDestinationNumberRequest AWS API Documentation
6229
+ #
6230
+ class VerifyDestinationNumberRequest < Struct.new(
6231
+ :verified_destination_number_id,
6232
+ :verification_code)
6233
+ SENSITIVE = []
6234
+ include Aws::Structure
6235
+ end
6236
+
6237
+ # @!attribute [rw] verified_destination_number_arn
6238
+ # The Amazon Resource Name (ARN) for the verified destination phone
6239
+ # number.
6240
+ # @return [String]
6241
+ #
6242
+ # @!attribute [rw] verified_destination_number_id
6243
+ # The unique identifier for the verified destination phone number.
6244
+ # @return [String]
6245
+ #
6246
+ # @!attribute [rw] destination_phone_number
6247
+ # The phone number in E.164 format.
6248
+ # @return [String]
6249
+ #
6250
+ # @!attribute [rw] status
6251
+ # The status for being able to send messages to the phone number.
6252
+ # @return [String]
6253
+ #
6254
+ # @!attribute [rw] created_timestamp
6255
+ # The time when the destination phone number was created, in [UNIX
6256
+ # epoch time][1] format.
6257
+ #
6258
+ #
6259
+ #
6260
+ # [1]: https://www.epochconverter.com/
6261
+ # @return [Time]
6262
+ #
6263
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/VerifyDestinationNumberResult AWS API Documentation
6264
+ #
6265
+ class VerifyDestinationNumberResult < Struct.new(
6266
+ :verified_destination_number_arn,
6267
+ :verified_destination_number_id,
6268
+ :destination_phone_number,
6269
+ :status,
6270
+ :created_timestamp)
6271
+ SENSITIVE = []
6272
+ include Aws::Structure
6273
+ end
6274
+
3555
6275
  end
3556
6276
  end