aws-sdk-chime 1.16.0 → 1.17.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.
@@ -241,6 +241,38 @@ module Aws::Chime
241
241
  include Aws::Structure
242
242
  end
243
243
 
244
+ # An Amazon Chime SDK meeting attendee. Includes a unique `AttendeeId`
245
+ # and `JoinToken`. The `JoinToken` allows a client to authenticate and
246
+ # join as the specified attendee. The `JoinToken` expires when the
247
+ # meeting ends or when DeleteAttendee is called. After that, the
248
+ # attendee is unable to join the meeting.
249
+ #
250
+ # We recommend securely transferring each `JoinToken` from your server
251
+ # application to the client so that no other client has access to the
252
+ # token except for the one authorized to represent the attendee.
253
+ #
254
+ # @!attribute [rw] external_user_id
255
+ # The Amazon Chime SDK external user ID. Links the attendee to an
256
+ # identity managed by a builder application.
257
+ # @return [String]
258
+ #
259
+ # @!attribute [rw] attendee_id
260
+ # The Amazon Chime SDK attendee ID.
261
+ # @return [String]
262
+ #
263
+ # @!attribute [rw] join_token
264
+ # The join token used by the Amazon Chime SDK attendee.
265
+ # @return [String]
266
+ #
267
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/Attendee AWS API Documentation
268
+ #
269
+ class Attendee < Struct.new(
270
+ :external_user_id,
271
+ :attendee_id,
272
+ :join_token)
273
+ include Aws::Structure
274
+ end
275
+
244
276
  # The input parameters don't match the service's restrictions.
245
277
  #
246
278
  # @!attribute [rw] code
@@ -257,6 +289,52 @@ module Aws::Chime
257
289
  include Aws::Structure
258
290
  end
259
291
 
292
+ # @note When making an API call, you may pass BatchCreateAttendeeRequest
293
+ # data as a hash:
294
+ #
295
+ # {
296
+ # meeting_id: "GuidString", # required
297
+ # attendees: [ # required
298
+ # {
299
+ # external_user_id: "ExternalUserIdType", # required
300
+ # },
301
+ # ],
302
+ # }
303
+ #
304
+ # @!attribute [rw] meeting_id
305
+ # The Amazon Chime SDK meeting ID.
306
+ # @return [String]
307
+ #
308
+ # @!attribute [rw] attendees
309
+ # The request containing the attendees to create.
310
+ # @return [Array<Types::CreateAttendeeRequestItem>]
311
+ #
312
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchCreateAttendeeRequest AWS API Documentation
313
+ #
314
+ class BatchCreateAttendeeRequest < Struct.new(
315
+ :meeting_id,
316
+ :attendees)
317
+ include Aws::Structure
318
+ end
319
+
320
+ # @!attribute [rw] attendees
321
+ # The attendee information, including attendees IDs and join tokens.
322
+ # @return [Array<Types::Attendee>]
323
+ #
324
+ # @!attribute [rw] errors
325
+ # If the action fails for one or more of the attendees in the request,
326
+ # a list of the attendees is returned, along with error codes and
327
+ # error messages.
328
+ # @return [Array<Types::CreateAttendeeError>]
329
+ #
330
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchCreateAttendeeResponse AWS API Documentation
331
+ #
332
+ class BatchCreateAttendeeResponse < Struct.new(
333
+ :attendees,
334
+ :errors)
335
+ include Aws::Structure
336
+ end
337
+
260
338
  # @note When making an API call, you may pass BatchCreateRoomMembershipRequest
261
339
  # data as a hash:
262
340
  #
@@ -613,6 +691,90 @@ module Aws::Chime
613
691
  include Aws::Structure
614
692
  end
615
693
 
