aws-sdk-chime 1.37.0 → 1.38.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.
@@ -328,8 +328,10 @@ module Aws::Chime
328
328
  # token except for the one authorized to represent the attendee.
329
329
  #
330
330
  # @!attribute [rw] external_user_id
331
- # The Amazon Chime SDK external user ID. Links the attendee to an
332
- # identity managed by a builder application.
331
+ # The Amazon Chime SDK external user ID. An idempotency token. Links
332
+ # the attendee to an identity managed by a builder application. If you
333
+ # create an attendee with the same external user id, the service
334
+ # returns the existing record.
333
335
  # @return [String]
334
336
  #
335
337
  # @!attribute [rw] attendee_id
@@ -810,7 +812,8 @@ module Aws::Chime
810
812
  end
811
813
 
812
814
  # @!attribute [rw] account
813
- # The Amazon Chime account details.
815
+ # The Amazon Chime account details. An AWS account can have multiple
816
+ # Amazon Chime accounts.
814
817
  # @return [Types::Account]
815
818
  #
816
819
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateAccountResponse AWS API Documentation
@@ -826,8 +829,10 @@ module Aws::Chime
826
829
  # user IDs, error codes, and error messages.
827
830
  #
828
831
  # @!attribute [rw] external_user_id
829
- # The Amazon Chime SDK external user ID. Links the attendee to an
830
- # identity managed by a builder application.
832
+ # The Amazon Chime SDK external user ID. An idempotency token. Links
833
+ # the attendee to an identity managed by a builder application. If you
834
+ # create an attendee with the same external user id, the service
835
+ # returns the existing record.
831
836
  # @return [String]
832
837
  #
833
838
  # @!attribute [rw] error_code
@@ -867,8 +872,10 @@ module Aws::Chime
867
872
  # @return [String]
868
873
  #
869
874
  # @!attribute [rw] external_user_id
870
- # The Amazon Chime SDK external user ID. Links the attendee to an
871
- # identity managed by a builder application.
875
+ # The Amazon Chime SDK external user ID. An idempotency token. Links
876
+ # the attendee to an identity managed by a builder application. If you
877
+ # create an attendee with the same external user id, the service
878
+ # returns the existing record.
872
879
  # @return [String]
873
880
  #
874
881
  # @!attribute [rw] tags
@@ -902,8 +909,10 @@ module Aws::Chime
902
909
  # }
903
910
  #
904
911
  # @!attribute [rw] external_user_id
905
- # The Amazon Chime SDK external user ID. Links the attendee to an
906
- # identity managed by a builder application.
912
+ # The Amazon Chime SDK external user ID. An idempotency token. Links
913
+ # the attendee to an identity managed by a builder application. If you
914
+ # create an attendee with the same external user id, the service
915
+ # returns the existing record.
907
916
  # @return [String]
908
917
  #
909
918
  # @!attribute [rw] tags
@@ -974,6 +983,68 @@ module Aws::Chime
974
983
  include Aws::Structure
975
984
  end
976
985
 
986
+ # @note When making an API call, you may pass CreateMeetingDialOutRequest
987
+ # data as a hash:
988
+ #
989
+ # {
990
+ # meeting_id: "GuidString", # required
991
+ # from_phone_number: "E164PhoneNumber", # required
992
+ # to_phone_number: "E164PhoneNumber", # required
993
+ # join_token: "JoinTokenString", # required
994
+ # }
995
+ #
996
+ # @!attribute [rw] meeting_id
997
+ # The Amazon Chime SDK meeting ID.
998
+ #
999
+ # Type: String
1000
+ #
1001
+ # Pattern:
1002
+ # \[a-fA-F0-9\]\\\{8\\}(?:-\[a-fA-F0-9\]\\\{4\\})\\\{3\\}-\[a-fA-F0-9\]\\\{12\\}
1003
+ #
1004
+ # Required: No
1005
+ # @return [String]
1006
+ #
1007
+ # @!attribute [rw] from_phone_number
1008
+ # Phone number used as the caller ID when the remote party receives a
1009
+ # call.
1010
+ # @return [String]
1011
+ #
1012
+ # @!attribute [rw] to_phone_number
1013
+ # Phone number called when inviting someone to a meeting.
1014
+ # @return [String]
1015
+ #
1016
+ # @!attribute [rw] join_token
1017
+ # Token used by the Amazon Chime SDK attendee. Call the [
1018
+ # CreateAttendee API][1] to get a join token.
1019
+ #
1020
+ #
1021
+ #
1022
+ # [1]: https://docs.aws.amazon.com/https:/docs.aws.amazon.com/chime/latest/APIReference/API_Attendee.html
1023
+ # @return [String]
1024
+ #
1025
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateMeetingDialOutRequest AWS API Documentation
1026
+ #
1027
+ class CreateMeetingDialOutRequest < Struct.new(
1028
+ :meeting_id,
1029
+ :from_phone_number,
1030
+ :to_phone_number,
1031
+ :join_token)
1032
+ SENSITIVE = [:from_phone_number, :to_phone_number, :join_token]
1033
+ include Aws::Structure
1034
+ end
1035
+
1036
+ # @!attribute [rw] transaction_id
1037
+ # Unique ID that tracks API calls.
1038
+ # @return [String]
1039
+ #
1040
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateMeetingDialOutResponse AWS API Documentation
1041
+ #
1042
+ class CreateMeetingDialOutResponse < Struct.new(
1043
+ :transaction_id)
1044
+ SENSITIVE = []
1045
+ include Aws::Structure
1046
+ end
1047
+
977
1048
  # @note When making an API call, you may pass CreateMeetingRequest
