aws-sdk-repostspace 1.22.0 → 1.23.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/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-repostspace/client.rb +679 -99
- data/lib/aws-sdk-repostspace/client_api.rb +262 -54
- data/lib/aws-sdk-repostspace/errors.rb +15 -15
- data/lib/aws-sdk-repostspace/types.rb +572 -201
- data/lib/aws-sdk-repostspace/waiters.rb +289 -0
- data/lib/aws-sdk-repostspace.rb +3 -2
- data/sig/client.rbs +149 -35
- data/sig/errors.rbs +3 -3
- data/sig/types.rbs +159 -46
- data/sig/waiters.rbs +42 -0
- metadata +2 -1
@@ -469,28 +469,115 @@ module Aws::Repostspace
|
|
469
469
|
|
470
470
|
# @!group API Operations
|
471
471
|
|
472
|
-
# Add role to multiple users or groups in a private re:Post.
|
472
|
+
# Add role to multiple users or groups in a private re:Post channel.
|
473
|
+
#
|
474
|
+
# @option params [required, String] :space_id
|
475
|
+
# The unique ID of the private re:Post.
|
476
|
+
#
|
477
|
+
# @option params [required, String] :channel_id
|
478
|
+
# The unique ID of the private re:Post channel.
|
473
479
|
#
|
474
480
|
# @option params [required, Array<String>] :accessor_ids
|
475
|
-
# The user or group
|
481
|
+
# The user or group identifiers to add the role to.
|
476
482
|
#
|
477
|
-
# @option params [required, String] :
|
478
|
-
# The role to add to the users or groups.
|
483
|
+
# @option params [required, String] :channel_role
|
484
|
+
# The channel role to add to the users or groups.
|
485
|
+
#
|
486
|
+
# @return [Types::BatchAddChannelRoleToAccessorsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
487
|
+
#
|
488
|
+
# * {Types::BatchAddChannelRoleToAccessorsOutput#added_accessor_ids #added_accessor_ids} => Array<String>
|
489
|
+
# * {Types::BatchAddChannelRoleToAccessorsOutput#errors #errors} => Array<Types::BatchError>
|
490
|
+
#
|
491
|
+
#
|
492
|
+
# @example Example: BatchAddChannelRoleToAccessors
|
493
|
+
#
|
494
|
+
# resp = client.batch_add_channel_role_to_accessors({
|
495
|
+
# accessor_ids: [
|
496
|
+
# "12345678-1234-1234-1234-1234567890ab",
|
497
|
+
# ],
|
498
|
+
# channel_id: "WS1234567890abcdefghijkl",
|
499
|
+
# channel_role: "MODERATOR",
|
500
|
+
# space_id: "SP1234567890abcdefghijkl",
|
501
|
+
# })
|
502
|
+
#
|
503
|
+
# resp.to_h outputs the following:
|
504
|
+
# {
|
505
|
+
# errors: [
|
506
|
+
# ],
|
507
|
+
# added_accessor_ids: [
|
508
|
+
# "12345678-1234-1234-1234-1234567890ab",
|
509
|
+
# ],
|
510
|
+
# }
|
511
|
+
#
|
512
|
+
# @example Request syntax with placeholder values
|
513
|
+
#
|
514
|
+
# resp = client.batch_add_channel_role_to_accessors({
|
515
|
+
# space_id: "SpaceId", # required
|
516
|
+
# channel_id: "ChannelId", # required
|
517
|
+
# accessor_ids: ["AccessorId"], # required
|
518
|
+
# channel_role: "ASKER", # required, accepts ASKER, EXPERT, MODERATOR, SUPPORTREQUESTOR
|
519
|
+
# })
|
520
|
+
#
|
521
|
+
# @example Response structure
|
522
|
+
#
|
523
|
+
# resp.added_accessor_ids #=> Array
|
524
|
+
# resp.added_accessor_ids[0] #=> String
|
525
|
+
# resp.errors #=> Array
|
526
|
+
# resp.errors[0].accessor_id #=> String
|
527
|
+
# resp.errors[0].error #=> Integer
|
528
|
+
# resp.errors[0].message #=> String
|
529
|
+
#
|
530
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/repostspace-2022-05-13/BatchAddChannelRoleToAccessors AWS API Documentation
|
531
|
+
#
|
532
|
+
# @overload batch_add_channel_role_to_accessors(params = {})
|
533
|
+
# @param [Hash] params ({})
|
534
|
+
def batch_add_channel_role_to_accessors(params = {}, options = {})
|
535
|
+
req = build_request(:batch_add_channel_role_to_accessors, params)
|
536
|
+
req.send_request(options)
|
537
|
+
end
|
538
|
+
|
539
|
+
# Add a role to multiple users or groups in a private re:Post.
|
479
540
|
#
|
480
541
|
# @option params [required, String] :space_id
|
481
542
|
# The unique ID of the private re:Post.
|
482
543
|
#
|
544
|
+
# @option params [required, Array<String>] :accessor_ids
|
545
|
+
# The user or group accessor identifiers to add the role to.
|
546
|
+
#
|
547
|
+
# @option params [required, String] :role
|
548
|
+
# The role to add to the users or groups.
|
549
|
+
#
|
483
550
|
# @return [Types::BatchAddRoleOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
484
551
|
#
|
485
552
|
# * {Types::BatchAddRoleOutput#added_accessor_ids #added_accessor_ids} => Array<String>
|
486
553
|
# * {Types::BatchAddRoleOutput#errors #errors} => Array<Types::BatchError>
|
487
554
|
#
|
555
|
+
#
|
556
|
+
# @example Example: BatchAddRole
|
557
|
+
#
|
558
|
+
# resp = client.batch_add_role({
|
559
|
+
# accessor_ids: [
|
560
|
+
# "12345678-1234-1234-1234-1234567890ab",
|
561
|
+
# ],
|
562
|
+
# role: "EXPERT",
|
563
|
+
# space_id: "SP1234567890abcdefghijkl",
|
564
|
+
# })
|
565
|
+
#
|
566
|
+
# resp.to_h outputs the following:
|
567
|
+
# {
|
568
|
+
# errors: [
|
569
|
+
# ],
|
570
|
+
# added_accessor_ids: [
|
571
|
+
# "12345678-1234-1234-1234-1234567890ab",
|
572
|
+
# ],
|
573
|
+
# }
|
574
|
+
#
|
488
575
|
# @example Request syntax with placeholder values
|
489
576
|
#
|
490
577
|
# resp = client.batch_add_role({
|
578
|
+
# space_id: "SpaceId", # required
|
491
579
|
# accessor_ids: ["AccessorId"], # required
|
492
580
|
# role: "EXPERT", # required, accepts EXPERT, MODERATOR, ADMINISTRATOR, SUPPORTREQUESTOR
|
493
|
-
# space_id: "SpaceId", # required
|
494
581
|
# })
|
495
582
|
#
|
496
583
|
# @example Response structure
|
@@ -511,38 +598,126 @@ module Aws::Repostspace
|
|
511
598
|
req.send_request(options)
|
512
599
|
end
|
513
600
|
|
514
|
-
# Remove role from multiple users or groups in a private re:Post
|
601
|
+
# Remove a role from multiple users or groups in a private re:Post
|
602
|
+
# channel.
|
603
|
+
#
|
604
|
+
# @option params [required, String] :space_id
|
605
|
+
# The unique ID of the private re:Post.
|
606
|
+
#
|
607
|
+
# @option params [required, String] :channel_id
|
608
|
+
# The unique ID of the private re:Post channel.
|
515
609
|
#
|
516
610
|
# @option params [required, Array<String>] :accessor_ids
|
517
|
-
# The
|
611
|
+
# The users or groups identifiers to remove the role from.
|
518
612
|
#
|
519
|
-
# @option params [required, String] :
|
520
|
-
# The role to remove from the users or groups.
|
613
|
+
# @option params [required, String] :channel_role
|
614
|
+
# The channel role to remove from the users or groups.
|
615
|
+
#
|
616
|
+
# @return [Types::BatchRemoveChannelRoleFromAccessorsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
617
|
+
#
|
618
|
+
# * {Types::BatchRemoveChannelRoleFromAccessorsOutput#removed_accessor_ids #removed_accessor_ids} => Array<String>
|
619
|
+
# * {Types::BatchRemoveChannelRoleFromAccessorsOutput#errors #errors} => Array<Types::BatchError>
|
620
|
+
#
|
621
|
+
#
|
622
|
+
# @example Example: BatchRemoveChannelRoleFromAccessors
|
623
|
+
#
|
624
|
+
# resp = client.batch_remove_channel_role_from_accessors({
|
625
|
+
# accessor_ids: [
|
626
|
+
# "12345678-1234-1234-1234-1234567890ab",
|
627
|
+
# ],
|
628
|
+
# channel_id: "WS1234567890abcdefghijkl",
|
629
|
+
# channel_role: "MODERATOR",
|
630
|
+
# space_id: "SP1234567890abcdefghijkl",
|
631
|
+
# })
|
632
|
+
#
|
633
|
+
# resp.to_h outputs the following:
|
634
|
+
# {
|
635
|
+
# errors: [
|
636
|
+
# ],
|
637
|
+
# removed_accessor_ids: [
|
638
|
+
# "12345678-1234-1234-1234-1234567890ab",
|
639
|
+
# ],
|
640
|
+
# }
|
641
|
+
#
|
642
|
+
# @example Request syntax with placeholder values
|
643
|
+
#
|
644
|
+
# resp = client.batch_remove_channel_role_from_accessors({
|
645
|
+
# space_id: "SpaceId", # required
|
646
|
+
# channel_id: "ChannelId", # required
|
647
|
+
# accessor_ids: ["AccessorId"], # required
|
648
|
+
# channel_role: "ASKER", # required, accepts ASKER, EXPERT, MODERATOR, SUPPORTREQUESTOR
|
649
|
+
# })
|
650
|
+
#
|
651
|
+
# @example Response structure
|
652
|
+
#
|
653
|
+
# resp.removed_accessor_ids #=> Array
|
654
|
+
# resp.removed_accessor_ids[0] #=> String
|
655
|
+
# resp.errors #=> Array
|
656
|
+
# resp.errors[0].accessor_id #=> String
|
657
|
+
# resp.errors[0].error #=> Integer
|
658
|
+
# resp.errors[0].message #=> String
|
659
|
+
#
|
660
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/repostspace-2022-05-13/BatchRemoveChannelRoleFromAccessors AWS API Documentation
|
661
|
+
#
|
662
|
+
# @overload batch_remove_channel_role_from_accessors(params = {})
|
663
|
+
# @param [Hash] params ({})
|
664
|
+
def batch_remove_channel_role_from_accessors(params = {}, options = {})
|
665
|
+
req = build_request(:batch_remove_channel_role_from_accessors, params)
|
666
|
+
req.send_request(options)
|
667
|
+
end
|
668
|
+
|
669
|
+
# Remove a role from multiple users or groups in a private re:Post.
|
521
670
|
#
|
522
671
|
# @option params [required, String] :space_id
|
523
672
|
# The unique ID of the private re:Post.
|
524
673
|
#
|
674
|
+
# @option params [required, Array<String>] :accessor_ids
|
675
|
+
# The user or group accessor identifiers to remove the role from.
|
676
|
+
#
|
677
|
+
# @option params [required, String] :role
|
678
|
+
# The role to remove from the users or groups.
|
679
|
+
#
|
525
680
|
# @return [Types::BatchRemoveRoleOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
526
681
|
#
|
527
|
-
# * {Types::BatchRemoveRoleOutput#errors #errors} => Array<Types::BatchError>
|
528
682
|
# * {Types::BatchRemoveRoleOutput#removed_accessor_ids #removed_accessor_ids} => Array<String>
|
683
|
+
# * {Types::BatchRemoveRoleOutput#errors #errors} => Array<Types::BatchError>
|
684
|
+
#
|
685
|
+
#
|
686
|
+
# @example Example: BatchRemoveRole
|
687
|
+
#
|
688
|
+
# resp = client.batch_remove_role({
|
689
|
+
# accessor_ids: [
|
690
|
+
# "12345678-1234-1234-1234-1234567890ab",
|
691
|
+
# ],
|
692
|
+
# role: "EXPERT",
|
693
|
+
# space_id: "SP1234567890abcdefghijkl",
|
694
|
+
# })
|
695
|
+
#
|
696
|
+
# resp.to_h outputs the following:
|
697
|
+
# {
|
698
|
+
# errors: [
|
699
|
+
# ],
|
700
|
+
# removed_accessor_ids: [
|
701
|
+
# "12345678-1234-1234-1234-1234567890ab",
|
702
|
+
# ],
|
703
|
+
# }
|
529
704
|
#
|
530
705
|
# @example Request syntax with placeholder values
|
531
706
|
#
|
532
707
|
# resp = client.batch_remove_role({
|
708
|
+
# space_id: "SpaceId", # required
|
533
709
|
# accessor_ids: ["AccessorId"], # required
|
534
710
|
# role: "EXPERT", # required, accepts EXPERT, MODERATOR, ADMINISTRATOR, SUPPORTREQUESTOR
|
535
|
-
# space_id: "SpaceId", # required
|
536
711
|
# })
|
537
712
|
#
|
538
713
|
# @example Response structure
|
539
714
|
#
|
715
|
+
# resp.removed_accessor_ids #=> Array
|
716
|
+
# resp.removed_accessor_ids[0] #=> String
|
540
717
|
# resp.errors #=> Array
|
541
718
|
# resp.errors[0].accessor_id #=> String
|
542
719
|
# resp.errors[0].error #=> Integer
|
543
720
|
# resp.errors[0].message #=> String
|
544
|
-
# resp.removed_accessor_ids #=> Array
|
545
|
-
# resp.removed_accessor_ids[0] #=> String
|
546
721
|
#
|
547
722
|
# @see http://docs.aws.amazon.com/goto/WebAPI/repostspace-2022-05-13/BatchRemoveRole AWS API Documentation
|
548
723
|
#
|
@@ -553,36 +728,89 @@ module Aws::Repostspace
|
|
553
728
|
req.send_request(options)
|
554
729
|
end
|
555
730
|
|
556
|
-
# Creates an AWS re:Post Private private re:Post.
|
731
|
+
# Creates a channel in an AWS re:Post Private private re:Post.
|
557
732
|
#
|
558
|
-
# @option params [String] :
|
559
|
-
#
|
560
|
-
#
|
733
|
+
# @option params [required, String] :space_id
|
734
|
+
# The unique ID of the private re:Post.
|
735
|
+
#
|
736
|
+
# @option params [required, String] :channel_name
|
737
|
+
# The name for the channel. This must be unique per private re:Post.
|
738
|
+
#
|
739
|
+
# @option params [String] :channel_description
|
740
|
+
# A description for the channel. This is used only to help you identify
|
741
|
+
# this channel.
|
742
|
+
#
|
743
|
+
# @return [Types::CreateChannelOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
744
|
+
#
|
745
|
+
# * {Types::CreateChannelOutput#channel_id #channel_id} => String
|
746
|
+
#
|
747
|
+
#
|
748
|
+
# @example Example: CreateChannel
|
749
|
+
#
|
750
|
+
# resp = client.create_channel({
|
751
|
+
# channel_description: "Useful channel description",
|
752
|
+
# channel_name: "My First Channel",
|
753
|
+
# space_id: "SP1234567890abcdefghijkl",
|
754
|
+
# })
|
755
|
+
#
|
756
|
+
# resp.to_h outputs the following:
|
757
|
+
# {
|
758
|
+
# channel_id: "WS1234567890abcdefghijkl",
|
759
|
+
# }
|
760
|
+
#
|
761
|
+
# @example Request syntax with placeholder values
|
762
|
+
#
|
763
|
+
# resp = client.create_channel({
|
764
|
+
# space_id: "SpaceId", # required
|
765
|
+
# channel_name: "ChannelName", # required
|
766
|
+
# channel_description: "ChannelDescription",
|
767
|
+
# })
|
768
|
+
#
|
769
|
+
# @example Response structure
|
770
|
+
#
|
771
|
+
# resp.channel_id #=> String
|
772
|
+
#
|
773
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/repostspace-2022-05-13/CreateChannel AWS API Documentation
|
774
|
+
#
|
775
|
+
# @overload create_channel(params = {})
|
776
|
+
# @param [Hash] params ({})
|
777
|
+
def create_channel(params = {}, options = {})
|
778
|
+
req = build_request(:create_channel, params)
|
779
|
+
req.send_request(options)
|
780
|
+
end
|
781
|
+
|
782
|
+
# Creates an AWS re:Post Private private re:Post.
|
561
783
|
#
|
562
784
|
# @option params [required, String] :name
|
563
785
|
# The name for the private re:Post. This must be unique in your account.
|
564
786
|
#
|
565
|
-
# @option params [String] :role_arn
|
566
|
-
# The IAM role that grants permissions to the private re:Post to convert
|
567
|
-
# unanswered questions into AWS support tickets.
|
568
|
-
#
|
569
787
|
# @option params [required, String] :subdomain
|
570
788
|
# The subdomain that you use to access your AWS re:Post Private private
|
571
789
|
# re:Post. All custom subdomains must be approved by AWS before use. In
|
572
790
|
# addition to your custom subdomain, all private re:Posts are issued an
|
573
791
|
# AWS generated subdomain for immediate use.
|
574
792
|
#
|
575
|
-
# @option params [Hash<String,String>] :tags
|
576
|
-
# The list of tags associated with the private re:Post.
|
577
|
-
#
|
578
793
|
# @option params [required, String] :tier
|
579
794
|
# The pricing tier for the private re:Post.
|
580
795
|
#
|
796
|
+
# @option params [String] :description
|
797
|
+
# A description for the private re:Post. This is used only to help you
|
798
|
+
# identify this private re:Post.
|
799
|
+
#
|
581
800
|
# @option params [String] :user_kms_key
|
582
801
|
# The AWS KMS key ARN that’s used for the AWS KMS encryption. If you
|
583
802
|
# don't provide a key, your data is encrypted by default with a key
|
584
803
|
# that AWS owns and manages for you.
|
585
804
|
#
|
805
|
+
# @option params [Hash<String,String>] :tags
|
806
|
+
# The list of tags associated with the private re:Post.
|
807
|
+
#
|
808
|
+
# @option params [String] :role_arn
|
809
|
+
# The IAM role that grants permissions to the private re:Post to convert
|
810
|
+
# unanswered questions into AWS support tickets.
|
811
|
+
#
|
812
|
+
# @option params [Types::SupportedEmailDomainsParameters] :supported_email_domains
|
813
|
+
#
|
586
814
|
# @return [Types::CreateSpaceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
587
815
|
#
|
588
816
|
# * {Types::CreateSpaceOutput#space_id #space_id} => String
|
@@ -590,15 +818,19 @@ module Aws::Repostspace
|
|
590
818
|
# @example Request syntax with placeholder values
|
591
819
|
#
|
592
820
|
# resp = client.create_space({
|
593
|
-
# description: "SpaceDescription",
|
594
821
|
# name: "SpaceName", # required
|
595
|
-
# role_arn: "Arn",
|
596
822
|
# subdomain: "SpaceSubdomain", # required
|
823
|
+
# tier: "BASIC", # required, accepts BASIC, STANDARD
|
824
|
+
# description: "SpaceDescription",
|
825
|
+
# user_kms_key: "KMSKey",
|
597
826
|
# tags: {
|
598
827
|
# "TagKey" => "TagValue",
|
599
828
|
# },
|
600
|
-
#
|
601
|
-
#
|
829
|
+
# role_arn: "Arn",
|
830
|
+
# supported_email_domains: {
|
831
|
+
# enabled: "ENABLED", # accepts ENABLED, DISABLED
|
832
|
+
# allowed_domains: ["EmailDomain"],
|
833
|
+
# },
|
602
834
|
# })
|
603
835
|
#
|
604
836
|
# @example Response structure
|
@@ -639,19 +871,19 @@ module Aws::Repostspace
|
|
639
871
|
# Removes the user or group from the list of administrators of the
|
640
872
|
# private re:Post.
|
641
873
|
#
|
642
|
-
# @option params [required, String] :admin_id
|
643
|
-
# The ID of the admin to remove.
|
644
|
-
#
|
645
874
|
# @option params [required, String] :space_id
|
646
875
|
# The ID of the private re:Post to remove the admin from.
|
647
876
|
#
|
877
|
+
# @option params [required, String] :admin_id
|
878
|
+
# The ID of the admin to remove.
|
879
|
+
#
|
648
880
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
649
881
|
#
|
650
882
|
# @example Request syntax with placeholder values
|
651
883
|
#
|
652
884
|
# resp = client.deregister_admin({
|
653
|
-
# admin_id: "AdminId", # required
|
654
885
|
# space_id: "SpaceId", # required
|
886
|
+
# admin_id: "AdminId", # required
|
655
887
|
# })
|
656
888
|
#
|
657
889
|
# @see http://docs.aws.amazon.com/goto/WebAPI/repostspace-2022-05-13/DeregisterAdmin AWS API Documentation
|
@@ -663,6 +895,83 @@ module Aws::Repostspace
|
|
663
895
|
req.send_request(options)
|
664
896
|
end
|
665
897
|
|
898
|
+
# Displays information about a channel in a private re:Post.
|
899
|
+
#
|
900
|
+
# @option params [required, String] :space_id
|
901
|
+
# The unique ID of the private re:Post.
|
902
|
+
#
|
903
|
+
# @option params [required, String] :channel_id
|
904
|
+
# The unique ID of the private re:Post channel.
|
905
|
+
#
|
906
|
+
# @return [Types::GetChannelOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
907
|
+
#
|
908
|
+
# * {Types::GetChannelOutput#space_id #space_id} => String
|
909
|
+
# * {Types::GetChannelOutput#channel_id #channel_id} => String
|
910
|
+
# * {Types::GetChannelOutput#channel_name #channel_name} => String
|
911
|
+
# * {Types::GetChannelOutput#channel_description #channel_description} => String
|
912
|
+
# * {Types::GetChannelOutput#create_date_time #create_date_time} => Time
|
913
|
+
# * {Types::GetChannelOutput#delete_date_time #delete_date_time} => Time
|
914
|
+
# * {Types::GetChannelOutput#channel_roles #channel_roles} => Hash<String,Array<String>>
|
915
|
+
# * {Types::GetChannelOutput#channel_status #channel_status} => String
|
916
|
+
#
|
917
|
+
#
|
918
|
+
# @example Example: GetChannel
|
919
|
+
#
|
920
|
+
# resp = client.get_channel({
|
921
|
+
# channel_id: "WS1234567890abcdefghijkl",
|
922
|
+
# space_id: "SP1234567890abcdefghijkl",
|
923
|
+
# })
|
924
|
+
#
|
925
|
+
# resp.to_h outputs the following:
|
926
|
+
# {
|
927
|
+
# channel_description: "Useful channel description",
|
928
|
+
# channel_id: "WS1234567890abcdefghijkl",
|
929
|
+
# channel_name: "My First Channel",
|
930
|
+
# channel_roles: {
|
931
|
+
# "12345678-1234-1234-1234-1234567890ab" => [
|
932
|
+
# "ASKER",
|
933
|
+
# ],
|
934
|
+
# },
|
935
|
+
# channel_status: "CREATED",
|
936
|
+
# create_date_time: Time.parse("2025-02-13T18:49:13.713Z"),
|
937
|
+
# space_id: "SP1234567890abcdefghijkl",
|
938
|
+
# }
|
939
|
+
#
|
940
|
+
# @example Request syntax with placeholder values
|
941
|
+
#
|
942
|
+
# resp = client.get_channel({
|
943
|
+
# space_id: "SpaceId", # required
|
944
|
+
# channel_id: "ChannelId", # required
|
945
|
+
# })
|
946
|
+
#
|
947
|
+
# @example Response structure
|
948
|
+
#
|
949
|
+
# resp.space_id #=> String
|
950
|
+
# resp.channel_id #=> String
|
951
|
+
# resp.channel_name #=> String
|
952
|
+
# resp.channel_description #=> String
|
953
|
+
# resp.create_date_time #=> Time
|
954
|
+
# resp.delete_date_time #=> Time
|
955
|
+
# resp.channel_roles #=> Hash
|
956
|
+
# resp.channel_roles["AccessorId"] #=> Array
|
957
|
+
# resp.channel_roles["AccessorId"][0] #=> String, one of "ASKER", "EXPERT", "MODERATOR", "SUPPORTREQUESTOR"
|
958
|
+
# resp.channel_status #=> String, one of "CREATED", "CREATING", "CREATE_FAILED", "DELETED", "DELETING", "DELETE_FAILED"
|
959
|
+
#
|
960
|
+
#
|
961
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
962
|
+
#
|
963
|
+
# * channel_created
|
964
|
+
# * channel_deleted
|
965
|
+
#
|
966
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/repostspace-2022-05-13/GetChannel AWS API Documentation
|
967
|
+
#
|
968
|
+
# @overload get_channel(params = {})
|
969
|
+
# @param [Hash] params ({})
|
970
|
+
def get_channel(params = {}, options = {})
|
971
|
+
req = build_request(:get_channel, params)
|
972
|
+
req.send_request(options)
|
973
|
+
end
|
974
|
+
|
666
975
|
# Displays information about the AWS re:Post Private private re:Post.
|
667
976
|
#
|
668
977
|
# @option params [required, String] :space_id
|
@@ -670,27 +979,30 @@ module Aws::Repostspace
|
|
670
979
|
#
|
671
980
|
# @return [Types::GetSpaceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
672
981
|
#
|
982
|
+
# * {Types::GetSpaceOutput#space_id #space_id} => String
|
673
983
|
# * {Types::GetSpaceOutput#arn #arn} => String
|
674
|
-
# * {Types::GetSpaceOutput#
|
984
|
+
# * {Types::GetSpaceOutput#name #name} => String
|
985
|
+
# * {Types::GetSpaceOutput#status #status} => String
|
675
986
|
# * {Types::GetSpaceOutput#configuration_status #configuration_status} => String
|
676
|
-
# * {Types::GetSpaceOutput#
|
677
|
-
# * {Types::GetSpaceOutput#
|
678
|
-
# * {Types::GetSpaceOutput#
|
679
|
-
# * {Types::GetSpaceOutput#delete_date_time #delete_date_time} => Time
|
987
|
+
# * {Types::GetSpaceOutput#client_id #client_id} => String
|
988
|
+
# * {Types::GetSpaceOutput#identity_store_id #identity_store_id} => String
|
989
|
+
# * {Types::GetSpaceOutput#application_arn #application_arn} => String
|
680
990
|
# * {Types::GetSpaceOutput#description #description} => String
|
681
|
-
# * {Types::GetSpaceOutput#
|
682
|
-
# * {Types::GetSpaceOutput#
|
991
|
+
# * {Types::GetSpaceOutput#vanity_domain_status #vanity_domain_status} => String
|
992
|
+
# * {Types::GetSpaceOutput#vanity_domain #vanity_domain} => String
|
683
993
|
# * {Types::GetSpaceOutput#random_domain #random_domain} => String
|
684
|
-
# * {Types::GetSpaceOutput#
|
685
|
-
# * {Types::GetSpaceOutput#
|
686
|
-
# * {Types::GetSpaceOutput#
|
687
|
-
# * {Types::GetSpaceOutput#storage_limit #storage_limit} => Integer
|
994
|
+
# * {Types::GetSpaceOutput#customer_role_arn #customer_role_arn} => String
|
995
|
+
# * {Types::GetSpaceOutput#create_date_time #create_date_time} => Time
|
996
|
+
# * {Types::GetSpaceOutput#delete_date_time #delete_date_time} => Time
|
688
997
|
# * {Types::GetSpaceOutput#tier #tier} => String
|
998
|
+
# * {Types::GetSpaceOutput#storage_limit #storage_limit} => Integer
|
689
999
|
# * {Types::GetSpaceOutput#user_admins #user_admins} => Array<String>
|
690
|
-
# * {Types::GetSpaceOutput#
|
1000
|
+
# * {Types::GetSpaceOutput#group_admins #group_admins} => Array<String>
|
1001
|
+
# * {Types::GetSpaceOutput#roles #roles} => Hash<String,Array<String>>
|
691
1002
|
# * {Types::GetSpaceOutput#user_kms_key #user_kms_key} => String
|
692
|
-
# * {Types::GetSpaceOutput#
|
693
|
-
# * {Types::GetSpaceOutput#
|
1003
|
+
# * {Types::GetSpaceOutput#user_count #user_count} => Integer
|
1004
|
+
# * {Types::GetSpaceOutput#content_size #content_size} => Integer
|
1005
|
+
# * {Types::GetSpaceOutput#supported_email_domains #supported_email_domains} => Types::SupportedEmailDomainsStatus
|
694
1006
|
#
|
695
1007
|
# @example Request syntax with placeholder values
|
696
1008
|
#
|
@@ -700,31 +1012,42 @@ module Aws::Repostspace
|
|
700
1012
|
#
|
701
1013
|
# @example Response structure
|
702
1014
|
#
|
1015
|
+
# resp.space_id #=> String
|
703
1016
|
# resp.arn #=> String
|
704
|
-
# resp.
|
1017
|
+
# resp.name #=> String
|
1018
|
+
# resp.status #=> String
|
705
1019
|
# resp.configuration_status #=> String, one of "CONFIGURED", "UNCONFIGURED"
|
706
|
-
# resp.
|
707
|
-
# resp.
|
1020
|
+
# resp.client_id #=> String
|
1021
|
+
# resp.identity_store_id #=> String
|
1022
|
+
# resp.application_arn #=> String
|
1023
|
+
# resp.description #=> String
|
1024
|
+
# resp.vanity_domain_status #=> String, one of "PENDING", "APPROVED", "UNAPPROVED"
|
1025
|
+
# resp.vanity_domain #=> String
|
1026
|
+
# resp.random_domain #=> String
|
708
1027
|
# resp.customer_role_arn #=> String
|
1028
|
+
# resp.create_date_time #=> Time
|
709
1029
|
# resp.delete_date_time #=> Time
|
710
|
-
# resp.
|
1030
|
+
# resp.tier #=> String, one of "BASIC", "STANDARD"
|
1031
|
+
# resp.storage_limit #=> Integer
|
1032
|
+
# resp.user_admins #=> Array
|
1033
|
+
# resp.user_admins[0] #=> String
|
711
1034
|
# resp.group_admins #=> Array
|
712
1035
|
# resp.group_admins[0] #=> String
|
713
|
-
# resp.name #=> String
|
714
|
-
# resp.random_domain #=> String
|
715
1036
|
# resp.roles #=> Hash
|
716
1037
|
# resp.roles["AccessorId"] #=> Array
|
717
1038
|
# resp.roles["AccessorId"][0] #=> String, one of "EXPERT", "MODERATOR", "ADMINISTRATOR", "SUPPORTREQUESTOR"
|
718
|
-
# resp.space_id #=> String
|
719
|
-
# resp.status #=> String
|
720
|
-
# resp.storage_limit #=> Integer
|
721
|
-
# resp.tier #=> String, one of "BASIC", "STANDARD"
|
722
|
-
# resp.user_admins #=> Array
|
723
|
-
# resp.user_admins[0] #=> String
|
724
|
-
# resp.user_count #=> Integer
|
725
1039
|
# resp.user_kms_key #=> String
|
726
|
-
# resp.
|
727
|
-
# resp.
|
1040
|
+
# resp.user_count #=> Integer
|
1041
|
+
# resp.content_size #=> Integer
|
1042
|
+
# resp.supported_email_domains.enabled #=> String, one of "ENABLED", "DISABLED", "NOT_ALLOWED"
|
1043
|
+
# resp.supported_email_domains.allowed_domains #=> Array
|
1044
|
+
# resp.supported_email_domains.allowed_domains[0] #=> String
|
1045
|
+
#
|
1046
|
+
#
|
1047
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
1048
|
+
#
|
1049
|
+
# * space_created
|
1050
|
+
# * space_deleted
|
728
1051
|
#
|
729
1052
|
# @see http://docs.aws.amazon.com/goto/WebAPI/repostspace-2022-05-13/GetSpace AWS API Documentation
|
730
1053
|
#
|
@@ -735,50 +1058,137 @@ module Aws::Repostspace
|
|
735
1058
|
req.send_request(options)
|
736
1059
|
end
|
737
1060
|
|
738
|
-
# Returns
|
739
|
-
#
|
1061
|
+
# Returns the list of channel within a private re:Post with some
|
1062
|
+
# information about each channel.
|
1063
|
+
#
|
1064
|
+
# @option params [required, String] :space_id
|
1065
|
+
# The unique ID of the private re:Post.
|
1066
|
+
#
|
1067
|
+
# @option params [String] :next_token
|
1068
|
+
# The token for the next set of channel to return. You receive this
|
1069
|
+
# token from a previous ListChannels operation.
|
740
1070
|
#
|
741
1071
|
# @option params [Integer] :max_results
|
742
|
-
# The maximum number of
|
1072
|
+
# The maximum number of channels to include in the results.
|
1073
|
+
#
|
1074
|
+
# @return [Types::ListChannelsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1075
|
+
#
|
1076
|
+
# * {Types::ListChannelsOutput#channels #channels} => Array<Types::ChannelData>
|
1077
|
+
# * {Types::ListChannelsOutput#next_token #next_token} => String
|
1078
|
+
#
|
1079
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1080
|
+
#
|
1081
|
+
#
|
1082
|
+
# @example Example: ListChannels
|
1083
|
+
#
|
1084
|
+
# resp = client.list_channels({
|
1085
|
+
# space_id: "SP1234567890abcdefghijkl",
|
1086
|
+
# })
|
1087
|
+
#
|
1088
|
+
# resp.to_h outputs the following:
|
1089
|
+
# {
|
1090
|
+
# channels: [
|
1091
|
+
# {
|
1092
|
+
# channel_description: "Useful channel description",
|
1093
|
+
# channel_id: "WS1234567890abcdefghijkl",
|
1094
|
+
# channel_name: "My First Channel",
|
1095
|
+
# channel_status: "CREATED",
|
1096
|
+
# create_date_time: Time.parse("2020-02-20T20:20:20.420Z"),
|
1097
|
+
# group_count: 1,
|
1098
|
+
# space_id: "SP1234567890abcdefghijkl",
|
1099
|
+
# user_count: 5,
|
1100
|
+
# },
|
1101
|
+
# {
|
1102
|
+
# channel_description: "Better channel description",
|
1103
|
+
# channel_id: "WSabcdefghijkl1234567890",
|
1104
|
+
# channel_name: "Better Channel",
|
1105
|
+
# channel_status: "CREATED",
|
1106
|
+
# create_date_time: Time.parse("2025-06-20T14:43:34.201Z"),
|
1107
|
+
# group_count: 0,
|
1108
|
+
# space_id: "SP1234567890abcdefghijkl",
|
1109
|
+
# user_count: 1,
|
1110
|
+
# },
|
1111
|
+
# ],
|
1112
|
+
# }
|
1113
|
+
#
|
1114
|
+
# @example Request syntax with placeholder values
|
1115
|
+
#
|
1116
|
+
# resp = client.list_channels({
|
1117
|
+
# space_id: "SpaceId", # required
|
1118
|
+
# next_token: "String",
|
1119
|
+
# max_results: 1,
|
1120
|
+
# })
|
1121
|
+
#
|
1122
|
+
# @example Response structure
|
1123
|
+
#
|
1124
|
+
# resp.channels #=> Array
|
1125
|
+
# resp.channels[0].space_id #=> String
|
1126
|
+
# resp.channels[0].channel_id #=> String
|
1127
|
+
# resp.channels[0].channel_name #=> String
|
1128
|
+
# resp.channels[0].channel_description #=> String
|
1129
|
+
# resp.channels[0].create_date_time #=> Time
|
1130
|
+
# resp.channels[0].delete_date_time #=> Time
|
1131
|
+
# resp.channels[0].channel_status #=> String, one of "CREATED", "CREATING", "CREATE_FAILED", "DELETED", "DELETING", "DELETE_FAILED"
|
1132
|
+
# resp.channels[0].user_count #=> Integer
|
1133
|
+
# resp.channels[0].group_count #=> Integer
|
1134
|
+
# resp.next_token #=> String
|
1135
|
+
#
|
1136
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/repostspace-2022-05-13/ListChannels AWS API Documentation
|
1137
|
+
#
|
1138
|
+
# @overload list_channels(params = {})
|
1139
|
+
# @param [Hash] params ({})
|
1140
|
+
def list_channels(params = {}, options = {})
|
1141
|
+
req = build_request(:list_channels, params)
|
1142
|
+
req.send_request(options)
|
1143
|
+
end
|
1144
|
+
|
1145
|
+
# Returns a list of AWS re:Post Private private re:Posts in the account
|
1146
|
+
# with some information about each private re:Post.
|
743
1147
|
#
|
744
1148
|
# @option params [String] :next_token
|
745
1149
|
# The token for the next set of private re:Posts to return. You receive
|
746
1150
|
# this token from a previous ListSpaces operation.
|
747
1151
|
#
|
1152
|
+
# @option params [Integer] :max_results
|
1153
|
+
# The maximum number of private re:Posts to include in the results.
|
1154
|
+
#
|
748
1155
|
# @return [Types::ListSpacesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
749
1156
|
#
|
750
|
-
# * {Types::ListSpacesOutput#next_token #next_token} => String
|
751
1157
|
# * {Types::ListSpacesOutput#spaces #spaces} => Array<Types::SpaceData>
|
1158
|
+
# * {Types::ListSpacesOutput#next_token #next_token} => String
|
752
1159
|
#
|
753
1160
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
754
1161
|
#
|
755
1162
|
# @example Request syntax with placeholder values
|
756
1163
|
#
|
757
1164
|
# resp = client.list_spaces({
|
758
|
-
# max_results: 1,
|
759
1165
|
# next_token: "String",
|
1166
|
+
# max_results: 1,
|
760
1167
|
# })
|
761
1168
|
#
|
762
1169
|
# @example Response structure
|
763
1170
|
#
|
764
|
-
# resp.next_token #=> String
|
765
1171
|
# resp.spaces #=> Array
|
1172
|
+
# resp.spaces[0].space_id #=> String
|
766
1173
|
# resp.spaces[0].arn #=> String
|
767
|
-
# resp.spaces[0].configuration_status #=> String, one of "CONFIGURED", "UNCONFIGURED"
|
768
|
-
# resp.spaces[0].content_size #=> Integer
|
769
|
-
# resp.spaces[0].create_date_time #=> Time
|
770
|
-
# resp.spaces[0].delete_date_time #=> Time
|
771
|
-
# resp.spaces[0].description #=> String
|
772
1174
|
# resp.spaces[0].name #=> String
|
773
|
-
# resp.spaces[0].
|
774
|
-
# resp.spaces[0].space_id #=> String
|
1175
|
+
# resp.spaces[0].description #=> String
|
775
1176
|
# resp.spaces[0].status #=> String
|
776
|
-
# resp.spaces[0].
|
1177
|
+
# resp.spaces[0].configuration_status #=> String, one of "CONFIGURED", "UNCONFIGURED"
|
1178
|
+
# resp.spaces[0].vanity_domain_status #=> String, one of "PENDING", "APPROVED", "UNAPPROVED"
|
1179
|
+
# resp.spaces[0].vanity_domain #=> String
|
1180
|
+
# resp.spaces[0].random_domain #=> String
|
777
1181
|
# resp.spaces[0].tier #=> String, one of "BASIC", "STANDARD"
|
778
|
-
# resp.spaces[0].
|
1182
|
+
# resp.spaces[0].storage_limit #=> Integer
|
1183
|
+
# resp.spaces[0].create_date_time #=> Time
|
1184
|
+
# resp.spaces[0].delete_date_time #=> Time
|
779
1185
|
# resp.spaces[0].user_kms_key #=> String
|
780
|
-
# resp.spaces[0].
|
781
|
-
# resp.spaces[0].
|
1186
|
+
# resp.spaces[0].user_count #=> Integer
|
1187
|
+
# resp.spaces[0].content_size #=> Integer
|
1188
|
+
# resp.spaces[0].supported_email_domains.enabled #=> String, one of "ENABLED", "DISABLED", "NOT_ALLOWED"
|
1189
|
+
# resp.spaces[0].supported_email_domains.allowed_domains #=> Array
|
1190
|
+
# resp.spaces[0].supported_email_domains.allowed_domains[0] #=> String
|
1191
|
+
# resp.next_token #=> String
|
782
1192
|
#
|
783
1193
|
# @see http://docs.aws.amazon.com/goto/WebAPI/repostspace-2022-05-13/ListSpaces AWS API Documentation
|
784
1194
|
#
|
@@ -823,19 +1233,19 @@ module Aws::Repostspace
|
|
823
1233
|
# Adds a user or group to the list of administrators of the private
|
824
1234
|
# re:Post.
|
825
1235
|
#
|
826
|
-
# @option params [required, String] :admin_id
|
827
|
-
# The ID of the administrator.
|
828
|
-
#
|
829
1236
|
# @option params [required, String] :space_id
|
830
1237
|
# The ID of the private re:Post.
|
831
1238
|
#
|
1239
|
+
# @option params [required, String] :admin_id
|
1240
|
+
# The ID of the administrator.
|
1241
|
+
#
|
832
1242
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
833
1243
|
#
|
834
1244
|
# @example Request syntax with placeholder values
|
835
1245
|
#
|
836
1246
|
# resp = client.register_admin({
|
837
|
-
# admin_id: "AdminId", # required
|
838
1247
|
# space_id: "SpaceId", # required
|
1248
|
+
# admin_id: "AdminId", # required
|
839
1249
|
# })
|
840
1250
|
#
|
841
1251
|
# @see http://docs.aws.amazon.com/goto/WebAPI/repostspace-2022-05-13/RegisterAdmin AWS API Documentation
|
@@ -849,27 +1259,27 @@ module Aws::Repostspace
|
|
849
1259
|
|
850
1260
|
# Sends an invitation email to selected users and groups.
|
851
1261
|
#
|
852
|
-
# @option params [required, Array<String>] :accessor_ids
|
853
|
-
# The array of identifiers for the users and groups.
|
854
|
-
#
|
855
|
-
# @option params [required, String] :body
|
856
|
-
# The body of the invite.
|
857
|
-
#
|
858
1262
|
# @option params [required, String] :space_id
|
859
1263
|
# The ID of the private re:Post.
|
860
1264
|
#
|
1265
|
+
# @option params [required, Array<String>] :accessor_ids
|
1266
|
+
# The array of identifiers for the users and groups.
|
1267
|
+
#
|
861
1268
|
# @option params [required, String] :title
|
862
1269
|
# The title of the invite.
|
863
1270
|
#
|
1271
|
+
# @option params [required, String] :body
|
1272
|
+
# The body of the invite.
|
1273
|
+
#
|
864
1274
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
865
1275
|
#
|
866
1276
|
# @example Request syntax with placeholder values
|
867
1277
|
#
|
868
1278
|
# resp = client.send_invites({
|
869
|
-
# accessor_ids: ["AccessorId"], # required
|
870
|
-
# body: "InviteBody", # required
|
871
1279
|
# space_id: "SpaceId", # required
|
1280
|
+
# accessor_ids: ["AccessorId"], # required
|
872
1281
|
# title: "InviteTitle", # required
|
1282
|
+
# body: "InviteBody", # required
|
873
1283
|
# })
|
874
1284
|
#
|
875
1285
|
# @see http://docs.aws.amazon.com/goto/WebAPI/repostspace-2022-05-13/SendInvites AWS API Documentation
|
@@ -943,31 +1353,82 @@ module Aws::Repostspace
|
|
943
1353
|
req.send_request(options)
|
944
1354
|
end
|
945
1355
|
|
1356
|
+
# Modifies an existing channel.
|
1357
|
+
#
|
1358
|
+
# @option params [required, String] :space_id
|
1359
|
+
# The unique ID of the private re:Post.
|
1360
|
+
#
|
1361
|
+
# @option params [required, String] :channel_id
|
1362
|
+
# The unique ID of the private re:Post channel.
|
1363
|
+
#
|
1364
|
+
# @option params [required, String] :channel_name
|
1365
|
+
# The name for the channel. This must be unique per private re:Post.
|
1366
|
+
#
|
1367
|
+
# @option params [String] :channel_description
|
1368
|
+
# A description for the channel. This is used only to help you identify
|
1369
|
+
# this channel.
|
1370
|
+
#
|
1371
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1372
|
+
#
|
1373
|
+
#
|
1374
|
+
# @example Example: UpdateChannel
|
1375
|
+
#
|
1376
|
+
# resp = client.update_channel({
|
1377
|
+
# channel_description: "Better channel description",
|
1378
|
+
# channel_id: "WS1234567890abcdefghijkl",
|
1379
|
+
# channel_name: "Better Channel",
|
1380
|
+
# space_id: "SP1234567890abcdefghijkl",
|
1381
|
+
# })
|
1382
|
+
#
|
1383
|
+
# @example Request syntax with placeholder values
|
1384
|
+
#
|
1385
|
+
# resp = client.update_channel({
|
1386
|
+
# space_id: "SpaceId", # required
|
1387
|
+
# channel_id: "ChannelId", # required
|
1388
|
+
# channel_name: "ChannelName", # required
|
1389
|
+
# channel_description: "ChannelDescription",
|
1390
|
+
# })
|
1391
|
+
#
|
1392
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/repostspace-2022-05-13/UpdateChannel AWS API Documentation
|
1393
|
+
#
|
1394
|
+
# @overload update_channel(params = {})
|
1395
|
+
# @param [Hash] params ({})
|
1396
|
+
def update_channel(params = {}, options = {})
|
1397
|
+
req = build_request(:update_channel, params)
|
1398
|
+
req.send_request(options)
|
1399
|
+
end
|
1400
|
+
|
946
1401
|
# Modifies an existing AWS re:Post Private private re:Post.
|
947
1402
|
#
|
1403
|
+
# @option params [required, String] :space_id
|
1404
|
+
# The unique ID of this private re:Post.
|
1405
|
+
#
|
948
1406
|
# @option params [String] :description
|
949
1407
|
# A description for the private re:Post. This is used only to help you
|
950
1408
|
# identify this private re:Post.
|
951
1409
|
#
|
1410
|
+
# @option params [String] :tier
|
1411
|
+
# The pricing tier of this private re:Post.
|
1412
|
+
#
|
952
1413
|
# @option params [String] :role_arn
|
953
1414
|
# The IAM role that grants permissions to the private re:Post to convert
|
954
1415
|
# unanswered questions into AWS support tickets.
|
955
1416
|
#
|
956
|
-
# @option params [
|
957
|
-
# The unique ID of this private re:Post.
|
958
|
-
#
|
959
|
-
# @option params [String] :tier
|
960
|
-
# The pricing tier of this private re:Post.
|
1417
|
+
# @option params [Types::SupportedEmailDomainsParameters] :supported_email_domains
|
961
1418
|
#
|
962
1419
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
963
1420
|
#
|
964
1421
|
# @example Request syntax with placeholder values
|
965
1422
|
#
|
966
1423
|
# resp = client.update_space({
|
967
|
-
# description: "SpaceDescription",
|
968
|
-
# role_arn: "Arn",
|
969
1424
|
# space_id: "SpaceId", # required
|
1425
|
+
# description: "SpaceDescription",
|
970
1426
|
# tier: "BASIC", # accepts BASIC, STANDARD
|
1427
|
+
# role_arn: "Arn",
|
1428
|
+
# supported_email_domains: {
|
1429
|
+
# enabled: "ENABLED", # accepts ENABLED, DISABLED
|
1430
|
+
# allowed_domains: ["EmailDomain"],
|
1431
|
+
# },
|
971
1432
|
# })
|
972
1433
|
#
|
973
1434
|
# @see http://docs.aws.amazon.com/goto/WebAPI/repostspace-2022-05-13/UpdateSpace AWS API Documentation
|
@@ -997,14 +1458,133 @@ module Aws::Repostspace
|
|
997
1458
|
tracer: tracer
|
998
1459
|
)
|
999
1460
|
context[:gem_name] = 'aws-sdk-repostspace'
|
1000
|
-
context[:gem_version] = '1.
|
1461
|
+
context[:gem_version] = '1.23.0'
|
1001
1462
|
Seahorse::Client::Request.new(handlers, context)
|
1002
1463
|
end
|
1003
1464
|
|
1465
|
+
# Polls an API operation until a resource enters a desired state.
|
1466
|
+
#
|
1467
|
+
# ## Basic Usage
|
1468
|
+
#
|
1469
|
+
# A waiter will call an API operation until:
|
1470
|
+
#
|
1471
|
+
# * It is successful
|
1472
|
+
# * It enters a terminal state
|
1473
|
+
# * It makes the maximum number of attempts
|
1474
|
+
#
|
1475
|
+
# In between attempts, the waiter will sleep.
|
1476
|
+
#
|
1477
|
+
# # polls in a loop, sleeping between attempts
|
1478
|
+
# client.wait_until(waiter_name, params)
|
1479
|
+
#
|
1480
|
+
# ## Configuration
|
1481
|
+
#
|
1482
|
+
# You can configure the maximum number of polling attempts, and the
|
1483
|
+
# delay (in seconds) between each polling attempt. You can pass
|
1484
|
+
# configuration as the final arguments hash.
|
1485
|
+
#
|
1486
|
+
# # poll for ~25 seconds
|
1487
|
+
# client.wait_until(waiter_name, params, {
|
1488
|
+
# max_attempts: 5,
|
1489
|
+
# delay: 5,
|
1490
|
+
# })
|
1491
|
+
#
|
1492
|
+
# ## Callbacks
|
1493
|
+
#
|
1494
|
+
# You can be notified before each polling attempt and before each
|
1495
|
+
# delay. If you throw `:success` or `:failure` from these callbacks,
|
1496
|
+
# it will terminate the waiter.
|
1497
|
+
#
|
1498
|
+
# started_at = Time.now
|
1499
|
+
# client.wait_until(waiter_name, params, {
|
1500
|
+
#
|
1501
|
+
# # disable max attempts
|
1502
|
+
# max_attempts: nil,
|
1503
|
+
#
|
1504
|
+
# # poll for 1 hour, instead of a number of attempts
|
1505
|
+
# before_wait: -> (attempts, response) do
|
1506
|
+
# throw :failure if Time.now - started_at > 3600
|
1507
|
+
# end
|
1508
|
+
# })
|
1509
|
+
#
|
1510
|
+
# ## Handling Errors
|
1511
|
+
#
|
1512
|
+
# When a waiter is unsuccessful, it will raise an error.
|
1513
|
+
# All of the failure errors extend from
|
1514
|
+
# {Aws::Waiters::Errors::WaiterFailed}.
|
1515
|
+
#
|
1516
|
+
# begin
|
1517
|
+
# client.wait_until(...)
|
1518
|
+
# rescue Aws::Waiters::Errors::WaiterFailed
|
1519
|
+
# # resource did not enter the desired state in time
|
1520
|
+
# end
|
1521
|
+
#
|
1522
|
+
# ## Valid Waiters
|
1523
|
+
#
|
1524
|
+
# The following table lists the valid waiter names, the operations they call,
|
1525
|
+
# and the default `:delay` and `:max_attempts` values.
|
1526
|
+
#
|
1527
|
+
# | waiter_name | params | :delay | :max_attempts |
|
1528
|
+
# | --------------- | -------------------- | -------- | ------------- |
|
1529
|
+
# | channel_created | {Client#get_channel} | 2 | 60 |
|
1530
|
+
# | channel_deleted | {Client#get_channel} | 2 | 60 |
|
1531
|
+
# | space_created | {Client#get_space} | 300 | 24 |
|
1532
|
+
# | space_deleted | {Client#get_space} | 300 | 24 |
|
1533
|
+
#
|
1534
|
+
# @raise [Errors::FailureStateError] Raised when the waiter terminates
|
1535
|
+
# because the waiter has entered a state that it will not transition
|
1536
|
+
# out of, preventing success.
|
1537
|
+
#
|
1538
|
+
# @raise [Errors::TooManyAttemptsError] Raised when the configured
|
1539
|
+
# maximum number of attempts have been made, and the waiter is not
|
1540
|
+
# yet successful.
|
1541
|
+
#
|
1542
|
+
# @raise [Errors::UnexpectedError] Raised when an error is encounted
|
1543
|
+
# while polling for a resource that is not expected.
|
1544
|
+
#
|
1545
|
+
# @raise [Errors::NoSuchWaiterError] Raised when you request to wait
|
1546
|
+
# for an unknown state.
|
1547
|
+
#
|
1548
|
+
# @return [Boolean] Returns `true` if the waiter was successful.
|
1549
|
+
# @param [Symbol] waiter_name
|
1550
|
+
# @param [Hash] params ({})
|
1551
|
+
# @param [Hash] options ({})
|
1552
|
+
# @option options [Integer] :max_attempts
|
1553
|
+
# @option options [Integer] :delay
|
1554
|
+
# @option options [Proc] :before_attempt
|
1555
|
+
# @option options [Proc] :before_wait
|
1556
|
+
def wait_until(waiter_name, params = {}, options = {})
|
1557
|
+
w = waiter(waiter_name, options)
|
1558
|
+
yield(w.waiter) if block_given? # deprecated
|
1559
|
+
w.wait(params)
|
1560
|
+
end
|
1561
|
+
|
1004
1562
|
# @api private
|
1005
1563
|
# @deprecated
|
1006
1564
|
def waiter_names
|
1007
|
-
|
1565
|
+
waiters.keys
|
1566
|
+
end
|
1567
|
+
|
1568
|
+
private
|
1569
|
+
|
1570
|
+
# @param [Symbol] waiter_name
|
1571
|
+
# @param [Hash] options ({})
|
1572
|
+
def waiter(waiter_name, options = {})
|
1573
|
+
waiter_class = waiters[waiter_name]
|
1574
|
+
if waiter_class
|
1575
|
+
waiter_class.new(options.merge(client: self))
|
1576
|
+
else
|
1577
|
+
raise Aws::Waiters::Errors::NoSuchWaiterError.new(waiter_name, waiters.keys)
|
1578
|
+
end
|
1579
|
+
end
|
1580
|
+
|
1581
|
+
def waiters
|
1582
|
+
{
|
1583
|
+
channel_created: Waiters::ChannelCreated,
|
1584
|
+
channel_deleted: Waiters::ChannelDeleted,
|
1585
|
+
space_created: Waiters::SpaceCreated,
|
1586
|
+
space_deleted: Waiters::SpaceDeleted
|
1587
|
+
}
|
1008
1588
|
end
|
1009
1589
|
|
1010
1590
|
class << self
|