aws-sdk-chimesdkidentity 1.10.0 → 1.12.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -46,7 +46,7 @@ module Aws::ChimeSDKIdentity
46
46
  include Aws::Structure
47
47
  end
48
48
 
49
- # The details of an `AppInstanceAdmin`.
49
+ # The name and ARN of the admin for the `AppInstance`.
50
50
  #
51
51
  # @!attribute [rw] admin
52
52
  # The `AppInstanceAdmin` data.
@@ -84,16 +84,70 @@ module Aws::ChimeSDKIdentity
84
84
  include Aws::Structure
85
85
  end
86
86
 
87
- # The details of the data-retention settings for an `AppInstance`.
87
+ # An Amazon Lex V2 chat bot created under an `AppInstance`.
88
+ #
89
+ # @!attribute [rw] app_instance_bot_arn
90
+ # The ARN of the AppInstanceBot.
91
+ # @return [String]
92
+ #
93
+ # @!attribute [rw] name
94
+ # The name of the AppInstanceBot.
95
+ # @return [String]
96
+ #
97
+ # @!attribute [rw] configuration
98
+ # The data processing instructions for an AppInstanceBot.
99
+ # @return [Types::Configuration]
100
+ #
101
+ # @!attribute [rw] created_timestamp
102
+ # The time at which the `AppInstanceBot` was created.
103
+ # @return [Time]
104
+ #
105
+ # @!attribute [rw] last_updated_timestamp
106
+ # The time at which the `AppInstanceBot` was last updated.
107
+ # @return [Time]
108
+ #
109
+ # @!attribute [rw] metadata
110
+ # The metadata for an AppInstanceBot.
111
+ # @return [String]
112
+ #
113
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/AppInstanceBot AWS API Documentation
114
+ #
115
+ class AppInstanceBot < Struct.new(
116
+ :app_instance_bot_arn,
117
+ :name,
118
+ :configuration,
119
+ :created_timestamp,
120
+ :last_updated_timestamp,
121
+ :metadata)
122
+ SENSITIVE = [:name, :metadata]
123
+ include Aws::Structure
124
+ end
125
+
126
+ # High-level information about an AppInstanceBot.
127
+ #
128
+ # @!attribute [rw] app_instance_bot_arn
129
+ # The ARN of the AppInstanceBot.
130
+ # @return [String]
131
+ #
132
+ # @!attribute [rw] name
133
+ # The name of the AppInstanceBox.
134
+ # @return [String]
135
+ #
136
+ # @!attribute [rw] metadata
137
+ # The metadata of the AppInstanceBot.
138
+ # @return [String]
88
139
  #
89
- # @note When making an API call, you may pass AppInstanceRetentionSettings
90
- # data as a hash:
140
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/AppInstanceBotSummary AWS API Documentation
91
141
  #
92
- # {
93
- # channel_retention_settings: {
94
- # retention_days: 1,
95
- # },
96
- # }
142
+ class AppInstanceBotSummary < Struct.new(
143
+ :app_instance_bot_arn,
144
+ :name,
145
+ :metadata)
146
+ SENSITIVE = [:name, :metadata]
147
+ include Aws::Structure
148
+ end
149
+
150
+ # The details of the data-retention settings for an `AppInstance`.
97
151
  #
98
152
  # @!attribute [rw] channel_retention_settings
99
153
  # The length of time in days to retain the messages in a channel.
@@ -153,6 +207,11 @@ module Aws::ChimeSDKIdentity
153
207
  # The time at which the `AppInstanceUser` was last updated.
154
208
  # @return [Time]
155
209
  #
210
+ # @!attribute [rw] expiration_settings
211
+ # The interval after which an `AppInstanceUser` is automatically
212
+ # deleted.
213
+ # @return [Types::ExpirationSettings]
214
+ #
156
215
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/AppInstanceUser AWS API Documentation
157
216
  #
158
217
  class AppInstanceUser < Struct.new(
@@ -160,7 +219,8 @@ module Aws::ChimeSDKIdentity
160
219
  :name,
161
220
  :metadata,
162
221
  :created_timestamp,
163
- :last_updated_timestamp)
222
+ :last_updated_timestamp,
223
+ :expiration_settings)
164
224
  SENSITIVE = [:name, :metadata]
165
225
  include Aws::Structure
166
226
  end
@@ -212,11 +272,11 @@ module Aws::ChimeSDKIdentity
212
272
  # A read-only field that represents the state of an
213
273
  # `AppInstanceUserEndpoint`. Supported values:
214
274
  #
215
- # * `ACTIVE`\: The `AppInstanceUserEndpoint` is active and able to
275
+ # * `ACTIVE`: The `AppInstanceUserEndpoint` is active and able to
216
276
  # receive messages. When `ACTIVE`, the `EndpointStatusReason`
217
277
  # remains empty.
218
278
  #
219
- # * `INACTIVE`\: The `AppInstanceUserEndpoint` is inactive and can't
279
+ # * `INACTIVE`: The `AppInstanceUserEndpoint` is inactive and can't
220
280
  # receive message. When `INACTIVE`, the corresponding reason will be
221
281
  # conveyed through `EndpointStatusReason`.