978
1049
  # data as a hash:
979
1050
  #
@@ -1375,6 +1446,174 @@ module Aws::Chime
1375
1446
  include Aws::Structure
1376
1447
  end
1377
1448
 
1449
+ # @note When making an API call, you may pass CreateSipMediaApplicationCallRequest
1450
+ # data as a hash:
1451
+ #
1452
+ # {
1453
+ # from_phone_number: "E164PhoneNumber",
1454
+ # to_phone_number: "E164PhoneNumber",
1455
+ # sip_media_application_id: "NonEmptyString", # required
1456
+ # }
1457
+ #
1458
+ # @!attribute [rw] from_phone_number
1459
+ # The phone number that a user calls from.
1460
+ # @return [String]
1461
+ #
1462
+ # @!attribute [rw] to_phone_number
1463
+ # The phone number that the user dials in order to connect to a
1464
+ # meeting
1465
+ # @return [String]
1466
+ #
1467
+ # @!attribute [rw] sip_media_application_id
1468
+ # The ID of the SIP media application.
1469
+ # @return [String]
1470
+ #
1471
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateSipMediaApplicationCallRequest AWS API Documentation
1472
+ #
1473
+ class CreateSipMediaApplicationCallRequest < Struct.new(
1474
+ :from_phone_number,
1475
+ :to_phone_number,
1476
+ :sip_media_application_id)
1477
+ SENSITIVE = [:from_phone_number, :to_phone_number]
1478
+ include Aws::Structure
1479
+ end
1480
+
1481
+ # @!attribute [rw] sip_media_application_call
1482
+ # The actual call.
1483
+ # @return [Types::SipMediaApplicationCall]
1484
+ #
1485
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateSipMediaApplicationCallResponse AWS API Documentation
1486
+ #
1487
+ class CreateSipMediaApplicationCallResponse < Struct.new(
1488
+ :sip_media_application_call)
1489
+ SENSITIVE = []
1490
+ include Aws::Structure
1491
+ end
1492
+
1493
+ # @note When making an API call, you may pass CreateSipMediaApplicationRequest
1494
+ # data as a hash:
1495
+ #
1496
+ # {
1497
+ # aws_region: "String", # required
1498
+ # name: "SipMediaApplicationName",
1499
+ # endpoints: [ # required
1500
+ # {
1501
+ # lambda_arn: "FunctionArn",
1502
+ # },
1503
+ # ],
1504
+ # }
1505
+ #
1506
+ # @!attribute [rw] aws_region
1507
+ # AWS Region assigned to the SIP media application.
1508
+ # @return [String]
1509
+ #
1510
+ # @!attribute [rw] name
1511
+ # The SIP media application name.
1512
+ # @return [String]
1513
+ #
1514
+ # @!attribute [rw] endpoints
1515
+ # List of endpoints (Lambda Amazon Resource Names) specified for the
1516
+ # SIP media application. Currently, only one endpoint is supported.
1517
+ # @return [Array<Types::SipMediaApplicationEndpoint>]
1518
+ #
1519
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateSipMediaApplicationRequest AWS API Documentation
1520
+ #
1521
+ class CreateSipMediaApplicationRequest < Struct.new(
1522
+ :aws_region,
1523
+ :name,
1524
+ :endpoints)
1525
+ SENSITIVE = []
1526
+ include Aws::Structure
1527
+ end
1528
+
1529
+ # @!attribute [rw] sip_media_application
1530
+ # The Sip media application details.
1531
+ # @return [Types::SipMediaApplication]
1532
+ #
1533
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateSipMediaApplicationResponse AWS API Documentation
1534
+ #
1535
+ class CreateSipMediaApplicationResponse < Struct.new(
1536
+ :sip_media_application)
1537
+ SENSITIVE = []
1538
+ include Aws::Structure
1539
+ end
1540
+
1541
+ # @note When making an API call, you may pass CreateSipRuleRequest
1542
+ # data as a hash:
1543
+ #
1544
+ # {
1545
+ # name: "SipRuleName", # required
1546
+ # trigger_type: "ToPhoneNumber", # required, accepts ToPhoneNumber, RequestUriHostname
1547
+ # trigger_value: "NonEmptyString", # required
1548
+ # disabled: false,
1549
+ # target_applications: [ # required
1550
+ # {
1551
+ # sip_media_application_id: "NonEmptyString",
1552
+ # priority: 1,
1553
+ # aws_region: "String",
1554
+ # },
1555
+ # ],
1556
+ # }
1557
+ #
1558
+ # @!attribute [rw] name
1559
+ # The name of the SIP rule.
1560
+ # @return [String]
1561
+ #
1562
+ # @!attribute [rw] trigger_type
1563
+ # The type of trigger whose value is assigned to the SIP rule in
1564
+ # `TriggerValue`. Allowed trigger values are `RequestUriHostname` and
1565
+ # `ToPhoneNumber`.
1566
+ # @return [String]
1567
+ #
1568
+ # @!attribute [rw] trigger_value
1569
+ # If `TriggerType` is `RequestUriHostname` then the value can be the
1570
+ # outbound host name of an Amazon Chime Voice Connector. If
1571
+ # `TriggerType` is `ToPhoneNumber` then the value can be a
1572
+ # customer-owned phone number in E164 format. `SipRule` is triggered
1573
+ # if the SIP application requests a host name, or a If `TriggerType`
1574
+ # is `RequestUriHostname`, then the value can be the outbound hostname
1575
+ # of an Amazon Chime Voice Connector. If `TriggerType` is
1576
+ # `ToPhoneNumber`, then the value can be a customer-owned phone number
1577
+ # in E164 format. `SipRule` is triggered if the SIP application
1578
+ # requests a host name, or a `ToPhoneNumber` value matches the
1579
+ # incoming SIP request.
1580
+ # @return [String]
1581
+ #
1582
+ # @!attribute [rw] disabled
1583
+ # Enables or disables a rule. You must disable rules before you can
1584
+ # delete them.
1585
+ # @return [Boolean]
1586
+ #
1587
+ # @!attribute [rw] target_applications
1588
+ # List of SIP media applications with priority and AWS Region. Only
1589
+ # one SIP application per AWS Region can be used.
1590
+ # @return [Array<Types::SipRuleTargetApplication>]
1591
+ #
1592
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateSipRuleRequest AWS API Documentation
1593
+ #
1594
+ class CreateSipRuleRequest < Struct.new(
1595
+ :name,
1596
+ :trigger_type,
1597
+ :trigger_value,
1598
+ :disabled,
1599
+ :target_applications)
1600
+ SENSITIVE = []
1601
+ include Aws::Structure
1602
+ end
1603
+
1604
+ # @!attribute [rw] sip_rule
1605
+ # Returns the SIP rule information, including the rule ID, triggers,
1606
+ # and target applications.
1607
+ # @return [Types::SipRule]
1608
+ #
1609
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateSipRuleResponse AWS API Documentation
1610
+ #
1611
+ class CreateSipRuleResponse < Struct.new(
1612
+ :sip_rule)
1613
+ SENSITIVE = []
1614
+ include Aws::Structure
1615
+ end
1616
+
1378
1617
  # @note When making an API call, you may pass CreateUserRequest
