aws-sdk-chime 1.32.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.
- checksums.yaml +4 -4
- data/lib/aws-sdk-chime.rb +3 -2
- data/lib/aws-sdk-chime/client.rb +649 -33
- data/lib/aws-sdk-chime/client_api.rb +398 -0
- data/lib/aws-sdk-chime/types.rb +825 -26
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: cb0121ce4b6c0cf0719f98be1fae153a9cd719ee07bcc8cfc1f922699006a779
|
4
|
+
data.tar.gz: 1a701c61241e994d30c4f793d58d21640aed52808517bfe4bd971dca404559c4
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 365030f2f5fb7f50a44ed158afd782d6a234b5f01ccf21d5336cbcbd81356cbdb4d6e56ea32006353cff7225e6dcf211228ce04ae7d09163828c3e239ba50ff1
|
7
|
+
data.tar.gz: 43de0388fe82cdca12f872a5c14fa136db044a95b30fc730384bda98c429ce3f9233527b1448e3a6caeb6041202f467a84a14be89e12474a92d1676e32313e07
|
data/lib/aws-sdk-chime.rb
CHANGED
@@ -7,6 +7,7 @@
|
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
10
|
+
|
10
11
|
require 'aws-sdk-core'
|
11
12
|
require 'aws-sigv4'
|
12
13
|
|
@@ -44,9 +45,9 @@ require_relative 'aws-sdk-chime/customizations'
|
|
44
45
|
#
|
45
46
|
# See {Errors} for more information.
|
46
47
|
#
|
47
|
-
#
|
48
|
+
# @!group service
|
48
49
|
module Aws::Chime
|
49
50
|
|
50
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.38.0'
|
51
52
|
|
52
53
|
end
|
data/lib/aws-sdk-chime/client.rb
CHANGED
@@ -85,13 +85,28 @@ module Aws::Chime
|
|
85
85
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
86
86
|
# credentials.
|
87
87
|
#
|
88
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
89
|
+
# shared file, such as `~/.aws/config`.
|
90
|
+
#
|
91
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
92
|
+
#
|
93
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
94
|
+
# assume a role after providing credentials via the web.
|
95
|
+
#
|
96
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
97
|
+
# access token generated from `aws login`.
|
98
|
+
#
|
99
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
100
|
+
# process that outputs to stdout.
|
101
|
+
#
|
88
102
|
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
89
103
|
# from an EC2 IMDS on an EC2 instance.
|
90
104
|
#
|
91
|
-
# * `Aws::
|
92
|
-
#
|
105
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
106
|
+
# instances running in ECS.
|
93
107
|
#
|
94
|
-
# * `Aws::
|
108
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
109
|
+
# from the Cognito Identity service.
|
95
110
|
#
|
96
111
|
# When `:credentials` are not configured directly, the following
|
97
112
|
# locations will be searched for credentials:
|
@@ -101,10 +116,10 @@ module Aws::Chime
|
|
101
116
|
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
102
117
|
# * `~/.aws/credentials`
|
103
118
|
# * `~/.aws/config`
|
104
|
-
# * EC2 IMDS instance profile - When used by default, the timeouts
|
105
|
-
# very aggressive. Construct and pass an instance of
|
106
|
-
# `Aws::InstanceProfileCredentails`
|
107
|
-
# timeouts.
|
119
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
|
+
# are very aggressive. Construct and pass an instance of
|
121
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
+
# enable retries and extended timeouts.
|
108
123
|
#
|
109
124
|
# @option options [required, String] :region
|
110
125
|
# The AWS region to connect to. The configured `:region` is
|
@@ -373,7 +388,7 @@ module Aws::Chime
|
|
373
388
|
#
|
374
389
|
# resp.phone_number_errors #=> Array
|
375
390
|
# resp.phone_number_errors[0].phone_number_id #=> String
|
376
|
-
# resp.phone_number_errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
|
391
|
+
# resp.phone_number_errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Throttling", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
|
377
392
|
# resp.phone_number_errors[0].error_message #=> String
|
378
393
|
#
|
379
394
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/AssociatePhoneNumbersWithVoiceConnector AWS API Documentation
|
@@ -416,7 +431,7 @@ module Aws::Chime
|
|
416
431
|
#
|
417
432
|
# resp.phone_number_errors #=> Array
|
418
433
|
# resp.phone_number_errors[0].phone_number_id #=> String
|
419
|
-
# resp.phone_number_errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
|
434
|
+
# resp.phone_number_errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Throttling", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
|
420
435
|
# resp.phone_number_errors[0].error_message #=> String
|
421
436
|
#
|
422
437
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/AssociatePhoneNumbersWithVoiceConnectorGroup AWS API Documentation
|
@@ -550,7 +565,7 @@ module Aws::Chime
|
|
550
565
|
#
|
551
566
|
# resp.errors #=> Array
|
552
567
|
# resp.errors[0].member_id #=> String
|
553
|
-
# resp.errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
|
568
|
+
# resp.errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Throttling", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
|
554
569
|
# resp.errors[0].error_message #=> String
|
555
570
|
#
|
556
571
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchCreateRoomMembership AWS API Documentation
|
@@ -586,7 +601,7 @@ module Aws::Chime
|
|
586
601
|
#
|
587
602
|
# resp.phone_number_errors #=> Array
|
588
603
|
# resp.phone_number_errors[0].phone_number_id #=> String
|
589
|
-
# resp.phone_number_errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
|
604
|
+
# resp.phone_number_errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Throttling", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
|
590
605
|
# resp.phone_number_errors[0].error_message #=> String
|
591
606
|
#
|
592
607
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchDeletePhoneNumber AWS API Documentation
|
@@ -641,7 +656,7 @@ module Aws::Chime
|
|
641
656
|
#
|
642
657
|
# resp.user_errors #=> Array
|
643
658
|
# resp.user_errors[0].user_id #=> String
|
644
|
-
# resp.user_errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
|
659
|
+
# resp.user_errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Throttling", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
|
645
660
|
# resp.user_errors[0].error_message #=> String
|
646
661
|
#
|
647
662
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchSuspendUser AWS API Documentation
|
@@ -688,7 +703,7 @@ module Aws::Chime
|
|
688
703
|
#
|
689
704
|
# resp.user_errors #=> Array
|
690
705
|
# resp.user_errors[0].user_id #=> String
|
691
|
-
# resp.user_errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
|
706
|
+
# resp.user_errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Throttling", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
|
692
707
|
# resp.user_errors[0].error_message #=> String
|
693
708
|
#
|
694
709
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchUnsuspendUser AWS API Documentation
|
@@ -736,7 +751,7 @@ module Aws::Chime
|
|
736
751
|
#
|
737
752
|
# resp.phone_number_errors #=> Array
|
738
753
|
# resp.phone_number_errors[0].phone_number_id #=> String
|
739
|
-
# resp.phone_number_errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
|
754
|
+
# resp.phone_number_errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Throttling", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
|
740
755
|
# resp.phone_number_errors[0].error_message #=> String
|
741
756
|
#
|
742
757
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchUpdatePhoneNumber AWS API Documentation
|
@@ -783,7 +798,7 @@ module Aws::Chime
|
|
783
798
|
#
|
784
799
|
# resp.user_errors #=> Array
|
785
800
|
# resp.user_errors[0].user_id #=> String
|
786
|
-
# resp.user_errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
|
801
|
+
# resp.user_errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Throttling", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
|
787
802
|
# resp.user_errors[0].error_message #=> String
|
788
803
|
#
|
789
804
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchUpdateUser AWS API Documentation
|
@@ -852,8 +867,10 @@ module Aws::Chime
|
|
852
867
|
# The Amazon Chime SDK meeting ID.
|
853
868
|
#
|
854
869
|
# @option params [required, String] :external_user_id
|
855
|
-
# The Amazon Chime SDK external user ID.
|
856
|
-
# identity managed by a builder application.
|
870
|
+
# The Amazon Chime SDK external user ID. An idempotency token. Links the
|
871
|
+
# attendee to an identity managed by a builder application. If you
|
872
|
+
# create an attendee with the same external user id, the service returns
|
873
|
+
# the existing record.
|
857
874
|
#
|
858
875
|
# @option params [Array<Types::Tag>] :tags
|
859
876
|
# The tag key-value pairs.
|
@@ -961,10 +978,11 @@ module Aws::Chime
|
|
961
978
|
# @option params [String] :media_region
|
962
979
|
# The Region in which to create the meeting. Default: `us-east-1`.
|
963
980
|
#
|
964
|
-
# Available values: `ap-northeast-1`, `ap-
|
965
|
-
# `ap-
|
966
|
-
# `eu-
|
967
|
-
# `
|
981
|
+
# Available values: `af-south-1`, `ap-northeast-1`, `ap-northeast-2`,
|
982
|
+
# `ap-south-1`, `ap-southeast-1`, `ap-southeast-2`, `ca-central-1`,
|
983
|
+
# `eu-central-1`, `eu-north-1`, `eu-south-1`, `eu-west-1`, `eu-west-2`,
|
984
|
+
# `eu-west-3`, `sa-east-1`, `us-east-1`, `us-east-2`, `us-west-1`,
|
985
|
+
# `us-west-2`.
|
968
986
|
#
|
969
987
|
# @option params [Array<Types::Tag>] :tags
|
970
988
|
# The tag key-value pairs.
|
@@ -1018,6 +1036,66 @@ module Aws::Chime
|
|
1018
1036
|
req.send_request(options)
|
1019
1037
|
end
|
1020
1038
|
|
1039
|
+
# Uses the join token and call metadata in a meeting request (From
|
1040
|
+
# number, To number, and so forth) to initiate an outbound call to a
|
1041
|
+
# public switched telephone network (PSTN) and joins them into Chime
|
1042
|
+
# meeting. Also ensures that the From number belongs to the customer.
|
1043
|
+
#
|
1044
|
+
# To play welcome audio or implement an interactive voice response
|
1045
|
+
# (IVR), use the `CreateSipMediaApplicationCall` API with the
|
1046
|
+
# corresponding SIP media application ID.
|
1047
|
+
#
|
1048
|
+
# @option params [required, String] :meeting_id
|
1049
|
+
# The Amazon Chime SDK meeting ID.
|
1050
|
+
#
|
1051
|
+
# Type: String
|
1052
|
+
#
|
1053
|
+
# Pattern:
|
1054
|
+
# \[a-fA-F0-9\]\\\{8\\}(?:-\[a-fA-F0-9\]\\\{4\\})\\\{3\\}-\[a-fA-F0-9\]\\\{12\\}
|
1055
|
+
#
|
1056
|
+
# Required: No
|
1057
|
+
#
|
1058
|
+
# @option params [required, String] :from_phone_number
|
1059
|
+
# Phone number used as the caller ID when the remote party receives a
|
1060
|
+
# call.
|
1061
|
+
#
|
1062
|
+
# @option params [required, String] :to_phone_number
|
1063
|
+
# Phone number called when inviting someone to a meeting.
|
1064
|
+
#
|
1065
|
+
# @option params [required, String] :join_token
|
1066
|
+
# Token used by the Amazon Chime SDK attendee. Call the [ CreateAttendee
|
1067
|
+
# API][1] to get a join token.
|
1068
|
+
#
|
1069
|
+
#
|
1070
|
+
#
|
1071
|
+
# [1]: https://docs.aws.amazon.com/https:/docs.aws.amazon.com/chime/latest/APIReference/API_Attendee.html
|
1072
|
+
#
|
1073
|
+
# @return [Types::CreateMeetingDialOutResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1074
|
+
#
|
1075
|
+
# * {Types::CreateMeetingDialOutResponse#transaction_id #transaction_id} => String
|
1076
|
+
#
|
1077
|
+
# @example Request syntax with placeholder values
|
1078
|
+
#
|
1079
|
+
# resp = client.create_meeting_dial_out({
|
1080
|
+
# meeting_id: "GuidString", # required
|
1081
|
+
# from_phone_number: "E164PhoneNumber", # required
|
1082
|
+
# to_phone_number: "E164PhoneNumber", # required
|
1083
|
+
# join_token: "JoinTokenString", # required
|
1084
|
+
# })
|
1085
|
+
#
|
1086
|
+
# @example Response structure
|
1087
|
+
#
|
1088
|
+
# resp.transaction_id #=> String
|
1089
|
+
#
|
1090
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateMeetingDialOut AWS API Documentation
|
1091
|
+
#
|
1092
|
+
# @overload create_meeting_dial_out(params = {})
|
1093
|
+
# @param [Hash] params ({})
|
1094
|
+
def create_meeting_dial_out(params = {}, options = {})
|
1095
|
+
req = build_request(:create_meeting_dial_out, params)
|
1096
|
+
req.send_request(options)
|
1097
|
+
end
|
1098
|
+
|
1021
1099
|
# Creates a new Amazon Chime SDK meeting in the specified media Region,
|
1022
1100
|
# with attendees. For more information about specifying media Regions,
|
1023
1101
|
# see [Amazon Chime SDK Media Regions][1] in the *Amazon Chime Developer
|
@@ -1045,10 +1123,11 @@ module Aws::Chime
|
|
1045
1123
|
# @option params [String] :media_region
|
1046
1124
|
# The Region in which to create the meeting. Default: `us-east-1`.
|
1047
1125
|
#
|
1048
|
-
# Available values: `ap-northeast-1`, `ap-
|
1049
|
-
# `ap-
|
1050
|
-
# `eu-
|
1051
|
-
# `
|
1126
|
+
# Available values: `af-south-1`, `ap-northeast-1`, `ap-northeast-2`,
|
1127
|
+
# `ap-south-1`, `ap-southeast-1`, `ap-southeast-2`, `ca-central-1`,
|
1128
|
+
# `eu-central-1`, `eu-north-1`, `eu-south-1`, `eu-west-1`, `eu-west-2`,
|
1129
|
+
# `eu-west-3`, `sa-east-1`, `us-east-1`, `us-east-2`, `us-west-1`,
|
1130
|
+
# `us-west-2`.
|
1052
1131
|
#
|
1053
1132
|
# @option params [Array<Types::Tag>] :tags
|
1054
1133
|
# The tag key-value pairs.
|
@@ -1343,6 +1422,165 @@ module Aws::Chime
|
|
1343
1422
|
req.send_request(options)
|
1344
1423
|
end
|
1345
1424
|
|
1425
|
+
# Creates a SIP media application.
|
1426
|
+
#
|
1427
|
+
# @option params [required, String] :aws_region
|
1428
|
+
# AWS Region assigned to the SIP media application.
|
1429
|
+
#
|
1430
|
+
# @option params [String] :name
|
1431
|
+
# The SIP media application name.
|
1432
|
+
#
|
1433
|
+
# @option params [required, Array<Types::SipMediaApplicationEndpoint>] :endpoints
|
1434
|
+
# List of endpoints (Lambda Amazon Resource Names) specified for the SIP
|
1435
|
+
# media application. Currently, only one endpoint is supported.
|
1436
|
+
#
|
1437
|
+
# @return [Types::CreateSipMediaApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1438
|
+
#
|
1439
|
+
# * {Types::CreateSipMediaApplicationResponse#sip_media_application #sip_media_application} => Types::SipMediaApplication
|
1440
|
+
#
|
1441
|
+
# @example Request syntax with placeholder values
|
1442
|
+
#
|
1443
|
+
# resp = client.create_sip_media_application({
|
1444
|
+
# aws_region: "String", # required
|
1445
|
+
# name: "SipMediaApplicationName",
|
1446
|
+
# endpoints: [ # required
|
1447
|
+
# {
|
1448
|
+
# lambda_arn: "FunctionArn",
|
1449
|
+
# },
|
1450
|
+
# ],
|
1451
|
+
# })
|
1452
|
+
#
|
1453
|
+
# @example Response structure
|
1454
|
+
#
|
1455
|
+
# resp.sip_media_application.sip_media_application_id #=> String
|
1456
|
+
# resp.sip_media_application.aws_region #=> String
|
1457
|
+
# resp.sip_media_application.name #=> String
|
1458
|
+
# resp.sip_media_application.endpoints #=> Array
|
1459
|
+
# resp.sip_media_application.endpoints[0].lambda_arn #=> String
|
1460
|
+
# resp.sip_media_application.created_timestamp #=> Time
|
1461
|
+
# resp.sip_media_application.updated_timestamp #=> Time
|
1462
|
+
#
|
1463
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateSipMediaApplication AWS API Documentation
|
1464
|
+
#
|
1465
|
+
# @overload create_sip_media_application(params = {})
|
1466
|
+
# @param [Hash] params ({})
|
1467
|
+
def create_sip_media_application(params = {}, options = {})
|
1468
|
+
req = build_request(:create_sip_media_application, params)
|
1469
|
+
req.send_request(options)
|
1470
|
+
end
|
1471
|
+
|
1472
|
+
# Creates an outbound call to a phone number from the phone number
|
1473
|
+
# specified in the request, and it invokes the endpoint of the specified
|
1474
|
+
# `sipMediaApplicationId`.
|
1475
|
+
#
|
1476
|
+
# @option params [String] :from_phone_number
|
1477
|
+
# The phone number that a user calls from.
|
1478
|
+
#
|
1479
|
+
# @option params [String] :to_phone_number
|
1480
|
+
# The phone number that the user dials in order to connect to a meeting
|
1481
|
+
#
|
1482
|
+
# @option params [required, String] :sip_media_application_id
|
1483
|
+
# The ID of the SIP media application.
|
1484
|
+
#
|
1485
|
+
# @return [Types::CreateSipMediaApplicationCallResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1486
|
+
#
|
1487
|
+
# * {Types::CreateSipMediaApplicationCallResponse#sip_media_application_call #sip_media_application_call} => Types::SipMediaApplicationCall
|
1488
|
+
#
|
1489
|
+
# @example Request syntax with placeholder values
|
1490
|
+
#
|
1491
|
+
# resp = client.create_sip_media_application_call({
|
1492
|
+
# from_phone_number: "E164PhoneNumber",
|
1493
|
+
# to_phone_number: "E164PhoneNumber",
|
1494
|
+
# sip_media_application_id: "NonEmptyString", # required
|
1495
|
+
# })
|
1496
|
+
#
|
1497
|
+
# @example Response structure
|
1498
|
+
#
|
1499
|
+
# resp.sip_media_application_call.transaction_id #=> String
|
1500
|
+
#
|
1501
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateSipMediaApplicationCall AWS API Documentation
|
1502
|
+
#
|
1503
|
+
# @overload create_sip_media_application_call(params = {})
|
1504
|
+
# @param [Hash] params ({})
|
1505
|
+
def create_sip_media_application_call(params = {}, options = {})
|
1506
|
+
req = build_request(:create_sip_media_application_call, params)
|
1507
|
+
req.send_request(options)
|
1508
|
+
end
|
1509
|
+
|
1510
|
+
# Creates a SIP rule which can be used to run a SIP media application as
|
1511
|
+
# a target for a specific trigger type.
|
1512
|
+
#
|
1513
|
+
# @option params [required, String] :name
|
1514
|
+
# The name of the SIP rule.
|
1515
|
+
#
|
1516
|
+
# @option params [required, String] :trigger_type
|
1517
|
+
# The type of trigger whose value is assigned to the SIP rule in
|
1518
|
+
# `TriggerValue`. Allowed trigger values are `RequestUriHostname` and
|
1519
|
+
# `ToPhoneNumber`.
|
1520
|
+
#
|
1521
|
+
# @option params [required, String] :trigger_value
|
1522
|
+
# If `TriggerType` is `RequestUriHostname` then the value can be the
|
1523
|
+
# outbound host name of an Amazon Chime Voice Connector. If
|
1524
|
+
# `TriggerType` is `ToPhoneNumber` then the value can be a
|
1525
|
+
# customer-owned phone number in E164 format. `SipRule` is triggered if
|
1526
|
+
# the SIP application requests a host name, or a If `TriggerType` is
|
1527
|
+
# `RequestUriHostname`, then the value can be the outbound hostname of
|
1528
|
+
# an Amazon Chime Voice Connector. If `TriggerType` is `ToPhoneNumber`,
|
1529
|
+
# then the value can be a customer-owned phone number in E164 format.
|
1530
|
+
# `SipRule` is triggered if the SIP application requests a host name, or
|
1531
|
+
# a `ToPhoneNumber` value matches the incoming SIP request.
|
1532
|
+
#
|
1533
|
+
# @option params [Boolean] :disabled
|
1534
|
+
# Enables or disables a rule. You must disable rules before you can
|
1535
|
+
# delete them.
|
1536
|
+
#
|
1537
|
+
# @option params [required, Array<Types::SipRuleTargetApplication>] :target_applications
|
1538
|
+
# List of SIP media applications with priority and AWS Region. Only one
|
1539
|
+
# SIP application per AWS Region can be used.
|
1540
|
+
#
|
1541
|
+
# @return [Types::CreateSipRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1542
|
+
#
|
1543
|
+
# * {Types::CreateSipRuleResponse#sip_rule #sip_rule} => Types::SipRule
|
1544
|
+
#
|
1545
|
+
# @example Request syntax with placeholder values
|
1546
|
+
#
|
1547
|
+
# resp = client.create_sip_rule({
|
1548
|
+
# name: "SipRuleName", # required
|
1549
|
+
# trigger_type: "ToPhoneNumber", # required, accepts ToPhoneNumber, RequestUriHostname
|
1550
|
+
# trigger_value: "NonEmptyString", # required
|
1551
|
+
# disabled: false,
|
1552
|
+
# target_applications: [ # required
|
1553
|
+
# {
|
1554
|
+
# sip_media_application_id: "NonEmptyString",
|
1555
|
+
# priority: 1,
|
1556
|
+
# aws_region: "String",
|
1557
|
+
# },
|
1558
|
+
# ],
|
1559
|
+
# })
|
1560
|
+
#
|
1561
|
+
# @example Response structure
|
1562
|
+
#
|
1563
|
+
# resp.sip_rule.sip_rule_id #=> String
|
1564
|
+
# resp.sip_rule.name #=> String
|
1565
|
+
# resp.sip_rule.disabled #=> Boolean
|
1566
|
+
# resp.sip_rule.trigger_type #=> String, one of "ToPhoneNumber", "RequestUriHostname"
|
1567
|
+
# resp.sip_rule.trigger_value #=> String
|
1568
|
+
# resp.sip_rule.target_applications #=> Array
|
1569
|
+
# resp.sip_rule.target_applications[0].sip_media_application_id #=> String
|
1570
|
+
# resp.sip_rule.target_applications[0].priority #=> Integer
|
1571
|
+
# resp.sip_rule.target_applications[0].aws_region #=> String
|
1572
|
+
# resp.sip_rule.created_timestamp #=> Time
|
1573
|
+
# resp.sip_rule.updated_timestamp #=> Time
|
1574
|
+
#
|
1575
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateSipRule AWS API Documentation
|
1576
|
+
#
|
1577
|
+
# @overload create_sip_rule(params = {})
|
1578
|
+
# @param [Hash] params ({})
|
1579
|
+
def create_sip_rule(params = {}, options = {})
|
1580
|
+
req = build_request(:create_sip_rule, params)
|
1581
|
+
req.send_request(options)
|
1582
|
+
end
|
1583
|
+
|
1346
1584
|
# Creates a user under the specified Amazon Chime account.
|
1347
1585
|
#
|
1348
1586
|
# @option params [required, String] :account_id
|
@@ -1733,6 +1971,51 @@ module Aws::Chime
|
|
1733
1971
|
req.send_request(options)
|
1734
1972
|
end
|
1735
1973
|
|
1974
|
+
# Deletes a SIP media application.
|
1975
|
+
#
|
1976
|
+
# @option params [required, String] :sip_media_application_id
|
1977
|
+
# The SIP media application ID.
|
1978
|
+
#
|
1979
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1980
|
+
#
|
1981
|
+
# @example Request syntax with placeholder values
|
1982
|
+
#
|
1983
|
+
# resp = client.delete_sip_media_application({
|
1984
|
+
# sip_media_application_id: "NonEmptyString", # required
|
1985
|
+
# })
|
1986
|
+
#
|
1987
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteSipMediaApplication AWS API Documentation
|
1988
|
+
#
|
1989
|
+
# @overload delete_sip_media_application(params = {})
|
1990
|
+
# @param [Hash] params ({})
|
1991
|
+
def delete_sip_media_application(params = {}, options = {})
|
1992
|
+
req = build_request(:delete_sip_media_application, params)
|
1993
|
+
req.send_request(options)
|
1994
|
+
end
|
1995
|
+
|
1996
|
+
# Deletes a SIP rule. You must disable a SIP rule before you can delete
|
1997
|
+
# it.
|
1998
|
+
#
|
1999
|
+
# @option params [required, String] :sip_rule_id
|
2000
|
+
# The SIP rule ID.
|
2001
|
+
#
|
2002
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2003
|
+
#
|
2004
|
+
# @example Request syntax with placeholder values
|
2005
|
+
#
|
2006
|
+
# resp = client.delete_sip_rule({
|
2007
|
+
# sip_rule_id: "NonEmptyString", # required
|
2008
|
+
# })
|
2009
|
+
#
|
2010
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteSipRule AWS API Documentation
|
2011
|
+
#
|
2012
|
+
# @overload delete_sip_rule(params = {})
|
2013
|
+
# @param [Hash] params ({})
|
2014
|
+
def delete_sip_rule(params = {}, options = {})
|
2015
|
+
req = build_request(:delete_sip_rule, params)
|
2016
|
+
req.send_request(options)
|
2017
|
+
end
|
2018
|
+
|
1736
2019
|
# Deletes the specified Amazon Chime Voice Connector. Any phone numbers
|
1737
2020
|
# associated with the Amazon Chime Voice Connector must be disassociated
|
1738
2021
|
# from it before it can be deleted.
|
@@ -1987,7 +2270,7 @@ module Aws::Chime
|
|
1987
2270
|
#
|
1988
2271
|
# resp.phone_number_errors #=> Array
|
1989
2272
|
# resp.phone_number_errors[0].phone_number_id #=> String
|
1990
|
-
# resp.phone_number_errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
|
2273
|
+
# resp.phone_number_errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Throttling", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
|
1991
2274
|
# resp.phone_number_errors[0].error_message #=> String
|
1992
2275
|
#
|
1993
2276
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DisassociatePhoneNumbersFromVoiceConnector AWS API Documentation
|
@@ -2023,7 +2306,7 @@ module Aws::Chime
|
|
2023
2306
|
#
|
2024
2307
|
# resp.phone_number_errors #=> Array
|
2025
2308
|
# resp.phone_number_errors[0].phone_number_id #=> String
|
2026
|
-
# resp.phone_number_errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
|
2309
|
+
# resp.phone_number_errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Throttling", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
|
2027
2310
|
# resp.phone_number_errors[0].error_message #=> String
|
2028
2311
|
#
|
2029
2312
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DisassociatePhoneNumbersFromVoiceConnectorGroup AWS API Documentation
|
@@ -2349,7 +2632,7 @@ module Aws::Chime
|
|
2349
2632
|
# resp.phone_number.capabilities.outbound_mms #=> Boolean
|
2350
2633
|
# resp.phone_number.associations #=> Array
|
2351
2634
|
# resp.phone_number.associations[0].value #=> String
|
2352
|
-
# resp.phone_number.associations[0].name #=> String, one of "AccountId", "UserId", "VoiceConnectorId", "VoiceConnectorGroupId"
|
2635
|
+
# resp.phone_number.associations[0].name #=> String, one of "AccountId", "UserId", "VoiceConnectorId", "VoiceConnectorGroupId", "SipRuleId"
|
2353
2636
|
# resp.phone_number.associations[0].associated_timestamp #=> Time
|
2354
2637
|
# resp.phone_number.calling_name #=> String
|
2355
2638
|
# resp.phone_number.calling_name_status #=> String, one of "Unassigned", "UpdateInProgress", "UpdateSucceeded", "UpdateFailed"
|
@@ -2550,6 +2833,109 @@ module Aws::Chime
|
|
2550
2833
|
req.send_request(options)
|
2551
2834
|
end
|
2552
2835
|
|
2836
|
+
# Retrieves the information for a SIP media application, including name,
|
2837
|
+
# AWS Region, and endpoints.
|
2838
|
+
#
|
2839
|
+
# @option params [required, String] :sip_media_application_id
|
2840
|
+
# The SIP media application ID.
|
2841
|
+
#
|
2842
|
+
# @return [Types::GetSipMediaApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2843
|
+
#
|
2844
|
+
# * {Types::GetSipMediaApplicationResponse#sip_media_application #sip_media_application} => Types::SipMediaApplication
|
2845
|
+
#
|
2846
|
+
# @example Request syntax with placeholder values
|
2847
|
+
#
|
2848
|
+
# resp = client.get_sip_media_application({
|
2849
|
+
# sip_media_application_id: "NonEmptyString", # required
|
2850
|
+
# })
|
2851
|
+
#
|
2852
|
+
# @example Response structure
|
2853
|
+
#
|
2854
|
+
# resp.sip_media_application.sip_media_application_id #=> String
|
2855
|
+
# resp.sip_media_application.aws_region #=> String
|
2856
|
+
# resp.sip_media_application.name #=> String
|
2857
|
+
# resp.sip_media_application.endpoints #=> Array
|
2858
|
+
# resp.sip_media_application.endpoints[0].lambda_arn #=> String
|
2859
|
+
# resp.sip_media_application.created_timestamp #=> Time
|
2860
|
+
# resp.sip_media_application.updated_timestamp #=> Time
|
2861
|
+
#
|
2862
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetSipMediaApplication AWS API Documentation
|
2863
|
+
#
|
2864
|
+
# @overload get_sip_media_application(params = {})
|
2865
|
+
# @param [Hash] params ({})
|
2866
|
+
def get_sip_media_application(params = {}, options = {})
|
2867
|
+
req = build_request(:get_sip_media_application, params)
|
2868
|
+
req.send_request(options)
|
2869
|
+
end
|
2870
|
+
|
2871
|
+
# Returns the logging configuration for the specified SIP media
|
2872
|
+
# application.
|
2873
|
+
#
|
2874
|
+
# @option params [required, String] :sip_media_application_id
|
2875
|
+
# The ID of the SIP media application.
|
2876
|
+
#
|
2877
|
+
# @return [Types::GetSipMediaApplicationLoggingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2878
|
+
#
|
2879
|
+
# * {Types::GetSipMediaApplicationLoggingConfigurationResponse#sip_media_application_logging_configuration #sip_media_application_logging_configuration} => Types::SipMediaApplicationLoggingConfiguration
|
2880
|
+
#
|
2881
|
+
# @example Request syntax with placeholder values
|
2882
|
+
#
|
2883
|
+
# resp = client.get_sip_media_application_logging_configuration({
|
2884
|
+
# sip_media_application_id: "NonEmptyString", # required
|
2885
|
+
# })
|
2886
|
+
#
|
2887
|
+
# @example Response structure
|
2888
|
+
#
|
2889
|
+
# resp.sip_media_application_logging_configuration.enable_sip_media_application_message_logs #=> Boolean
|
2890
|
+
#
|
2891
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetSipMediaApplicationLoggingConfiguration AWS API Documentation
|
2892
|
+
#
|
2893
|
+
# @overload get_sip_media_application_logging_configuration(params = {})
|
2894
|
+
# @param [Hash] params ({})
|
2895
|
+
def get_sip_media_application_logging_configuration(params = {}, options = {})
|
2896
|
+
req = build_request(:get_sip_media_application_logging_configuration, params)
|
2897
|
+
req.send_request(options)
|
2898
|
+
end
|
2899
|
+
|
2900
|
+
# Retrieves the details of a SIP rule, such as the rule ID, name,
|
2901
|
+
# triggers, and target endpoints.
|
2902
|
+
#
|
2903
|
+
# @option params [required, String] :sip_rule_id
|
2904
|
+
# The SIP rule ID.
|
2905
|
+
#
|
2906
|
+
# @return [Types::GetSipRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2907
|
+
#
|
2908
|
+
# * {Types::GetSipRuleResponse#sip_rule #sip_rule} => Types::SipRule
|
2909
|
+
#
|
2910
|
+
# @example Request syntax with placeholder values
|
2911
|
+
#
|
2912
|
+
# resp = client.get_sip_rule({
|
2913
|
+
# sip_rule_id: "NonEmptyString", # required
|
2914
|
+
# })
|
2915
|
+
#
|
2916
|
+
# @example Response structure
|
2917
|
+
#
|
2918
|
+
# resp.sip_rule.sip_rule_id #=> String
|
2919
|
+
# resp.sip_rule.name #=> String
|
2920
|
+
# resp.sip_rule.disabled #=> Boolean
|
2921
|
+
# resp.sip_rule.trigger_type #=> String, one of "ToPhoneNumber", "RequestUriHostname"
|
2922
|
+
# resp.sip_rule.trigger_value #=> String
|
2923
|
+
# resp.sip_rule.target_applications #=> Array
|
2924
|
+
# resp.sip_rule.target_applications[0].sip_media_application_id #=> String
|
2925
|
+
# resp.sip_rule.target_applications[0].priority #=> Integer
|
2926
|
+
# resp.sip_rule.target_applications[0].aws_region #=> String
|
2927
|
+
# resp.sip_rule.created_timestamp #=> Time
|
2928
|
+
# resp.sip_rule.updated_timestamp #=> Time
|
2929
|
+
#
|
2930
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetSipRule AWS API Documentation
|
2931
|
+
#
|
2932
|
+
# @overload get_sip_rule(params = {})
|
2933
|
+
# @param [Hash] params ({})
|
2934
|
+
def get_sip_rule(params = {}, options = {})
|
2935
|
+
req = build_request(:get_sip_rule, params)
|
2936
|
+
req.send_request(options)
|
2937
|
+
end
|
2938
|
+
|
2553
2939
|
# Retrieves details for the specified user ID, such as primary email
|
2554
2940
|
# address, license type, and personal meeting PIN.
|
2555
2941
|
#
|
@@ -3329,7 +3715,7 @@ module Aws::Chime
|
|
3329
3715
|
# resp = client.list_phone_numbers({
|
3330
3716
|
# status: "AcquireInProgress", # accepts AcquireInProgress, AcquireFailed, Unassigned, Assigned, ReleaseInProgress, DeleteInProgress, ReleaseFailed, DeleteFailed
|
3331
3717
|
# product_type: "BusinessCalling", # accepts BusinessCalling, VoiceConnector
|
3332
|
-
# filter_name: "AccountId", # accepts AccountId, UserId, VoiceConnectorId, VoiceConnectorGroupId
|
3718
|
+
# filter_name: "AccountId", # accepts AccountId, UserId, VoiceConnectorId, VoiceConnectorGroupId, SipRuleId
|
3333
3719
|
# filter_value: "String",
|
3334
3720
|
# max_results: 1,
|
3335
3721
|
# next_token: "String",
|
@@ -3351,7 +3737,7 @@ module Aws::Chime
|
|
3351
3737
|
# resp.phone_numbers[0].capabilities.outbound_mms #=> Boolean
|
3352
3738
|
# resp.phone_numbers[0].associations #=> Array
|
3353
3739
|
# resp.phone_numbers[0].associations[0].value #=> String
|
3354
|
-
# resp.phone_numbers[0].associations[0].name #=> String, one of "AccountId", "UserId", "VoiceConnectorId", "VoiceConnectorGroupId"
|
3740
|
+
# resp.phone_numbers[0].associations[0].name #=> String, one of "AccountId", "UserId", "VoiceConnectorId", "VoiceConnectorGroupId", "SipRuleId"
|
3355
3741
|
# resp.phone_numbers[0].associations[0].associated_timestamp #=> Time
|
3356
3742
|
# resp.phone_numbers[0].calling_name #=> String
|
3357
3743
|
# resp.phone_numbers[0].calling_name_status #=> String, one of "Unassigned", "UpdateInProgress", "UpdateSucceeded", "UpdateFailed"
|
@@ -3538,6 +3924,99 @@ module Aws::Chime
|
|
3538
3924
|
req.send_request(options)
|
3539
3925
|
end
|
3540
3926
|
|
3927
|
+
# Lists the SIP media applications under the administrator's AWS
|
3928
|
+
# account.
|
3929
|
+
#
|
3930
|
+
# @option params [Integer] :max_results
|
3931
|
+
# The maximum number of results to return in a single call. Defaults to
|
3932
|
+
# 100.
|
3933
|
+
#
|
3934
|
+
# @option params [String] :next_token
|
3935
|
+
# The token to use to retrieve the next page of results.
|
3936
|
+
#
|
3937
|
+
# @return [Types::ListSipMediaApplicationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3938
|
+
#
|
3939
|
+
# * {Types::ListSipMediaApplicationsResponse#sip_media_applications #sip_media_applications} => Array<Types::SipMediaApplication>
|
3940
|
+
# * {Types::ListSipMediaApplicationsResponse#next_token #next_token} => String
|
3941
|
+
#
|
3942
|
+
# @example Request syntax with placeholder values
|
3943
|
+
#
|
3944
|
+
# resp = client.list_sip_media_applications({
|
3945
|
+
# max_results: 1,
|
3946
|
+
# next_token: "NextTokenString",
|
3947
|
+
# })
|
3948
|
+
#
|
3949
|
+
# @example Response structure
|
3950
|
+
#
|
3951
|
+
# resp.sip_media_applications #=> Array
|
3952
|
+
# resp.sip_media_applications[0].sip_media_application_id #=> String
|
3953
|
+
# resp.sip_media_applications[0].aws_region #=> String
|
3954
|
+
# resp.sip_media_applications[0].name #=> String
|
3955
|
+
# resp.sip_media_applications[0].endpoints #=> Array
|
3956
|
+
# resp.sip_media_applications[0].endpoints[0].lambda_arn #=> String
|
3957
|
+
# resp.sip_media_applications[0].created_timestamp #=> Time
|
3958
|
+
# resp.sip_media_applications[0].updated_timestamp #=> Time
|
3959
|
+
# resp.next_token #=> String
|
3960
|
+
#
|
3961
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListSipMediaApplications AWS API Documentation
|
3962
|
+
#
|
3963
|
+
# @overload list_sip_media_applications(params = {})
|
3964
|
+
# @param [Hash] params ({})
|
3965
|
+
def list_sip_media_applications(params = {}, options = {})
|
3966
|
+
req = build_request(:list_sip_media_applications, params)
|
3967
|
+
req.send_request(options)
|
3968
|
+
end
|
3969
|
+
|
3970
|
+
# Lists the SIP rules under the administrator's AWS account.
|
3971
|
+
#
|
3972
|
+
# @option params [String] :sip_media_application_id
|
3973
|
+
# The SIP media application ID.
|
3974
|
+
#
|
3975
|
+
# @option params [Integer] :max_results
|
3976
|
+
# The maximum number of results to return in a single call. Defaults to
|
3977
|
+
# 100.
|
3978
|
+
#
|
3979
|
+
# @option params [String] :next_token
|
3980
|
+
# The token to use to retrieve the next page of results.
|
3981
|
+
#
|
3982
|
+
# @return [Types::ListSipRulesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3983
|
+
#
|
3984
|
+
# * {Types::ListSipRulesResponse#sip_rules #sip_rules} => Array<Types::SipRule>
|
3985
|
+
# * {Types::ListSipRulesResponse#next_token #next_token} => String
|
3986
|
+
#
|
3987
|
+
# @example Request syntax with placeholder values
|
3988
|
+
#
|
3989
|
+
# resp = client.list_sip_rules({
|
3990
|
+
# sip_media_application_id: "NonEmptyString",
|
3991
|
+
# max_results: 1,
|
3992
|
+
# next_token: "NextTokenString",
|
3993
|
+
# })
|
3994
|
+
#
|
3995
|
+
# @example Response structure
|
3996
|
+
#
|
3997
|
+
# resp.sip_rules #=> Array
|
3998
|
+
# resp.sip_rules[0].sip_rule_id #=> String
|
3999
|
+
# resp.sip_rules[0].name #=> String
|
4000
|
+
# resp.sip_rules[0].disabled #=> Boolean
|
4001
|
+
# resp.sip_rules[0].trigger_type #=> String, one of "ToPhoneNumber", "RequestUriHostname"
|
4002
|
+
# resp.sip_rules[0].trigger_value #=> String
|
4003
|
+
# resp.sip_rules[0].target_applications #=> Array
|
4004
|
+
# resp.sip_rules[0].target_applications[0].sip_media_application_id #=> String
|
4005
|
+
# resp.sip_rules[0].target_applications[0].priority #=> Integer
|
4006
|
+
# resp.sip_rules[0].target_applications[0].aws_region #=> String
|
4007
|
+
# resp.sip_rules[0].created_timestamp #=> Time
|
4008
|
+
# resp.sip_rules[0].updated_timestamp #=> Time
|
4009
|
+
# resp.next_token #=> String
|
4010
|
+
#
|
4011
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListSipRules AWS API Documentation
|
4012
|
+
#
|
4013
|
+
# @overload list_sip_rules(params = {})
|
4014
|
+
# @param [Hash] params ({})
|
4015
|
+
def list_sip_rules(params = {}, options = {})
|
4016
|
+
req = build_request(:list_sip_rules, params)
|
4017
|
+
req.send_request(options)
|
4018
|
+
end
|
4019
|
+
|
3541
4020
|
# Lists the tags applied to an Amazon Chime SDK meeting resource.
|
3542
4021
|
#
|
3543
4022
|
# @option params [required, String] :resource_arn
|
@@ -3879,6 +4358,41 @@ module Aws::Chime
|
|
3879
4358
|
req.send_request(options)
|
3880
4359
|
end
|
3881
4360
|
|
4361
|
+
# Updates the logging configuration for the specified SIP media
|
4362
|
+
# application.
|
4363
|
+
#
|
4364
|
+
# @option params [required, String] :sip_media_application_id
|
4365
|
+
# The ID of the specified SIP media application
|
4366
|
+
#
|
4367
|
+
# @option params [Types::SipMediaApplicationLoggingConfiguration] :sip_media_application_logging_configuration
|
4368
|
+
# The actual logging configuration.
|
4369
|
+
#
|
4370
|
+
# @return [Types::PutSipMediaApplicationLoggingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4371
|
+
#
|
4372
|
+
# * {Types::PutSipMediaApplicationLoggingConfigurationResponse#sip_media_application_logging_configuration #sip_media_application_logging_configuration} => Types::SipMediaApplicationLoggingConfiguration
|
4373
|
+
#
|
4374
|
+
# @example Request syntax with placeholder values
|
4375
|
+
#
|
4376
|
+
# resp = client.put_sip_media_application_logging_configuration({
|
4377
|
+
# sip_media_application_id: "NonEmptyString", # required
|
4378
|
+
# sip_media_application_logging_configuration: {
|
4379
|
+
# enable_sip_media_application_message_logs: false,
|
4380
|
+
# },
|
4381
|
+
# })
|
4382
|
+
#
|
4383
|
+
# @example Response structure
|
4384
|
+
#
|
4385
|
+
# resp.sip_media_application_logging_configuration.enable_sip_media_application_message_logs #=> Boolean
|
4386
|
+
#
|
4387
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/PutSipMediaApplicationLoggingConfiguration AWS API Documentation
|
4388
|
+
#
|
4389
|
+
# @overload put_sip_media_application_logging_configuration(params = {})
|
4390
|
+
# @param [Hash] params ({})
|
4391
|
+
def put_sip_media_application_logging_configuration(params = {}, options = {})
|
4392
|
+
req = build_request(:put_sip_media_application_logging_configuration, params)
|
4393
|
+
req.send_request(options)
|
4394
|
+
end
|
4395
|
+
|
3882
4396
|
# Puts emergency calling configuration details to the specified Amazon
|
3883
4397
|
# Chime Voice Connector, such as emergency phone numbers and calling
|
3884
4398
|
# countries. Origination and termination settings must be enabled for
|
@@ -4377,7 +4891,7 @@ module Aws::Chime
|
|
4377
4891
|
# resp.phone_number.capabilities.outbound_mms #=> Boolean
|
4378
4892
|
# resp.phone_number.associations #=> Array
|
4379
4893
|
# resp.phone_number.associations[0].value #=> String
|
4380
|
-
# resp.phone_number.associations[0].name #=> String, one of "AccountId", "UserId", "VoiceConnectorId", "VoiceConnectorGroupId"
|
4894
|
+
# resp.phone_number.associations[0].name #=> String, one of "AccountId", "UserId", "VoiceConnectorId", "VoiceConnectorGroupId", "SipRuleId"
|
4381
4895
|
# resp.phone_number.associations[0].associated_timestamp #=> Time
|
4382
4896
|
# resp.phone_number.calling_name #=> String
|
4383
4897
|
# resp.phone_number.calling_name_status #=> String, one of "Unassigned", "UpdateInProgress", "UpdateSucceeded", "UpdateFailed"
|
@@ -4832,7 +5346,7 @@ module Aws::Chime
|
|
4832
5346
|
# resp.phone_number.capabilities.outbound_mms #=> Boolean
|
4833
5347
|
# resp.phone_number.associations #=> Array
|
4834
5348
|
# resp.phone_number.associations[0].value #=> String
|
4835
|
-
# resp.phone_number.associations[0].name #=> String, one of "AccountId", "UserId", "VoiceConnectorId", "VoiceConnectorGroupId"
|
5349
|
+
# resp.phone_number.associations[0].name #=> String, one of "AccountId", "UserId", "VoiceConnectorId", "VoiceConnectorGroupId", "SipRuleId"
|
4836
5350
|
# resp.phone_number.associations[0].associated_timestamp #=> Time
|
4837
5351
|
# resp.phone_number.calling_name #=> String
|
4838
5352
|
# resp.phone_number.calling_name_status #=> String, one of "Unassigned", "UpdateInProgress", "UpdateSucceeded", "UpdateFailed"
|
@@ -5024,6 +5538,108 @@ module Aws::Chime
|
|
5024
5538
|
req.send_request(options)
|
5025
5539
|
end
|
5026
5540
|
|
5541
|
+
# Updates the details for the specified SIP media application.
|
5542
|
+
#
|
5543
|
+
# @option params [required, String] :sip_media_application_id
|
5544
|
+
# The SIP media application ID.
|
5545
|
+
#
|
5546
|
+
# @option params [String] :name
|
5547
|
+
# The new name for the specified SIP media application.
|
5548
|
+
#
|
5549
|
+
# @option params [Array<Types::SipMediaApplicationEndpoint>] :endpoints
|
5550
|
+
# The new set of endpoints for the specified SIP media application.
|
5551
|
+
#
|
5552
|
+
# @return [Types::UpdateSipMediaApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5553
|
+
#
|
5554
|
+
# * {Types::UpdateSipMediaApplicationResponse#sip_media_application #sip_media_application} => Types::SipMediaApplication
|
5555
|
+
#
|
5556
|
+
# @example Request syntax with placeholder values
|
5557
|
+
#
|
5558
|
+
# resp = client.update_sip_media_application({
|
5559
|
+
# sip_media_application_id: "NonEmptyString", # required
|
5560
|
+
# name: "SipMediaApplicationName",
|
5561
|
+
# endpoints: [
|
5562
|
+
# {
|
5563
|
+
# lambda_arn: "FunctionArn",
|
5564
|
+
# },
|
5565
|
+
# ],
|
5566
|
+
# })
|
5567
|
+
#
|
5568
|
+
# @example Response structure
|
5569
|
+
#
|
5570
|
+
# resp.sip_media_application.sip_media_application_id #=> String
|
5571
|
+
# resp.sip_media_application.aws_region #=> String
|
5572
|
+
# resp.sip_media_application.name #=> String
|
5573
|
+
# resp.sip_media_application.endpoints #=> Array
|
5574
|
+
# resp.sip_media_application.endpoints[0].lambda_arn #=> String
|
5575
|
+
# resp.sip_media_application.created_timestamp #=> Time
|
5576
|
+
# resp.sip_media_application.updated_timestamp #=> Time
|
5577
|
+
#
|
5578
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateSipMediaApplication AWS API Documentation
|
5579
|
+
#
|
5580
|
+
# @overload update_sip_media_application(params = {})
|
5581
|
+
# @param [Hash] params ({})
|
5582
|
+
def update_sip_media_application(params = {}, options = {})
|
5583
|
+
req = build_request(:update_sip_media_application, params)
|
5584
|
+
req.send_request(options)
|
5585
|
+
end
|
5586
|
+
|
5587
|
+
# Updates the details for the specified SIP rule.
|
5588
|
+
#
|
5589
|
+
# @option params [required, String] :sip_rule_id
|
5590
|
+
# The SIP rule ID.
|
5591
|
+
#
|
5592
|
+
# @option params [required, String] :name
|
5593
|
+
# The new name for the specified SIP rule.
|
5594
|
+
#
|
5595
|
+
# @option params [Boolean] :disabled
|
5596
|
+
# The new value specified to indicate whether the rule is disabled.
|
5597
|
+
#
|
5598
|
+
# @option params [Array<Types::SipRuleTargetApplication>] :target_applications
|
5599
|
+
# The new value of the list of target applications.
|
5600
|
+
#
|
5601
|
+
# @return [Types::UpdateSipRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5602
|
+
#
|
5603
|
+
# * {Types::UpdateSipRuleResponse#sip_rule #sip_rule} => Types::SipRule
|
5604
|
+
#
|
5605
|
+
# @example Request syntax with placeholder values
|
5606
|
+
#
|
5607
|
+
# resp = client.update_sip_rule({
|
5608
|
+
# sip_rule_id: "NonEmptyString", # required
|
5609
|
+
# name: "SipRuleName", # required
|
5610
|
+
# disabled: false,
|
5611
|
+
# target_applications: [
|
5612
|
+
# {
|
5613
|
+
# sip_media_application_id: "NonEmptyString",
|
5614
|
+
# priority: 1,
|
5615
|
+
# aws_region: "String",
|
5616
|
+
# },
|
5617
|
+
# ],
|
5618
|
+
# })
|
5619
|
+
#
|
5620
|
+
# @example Response structure
|
5621
|
+
#
|
5622
|
+
# resp.sip_rule.sip_rule_id #=> String
|
5623
|
+
# resp.sip_rule.name #=> String
|
5624
|
+
# resp.sip_rule.disabled #=> Boolean
|
5625
|
+
# resp.sip_rule.trigger_type #=> String, one of "ToPhoneNumber", "RequestUriHostname"
|
5626
|
+
# resp.sip_rule.trigger_value #=> String
|
5627
|
+
# resp.sip_rule.target_applications #=> Array
|
5628
|
+
# resp.sip_rule.target_applications[0].sip_media_application_id #=> String
|
5629
|
+
# resp.sip_rule.target_applications[0].priority #=> Integer
|
5630
|
+
# resp.sip_rule.target_applications[0].aws_region #=> String
|
5631
|
+
# resp.sip_rule.created_timestamp #=> Time
|
5632
|
+
# resp.sip_rule.updated_timestamp #=> Time
|
5633
|
+
#
|
5634
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateSipRule AWS API Documentation
|
5635
|
+
#
|
5636
|
+
# @overload update_sip_rule(params = {})
|
5637
|
+
# @param [Hash] params ({})
|
5638
|
+
def update_sip_rule(params = {}, options = {})
|
5639
|
+
req = build_request(:update_sip_rule, params)
|
5640
|
+
req.send_request(options)
|
5641
|
+
end
|
5642
|
+
|
5027
5643
|
# Updates user details for a specified user ID. Currently, only
|
5028
5644
|
# `LicenseType` updates are supported for this action.
|
5029
5645
|
#
|
@@ -5227,7 +5843,7 @@ module Aws::Chime
|
|
5227
5843
|
params: params,
|
5228
5844
|
config: config)
|
5229
5845
|
context[:gem_name] = 'aws-sdk-chime'
|
5230
|
-
context[:gem_version] = '1.
|
5846
|
+
context[:gem_version] = '1.38.0'
|
5231
5847
|
Seahorse::Client::Request.new(handlers, context)
|
5232
5848
|
end
|
5233
5849
|
|