694
+ # The list of errors returned when errors are encountered during the
695
+ # BatchCreateAttendee and CreateAttendee actions. This includes external
696
+ # user IDs, error codes, and error messages.
697
+ #
698
+ # @!attribute [rw] external_user_id
699
+ # The Amazon Chime SDK external user ID. Links the attendee to an
700
+ # identity managed by a builder application.
701
+ # @return [String]
702
+ #
703
+ # @!attribute [rw] error_code
704
+ # The error code.
705
+ # @return [String]
706
+ #
707
+ # @!attribute [rw] error_message
708
+ # The error message.
709
+ # @return [String]
710
+ #
711
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateAttendeeError AWS API Documentation
712
+ #
713
+ class CreateAttendeeError < Struct.new(
714
+ :external_user_id,
715
+ :error_code,
716
+ :error_message)
717
+ include Aws::Structure
718
+ end
719
+
720
+ # @note When making an API call, you may pass CreateAttendeeRequest
721
+ # data as a hash:
722
+ #
723
+ # {
724
+ # meeting_id: "GuidString", # required
725
+ # external_user_id: "ExternalUserIdType", # required
726
+ # }
727
+ #
728
+ # @!attribute [rw] meeting_id
729
+ # The Amazon Chime SDK meeting ID.
730
+ # @return [String]
731
+ #
732
+ # @!attribute [rw] external_user_id
733
+ # The Amazon Chime SDK external user ID. Links the attendee to an
734
+ # identity managed by a builder application.
735
+ # @return [String]
736
+ #
737
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateAttendeeRequest AWS API Documentation
738
+ #
739
+ class CreateAttendeeRequest < Struct.new(
740
+ :meeting_id,
741
+ :external_user_id)
742
+ include Aws::Structure
743
+ end
744
+
745
+ # The Amazon Chime SDK attendee fields to create, used with the
746
+ # BatchCreateAttendee action.
747
+ #
748
+ # @note When making an API call, you may pass CreateAttendeeRequestItem
749
+ # data as a hash:
750
+ #
751
+ # {
752
+ # external_user_id: "ExternalUserIdType", # required
753
+ # }
754
+ #
755
+ # @!attribute [rw] external_user_id
756
+ # The Amazon Chime SDK external user ID. Links the attendee to an
757
+ # identity managed by a builder application.
758
+ # @return [String]
759
+ #
760
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateAttendeeRequestItem AWS API Documentation
761
+ #
762
+ class CreateAttendeeRequestItem < Struct.new(
763
+ :external_user_id)
764
+ include Aws::Structure
765
+ end
766
+
767
+ # @!attribute [rw] attendee
768
+ # The attendee information, including attendee ID and join token.
769
+ # @return [Types::Attendee]
770
+ #
771
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateAttendeeResponse AWS API Documentation
772
+ #
773
+ class CreateAttendeeResponse < Struct.new(
774
+ :attendee)
775
+ include Aws::Structure
776
+ end
777
+
616
778
  # @note When making an API call, you may pass CreateBotRequest
617
779
  # data as a hash:
618
780
  #
@@ -654,6 +816,63 @@ module Aws::Chime
654
816
  include Aws::Structure
655
817
  end
656
818
 
819
+ # @note When making an API call, you may pass CreateMeetingRequest
820
+ # data as a hash:
821
+ #
822
+ # {
823
+ # client_request_token: "ClientRequestToken", # required
824
+ # meeting_host_id: "ExternalUserIdType",
825
+ # media_region: "String",
826
+ # notifications_configuration: {
827
+ # sns_topic_arn: "Arn",
828
+ # sqs_queue_arn: "Arn",
829
+ # },
830
+ # }
831
+ #
832
+ # @!attribute [rw] client_request_token
833
+ # The unique identifier for the client request. Use a different token
834
+ # for different meetings.
835
+ #
836
+ # **A suitable default value is auto-generated.** You should normally
837
+ # not need to pass this option.
838
+ # @return [String]
839
+ #
840
+ # @!attribute [rw] meeting_host_id
841
+ # Reserved.
842
+ # @return [String]
843
+ #
844
+ # @!attribute [rw] media_region
845
+ # The Region in which to create the meeting. Available values:
846
+ # `us-east-1`, `us-west-2`.
847
+ # @return [String]
848
+ #
849
+ # @!attribute [rw] notifications_configuration
850
+ # The configuration for resource targets to receive notifications when
851
+ # meeting and attendee events occur.
852
+ # @return [Types::MeetingNotificationConfiguration]
853
+ #
854
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateMeetingRequest AWS API Documentation
855
+ #
856
+ class CreateMeetingRequest < Struct.new(
857
+ :client_request_token,
858
+ :meeting_host_id,
859
+ :media_region,
860
+ :notifications_configuration)
861
+ include Aws::Structure
862
+ end
863
+
864
+ # @!attribute [rw] meeting
865
+ # The meeting information, including the meeting ID and
866
+ # `MediaPlacement`.
867
+ # @return [Types::Meeting]
868
+ #
869
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateMeetingResponse AWS API Documentation
870
+ #
871
+ class CreateMeetingResponse < Struct.new(
872
+ :meeting)
873
+ include Aws::Structure
874
+ end
875
+
657
876
  # @note When making an API call, you may pass CreatePhoneNumberOrderRequest