222
282
  #
@@ -241,7 +301,7 @@ module Aws::ChimeSDKIdentity
241
301
  :last_updated_timestamp,
242
302
  :allow_messages,
243
303
  :endpoint_state)
244
- SENSITIVE = [:app_instance_user_arn, :endpoint_id, :name, :resource_arn]
304
+ SENSITIVE = [:app_instance_user_arn, :endpoint_id, :name]
245
305
  include Aws::Structure
246
306
  end
247
307
 
@@ -331,13 +391,6 @@ module Aws::ChimeSDKIdentity
331
391
 
332
392
  # The details of the retention settings for a channel.
333
393
  #
334
- # @note When making an API call, you may pass ChannelRetentionSettings
335
- # data as a hash:
336
- #
337
- # {
338
- # retention_days: 1,
339
- # }
340
- #
341
394
  # @!attribute [rw] retention_days
342
395
  # The time in days to retain the messages in a channel.
343
396
  # @return [Integer]
@@ -350,6 +403,20 @@ module Aws::ChimeSDKIdentity
350
403
  include Aws::Structure
351
404
  end
352
405
 
406
+ # A structure that contains configuration data.
407
+ #
408
+ # @!attribute [rw] lex
409
+ # The configuration for an Amazon Lex V2 bot.
410
+ # @return [Types::LexConfiguration]
411
+ #
412
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/Configuration AWS API Documentation
413
+ #
414
+ class Configuration < Struct.new(
415
+ :lex)
416
+ SENSITIVE = []
417
+ include Aws::Structure
418
+ end
419
+
353
420
  # The request could not be processed because of conflict in the current
354
421
  # state of the resource.
355
422
  #
@@ -368,14 +435,6 @@ module Aws::ChimeSDKIdentity
368
435
  include Aws::Structure
369
436
  end
370
437
 
371
- # @note When making an API call, you may pass CreateAppInstanceAdminRequest
372
- # data as a hash:
373
- #
374
- # {
375
- # app_instance_admin_arn: "ChimeArn", # required
376
- # app_instance_arn: "ChimeArn", # required
377
- # }
378
- #
379
438
  # @!attribute [rw] app_instance_admin_arn
380
439
  # The ARN of the administrator of the current `AppInstance`.
381
440
  # @return [String]
@@ -394,7 +453,9 @@ module Aws::ChimeSDKIdentity
394
453
  end
395
454
 
396
455
  # @!attribute [rw] app_instance_admin
397
- # The name and ARN of the admin for the `AppInstance`.
456
+ # The ARN and name of the administrator, the ARN of the `AppInstance`,
457
+ # and the created and last-updated timestamps. All timestamps use
458
+ # epoch milliseconds.
398
459
  # @return [Types::Identity]
399
460
  #
400
461
  # @!attribute [rw] app_instance_arn
@@ -410,21 +471,59 @@ module Aws::ChimeSDKIdentity
410
471
  include Aws::Structure
411
472
  end
412
473
 
413
- # @note When making an API call, you may pass CreateAppInstanceRequest
414
- # data as a hash:
474
+ # @!attribute [rw] app_instance_arn
475
+ # The ARN of the `AppInstance` request.
476
+ # @return [String]
477
+ #
478
+ # @!attribute [rw] name
479
+ # The user's name.
480
+ # @return [String]
415
481
  #
416
- # {
417
- # name: "NonEmptyResourceName", # required
418
- # metadata: "Metadata",
419
- # client_request_token: "ClientRequestToken", # required
420
- # tags: [
421
- # {
422
- # key: "TagKey", # required
423
- # value: "TagValue", # required
424
- # },
425
- # ],
426
- # }
482
+ # @!attribute [rw] metadata
483
+ # The request metadata. Limited to a 1KB string in UTF-8.
484
+ # @return [String]
427
485
  #
486
+ # @!attribute [rw] client_request_token
487
+ # The unique ID for the client making the request. Use different
488
+ # tokens for different `AppInstanceBots`.
489
+ #
490
+ # **A suitable default value is auto-generated.** You should normally
491
+ # not need to pass this option.
492
+ # @return [String]
493
+ #
494
+ # @!attribute [rw] tags
495
+ # The tags assigned to the `AppInstanceBot`.
496
+ # @return [Array<Types::Tag>]
497
+ #
498
+ # @!attribute [rw] configuration
499
+ # Configuration information about the Amazon Lex V2 V2 bot.
500
+ # @return [Types::Configuration]
501
+ #
502
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/CreateAppInstanceBotRequest AWS API Documentation
503
+ #
504
+ class CreateAppInstanceBotRequest < Struct.new(
505
+ :app_instance_arn,
506
+ :name,
507
+ :metadata,
508
+ :client_request_token,
509
+ :tags,
510
+ :configuration)
511
+ SENSITIVE = [:name, :metadata]
512
+ include Aws::Structure
513
+ end
514
+
515
+ # @!attribute [rw] app_instance_bot_arn
516
+ # The ARN of the `AppinstanceBot`.
517
+ # @return [String]
518
+ #
519
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/CreateAppInstanceBotResponse AWS API Documentation
520
+ #
521
+ class CreateAppInstanceBotResponse < Struct.new(
522
+ :app_instance_bot_arn)
523
+ SENSITIVE = []
524
+ include Aws::Structure
525
+ end
526
+
428
527
  # @!attribute [rw] name