1379
1618
  # data as a hash:
1380
1619
  #
@@ -1770,6 +2009,44 @@ module Aws::Chime
1770
2009
  include Aws::Structure
1771
2010
  end
1772
2011
 
2012
+ # @note When making an API call, you may pass DeleteSipMediaApplicationRequest
2013
+ # data as a hash:
2014
+ #
2015
+ # {
2016
+ # sip_media_application_id: "NonEmptyString", # required
2017
+ # }
2018
+ #
2019
+ # @!attribute [rw] sip_media_application_id
2020
+ # The SIP media application ID.
2021
+ # @return [String]
2022
+ #
2023
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteSipMediaApplicationRequest AWS API Documentation
2024
+ #
2025
+ class DeleteSipMediaApplicationRequest < Struct.new(
2026
+ :sip_media_application_id)
2027
+ SENSITIVE = []
2028
+ include Aws::Structure
2029
+ end
2030
+
2031
+ # @note When making an API call, you may pass DeleteSipRuleRequest
2032
+ # data as a hash:
2033
+ #
2034
+ # {
2035
+ # sip_rule_id: "NonEmptyString", # required
2036
+ # }
2037
+ #
2038
+ # @!attribute [rw] sip_rule_id
2039
+ # The SIP rule ID.
2040
+ # @return [String]
2041
+ #
2042
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteSipRuleRequest AWS API Documentation
2043
+ #
2044
+ class DeleteSipRuleRequest < Struct.new(
2045
+ :sip_rule_id)
2046
+ SENSITIVE = []
2047
+ include Aws::Structure
2048
+ end
2049
+
1773
2050
  # @note When making an API call, you may pass DeleteVoiceConnectorEmergencyCallingConfigurationRequest