658
877
  # data as a hash:
659
878
  #
@@ -914,6 +1133,30 @@ module Aws::Chime
914
1133
  #
915
1134
  class DeleteAccountResponse < Aws::EmptyStructure; end
916
1135
 
1136
+ # @note When making an API call, you may pass DeleteAttendeeRequest
1137
+ # data as a hash:
1138
+ #
1139
+ # {
1140
+ # meeting_id: "GuidString", # required
1141
+ # attendee_id: "GuidString", # required
1142
+ # }
1143
+ #
1144
+ # @!attribute [rw] meeting_id
1145
+ # The Amazon Chime SDK meeting ID.
1146
+ # @return [String]
1147
+ #
1148
+ # @!attribute [rw] attendee_id
1149
+ # The Amazon Chime SDK attendee ID.
1150
+ # @return [String]
1151
+ #
1152
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteAttendeeRequest AWS API Documentation
1153
+ #
1154
+ class DeleteAttendeeRequest < Struct.new(
1155
+ :meeting_id,
1156
+ :attendee_id)
1157
+ include Aws::Structure
1158
+ end
1159
+
917
1160
  # @note When making an API call, you may pass DeleteEventsConfigurationRequest
918
1161
  # data as a hash:
919
1162
  #
@@ -938,6 +1181,24 @@ module Aws::Chime
938
1181
  include Aws::Structure
939
1182
  end
940
1183
 
1184
+ # @note When making an API call, you may pass DeleteMeetingRequest
1185
+ # data as a hash:
1186
+ #
1187
+ # {
1188
+ # meeting_id: "GuidString", # required
1189
+ # }
1190
+ #
1191
+ # @!attribute [rw] meeting_id
1192
+ # The Amazon Chime SDK meeting ID.
1193
+ # @return [String]
1194
+ #
1195
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteMeetingRequest AWS API Documentation
1196
+ #
1197
+ class DeleteMeetingRequest < Struct.new(
1198
+ :meeting_id)
1199
+ include Aws::Structure
1200
+ end
1201
+
941
1202
  # @note When making an API call, you may pass DeletePhoneNumberRequest
942
1203
  # data as a hash:
943
1204
  #
@@ -1327,6 +1588,41 @@ module Aws::Chime
1327
1588
  include Aws::Structure
1328
1589
  end
1329
1590
 
1591
+ # @note When making an API call, you may pass GetAttendeeRequest
1592
+ # data as a hash:
1593
+ #
1594
+ # {
1595
+ # meeting_id: "GuidString", # required
1596
+ # attendee_id: "GuidString", # required
1597
+ # }
1598
+ #
1599
+ # @!attribute [rw] meeting_id
1600
+ # The Amazon Chime SDK meeting ID.
1601
+ # @return [String]
1602
+ #
1603
+ # @!attribute [rw] attendee_id
1604
+ # The Amazon Chime SDK attendee ID.
1605
+ # @return [String]
1606
+ #
1607
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetAttendeeRequest AWS API Documentation
1608
+ #
1609
+ class GetAttendeeRequest < Struct.new(
1610
+ :meeting_id,
1611
+ :attendee_id)
1612
+ include Aws::Structure
1613
+ end
1614
+
1615
+ # @!attribute [rw] attendee
1616
+ # The Amazon Chime SDK attendee information.
1617
+ # @return [Types::Attendee]
1618
+ #
1619
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetAttendeeResponse AWS API Documentation
1620
+ #
1621
+ class GetAttendeeResponse < Struct.new(
1622
+ :attendee)
1623
+ include Aws::Structure
1624
+ end
1625
+
1330
1626
  # @note When making an API call, you may pass GetBotRequest
1331
1627
  # data as a hash:
1332
1628
  #