429
528
  # The name of the `AppInstance`.
430
529
  # @return [String]
@@ -434,14 +533,15 @@ module Aws::ChimeSDKIdentity
434
533
  # @return [String]
435
534
  #
436
535
  # @!attribute [rw] client_request_token
437
- # The `ClientRequestToken` of the `AppInstance`.
536
+ # The unique ID of the request. Use different tokens to create
537
+ # different `AppInstances`.
438
538
  #
439
539
  # **A suitable default value is auto-generated.** You should normally
440
540
  # not need to pass this option.
441
541
  # @return [String]
442
542
  #
443
543
  # @!attribute [rw] tags
444
- # Tags assigned to the `AppInstanceUser`.
544
+ # Tags assigned to the `AppInstance`.
445
545
  # @return [Array<Types::Tag>]
446
546
  #
447
547
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/CreateAppInstanceRequest AWS API Documentation
@@ -451,7 +551,7 @@ module Aws::ChimeSDKIdentity
451
551
  :metadata,
452
552
  :client_request_token,
453
553
  :tags)
454
- SENSITIVE = [:name, :metadata, :client_request_token]
554
+ SENSITIVE = [:name, :metadata]
455
555
  include Aws::Structure
456
556
  end
457
557
 
@@ -467,23 +567,6 @@ module Aws::ChimeSDKIdentity
467
567
  include Aws::Structure
468
568
  end
469
569
 
470
- # @note When making an API call, you may pass CreateAppInstanceUserRequest
471
- # data as a hash:
472
- #
473
- # {
474
- # app_instance_arn: "ChimeArn", # required
475
- # app_instance_user_id: "UserId", # required
476
- # name: "UserName", # required
477
- # metadata: "Metadata",
478
- # client_request_token: "ClientRequestToken", # required
479
- # tags: [
480
- # {
481
- # key: "TagKey", # required
482
- # value: "TagValue", # required
483
- # },
484
- # ],
485
- # }
486
- #
487
570
  # @!attribute [rw] app_instance_arn
488
571
  # The ARN of the `AppInstance` request.
489
572
  # @return [String]
@@ -501,7 +584,8 @@ module Aws::ChimeSDKIdentity
501
584
  # @return [String]
502
585
  #
503
586
  # @!attribute [rw] client_request_token
504
- # The token assigned to the user requesting an `AppInstance`.
587
+ # The unique ID of the request. Use different tokens to request
588
+ # additional `AppInstances`.
505
589
  #
506
590
  # **A suitable default value is auto-generated.** You should normally
507
591
  # not need to pass this option.
@@ -511,6 +595,11 @@ module Aws::ChimeSDKIdentity
511
595
  # Tags assigned to the `AppInstanceUser`.
512
596
  # @return [Array<Types::Tag>]
513
597
  #
598
+ # @!attribute [rw] expiration_settings
599
+ # Settings that control the interval after which the `AppInstanceUser`
600
+ # is automatically deleted.
601
+ # @return [Types::ExpirationSettings]
602
+ #
514
603
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/CreateAppInstanceUserRequest AWS API Documentation
515
604
  #
516
605
  class CreateAppInstanceUserRequest < Struct.new(
@@ -519,8 +608,9 @@ module Aws::ChimeSDKIdentity
519
608
  :name,
520
609
  :metadata,
521
610
  :client_request_token,
522
- :tags)
523
- SENSITIVE = [:app_instance_user_id, :name, :metadata, :client_request_token]
611
+ :tags,
612
+ :expiration_settings)
613
+ SENSITIVE = [:app_instance_user_id, :name, :metadata]
524
614
  include Aws::Structure
525
615
  end
526
616
 
@@ -536,14 +626,6 @@ module Aws::ChimeSDKIdentity
536
626
  include Aws::Structure
537
627
  end
538
628
 
539
- # @note When making an API call, you may pass DeleteAppInstanceAdminRequest
540
- # data as a hash:
541
- #
542
- # {
543
- # app_instance_admin_arn: "ChimeArn", # required
544
- # app_instance_arn: "ChimeArn", # required
545
- # }
546
- #
547
629
  # @!attribute [rw] app_instance_admin_arn
548
630
  # The ARN of the `AppInstance`'s administrator.
549
631
  # @return [String]
@@ -561,13 +643,18 @@ module Aws::ChimeSDKIdentity
561
643
  include Aws::Structure
562
644
  end
563
645
 
564
- # @note When making an API call, you may pass DeleteAppInstanceRequest
565
- # data as a hash:
646
+ # @!attribute [rw] app_instance_bot_arn
647
+ # The ARN of the `AppInstanceBot` being deleted.
648
+ # @return [String]
566
649
  #
567
- # {
568
- # app_instance_arn: "ChimeArn", # required
569
- # }
650
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/DeleteAppInstanceBotRequest AWS API Documentation
570
651
  #