1774
2051
  # data as a hash:
1775
2052
  #
@@ -2186,7 +2463,8 @@ module Aws::Chime
2186
2463
  end
2187
2464
 
2188
2465
  # @!attribute [rw] account
2189
- # The Amazon Chime account details.
2466
+ # The Amazon Chime account details. An AWS account can have multiple
2467
+ # Amazon Chime accounts.
2190
2468
  # @return [Types::Account]
2191
2469
  #
2192
2470
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetAccountResponse AWS API Documentation
@@ -2577,6 +2855,99 @@ module Aws::Chime
2577
2855
  include Aws::Structure
2578
2856
  end
2579
2857
 
2858
+ # @note When making an API call, you may pass GetSipMediaApplicationLoggingConfigurationRequest
2859
+ # data as a hash:
2860
+ #
2861
+ # {
2862
+ # sip_media_application_id: "NonEmptyString", # required
2863
+ # }
2864
+ #
2865
+ # @!attribute [rw] sip_media_application_id
2866
+ # The ID of the SIP media application.
2867
+ # @return [String]
2868
+ #
2869
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetSipMediaApplicationLoggingConfigurationRequest AWS API Documentation
2870
+ #
2871
+ class GetSipMediaApplicationLoggingConfigurationRequest < Struct.new(
2872
+ :sip_media_application_id)
2873
+ SENSITIVE = []
2874
+ include Aws::Structure
2875
+ end
2876
+
2877
+ # @!attribute [rw] sip_media_application_logging_configuration
2878
+ # The actual logging configuration.
2879
+ # @return [Types::SipMediaApplicationLoggingConfiguration]
2880
+ #
2881
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetSipMediaApplicationLoggingConfigurationResponse AWS API Documentation
2882
+ #
2883
+ class GetSipMediaApplicationLoggingConfigurationResponse < Struct.new(
2884
+ :sip_media_application_logging_configuration)
2885
+ SENSITIVE = []
2886
+ include Aws::Structure
2887
+ end
2888
+
2889
+ # @note When making an API call, you may pass GetSipMediaApplicationRequest
2890
+ # data as a hash:
2891
+ #
2892
+ # {
2893
+ # sip_media_application_id: "NonEmptyString", # required
2894
+ # }
2895
+ #
2896
+ # @!attribute [rw] sip_media_application_id
2897
+ # The SIP media application ID.
2898
+ # @return [String]
2899
+ #
2900
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetSipMediaApplicationRequest AWS API Documentation
2901
+ #
2902
+ class GetSipMediaApplicationRequest < Struct.new(
2903
+ :sip_media_application_id)
2904
+ SENSITIVE = []
2905
+ include Aws::Structure
2906
+ end
2907
+
2908
+ # @!attribute [rw] sip_media_application
2909
+ # The SIP media application details.
2910
+ # @return [Types::SipMediaApplication]
2911
+ #
2912
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetSipMediaApplicationResponse AWS API Documentation
2913
+ #
2914
+ class GetSipMediaApplicationResponse < Struct.new(
2915
+ :sip_media_application)
2916
+ SENSITIVE = []
2917
+ include Aws::Structure
2918
+ end
2919
+
2920
+ # @note When making an API call, you may pass GetSipRuleRequest
2921
+ # data as a hash:
2922
+ #
2923
+ # {
2924
+ # sip_rule_id: "NonEmptyString", # required
2925
+ # }
2926
+ #
2927
+ # @!attribute [rw] sip_rule_id
2928
+ # The SIP rule ID.
2929
+ # @return [String]
2930
+ #
2931
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetSipRuleRequest AWS API Documentation
2932
+ #
2933
+ class GetSipRuleRequest < Struct.new(
2934
+ :sip_rule_id)
2935
+ SENSITIVE = []
2936
+ include Aws::Structure
2937
+ end
2938
+
2939
+ # @!attribute [rw] sip_rule
2940
+ # The SIP rule details.
2941
+ # @return [Types::SipRule]
2942
+ #
2943
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetSipRuleResponse AWS API Documentation
2944
+ #
2945
+ class GetSipRuleResponse < Struct.new(
2946
+ :sip_rule)
2947
+ SENSITIVE = []
2948
+ include Aws::Structure
2949
+ end
2950
+
2580
2951
  # @note When making an API call, you may pass GetUserRequest
2581
2952
  # data as a hash:
2582
2953
  #
@@ -3042,11 +3413,11 @@ module Aws::Chime
3042
3413
  end
3043
3414
 
3044
3415
  # @!attribute [rw] accounts
3045
- # List of Amazon Chime accounts and account details.
3416
+ # The list of accounts.
3046
3417
  # @return [Array<Types::Account>]
3047
3418
  #
3048
3419
  # @!attribute [rw] next_token