@@ -1413,6 +1709,35 @@ module Aws::Chime
1413
1709
  include Aws::Structure
1414
1710
  end
1415
1711
 
1712
+ # @note When making an API call, you may pass GetMeetingRequest
1713
+ # data as a hash:
1714
+ #
1715
+ # {
1716
+ # meeting_id: "GuidString", # required
1717
+ # }
1718
+ #
1719
+ # @!attribute [rw] meeting_id
1720
+ # The Amazon Chime SDK meeting ID.
1721
+ # @return [String]
1722
+ #
1723
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetMeetingRequest AWS API Documentation
1724
+ #
1725
+ class GetMeetingRequest < Struct.new(
1726
+ :meeting_id)
1727
+ include Aws::Structure
1728
+ end
1729
+
1730
+ # @!attribute [rw] meeting
1731
+ # The Amazon Chime SDK meeting information.
1732
+ # @return [Types::Meeting]
1733
+ #
1734
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetMeetingResponse AWS API Documentation
1735
+ #
1736
+ class GetMeetingResponse < Struct.new(
1737
+ :meeting)
1738
+ include Aws::Structure
1739
+ end
1740
+
1416
1741
  # @note When making an API call, you may pass GetPhoneNumberOrderRequest
1417
1742
  # data as a hash:
1418
1743
  #
@@ -1912,6 +2237,52 @@ module Aws::Chime
1912
2237
  include Aws::Structure
1913
2238
  end
1914
2239
 
2240
+ # @note When making an API call, you may pass ListAttendeesRequest
2241
+ # data as a hash:
2242
+ #
2243
+ # {
2244
+ # meeting_id: "GuidString", # required
2245
+ # next_token: "String",
2246
+ # max_results: 1,
2247
+ # }
2248
+ #
2249
+ # @!attribute [rw] meeting_id
2250
+ # The Amazon Chime SDK meeting ID.
2251
+ # @return [String]
2252
+ #
2253
+ # @!attribute [rw] next_token
2254
+ # The token to use to retrieve the next page of results.
2255
+ # @return [String]
2256
+ #
2257
+ # @!attribute [rw] max_results
2258
+ # The maximum number of results to return in a single call.
2259
+ # @return [Integer]
2260
+ #
2261
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListAttendeesRequest AWS API Documentation
2262
+ #
2263
+ class ListAttendeesRequest < Struct.new(
2264
+ :meeting_id,
2265
+ :next_token,
2266
+ :max_results)
2267
+ include Aws::Structure
2268
+ end
2269
+
2270
+ # @!attribute [rw] attendees
2271
+ # The Amazon Chime SDK attendee information.
2272
+ # @return [Array<Types::Attendee>]
2273
+ #
2274
+ # @!attribute [rw] next_token
2275
+ # The token to use to retrieve the next page of results.
2276
+ # @return [String]
2277
+ #
2278
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListAttendeesResponse AWS API Documentation
2279
+ #
2280
+ class ListAttendeesResponse < Struct.new(
2281
+ :attendees,
2282
+ :next_token)
2283
+ include Aws::Structure
2284
+ end
2285
+
1915
2286
  # @note When making an API call, you may pass ListBotsRequest
1916
2287
  # data as a hash:
1917
2288
  #
@@ -1959,6 +2330,46 @@ module Aws::Chime
1959
2330
  include Aws::Structure
1960
2331
  end
1961
2332
 
2333
+ # @note When making an API call, you may pass ListMeetingsRequest
2334
+ # data as a hash:
2335
+ #
2336
+ # {
2337
+ # next_token: "String",
2338
+ # max_results: 1,
2339
+ # }
2340
+ #
2341
+ # @!attribute [rw] next_token
2342
+ # The token to use to retrieve the next page of results.
2343
+ # @return [String]
2344
+ #
2345
+ # @!attribute [rw] max_results
2346
+ # The maximum number of results to return in a single call.
2347
+ # @return [Integer]
2348
+ #
2349
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListMeetingsRequest AWS API Documentation
2350
+ #
2351
+ class ListMeetingsRequest < Struct.new(
2352
+ :next_token,
2353
+ :max_results)
2354
+ include Aws::Structure
2355
+ end
2356
+
2357
+ # @!attribute [rw] meetings
2358
+ # The Amazon Chime SDK meeting information.
2359
+ # @return [Array<Types::Meeting>]
2360
+ #
2361
+ # @!attribute [rw] next_token
2362
+ # The token to use to retrieve the next page of results.
2363
+ # @return [String]
2364
+ #
2365
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListMeetingsResponse AWS API Documentation
2366
+ #
2367
+ class ListMeetingsResponse < Struct.new(
2368
+ :meetings,
2369
+ :next_token)
2370
+ include Aws::Structure
2371
+ end
2372
+
1962
2373
  # @note When making an API call, you may pass ListPhoneNumberOrdersRequest