652
+ class DeleteAppInstanceBotRequest < Struct.new(
653
+ :app_instance_bot_arn)
654
+ SENSITIVE = []
655
+ include Aws::Structure
656
+ end
657
+
571
658
  # @!attribute [rw] app_instance_arn
572
659
  # The ARN of the `AppInstance`.
573
660
  # @return [String]
@@ -580,13 +667,6 @@ module Aws::ChimeSDKIdentity
580
667
  include Aws::Structure
581
668
  end
582
669
 
583
- # @note When making an API call, you may pass DeleteAppInstanceUserRequest
584
- # data as a hash:
585
- #
586
- # {
587
- # app_instance_user_arn: "ChimeArn", # required
588
- # }
589
- #
590
670
  # @!attribute [rw] app_instance_user_arn
591
671
  # The ARN of the user request being deleted.
592
672
  # @return [String]
@@ -599,14 +679,6 @@ module Aws::ChimeSDKIdentity
599
679
  include Aws::Structure
600
680
  end
601
681
 
602
- # @note When making an API call, you may pass DeregisterAppInstanceUserEndpointRequest
603
- # data as a hash:
604
- #
605
- # {
606
- # app_instance_user_arn: "SensitiveChimeArn", # required
607
- # endpoint_id: "SensitiveString64", # required
608
- # }
609
- #
610
682
  # @!attribute [rw] app_instance_user_arn
611
683
  # The ARN of the `AppInstanceUser`.
612
684
  # @return [String]
@@ -624,14 +696,6 @@ module Aws::ChimeSDKIdentity
624
696
  include Aws::Structure
625
697
  end
626
698
 
627
- # @note When making an API call, you may pass DescribeAppInstanceAdminRequest
628
- # data as a hash:
629
- #
630
- # {
631
- # app_instance_admin_arn: "ChimeArn", # required
632
- # app_instance_arn: "ChimeArn", # required
633
- # }
634
- #
635
699
  # @!attribute [rw] app_instance_admin_arn
636
700
  # The ARN of the `AppInstanceAdmin`.
637
701
  # @return [String]
@@ -663,13 +727,30 @@ module Aws::ChimeSDKIdentity
663
727
  include Aws::Structure
664
728
  end
665
729
 
666
- # @note When making an API call, you may pass DescribeAppInstanceRequest
667
- # data as a hash:
730
+ # @!attribute [rw] app_instance_bot_arn
731
+ # The ARN of the `AppInstanceBot`.
732
+ # @return [String]
668
733
  #
669
- # {
670
- # app_instance_arn: "ChimeArn", # required
671
- # }
734
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/DescribeAppInstanceBotRequest AWS API Documentation
672
735
  #
736
+ class DescribeAppInstanceBotRequest < Struct.new(
737
+ :app_instance_bot_arn)
738
+ SENSITIVE = []
739
+ include Aws::Structure
740
+ end
741
+
742
+ # @!attribute [rw] app_instance_bot
743
+ # The detials of the `AppInstanceBot`.
744
+ # @return [Types::AppInstanceBot]
745
+ #
746
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/DescribeAppInstanceBotResponse AWS API Documentation
747
+ #
748
+ class DescribeAppInstanceBotResponse < Struct.new(
749
+ :app_instance_bot)
750
+ SENSITIVE = []
751
+ include Aws::Structure
752
+ end
753
+
673
754
  # @!attribute [rw] app_instance_arn
674
755
  # The ARN of the `AppInstance`.
675
756
  # @return [String]
@@ -695,14 +776,6 @@ module Aws::ChimeSDKIdentity
695
776
  include Aws::Structure
696
777
  end
697
778
 
698
- # @note When making an API call, you may pass DescribeAppInstanceUserEndpointRequest
699
- # data as a hash:
700
- #
701
- # {
702
- # app_instance_user_arn: "SensitiveString1600", # required
703
- # endpoint_id: "SensitiveString64", # required
704
- # }
705
- #
706
779
  # @!attribute [rw] app_instance_user_arn
707
780
  # The ARN of the `AppInstanceUser`.
708
781
  # @return [String]
@@ -721,7 +794,7 @@ module Aws::ChimeSDKIdentity
721
794
  end
722
795
 
723
796
  # @!attribute [rw] app_instance_user_endpoint
724
- # The full details of an `AppInstanceUserEndpoint`\: the
797
+ # The full details of an `AppInstanceUserEndpoint`: the
725
798
  # `AppInstanceUserArn`, ID, name, type, resource ARN, attributes,
726
799
  # allow messages, state, and created and last updated timestamps. All
727
800
  # timestamps use epoch milliseconds.
@@ -735,13 +808,6 @@ module Aws::ChimeSDKIdentity
735
808
  include Aws::Structure
736
809
  end
737
810
 
738
- # @note When making an API call, you may pass DescribeAppInstanceUserRequest
739
- # data as a hash:
740
- #
741
- # {
742
- # app_instance_user_arn: "ChimeArn", # required
743
- # }
744
- #
745
811
  # @!attribute [rw] app_instance_user_arn
746
812
  # The ARN of the `AppInstanceUser`.
747
813
  # @return [String]
@@ -768,14 +834,6 @@ module Aws::ChimeSDKIdentity
768
834
 
769
835
  # The attributes of an `Endpoint`.