3049
- # The token to use to retrieve the next page of results.
3420
+ # The account's user token.
3050
3421
  # @return [String]
3051
3422
  #
3052
3423
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListAccountsResponse AWS API Documentation
@@ -3313,7 +3684,7 @@ module Aws::Chime
3313
3684
  # {
3314
3685
  # status: "AcquireInProgress", # accepts AcquireInProgress, AcquireFailed, Unassigned, Assigned, ReleaseInProgress, DeleteInProgress, ReleaseFailed, DeleteFailed
3315
3686
  # product_type: "BusinessCalling", # accepts BusinessCalling, VoiceConnector
3316
- # filter_name: "AccountId", # accepts AccountId, UserId, VoiceConnectorId, VoiceConnectorGroupId
3687
+ # filter_name: "AccountId", # accepts AccountId, UserId, VoiceConnectorId, VoiceConnectorGroupId, SipRuleId
3317
3688
  # filter_value: "String",
3318
3689
  # max_results: 1,
3319
3690
  # next_token: "String",
@@ -3535,6 +3906,98 @@ module Aws::Chime
3535
3906
  include Aws::Structure
3536
3907
  end
3537
3908
 
3909
+ # @note When making an API call, you may pass ListSipMediaApplicationsRequest
3910
+ # data as a hash:
3911
+ #
3912
+ # {
3913
+ # max_results: 1,
3914
+ # next_token: "NextTokenString",
3915
+ # }
3916
+ #
3917
+ # @!attribute [rw] max_results
3918
+ # The maximum number of results to return in a single call. Defaults
3919
+ # to 100.
3920
+ # @return [Integer]
3921
+ #
3922
+ # @!attribute [rw] next_token
3923
+ # The token to use to retrieve the next page of results.
3924
+ # @return [String]
3925
+ #
3926
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListSipMediaApplicationsRequest AWS API Documentation
3927
+ #
3928
+ class ListSipMediaApplicationsRequest < Struct.new(
3929
+ :max_results,
3930
+ :next_token)
3931
+ SENSITIVE = []
3932
+ include Aws::Structure
3933
+ end
3934
+
3935
+ # @!attribute [rw] sip_media_applications
3936
+ # List of SIP media applications and application details.
3937
+ # @return [Array<Types::SipMediaApplication>]
3938
+ #
3939
+ # @!attribute [rw] next_token
3940
+ # The token to use to retrieve the next page of results.
3941
+ # @return [String]
3942
+ #
3943
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListSipMediaApplicationsResponse AWS API Documentation
3944
+ #
3945
+ class ListSipMediaApplicationsResponse < Struct.new(
3946
+ :sip_media_applications,
3947
+ :next_token)
3948
+ SENSITIVE = []
3949
+ include Aws::Structure
3950
+ end
3951
+
3952
+ # @note When making an API call, you may pass ListSipRulesRequest
3953
+ # data as a hash:
3954
+ #
3955
+ # {
3956
+ # sip_media_application_id: "NonEmptyString",
3957
+ # max_results: 1,
3958
+ # next_token: "NextTokenString",
3959
+ # }
3960
+ #
3961
+ # @!attribute [rw] sip_media_application_id
3962
+ # The SIP media application ID.
3963
+ # @return [String]
3964
+ #
3965
+ # @!attribute [rw] max_results
3966
+ # The maximum number of results to return in a single call. Defaults
3967
+ # to 100.
3968
+ # @return [Integer]
3969
+ #
3970
+ # @!attribute [rw] next_token
3971
+ # The token to use to retrieve the next page of results.
3972
+ # @return [String]
3973
+ #
3974
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListSipRulesRequest AWS API Documentation
3975
+ #
3976
+ class ListSipRulesRequest < Struct.new(
3977
+ :sip_media_application_id,
3978
+ :max_results,
3979
+ :next_token)
3980
+ SENSITIVE = []
3981
+ include Aws::Structure
3982
+ end
3983
+
3984
+ # @!attribute [rw] sip_rules
3985
+ # List of SIP rules and rule details.
3986
+ # @return [Array<Types::SipRule>]
3987
+ #
3988
+ # @!attribute [rw] next_token
3989
+ # The token to use to retrieve the next page of results.
3990
+ # @return [String]
3991
+ #
3992
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListSipRulesResponse AWS API Documentation
3993
+ #
3994
+ class ListSipRulesResponse < Struct.new(
3995
+ :sip_rules,
3996
+ :next_token)
3997
+ SENSITIVE = []
3998
+ include Aws::Structure
3999
+ end
4000
+
3538
4001
  # @note When making an API call, you may pass ListTagsForResourceRequest
3539
4002
  # data as a hash:
3540
4003
  #
@@ -4550,6 +5013,45 @@ module Aws::Chime
4550
5013
  include Aws::Structure
4551
5014
  end
4552
5015
 