1963
2374
  # data as a hash:
1964
2375
  #
@@ -2380,6 +2791,96 @@ module Aws::Chime
2380
2791
  #
2381
2792
  class LogoutUserResponse < Aws::EmptyStructure; end
2382
2793
 
2794
+ # A set of endpoints used by clients to connect to the media service
2795
+ # group for a Amazon Chime SDK meeting.
2796
+ #
2797
+ # @!attribute [rw] audio_host_url
2798
+ # The audio host URL.
2799
+ # @return [String]
2800
+ #
2801
+ # @!attribute [rw] screen_data_url
2802
+ # The screen data URL.
2803
+ # @return [String]
2804
+ #
2805
+ # @!attribute [rw] screen_sharing_url
2806
+ # The screen sharing URL.
2807
+ # @return [String]
2808
+ #
2809
+ # @!attribute [rw] screen_viewing_url
2810
+ # The screen viewing URL.
2811
+ # @return [String]
2812
+ #
2813
+ # @!attribute [rw] signaling_url
2814
+ # The signaling URL.
2815
+ # @return [String]
2816
+ #
2817
+ # @!attribute [rw] turn_control_url
2818
+ # The turn control URL.
2819
+ # @return [String]
2820
+ #
2821
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/MediaPlacement AWS API Documentation
2822
+ #
2823
+ class MediaPlacement < Struct.new(
2824
+ :audio_host_url,
2825
+ :screen_data_url,
2826
+ :screen_sharing_url,
2827
+ :screen_viewing_url,
2828
+ :signaling_url,
2829
+ :turn_control_url)
2830
+ include Aws::Structure
2831
+ end
2832
+
2833
+ # A meeting created using the Amazon Chime SDK.
2834
+ #
2835
+ # @!attribute [rw] meeting_id
2836
+ # The Amazon Chime SDK meeting ID.
2837
+ # @return [String]
2838
+ #
2839
+ # @!attribute [rw] media_placement
2840
+ # The media placement for the meeting.
2841
+ # @return [Types::MediaPlacement]
2842
+ #
2843
+ # @!attribute [rw] media_region
2844
+ # The Region in which to create the meeting. Available values:
2845
+ # `us-east-1`, `us-west-2`.
2846
+ # @return [String]
2847
+ #
2848
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/Meeting AWS API Documentation
2849
+ #
2850
+ class Meeting < Struct.new(
2851
+ :meeting_id,
2852
+ :media_placement,
2853
+ :media_region)
2854
+ include Aws::Structure
2855
+ end
2856
+
2857
+ # The configuration for resource targets to receive notifications when
2858
+ # Amazon Chime SDK meeting and attendee events occur.
2859
+ #
2860
+ # @note When making an API call, you may pass MeetingNotificationConfiguration
2861
+ # data as a hash:
2862
+ #
2863
+ # {
2864
+ # sns_topic_arn: "Arn",
2865
+ # sqs_queue_arn: "Arn",
2866
+ # }
2867
+ #
2868
+ # @!attribute [rw] sns_topic_arn
2869
+ # The SNS topic ARN.
2870
+ # @return [String]
2871
+ #
2872
+ # @!attribute [rw] sqs_queue_arn
2873
+ # The SQS queue ARN.
2874
+ # @return [String]
2875
+ #
2876
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/MeetingNotificationConfiguration AWS API Documentation
2877
+ #
2878
+ class MeetingNotificationConfiguration < Struct.new(
2879
+ :sns_topic_arn,
2880
+ :sqs_queue_arn)
2881
+ include Aws::Structure
2882
+ end
2883
+
2383
2884
  # The member details, such as email address, name, member ID, and member
2384
2885
  # type.
2385
2886
  #