770
836
  #
771
- # @note When making an API call, you may pass EndpointAttributes
772
- # data as a hash:
773
- #
774
- # {
775
- # device_token: "NonEmptySensitiveString1600", # required
776
- # voip_device_token: "NonEmptySensitiveString1600",
777
- # }
778
- #
779
837
  # @!attribute [rw] device_token
780
838
  # The device token for the GCM, APNS, and APNS\_SANDBOX endpoint
781
839
  # types.
@@ -797,11 +855,11 @@ module Aws::ChimeSDKIdentity
797
855
  # A read-only field that represents the state of an
798
856
  # `AppInstanceUserEndpoint`. Supported values:
799
857
  #
800
- # * `ACTIVE`\: The `AppInstanceUserEndpoint` is active and able to
858
+ # * `ACTIVE`: The `AppInstanceUserEndpoint` is active and able to
801
859
  # receive messages. When `ACTIVE`, the `EndpointStatusReason` remains
802
860
  # empty.
803
861
  #
804
- # * `INACTIVE`\: The `AppInstanceUserEndpoint` is inactive and can't
862
+ # * `INACTIVE`: The `AppInstanceUserEndpoint` is inactive and can't
805
863
  # receive message. When INACTIVE, the corresponding reason will be
806
864
  # conveyed through EndpointStatusReason.
807
865
  #
@@ -829,6 +887,28 @@ module Aws::ChimeSDKIdentity
829
887
  include Aws::Structure
830
888
  end
831
889
 
890
+ # Determines the interval after which an `AppInstanceUser` is
891
+ # automatically deleted.
892
+ #
893
+ # @!attribute [rw] expiration_days
894
+ # The period in days after which an `AppInstanceUser` will be
895
+ # automatically deleted.
896
+ # @return [Integer]
897
+ #
898
+ # @!attribute [rw] expiration_criterion
899
+ # Specifies the conditions under which an `AppInstanceUser` will
900
+ # expire.
901
+ # @return [String]
902
+ #
903
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/ExpirationSettings AWS API Documentation
904
+ #
905
+ class ExpirationSettings < Struct.new(
906
+ :expiration_days,
907
+ :expiration_criterion)
908
+ SENSITIVE = []
909
+ include Aws::Structure
910
+ end
911
+
832
912
  # The client is permanently forbidden from making the request.
833
913
  #
834
914
  # @!attribute [rw] code
@@ -846,13 +926,6 @@ module Aws::ChimeSDKIdentity
846
926
  include Aws::Structure
847
927
  end
848
928
 
849
- # @note When making an API call, you may pass GetAppInstanceRetentionSettingsRequest
850
- # data as a hash:
851
- #
852
- # {
853
- # app_instance_arn: "ChimeArn", # required
854
- # }
855
- #
856
929
  # @!attribute [rw] app_instance_arn
857
930
  # The ARN of the `AppInstance`.
858
931
  # @return [String]
@@ -883,7 +956,7 @@ module Aws::ChimeSDKIdentity
883
956
  include Aws::Structure
884
957
  end
885
958
 
886
- # The details of a user.
959
+ # The details of a user or bot.
887
960
  #
888
961
  # @!attribute [rw] arn
889
962
  # The ARN in an Identity.
@@ -902,15 +975,45 @@ module Aws::ChimeSDKIdentity
902
975
  include Aws::Structure
903
976
  end
904
977
 
905
- # @note When making an API call, you may pass ListAppInstanceAdminsRequest
906
- # data as a hash:
978
+ # The configuration for an Amazon Lex V2 bot.
979
+ #
980
+ # @!attribute [rw] responds_to
981
+ # Determines whether the Amazon Lex V2 bot responds to all standard
982
+ # messages. Control messages are not supported.
983
+ # @return [String]
984
+ #
985
+ # @!attribute [rw] lex_bot_alias_arn
986
+ # The ARN of the Amazon Lex V2 bot's alias. The ARN uses this format:
987
+ # `arn:aws:lex:REGION:ACCOUNT:bot-alias/MYBOTID/MYBOTALIAS`
988
+ # @return [String]
989
+ #
990
+ # @!attribute [rw] locale_id
991
+ # Identifies the Amazon Lex V2 bot's language and locale. The string
992
+ # must match one of the supported locales in Amazon Lex V2. All of the
993
+ # intents, slot types, and slots used in the bot must have the same
994
+ # locale. For more information, see [Supported languages][1] in the
995
+ # *Amazon Lex V2 Developer Guide*.
907
996
  #
908
- # {
909
- # app_instance_arn: "ChimeArn", # required
910
- # max_results: 1,
911
- # next_token: "NextToken",
912
- # }
913
997
  #
998
+ #
999
+ # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html
1000
+ # @return [String]
1001
+ #
1002
+ # @!attribute [rw] welcome_intent
1003
+ # The name of the welcome intent configured in the Amazon Lex V2 bot.
1004
+ # @return [String]
1005
+ #
1006
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/LexConfiguration AWS API Documentation
1007
+ #
1008
+ class LexConfiguration < Struct.new(
1009
+ :responds_to,
1010
+ :lex_bot_alias_arn,
1011
+ :locale_id,
1012
+ :welcome_intent)
1013
+ SENSITIVE = []
1014
+ include Aws::Structure
1015
+ end
1016
+
914
1017
  # @!attribute [rw] app_instance_arn