5016
+ # @note When making an API call, you may pass PutSipMediaApplicationLoggingConfigurationRequest
5017
+ # data as a hash:
5018
+ #
5019
+ # {
5020
+ # sip_media_application_id: "NonEmptyString", # required
5021
+ # sip_media_application_logging_configuration: {
5022
+ # enable_sip_media_application_message_logs: false,
5023
+ # },
5024
+ # }
5025
+ #
5026
+ # @!attribute [rw] sip_media_application_id
5027
+ # The ID of the specified SIP media application
5028
+ # @return [String]
5029
+ #
5030
+ # @!attribute [rw] sip_media_application_logging_configuration
5031
+ # The actual logging configuration.
5032
+ # @return [Types::SipMediaApplicationLoggingConfiguration]
5033
+ #
5034
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/PutSipMediaApplicationLoggingConfigurationRequest AWS API Documentation
5035
+ #
5036
+ class PutSipMediaApplicationLoggingConfigurationRequest < Struct.new(
5037
+ :sip_media_application_id,
5038
+ :sip_media_application_logging_configuration)
5039
+ SENSITIVE = []
5040
+ include Aws::Structure
5041
+ end
5042
+
5043
+ # @!attribute [rw] sip_media_application_logging_configuration
5044
+ # The actual logging configuration.
5045
+ # @return [Types::SipMediaApplicationLoggingConfiguration]
5046
+ #
5047
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/PutSipMediaApplicationLoggingConfigurationResponse AWS API Documentation
5048
+ #
5049
+ class PutSipMediaApplicationLoggingConfigurationResponse < Struct.new(
5050
+ :sip_media_application_logging_configuration)
5051
+ SENSITIVE = []
5052
+ include Aws::Structure
5053
+ end
5054
+
4553
5055
  # @note When making an API call, you may pass PutVoiceConnectorEmergencyCallingConfigurationRequest
4554
5056
  # data as a hash:
4555
5057
  #
@@ -5301,6 +5803,198 @@ module Aws::Chime
5301
5803
  include Aws::Structure
5302
5804
  end
5303
5805
 