915
1018
  # The ARN of the `AppInstance`.
916
1019
  # @return [String]
@@ -957,15 +1060,52 @@ module Aws::ChimeSDKIdentity
957
1060
  include Aws::Structure
958
1061
  end
959
1062
 
960
- # @note When making an API call, you may pass ListAppInstanceUserEndpointsRequest
961
- # data as a hash:
1063
+ # @!attribute [rw] app_instance_arn
1064
+ # The ARN of the `AppInstance`.
1065
+ # @return [String]
962
1066
  #
963
- # {
964
- # app_instance_user_arn: "SensitiveChimeArn", # required
965
- # max_results: 1,
966
- # next_token: "NextToken",
967
- # }
1067
+ # @!attribute [rw] max_results
1068
+ # The maximum number of requests to return.
1069
+ # @return [Integer]
968
1070
  #
1071
+ # @!attribute [rw] next_token
1072
+ # The token passed by previous API calls until all requested bots are
1073
+ # returned.
1074
+ # @return [String]
1075
+ #
1076
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/ListAppInstanceBotsRequest AWS API Documentation
1077
+ #
1078
+ class ListAppInstanceBotsRequest < Struct.new(
1079
+ :app_instance_arn,
1080
+ :max_results,
1081
+ :next_token)
1082
+ SENSITIVE = [:next_token]
1083
+ include Aws::Structure
1084
+ end
1085
+
1086
+ # @!attribute [rw] app_instance_arn
1087
+ # The ARN of the AppInstance.
1088
+ # @return [String]
1089
+ #
1090
+ # @!attribute [rw] app_instance_bots
1091
+ # The information for each requested `AppInstanceBot`.
1092
+ # @return [Array<Types::AppInstanceBotSummary>]
1093
+ #
1094
+ # @!attribute [rw] next_token
1095
+ # The token passed by previous API calls until all requested bots are
1096
+ # returned.
1097
+ # @return [String]
1098
+ #
1099
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/ListAppInstanceBotsResponse AWS API Documentation
1100
+ #
1101
+ class ListAppInstanceBotsResponse < Struct.new(
1102
+ :app_instance_arn,
1103
+ :app_instance_bots,
1104
+ :next_token)
1105
+ SENSITIVE = [:next_token]
1106
+ include Aws::Structure
1107
+ end
1108
+
969
1109
  # @!attribute [rw] app_instance_user_arn
970
1110
  # The ARN of the `AppInstanceUser`.
971
1111
  # @return [String]
@@ -1007,15 +1147,6 @@ module Aws::ChimeSDKIdentity
1007
1147
  include Aws::Structure
1008
1148
  end
1009
1149
 
1010
- # @note When making an API call, you may pass ListAppInstanceUsersRequest
1011
- # data as a hash:
1012
- #
1013
- # {
1014
- # app_instance_arn: "ChimeArn", # required
1015
- # max_results: 1,
1016
- # next_token: "NextToken",
1017
- # }
1018
- #
1019
1150
  # @!attribute [rw] app_instance_arn
1020
1151
  # The ARN of the `AppInstance`.
1021
1152
  # @return [String]
@@ -1062,14 +1193,6 @@ module Aws::ChimeSDKIdentity
1062
1193
  include Aws::Structure
1063
1194
  end
1064
1195
 
1065
- # @note When making an API call, you may pass ListAppInstancesRequest
1066
- # data as a hash:
1067
- #
1068
- # {
1069
- # max_results: 1,
1070
- # next_token: "NextToken",
1071
- # }
1072
- #
1073
1196
  # @!attribute [rw] max_results
1074
1197
  # The maximum number of `AppInstance`s that you want to return.
1075
1198
  # @return [Integer]
@@ -1106,13 +1229,6 @@ module Aws::ChimeSDKIdentity
1106
1229
  include Aws::Structure
1107
1230
  end
1108
1231
 
1109
- # @note When making an API call, you may pass ListTagsForResourceRequest
1110
- # data as a hash:
1111
- #
1112
- # {
1113
- # resource_arn: "ChimeArn", # required
1114
- # }
1115
- #
1116
1232
  # @!attribute [rw] resource_arn
1117
1233
  # The ARN of the resource.
1118
1234
  # @return [String]
@@ -1137,18 +1253,24 @@ module Aws::ChimeSDKIdentity
1137
1253
  include Aws::Structure
1138
1254
  end
1139
1255
 
1140
- # @note When making an API call, you may pass PutAppInstanceRetentionSettingsRequest
1141
- # data as a hash:
1256
+ # One or more of the resources in the request does not exist in the
1257
+ # system.
1258
+ #
1259
+ # @!attribute [rw] code
1260
+ # @return [String]
1142
1261
  #
1143
- # {
1144
- # app_instance_arn: "ChimeArn", # required
1145
- # app_instance_retention_settings: { # required
1146
- # channel_retention_settings: {
1147
- # retention_days: 1,
1148
- # },
1149
- # },
1150
- # }
1262
+ # @!attribute [rw] message
1263
+ # @return [String]
1151
1264
  #
1265
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/NotFoundException AWS API Documentation
1266
+ #
1267
+ class NotFoundException < Struct.new(
1268
+ :code,
1269
+ :message)
1270
+ SENSITIVE = []
1271
+ include Aws::Structure
1272
+ end
1273
+
1152
1274
  # @!attribute [rw] app_instance_arn
1153
1275
  # The ARN of the `AppInstance`.
1154
1276
  # @return [String]
@@ -1183,22 +1305,42 @@ module Aws::ChimeSDKIdentity
1183
1305
  include Aws::Structure
1184
1306
  end
1185
1307
 
1186
- # @note When making an API call, you may pass RegisterAppInstanceUserEndpointRequest
1187
- # data as a hash:
1308
+ # @!attribute [rw] app_instance_user_arn
1309
+ # The ARN of the `AppInstanceUser`.
1310
+ # @return [String]
1188
1311
  #
1189
- # {
1190
- # app_instance_user_arn: "SensitiveChimeArn", # required
1191
- # name: "SensitiveString1600",
1192
- # type: "APNS", # required, accepts APNS, APNS_SANDBOX, GCM
1193
- # resource_arn: "SensitiveChimeArn", # required
1194
- # endpoint_attributes: { # required
1195
- # device_token: "NonEmptySensitiveString1600", # required
1196
- # voip_device_token: "NonEmptySensitiveString1600",
1197
- # },
1198
- # client_request_token: "ClientRequestToken", # required
1199
- # allow_messages: "ALL", # accepts ALL, NONE
1200
- # }
1312
+ # @!attribute [rw] expiration_settings
1313
+ # Settings that control the interval after which an `AppInstanceUser`
1314
+ # is automatically deleted.
1315
+ # @return [Types::ExpirationSettings]
1201
1316
  #
1317
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/PutAppInstanceUserExpirationSettingsRequest AWS API Documentation
1318
+ #
1319
+ class PutAppInstanceUserExpirationSettingsRequest < Struct.new(
1320
+ :app_instance_user_arn,
1321
+ :expiration_settings)
1322
+ SENSITIVE = []
1323
+ include Aws::Structure
1324
+ end
1325
+
1326
+ # @!attribute [rw] app_instance_user_arn
1327
+ # The ARN of the `AppInstanceUser`.
1328
+ # @return [String]
1329
+ #
1330
+ # @!attribute [rw] expiration_settings
1331
+ # Settings that control the interval after which an `AppInstanceUser`
1332
+ # is automatically deleted.
1333
+ # @return [Types::ExpirationSettings]
1334
+ #
1335
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/PutAppInstanceUserExpirationSettingsResponse AWS API Documentation
1336
+ #
1337
+ class PutAppInstanceUserExpirationSettingsResponse < Struct.new(
1338
+ :app_instance_user_arn,
1339
+ :expiration_settings)
1340
+ SENSITIVE = []
1341
+ include Aws::Structure
1342
+ end
1343
+
1202
1344
  # @!attribute [rw] app_instance_user_arn
1203
1345
  # The ARN of the `AppInstanceUser`.
1204
1346
  # @return [String]
@@ -1210,12 +1352,12 @@ module Aws::ChimeSDKIdentity
1210
1352
  # @!attribute [rw] type
1211
1353
  # The type of the `AppInstanceUserEndpoint`. Supported types:
1212
1354
  #
1213
- # * `APNS`\: The mobile notification service for an Apple device.
1355
+ # * `APNS`: The mobile notification service for an Apple device.
1214
1356
  #
1215
- # * `APNS_SANDBOX`\: The sandbox environment of the mobile
1216
- # notification service for an Apple device.
1357
+ # * `APNS_SANDBOX`: The sandbox environment of the mobile notification
1358
+ # service for an Apple device.
1217
1359
  #
1218
- # * `GCM`\: The mobile notification service for an Android device.
1360
+ # * `GCM`: The mobile notification service for an Android device.
1219
1361
  #
1220
1362
  # Populate the `ResourceArn` value of each type as `PinpointAppArn`.
1221
1363
  # @return [String]
@@ -1229,7 +1371,8 @@ module Aws::ChimeSDKIdentity
1229
1371
  # @return [Types::EndpointAttributes]
1230
1372
  #
1231
1373
  # @!attribute [rw] client_request_token
1232
- # The idempotency token for each client request.
1374
+ # The unique ID assigned to the request. Use different tokens to
1375
+ # register other endpoints.
1233
1376
  #
1234
1377
  # **A suitable default value is auto-generated.** You should normally
1235
1378
  # not need to pass this option.
@@ -1251,7 +1394,7 @@ module Aws::ChimeSDKIdentity
1251
1394
  :endpoint_attributes,
1252
1395
  :client_request_token,
1253
1396
  :allow_messages)
1254
- SENSITIVE = [:app_instance_user_arn, :name, :resource_arn, :client_request_token]
1397
+ SENSITIVE = [:app_instance_user_arn, :name]
1255
1398
  include Aws::Structure
1256
1399
  end
1257
1400
 