5806
+ # The SIP media application details, including name and endpoints. An
5807
+ # AWS account can have multiple SIP media applications.
5808
+ #
5809
+ # @!attribute [rw] sip_media_application_id
5810
+ # The SIP media application ID.
5811
+ # @return [String]
5812
+ #
5813
+ # @!attribute [rw] aws_region
5814
+ # The AWS Region in which the SIP media application is created.
5815
+ # @return [String]
5816
+ #
5817
+ # @!attribute [rw] name
5818
+ # The name of the SIP media application.
5819
+ # @return [String]
5820
+ #
5821
+ # @!attribute [rw] endpoints
5822
+ # List of endpoints for SIP media application. Currently, only one
5823
+ # endpoint per SIP media application is permitted.
5824
+ # @return [Array<Types::SipMediaApplicationEndpoint>]
5825
+ #
5826
+ # @!attribute [rw] created_timestamp
5827
+ # The SIP media application creation timestamp, in ISO 8601 format.
5828
+ # @return [Time]
5829
+ #
5830
+ # @!attribute [rw] updated_timestamp
5831
+ # The SIP media application updated timestamp, in ISO 8601 format.
5832
+ # @return [Time]
5833
+ #
5834
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/SipMediaApplication AWS API Documentation
5835
+ #
5836
+ class SipMediaApplication < Struct.new(
5837
+ :sip_media_application_id,
5838
+ :aws_region,
5839
+ :name,
5840
+ :endpoints,
5841
+ :created_timestamp,
5842
+ :updated_timestamp)
5843
+ SENSITIVE = []
5844
+ include Aws::Structure
5845
+ end
5846
+
5847
+ # A `Call` instance for a SIP media application.
5848
+ #
5849
+ # @!attribute [rw] transaction_id
5850
+ # The transaction ID of a call.
5851
+ # @return [String]
5852
+ #
5853
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/SipMediaApplicationCall AWS API Documentation
5854
+ #
5855
+ class SipMediaApplicationCall < Struct.new(
5856
+ :transaction_id)
5857
+ SENSITIVE = []
5858
+ include Aws::Structure
5859
+ end
5860
+
5861
+ # Endpoints to specify as part of a SIP media application.
5862
+ #
5863
+ # @note When making an API call, you may pass SipMediaApplicationEndpoint
5864
+ # data as a hash:
5865
+ #
5866
+ # {
5867
+ # lambda_arn: "FunctionArn",
5868
+ # }
5869
+ #
5870
+ # @!attribute [rw] lambda_arn
5871
+ # Valid Amazon Resource Name (ARN) of the Lambda function of the same
5872
+ # AWS Region where the SIP media application is created.
5873
+ # @return [String]
5874
+ #
5875
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/SipMediaApplicationEndpoint AWS API Documentation
5876
+ #
5877
+ class SipMediaApplicationEndpoint < Struct.new(
5878
+ :lambda_arn)
5879
+ SENSITIVE = [:lambda_arn]
5880
+ include Aws::Structure
5881
+ end
5882
+
5883
+ # Logging configuration of the SIP media application.
5884
+ #
5885
+ # @note When making an API call, you may pass SipMediaApplicationLoggingConfiguration
5886
+ # data as a hash:
5887
+ #
5888
+ # {
5889
+ # enable_sip_media_application_message_logs: false,
5890
+ # }
5891
+ #
5892
+ # @!attribute [rw] enable_sip_media_application_message_logs
5893
+ # Enables application message logs for the SIP media application.
5894
+ # @return [Boolean]
5895
+ #
5896
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/SipMediaApplicationLoggingConfiguration AWS API Documentation
5897
+ #
5898
+ class SipMediaApplicationLoggingConfiguration < Struct.new(
5899
+ :enable_sip_media_application_message_logs)
5900
+ SENSITIVE = []
5901
+ include Aws::Structure
5902
+ end
5903
+
5904
+ # The SIP rule details, including name, triggers, and target
5905
+ # applications. An AWS account can have multiple SIP rules.
5906
+ #
5907
+ # @!attribute [rw] sip_rule_id
5908
+ # The SIP rule ID.
5909
+ # @return [String]
5910
+ #
5911
+ # @!attribute [rw] name
5912
+ # The name of the SIP rule.
5913
+ # @return [String]
5914
+ #
5915
+ # @!attribute [rw] disabled
5916
+ # Indicates if the SIP rule is enabled or disabled. You must disable a
5917
+ # rule before you can delete it.
5918
+ # @return [Boolean]
5919
+ #
5920
+ # @!attribute [rw] trigger_type
5921
+ # The type of trigger whose value is assigned to the SIP rule in
5922
+ # `TriggerValue`.
5923
+ # @return [String]
5924
+ #
5925
+ # @!attribute [rw] trigger_value
5926
+ # If `TriggerType` is `RequestUriHostname`, then the value can be the
5927
+ # outbound host name of the Amazon Chime Voice Connector. If
5928
+ # `TriggerType` is `ToPhoneNumber`, then the value can be a
5929
+ # customer-owned phone number in E164 format. `SipRule` is triggered
5930
+ # when a SIP rule requests host name or `ToPhoneNumber` matches in the
5931
+ # incoming SIP request.
5932
+ # @return [String]
5933
+ #
5934
+ # @!attribute [rw] target_applications
5935
+ # List of SIP media applications with priority and AWS Region. You can
5936
+ # only use one SIP application per AWS Region and priority
5937
+ # combination.
5938
+ # @return [Array<Types::SipRuleTargetApplication>]
5939
+ #
5940
+ # @!attribute [rw] created_timestamp
5941
+ # The SIP rule created timestamp, in ISO 8601 format.
5942
+ # @return [Time]
5943
+ #
5944
+ # @!attribute [rw] updated_timestamp
5945
+ # The SIP rule updated timestamp, in ISO 8601 format.
5946
+ # @return [Time]
5947
+ #
5948
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/SipRule AWS API Documentation
5949
+ #
5950
+ class SipRule < Struct.new(
5951
+ :sip_rule_id,
5952
+ :name,
5953
+ :disabled,
5954
+ :trigger_type,
5955
+ :trigger_value,
5956
+ :target_applications,
5957
+ :created_timestamp,
5958
+ :updated_timestamp)
5959
+ SENSITIVE = []
5960
+ include Aws::Structure
5961
+ end
5962
+
5963
+ # Target SIP media application along with other details like priority
5964
+ # and AWS Region to be specified in the SIP rule. Only one SIP rule per
5965
+ # AWS Region can be provided.
5966
+ #
5967
+ # @note When making an API call, you may pass SipRuleTargetApplication
5968
+ # data as a hash:
5969
+ #
5970
+ # {
5971
+ # sip_media_application_id: "NonEmptyString",
5972
+ # priority: 1,
5973
+ # aws_region: "String",
5974
+ # }
5975
+ #
5976
+ # @!attribute [rw] sip_media_application_id
5977
+ # The SIP media application ID.
5978
+ # @return [String]
5979
+ #
5980
+ # @!attribute [rw] priority
5981
+ # Priority of the SIP media application in the target list.
5982
+ # @return [Integer]
5983
+ #
5984
+ # @!attribute [rw] aws_region
5985
+ # AWS Region of target application.
5986
+ # @return [String]
5987
+ #
5988
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/SipRuleTargetApplication AWS API Documentation
5989
+ #
5990
+ class SipRuleTargetApplication < Struct.new(
5991
+ :sip_media_application_id,
5992
+ :priority,
5993
+ :aws_region)
5994
+ SENSITIVE = []
5995
+ include Aws::Structure
5996
+ end
5997
+
5304
5998
  # The streaming configuration associated with an Amazon Chime Voice