@@ -1325,14 +1468,6 @@ module Aws::ChimeSDKIdentity
1325
1468
 
1326
1469
  # A tag object containing a key-value pair.
1327
1470
  #
1328
- # @note When making an API call, you may pass Tag
1329
- # data as a hash:
1330
- #
1331
- # {
1332
- # key: "TagKey", # required
1333
- # value: "TagValue", # required
1334
- # }
1335
- #
1336
1471
  # @!attribute [rw] key
1337
1472
  # The key in a tag.
1338
1473
  # @return [String]
@@ -1350,19 +1485,6 @@ module Aws::ChimeSDKIdentity
1350
1485
  include Aws::Structure
1351
1486
  end
1352
1487
 
1353
- # @note When making an API call, you may pass TagResourceRequest
1354
- # data as a hash:
1355
- #
1356
- # {
1357
- # resource_arn: "ChimeArn", # required
1358
- # tags: [ # required
1359
- # {
1360
- # key: "TagKey", # required
1361
- # value: "TagValue", # required
1362
- # },
1363
- # ],
1364
- # }
1365
- #
1366
1488
  # @!attribute [rw] resource_arn
1367
1489
  # The resource ARN.
1368
1490
  # @return [String]
@@ -1414,14 +1536,6 @@ module Aws::ChimeSDKIdentity
1414
1536
  include Aws::Structure
1415
1537
  end
1416
1538
 
1417
- # @note When making an API call, you may pass UntagResourceRequest
1418
- # data as a hash:
1419
- #
1420
- # {
1421
- # resource_arn: "ChimeArn", # required
1422
- # tag_keys: ["TagKey"], # required
1423
- # }
1424
- #
1425
1539
  # @!attribute [rw] resource_arn
1426
1540
  # The resource ARN.
1427
1541
  # @return [String]
@@ -1439,15 +1553,40 @@ module Aws::ChimeSDKIdentity
1439
1553
  include Aws::Structure
1440
1554
  end
1441
1555
 
1442
- # @note When making an API call, you may pass UpdateAppInstanceRequest
1443
- # data as a hash:
1556
+ # @!attribute [rw] app_instance_bot_arn
1557
+ # The ARN of the `AppInstanceBot`.
1558
+ # @return [String]
1444
1559
  #
1445
- # {
1446
- # app_instance_arn: "ChimeArn", # required
1447
- # name: "NonEmptyResourceName", # required
1448
- # metadata: "Metadata", # required
1449
- # }
1560
+ # @!attribute [rw] name
1561
+ # The name of the `AppInstanceBot`.
1562
+ # @return [String]
1563
+ #
1564
+ # @!attribute [rw] metadata
1565
+ # The metadata of the `AppInstanceBot`.
1566
+ # @return [String]
1567
+ #
1568
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/UpdateAppInstanceBotRequest AWS API Documentation
1450
1569
  #
1570
+ class UpdateAppInstanceBotRequest < Struct.new(
1571
+ :app_instance_bot_arn,
1572
+ :name,
1573
+ :metadata)
1574
+ SENSITIVE = [:name, :metadata]
1575
+ include Aws::Structure
1576
+ end
1577
+
1578
+ # @!attribute [rw] app_instance_bot_arn
1579
+ # The ARN of the `AppInstanceBot`.
1580
+ # @return [String]
1581
+ #
1582
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/UpdateAppInstanceBotResponse AWS API Documentation
1583
+ #
1584
+ class UpdateAppInstanceBotResponse < Struct.new(
1585
+ :app_instance_bot_arn)
1586
+ SENSITIVE = []
1587
+ include Aws::Structure
1588
+ end
1589
+
1451
1590
  # @!attribute [rw] app_instance_arn
1452
1591
  # The ARN of the `AppInstance`.
1453
1592
  # @return [String]
@@ -1482,16 +1621,6 @@ module Aws::ChimeSDKIdentity
1482
1621
  include Aws::Structure
1483
1622
  end
1484
1623
 
1485
- # @note When making an API call, you may pass UpdateAppInstanceUserEndpointRequest
1486
- # data as a hash:
1487
- #
1488
- # {
1489
- # app_instance_user_arn: "SensitiveChimeArn", # required
1490
- # endpoint_id: "SensitiveString64", # required
1491
- # name: "SensitiveString1600",
1492
- # allow_messages: "ALL", # accepts ALL, NONE
1493
- # }
1494
- #
1495
1624
  # @!attribute [rw] app_instance_user_arn
1496
1625
  # The ARN of the `AppInstanceUser`.
1497
1626
  # @return [String]
@@ -1539,15 +1668,6 @@ module Aws::ChimeSDKIdentity
1539
1668
  include Aws::Structure
1540
1669
  end
1541
1670
 
1542
- # @note When making an API call, you may pass UpdateAppInstanceUserRequest
1543
- # data as a hash:
1544
- #
1545
- # {
1546
- # app_instance_user_arn: "ChimeArn", # required
1547
- # name: "UserName", # required
1548
- # metadata: "Metadata", # required
1549
- # }
1550
- #
1551
1671
  # @!attribute [rw] app_instance_user_arn
1552
1672
  # The ARN of the `AppInstanceUser`.
1553
1673
  # @return [String]