5305
5999
  # Connector. Specifies whether media streaming is enabled for sending to
5306
6000
  # Amazon Kinesis, and shows the retention period for the Amazon Kinesis
@@ -5748,7 +6442,8 @@ module Aws::Chime
5748
6442
  end
5749
6443
 
5750
6444
  # @!attribute [rw] account
5751
- # The updated Amazon Chime account details.
6445
+ # The Amazon Chime account details. An AWS account can have multiple
6446
+ # Amazon Chime accounts.
5752
6447
  # @return [Types::Account]
5753
6448
  #
5754
6449
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateAccountResponse AWS API Documentation
@@ -6100,6 +6795,108 @@ module Aws::Chime
6100
6795
  include Aws::Structure
6101
6796
  end
6102
6797
 
6798
+ # @note When making an API call, you may pass UpdateSipMediaApplicationRequest
6799
+ # data as a hash:
6800
+ #
6801
+ # {
6802
+ # sip_media_application_id: "NonEmptyString", # required
6803
+ # name: "SipMediaApplicationName",
6804
+ # endpoints: [
6805
+ # {
6806
+ # lambda_arn: "FunctionArn",
6807
+ # },
6808
+ # ],
6809
+ # }
6810
+ #
6811
+ # @!attribute [rw] sip_media_application_id
6812
+ # The SIP media application ID.
6813
+ # @return [String]
6814
+ #
6815
+ # @!attribute [rw] name
6816
+ # The new name for the specified SIP media application.
6817
+ # @return [String]
6818
+ #
6819
+ # @!attribute [rw] endpoints
6820
+ # The new set of endpoints for the specified SIP media application.
6821
+ # @return [Array<Types::SipMediaApplicationEndpoint>]
6822
+ #
6823
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateSipMediaApplicationRequest AWS API Documentation
6824
+ #
6825
+ class UpdateSipMediaApplicationRequest < Struct.new(
6826
+ :sip_media_application_id,
6827
+ :name,
6828
+ :endpoints)
6829
+ SENSITIVE = []
6830
+ include Aws::Structure
6831
+ end
6832
+
6833
+ # @!attribute [rw] sip_media_application
6834
+ # The updated SIP media application details.
6835
+ # @return [Types::SipMediaApplication]
6836
+ #
6837
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateSipMediaApplicationResponse AWS API Documentation
6838
+ #
6839
+ class UpdateSipMediaApplicationResponse < Struct.new(
6840
+ :sip_media_application)
6841
+ SENSITIVE = []
6842
+ include Aws::Structure
6843
+ end
6844
+
6845
+ # @note When making an API call, you may pass UpdateSipRuleRequest
6846
+ # data as a hash:
6847
+ #
6848
+ # {
6849
+ # sip_rule_id: "NonEmptyString", # required
6850
+ # name: "SipRuleName", # required
6851
+ # disabled: false,
6852
+ # target_applications: [
6853
+ # {
6854
+ # sip_media_application_id: "NonEmptyString",
6855
+ # priority: 1,
6856
+ # aws_region: "String",
6857
+ # },
6858
+ # ],
6859
+ # }
6860
+ #
6861
+ # @!attribute [rw] sip_rule_id
6862
+ # The SIP rule ID.
6863
+ # @return [String]
6864
+ #
6865
+ # @!attribute [rw] name
6866
+ # The new name for the specified SIP rule.
6867
+ # @return [String]
6868
+ #
6869
+ # @!attribute [rw] disabled
6870
+ # The new value specified to indicate whether the rule is disabled.
6871
+ # @return [Boolean]
6872
+ #
6873
+ # @!attribute [rw] target_applications
6874
+ # The new value of the list of target applications.
6875
+ # @return [Array<Types::SipRuleTargetApplication>]
6876
+ #
6877
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateSipRuleRequest AWS API Documentation
6878
+ #
6879
+ class UpdateSipRuleRequest < Struct.new(
6880
+ :sip_rule_id,
6881
+ :name,
6882
+ :disabled,
6883
+ :target_applications)
6884
+ SENSITIVE = []
6885
+ include Aws::Structure
6886
+ end
6887
+
6888
+ # @!attribute [rw] sip_rule
6889
+ # Updated SIP rule details.
6890
+ # @return [Types::SipRule]
6891
+ #
6892
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateSipRuleResponse AWS API Documentation
6893
+ #
6894
+ class UpdateSipRuleResponse < Struct.new(
6895
+ :sip_rule)
6896
+ SENSITIVE = []
6897
+ include Aws::Structure
6898
+ end
6899
+
6103
6900
  # @note When making an API call, you may pass UpdateUserRequest
6104
6901
  # data as a hash:
6105
6902
  #