aws-sdk-connectparticipant 1.56.0 → 1.58.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: eb0a7d3278ccfc5663896c95f95d7d8e96374b007ad83ee9cab074e369f657b5
4
- data.tar.gz: '04673824875dc8af1748d0545d3c0b2e7569611a9a059486d65424bcbff138ac'
3
+ metadata.gz: b169e61aeeecbed1bd6da445d25f98403eb658842e2dac3ebf6457c38bedd6c7
4
+ data.tar.gz: 77b8136bd0d9fcabaaeaa48b7d5e2b60807839138574eecc47a9513c104ec789
5
5
  SHA512:
6
- metadata.gz: 7b45a42905e8c7b804946da265a86682bcf3216f01bbf8e5d6552183eed475450e158380685707440c6f0cf4e55988dec3ec43768dbc07bc26d4075b2ec3e61b
7
- data.tar.gz: 634abc489025e31093d0bad4bcaacfe9f10ef073a200150741dd8020cedb8e11668b16544c1fe010738bc1734a1bb96a43cac603abb9c3cbb6ce7c7ba084260b
6
+ metadata.gz: fbbd84d7c52280552c6cfff570ba014e244f1e3342c16aec54726afb4117424babdb708d6efbf7e9430960561864812a31e2fbdd6b038260e11ea76f93002514
7
+ data.tar.gz: 46bb5419d3dcf4d1bb43162a6ec611c066ae7d56e3ccb99b92f9868b996fb41d2bc3840a2e84ce35ab87bdbe5dec04cb4554ef9aec1baff96dd0ca2961395a3d
data/CHANGELOG.md CHANGED
@@ -1,6 +1,16 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.58.0 (2024-12-18)
5
+ ------------------
6
+
7
+ * Feature - This release adds support for the GetAuthenticationUrl and CancelParticipantAuthentication APIs used for customer authentication within Amazon Connect chats. There are also minor updates to the GetAttachment API.
8
+
9
+ 1.57.0 (2024-11-06)
10
+ ------------------
11
+
12
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
13
+
4
14
  1.56.0 (2024-10-18)
5
15
  ------------------
6
16
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.56.0
1
+ 1.58.0
@@ -447,22 +447,59 @@ module Aws::ConnectParticipant
447
447
 
448
448
  # @!group API Operations
449
449
 
450
+ # Cancels the authentication session. The opted out branch of the
451
+ # Authenticate Customer flow block will be taken.
452
+ #
453
+ # <note markdown="1"> The current supported channel is chat. This API is not supported for
454
+ # Apple Messages for Business, WhatsApp, or SMS chats.
455
+ #
456
+ # </note>
457
+ #
458
+ # @option params [required, String] :session_id
459
+ # The `sessionId` provided in the `authenticationInitiated` event.
460
+ #
461
+ # @option params [required, String] :connection_token
462
+ # The authentication token associated with the participant's
463
+ # connection.
464
+ #
465
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
466
+ #
467
+ # @example Request syntax with placeholder values
468
+ #
469
+ # resp = client.cancel_participant_authentication({
470
+ # session_id: "SessionId", # required
471
+ # connection_token: "ParticipantToken", # required
472
+ # })
473
+ #
474
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/CancelParticipantAuthentication AWS API Documentation
475
+ #
476
+ # @overload cancel_participant_authentication(params = {})
477
+ # @param [Hash] params ({})
478
+ def cancel_participant_authentication(params = {}, options = {})
479
+ req = build_request(:cancel_participant_authentication, params)
480
+ req.send_request(options)
481
+ end
482
+
450
483
  # Allows you to confirm that the attachment has been uploaded using the
451
484
  # pre-signed URL provided in StartAttachmentUpload API. A conflict
452
485
  # exception is thrown when an attachment with that identifier is already
453
486
  # being uploaded.
454
487
  #
488
+ # For security recommendations, see [Amazon Connect Chat security best
489
+ # practices][1].
490
+ #
455
491
  # <note markdown="1"> `ConnectionToken` is used for invoking this API instead of
456
492
  # `ParticipantToken`.
457
493
  #
458
494
  # </note>
459
495
  #
460
496
  # The Amazon Connect Participant Service APIs do not use [Signature
461
- # Version 4 authentication][1].
497
+ # Version 4 authentication][2].
462
498
  #
463
499
  #
464
500
  #
465
- # [1]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
501
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat
502
+ # [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
466
503
  #
467
504
  # @option params [required, Array<String>] :attachment_ids
468
505
  # A list of unique identifiers for the attachments.
@@ -505,6 +542,9 @@ module Aws::ConnectParticipant
505
542
 
506
543
  # Creates the participant's connection.
507
544
  #
545
+ # For security recommendations, see [Amazon Connect Chat security best
546
+ # practices][1].
547
+ #
508
548
  # <note markdown="1"> `ParticipantToken` is used for invoking this API instead of
509
549
  # `ConnectionToken`.
510
550
  #
@@ -520,34 +560,35 @@ module Aws::ConnectParticipant
520
560
  # For chat, you need to publish the following on the established
521
561
  # websocket connection:
522
562
  #
523
- # `\{"topic":"aws/subscribe","content":\{"topics":["aws/chat"]\}\}`
563
+ # `{"topic":"aws/subscribe","content":{"topics":["aws/chat"]}}`
524
564
  #
525
565
  # Upon websocket URL expiry, as specified in the response
526
566
  # ConnectionExpiry parameter, clients need to call this API again to
527
567
  # obtain a new websocket URL and perform the same steps as before.
528
568
  #
529
569
  # **Message streaming support**: This API can also be used together with
530
- # the [StartContactStreaming][1] API to create a participant connection
570
+ # the [StartContactStreaming][2] API to create a participant connection
531
571
  # for chat contacts that are not using a websocket. For more information
532
- # about message streaming, [Enable real-time chat message streaming][2]
572
+ # about message streaming, [Enable real-time chat message streaming][3]
533
573
  # in the *Amazon Connect Administrator Guide*.
534
574
  #
535
575
  # **Feature specifications**: For information about feature
536
576
  # specifications, such as the allowed number of open websocket
537
- # connections per participant, see [Feature specifications][3] in the
577
+ # connections per participant, see [Feature specifications][4] in the
538
578
  # *Amazon Connect Administrator Guide*.
539
579
  #
540
580
  # <note markdown="1"> The Amazon Connect Participant Service APIs do not use [Signature
541
- # Version 4 authentication][4].
581
+ # Version 4 authentication][5].
542
582
  #
543
583
  # </note>
544
584
  #
545
585
  #
546
586
  #
547
- # [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_StartContactStreaming.html
548
- # [2]: https://docs.aws.amazon.com/connect/latest/adminguide/chat-message-streaming.html
549
- # [3]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits
550
- # [4]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
587
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat
588
+ # [2]: https://docs.aws.amazon.com/connect/latest/APIReference/API_StartContactStreaming.html
589
+ # [3]: https://docs.aws.amazon.com/connect/latest/adminguide/chat-message-streaming.html
590
+ # [4]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits
591
+ # [5]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
551
592
  #
552
593
  # @option params [Array<String>] :type
553
594
  # Type of connection information required. If you need
@@ -600,6 +641,13 @@ module Aws::ConnectParticipant
600
641
 
601
642
  # Retrieves the view for the specified view token.
602
643
  #
644
+ # For security recommendations, see [Amazon Connect Chat security best
645
+ # practices][1].
646
+ #
647
+ #
648
+ #
649
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat
650
+ #
603
651
  # @option params [required, String] :view_token
604
652
  # An encrypted token originating from the interactive message of a
605
653
  # ShowView block operation. Represents the desired view.
@@ -640,17 +688,21 @@ module Aws::ConnectParticipant
640
688
 
641
689
  # Disconnects a participant.
642
690
  #
691
+ # For security recommendations, see [Amazon Connect Chat security best
692
+ # practices][1].
693
+ #
643
694
  # <note markdown="1"> `ConnectionToken` is used for invoking this API instead of
644
695
  # `ParticipantToken`.
645
696
  #
646
697
  # </note>
647
698
  #
648
699
  # The Amazon Connect Participant Service APIs do not use [Signature
649
- # Version 4 authentication][1].
700
+ # Version 4 authentication][2].
650
701
  #
651
702
  #
652
703
  #
653
- # [1]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
704
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat
705
+ # [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
654
706
  #
655
707
  # @option params [String] :client_token
656
708
  # A unique, case-sensitive identifier that you provide to ensure the
@@ -690,17 +742,21 @@ module Aws::ConnectParticipant
690
742
  # Provides a pre-signed URL for download of a completed attachment. This
691
743
  # is an asynchronous API for use with active contacts.
692
744
  #
745
+ # For security recommendations, see [Amazon Connect Chat security best
746
+ # practices][1].
747
+ #
693
748
  # <note markdown="1"> `ConnectionToken` is used for invoking this API instead of
694
749
  # `ParticipantToken`.
695
750
  #
696
751
  # </note>
697
752
  #
698
753
  # The Amazon Connect Participant Service APIs do not use [Signature
699
- # Version 4 authentication][1].
754
+ # Version 4 authentication][2].
700
755
  #
701
756
  #
702
757
  #
703
- # [1]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
758
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat
759
+ # [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
704
760
  #
705
761
  # @option params [required, String] :attachment_id
706
762
  # A unique identifier for the attachment.
@@ -709,22 +765,30 @@ module Aws::ConnectParticipant
709
765
  # The authentication token associated with the participant's
710
766
  # connection.
711
767
  #
768
+ # @option params [Integer] :url_expiry_in_seconds
769
+ # The expiration time of the URL in ISO timestamp. It's specified in
770
+ # ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,
771
+ # 2019-11-08T02:41:28.172Z.
772
+ #
712
773
  # @return [Types::GetAttachmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
713
774
  #
714
775
  # * {Types::GetAttachmentResponse#url #url} => String
715
776
  # * {Types::GetAttachmentResponse#url_expiry #url_expiry} => String
777
+ # * {Types::GetAttachmentResponse#attachment_size_in_bytes #attachment_size_in_bytes} => Integer
716
778
  #
717
779
  # @example Request syntax with placeholder values
718
780
  #
719
781
  # resp = client.get_attachment({
720
782
  # attachment_id: "ArtifactId", # required
721
783
  # connection_token: "ParticipantToken", # required
784
+ # url_expiry_in_seconds: 1,
722
785
  # })
723
786
  #
724
787
  # @example Response structure
725
788
  #
726
789
  # resp.url #=> String
727
790
  # resp.url_expiry #=> String
791
+ # resp.attachment_size_in_bytes #=> Integer
728
792
  #
729
793
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/GetAttachment AWS API Documentation
730
794
  #
@@ -735,10 +799,67 @@ module Aws::ConnectParticipant
735
799
  req.send_request(options)
736
800
  end
737
801
 
802
+ # Retrieves the AuthenticationUrl for the current authentication session
803
+ # for the AuthenticateCustomer flow block.
804
+ #
805
+ # For security recommendations, see [Amazon Connect Chat security best
806
+ # practices][1].
807
+ #
808
+ # <note markdown="1"> * This API can only be called within one minute of receiving the
809
+ # authenticationInitiated event.
810
+ #
811
+ # * The current supported channel is chat. This API is not supported for
812
+ # Apple Messages for Business, WhatsApp, or SMS chats.
813
+ #
814
+ # </note>
815
+ #
816
+ #
817
+ #
818
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat
819
+ #
820
+ # @option params [required, String] :session_id
821
+ # The sessionId provided in the authenticationInitiated event.
822
+ #
823
+ # @option params [required, String] :redirect_uri
824
+ # The URL where the customer will be redirected after Amazon Cognito
825
+ # authorizes the user.
826
+ #
827
+ # @option params [required, String] :connection_token
828
+ # The authentication token associated with the participant's
829
+ # connection.
830
+ #
831
+ # @return [Types::GetAuthenticationUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
832
+ #
833
+ # * {Types::GetAuthenticationUrlResponse#authentication_url #authentication_url} => String
834
+ #
835
+ # @example Request syntax with placeholder values
836
+ #
837
+ # resp = client.get_authentication_url({
838
+ # session_id: "SessionId", # required
839
+ # redirect_uri: "RedirectURI", # required
840
+ # connection_token: "ParticipantToken", # required
841
+ # })
842
+ #
843
+ # @example Response structure
844
+ #
845
+ # resp.authentication_url #=> String
846
+ #
847
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/GetAuthenticationUrl AWS API Documentation
848
+ #
849
+ # @overload get_authentication_url(params = {})
850
+ # @param [Hash] params ({})
851
+ def get_authentication_url(params = {}, options = {})
852
+ req = build_request(:get_authentication_url, params)
853
+ req.send_request(options)
854
+ end
855
+
738
856
  # Retrieves a transcript of the session, including details about any
739
857
  # attachments. For information about accessing past chat contact
740
858
  # transcripts for a persistent chat, see [Enable persistent chat][1].
741
859
  #
860
+ # For security recommendations, see [Amazon Connect Chat security best
861
+ # practices][2].
862
+ #
742
863
  # If you have a process that consumes events in the transcript of an
743
864
  # chat that has ended, note that chat transcripts contain the following
744
865
  # event content types if the event has occurred during the chat session:
@@ -759,12 +880,13 @@ module Aws::ConnectParticipant
759
880
  # </note>
760
881
  #
761
882
  # The Amazon Connect Participant Service APIs do not use [Signature
762
- # Version 4 authentication][2].
883
+ # Version 4 authentication][3].
763
884
  #
764
885
  #
765
886
  #
766
887
  # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html
767
- # [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
888
+ # [2]: https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat
889
+ # [3]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
768
890
  #
769
891
  # @option params [String] :contact_id
770
892
  # The contactId from the current contact chain for which transcript is
@@ -863,18 +985,22 @@ module Aws::ConnectParticipant
863
985
  # message receipts when a supervisor is barged-in will result in a
864
986
  # conflict exception.
865
987
  #
988
+ # For security recommendations, see [Amazon Connect Chat security best
989
+ # practices][2].
990
+ #
866
991
  # <note markdown="1"> `ConnectionToken` is used for invoking this API instead of
867
992
  # `ParticipantToken`.
868
993
  #
869
994
  # </note>
870
995
  #
871
996
  # The Amazon Connect Participant Service APIs do not use [Signature
872
- # Version 4 authentication][2].
997
+ # Version 4 authentication][3].
873
998
  #
874
999
  #
875
1000
  #
876
1001
  # [1]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html
877
- # [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
1002
+ # [2]: https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat
1003
+ # [3]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
878
1004
  #
879
1005
  # @option params [required, String] :content_type
880
1006
  # The content type of the request. Supported types are:
@@ -894,7 +1020,7 @@ module Aws::ConnectParticipant
894
1020
  # a JSON string.
895
1021
  #
896
1022
  # Sample Content:
897
- # "\\\{\\"messageId\\":\\"11111111-aaaa-bbbb-cccc-EXAMPLE01234\\"\\}"
1023
+ # "\{\\"messageId\\":\\"11111111-aaaa-bbbb-cccc-EXAMPLE01234\\"}"
898
1024
  #
899
1025
  # @option params [String] :client_token
900
1026
  # A unique, case-sensitive identifier that you provide to ensure the
@@ -943,17 +1069,21 @@ module Aws::ConnectParticipant
943
1069
 
944
1070
  # Sends a message.
945
1071
  #
1072
+ # For security recommendations, see [Amazon Connect Chat security best
1073
+ # practices][1].
1074
+ #
946
1075
  # <note markdown="1"> `ConnectionToken` is used for invoking this API instead of
947
1076
  # `ParticipantToken`.
948
1077
  #
949
1078
  # </note>
950
1079
  #
951
1080
  # The Amazon Connect Participant Service APIs do not use [Signature
952
- # Version 4 authentication][1].
1081
+ # Version 4 authentication][2].
953
1082
  #
954
1083
  #
955
1084
  #
956
- # [1]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
1085
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat
1086
+ # [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
957
1087
  #
958
1088
  # @option params [required, String] :content_type
959
1089
  # The type of the content. Supported types are `text/plain`,
@@ -1020,17 +1150,21 @@ module Aws::ConnectParticipant
1020
1150
  # Provides a pre-signed Amazon S3 URL in response for uploading the file
1021
1151
  # directly to S3.
1022
1152
  #
1153
+ # For security recommendations, see [Amazon Connect Chat security best
1154
+ # practices][1].
1155
+ #
1023
1156
  # <note markdown="1"> `ConnectionToken` is used for invoking this API instead of
1024
1157
  # `ParticipantToken`.
1025
1158
  #
1026
1159
  # </note>
1027
1160
  #
1028
1161
  # The Amazon Connect Participant Service APIs do not use [Signature
1029
- # Version 4 authentication][1].
1162
+ # Version 4 authentication][2].
1030
1163
  #
1031
1164
  #
1032
1165
  #
1033
- # [1]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
1166
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat
1167
+ # [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
1034
1168
  #
1035
1169
  # @option params [required, String] :content_type
1036
1170
  # Describes the MIME file type of the attachment. For a list of
@@ -1114,7 +1248,7 @@ module Aws::ConnectParticipant
1114
1248
  tracer: tracer
1115
1249
  )
1116
1250
  context[:gem_name] = 'aws-sdk-connectparticipant'
1117
- context[:gem_version] = '1.56.0'
1251
+ context[:gem_version] = '1.58.0'
1118
1252
  Seahorse::Client::Request.new(handlers, context)
1119
1253
  end
1120
1254
 
@@ -23,7 +23,10 @@ module Aws::ConnectParticipant
23
23
  AttachmentName = Shapes::StringShape.new(name: 'AttachmentName')
24
24
  AttachmentSizeInBytes = Shapes::IntegerShape.new(name: 'AttachmentSizeInBytes')
25
25
  Attachments = Shapes::ListShape.new(name: 'Attachments')
26
+ AuthenticationUrl = Shapes::StringShape.new(name: 'AuthenticationUrl')
26
27
  Bool = Shapes::BooleanShape.new(name: 'Bool')
28
+ CancelParticipantAuthenticationRequest = Shapes::StructureShape.new(name: 'CancelParticipantAuthenticationRequest')
29
+ CancelParticipantAuthenticationResponse = Shapes::StructureShape.new(name: 'CancelParticipantAuthenticationResponse')
27
30
  ChatContent = Shapes::StringShape.new(name: 'ChatContent')
28
31
  ChatContentType = Shapes::StringShape.new(name: 'ChatContentType')
29
32
  ChatItemId = Shapes::StringShape.new(name: 'ChatItemId')
@@ -46,6 +49,8 @@ module Aws::ConnectParticipant
46
49
  DisplayName = Shapes::StringShape.new(name: 'DisplayName')
47
50
  GetAttachmentRequest = Shapes::StructureShape.new(name: 'GetAttachmentRequest')
48
51
  GetAttachmentResponse = Shapes::StructureShape.new(name: 'GetAttachmentResponse')
52
+ GetAuthenticationUrlRequest = Shapes::StructureShape.new(name: 'GetAuthenticationUrlRequest')
53
+ GetAuthenticationUrlResponse = Shapes::StructureShape.new(name: 'GetAuthenticationUrlResponse')
49
54
  GetTranscriptRequest = Shapes::StructureShape.new(name: 'GetTranscriptRequest')
50
55
  GetTranscriptResponse = Shapes::StructureShape.new(name: 'GetTranscriptResponse')
51
56
  ISO8601Datetime = Shapes::StringShape.new(name: 'ISO8601Datetime')
@@ -66,6 +71,7 @@ module Aws::ConnectParticipant
66
71
  Reason = Shapes::StringShape.new(name: 'Reason')
67
72
  Receipt = Shapes::StructureShape.new(name: 'Receipt')
68
73
  Receipts = Shapes::ListShape.new(name: 'Receipts')
74
+ RedirectURI = Shapes::StringShape.new(name: 'RedirectURI')
69
75
  ResourceId = Shapes::StringShape.new(name: 'ResourceId')
70
76
  ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
71
77
  ResourceType = Shapes::StringShape.new(name: 'ResourceType')
@@ -75,12 +81,14 @@ module Aws::ConnectParticipant
75
81
  SendMessageRequest = Shapes::StructureShape.new(name: 'SendMessageRequest')
76
82
  SendMessageResponse = Shapes::StructureShape.new(name: 'SendMessageResponse')
77
83
  ServiceQuotaExceededException = Shapes::StructureShape.new(name: 'ServiceQuotaExceededException')
84
+ SessionId = Shapes::StringShape.new(name: 'SessionId')
78
85
  SortKey = Shapes::StringShape.new(name: 'SortKey')
79
86
  StartAttachmentUploadRequest = Shapes::StructureShape.new(name: 'StartAttachmentUploadRequest')
80
87
  StartAttachmentUploadResponse = Shapes::StructureShape.new(name: 'StartAttachmentUploadResponse')
81
88
  StartPosition = Shapes::StructureShape.new(name: 'StartPosition')
82
89
  ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
83
90
  Transcript = Shapes::ListShape.new(name: 'Transcript')
91
+ URLExpiryInSeconds = Shapes::IntegerShape.new(name: 'URLExpiryInSeconds')
84
92
  UploadMetadata = Shapes::StructureShape.new(name: 'UploadMetadata')
85
93
  UploadMetadataSignedHeaders = Shapes::MapShape.new(name: 'UploadMetadataSignedHeaders')
86
94
  UploadMetadataSignedHeadersKey = Shapes::StringShape.new(name: 'UploadMetadataSignedHeadersKey')
@@ -112,6 +120,12 @@ module Aws::ConnectParticipant
112
120
 
113
121
  Attachments.member = Shapes::ShapeRef.new(shape: AttachmentItem)
114
122
 
123
+ CancelParticipantAuthenticationRequest.add_member(:session_id, Shapes::ShapeRef.new(shape: SessionId, required: true, location_name: "SessionId"))
124
+ CancelParticipantAuthenticationRequest.add_member(:connection_token, Shapes::ShapeRef.new(shape: ParticipantToken, required: true, location: "header", location_name: "X-Amz-Bearer"))
125
+ CancelParticipantAuthenticationRequest.struct_class = Types::CancelParticipantAuthenticationRequest
126
+
127
+ CancelParticipantAuthenticationResponse.struct_class = Types::CancelParticipantAuthenticationResponse
128
+
115
129
  CompleteAttachmentUploadRequest.add_member(:attachment_ids, Shapes::ShapeRef.new(shape: AttachmentIdList, required: true, location_name: "AttachmentIds"))
116
130
  CompleteAttachmentUploadRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: NonEmptyClientToken, required: true, location_name: "ClientToken", metadata: {"idempotencyToken"=>true}))
117
131
  CompleteAttachmentUploadRequest.add_member(:connection_token, Shapes::ShapeRef.new(shape: ParticipantToken, required: true, location: "header", location_name: "X-Amz-Bearer"))
@@ -152,12 +166,22 @@ module Aws::ConnectParticipant
152
166
 
153
167
  GetAttachmentRequest.add_member(:attachment_id, Shapes::ShapeRef.new(shape: ArtifactId, required: true, location_name: "AttachmentId"))
154
168
  GetAttachmentRequest.add_member(:connection_token, Shapes::ShapeRef.new(shape: ParticipantToken, required: true, location: "header", location_name: "X-Amz-Bearer"))
169
+ GetAttachmentRequest.add_member(:url_expiry_in_seconds, Shapes::ShapeRef.new(shape: URLExpiryInSeconds, location_name: "UrlExpiryInSeconds"))
155
170
  GetAttachmentRequest.struct_class = Types::GetAttachmentRequest
156
171
 
157
172
  GetAttachmentResponse.add_member(:url, Shapes::ShapeRef.new(shape: PreSignedAttachmentUrl, location_name: "Url"))
158
173
  GetAttachmentResponse.add_member(:url_expiry, Shapes::ShapeRef.new(shape: ISO8601Datetime, location_name: "UrlExpiry"))
174
+ GetAttachmentResponse.add_member(:attachment_size_in_bytes, Shapes::ShapeRef.new(shape: AttachmentSizeInBytes, required: true, location_name: "AttachmentSizeInBytes", metadata: {"box"=>true}))
159
175
  GetAttachmentResponse.struct_class = Types::GetAttachmentResponse
160
176
 
177
+ GetAuthenticationUrlRequest.add_member(:session_id, Shapes::ShapeRef.new(shape: SessionId, required: true, location_name: "SessionId"))
178
+ GetAuthenticationUrlRequest.add_member(:redirect_uri, Shapes::ShapeRef.new(shape: RedirectURI, required: true, location_name: "RedirectUri"))
179
+ GetAuthenticationUrlRequest.add_member(:connection_token, Shapes::ShapeRef.new(shape: ParticipantToken, required: true, location: "header", location_name: "X-Amz-Bearer"))
180
+ GetAuthenticationUrlRequest.struct_class = Types::GetAuthenticationUrlRequest
181
+
182
+ GetAuthenticationUrlResponse.add_member(:authentication_url, Shapes::ShapeRef.new(shape: AuthenticationUrl, location_name: "AuthenticationUrl"))
183
+ GetAuthenticationUrlResponse.struct_class = Types::GetAuthenticationUrlResponse
184
+
161
185
  GetTranscriptRequest.add_member(:contact_id, Shapes::ShapeRef.new(shape: ContactId, location_name: "ContactId"))
162
186
  GetTranscriptRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults", metadata: {"box"=>true}))
163
187
  GetTranscriptRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
@@ -299,6 +323,18 @@ module Aws::ConnectParticipant
299
323
  "uid" => "connectparticipant-2018-09-07",
300
324
  }
301
325
 
326
+ api.add_operation(:cancel_participant_authentication, Seahorse::Model::Operation.new.tap do |o|
327
+ o.name = "CancelParticipantAuthentication"
328
+ o.http_method = "POST"
329
+ o.http_request_uri = "/participant/cancel-authentication"
330
+ o.input = Shapes::ShapeRef.new(shape: CancelParticipantAuthenticationRequest)
331
+ o.output = Shapes::ShapeRef.new(shape: CancelParticipantAuthenticationResponse)
332
+ o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
333
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
334
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
335
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
336
+ end)
337
+
302
338
  api.add_operation(:complete_attachment_upload, Seahorse::Model::Operation.new.tap do |o|
303
339
  o.name = "CompleteAttachmentUpload"
304
340
  o.http_method = "POST"
@@ -362,6 +398,18 @@ module Aws::ConnectParticipant
362
398
  o.errors << Shapes::ShapeRef.new(shape: ValidationException)
363
399
  end)
364
400
 
401
+ api.add_operation(:get_authentication_url, Seahorse::Model::Operation.new.tap do |o|
402
+ o.name = "GetAuthenticationUrl"
403
+ o.http_method = "POST"
404
+ o.http_request_uri = "/participant/authentication-url"
405
+ o.input = Shapes::ShapeRef.new(shape: GetAuthenticationUrlRequest)
406
+ o.output = Shapes::ShapeRef.new(shape: GetAuthenticationUrlResponse)
407
+ o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
408
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
409
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
410
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
411
+ end)
412
+
365
413
  api.add_operation(:get_transcript, Seahorse::Model::Operation.new.tap do |o|
366
414
  o.name = "GetTranscript"
367
415
  o.http_method = "POST"
@@ -59,6 +59,28 @@ module Aws::ConnectParticipant
59
59
  include Aws::Structure
60
60
  end
61
61
 
62
+ # @!attribute [rw] session_id
63
+ # The `sessionId` provided in the `authenticationInitiated` event.
64
+ # @return [String]
65
+ #
66
+ # @!attribute [rw] connection_token
67
+ # The authentication token associated with the participant's
68
+ # connection.
69
+ # @return [String]
70
+ #
71
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/CancelParticipantAuthenticationRequest AWS API Documentation
72
+ #
73
+ class CancelParticipantAuthenticationRequest < Struct.new(
74
+ :session_id,
75
+ :connection_token)
76
+ SENSITIVE = []
77
+ include Aws::Structure
78
+ end
79
+
80
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/CancelParticipantAuthenticationResponse AWS API Documentation
81
+ #
82
+ class CancelParticipantAuthenticationResponse < Aws::EmptyStructure; end
83
+
62
84
  # @!attribute [rw] attachment_ids
63
85
  # A list of unique identifiers for the attachments.
64
86
  # @return [Array<String>]
@@ -255,11 +277,18 @@ module Aws::ConnectParticipant
255
277
  # connection.
256
278
  # @return [String]
257
279
  #
280
+ # @!attribute [rw] url_expiry_in_seconds
281
+ # The expiration time of the URL in ISO timestamp. It's specified in
282
+ # ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,
283
+ # 2019-11-08T02:41:28.172Z.
284
+ # @return [Integer]
285
+ #
258
286
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/GetAttachmentRequest AWS API Documentation
259
287
  #
260
288
  class GetAttachmentRequest < Struct.new(
261
289
  :attachment_id,
262
- :connection_token)
290
+ :connection_token,
291
+ :url_expiry_in_seconds)
263
292
  SENSITIVE = []
264
293
  include Aws::Structure
265
294
  end
@@ -279,11 +308,54 @@ module Aws::ConnectParticipant
279
308
  # 2019-11-08T02:41:28.172Z.
280
309
  # @return [String]
281
310
  #
311
+ # @!attribute [rw] attachment_size_in_bytes
312
+ # The size of the attachment in bytes.
313
+ # @return [Integer]
314
+ #
282
315
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/GetAttachmentResponse AWS API Documentation
283
316
  #
284
317
  class GetAttachmentResponse < Struct.new(
285
318
  :url,
286
- :url_expiry)
319
+ :url_expiry,
320
+ :attachment_size_in_bytes)
321
+ SENSITIVE = []
322
+ include Aws::Structure
323
+ end
324
+
325
+ # @!attribute [rw] session_id
326
+ # The sessionId provided in the authenticationInitiated event.
327
+ # @return [String]
328
+ #
329
+ # @!attribute [rw] redirect_uri
330
+ # The URL where the customer will be redirected after Amazon Cognito
331
+ # authorizes the user.
332
+ # @return [String]
333
+ #
334
+ # @!attribute [rw] connection_token
335
+ # The authentication token associated with the participant's
336
+ # connection.
337
+ # @return [String]
338
+ #
339
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/GetAuthenticationUrlRequest AWS API Documentation
340
+ #
341
+ class GetAuthenticationUrlRequest < Struct.new(
342
+ :session_id,
343
+ :redirect_uri,
344
+ :connection_token)
345
+ SENSITIVE = []
346
+ include Aws::Structure
347
+ end
348
+
349
+ # @!attribute [rw] authentication_url
350
+ # The URL where the customer will sign in to the identity provider.
351
+ # This URL contains the authorize endpoint for the Cognito UserPool
352
+ # used in the authentication.
353
+ # @return [String]
354
+ #
355
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/GetAuthenticationUrlResponse AWS API Documentation
356
+ #
357
+ class GetAuthenticationUrlResponse < Struct.new(
358
+ :authentication_url)
287
359
  SENSITIVE = []
288
360
  include Aws::Structure
289
361
  end
@@ -542,7 +614,7 @@ module Aws::ConnectParticipant
542
614
  # of a JSON string.
543
615
  #
544
616
  # Sample Content:
545
- # "\\\{\\"messageId\\":\\"11111111-aaaa-bbbb-cccc-EXAMPLE01234\\"\\}"
617
+ # "\{\\"messageId\\":\\"11111111-aaaa-bbbb-cccc-EXAMPLE01234\\"}"
546
618
  # @return [String]
547
619
  #
548
620
  # @!attribute [rw] client_token
@@ -731,7 +803,7 @@ module Aws::ConnectParticipant
731
803
  # @return [String]
732
804
  #
733
805
  # @!attribute [rw] upload_metadata
734
- # Fields to be used while uploading the attachment.
806
+ # The headers to be provided while uploading the file to the URL.
735
807
  # @return [Types::UploadMetadata]
736
808
  #
737
809
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/StartAttachmentUploadResponse AWS API Documentation
@@ -23,7 +23,7 @@ Aws::Plugins::GlobalConfiguration.add_identifier(:connectparticipant)
23
23
  # structure.
24
24
  #
25
25
  # connect_participant = Aws::ConnectParticipant::Client.new
26
- # resp = connect_participant.complete_attachment_upload(params)
26
+ # resp = connect_participant.cancel_participant_authentication(params)
27
27
  #
28
28
  # See {Client} for more information.
29
29
  #
@@ -54,7 +54,7 @@ module Aws::ConnectParticipant
54
54
  autoload :EndpointProvider, 'aws-sdk-connectparticipant/endpoint_provider'
55
55
  autoload :Endpoints, 'aws-sdk-connectparticipant/endpoints'
56
56
 
57
- GEM_VERSION = '1.56.0'
57
+ GEM_VERSION = '1.58.0'
58
58
 
59
59
  end
60
60
 
data/sig/client.rbs CHANGED
@@ -75,6 +75,16 @@ module Aws
75
75
  | (?Hash[Symbol, untyped]) -> instance
76
76
 
77
77
 
78
+ interface _CancelParticipantAuthenticationResponseSuccess
79
+ include ::Seahorse::Client::_ResponseSuccess[Types::CancelParticipantAuthenticationResponse]
80
+ end
81
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectParticipant/Client.html#cancel_participant_authentication-instance_method
82
+ def cancel_participant_authentication: (
83
+ session_id: ::String,
84
+ connection_token: ::String
85
+ ) -> _CancelParticipantAuthenticationResponseSuccess
86
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CancelParticipantAuthenticationResponseSuccess
87
+
78
88
  interface _CompleteAttachmentUploadResponseSuccess
79
89
  include ::Seahorse::Client::_ResponseSuccess[Types::CompleteAttachmentUploadResponse]
80
90
  end
@@ -124,14 +134,28 @@ module Aws
124
134
  include ::Seahorse::Client::_ResponseSuccess[Types::GetAttachmentResponse]
125
135
  def url: () -> ::String
126
136
  def url_expiry: () -> ::String
137
+ def attachment_size_in_bytes: () -> ::Integer
127
138
  end
128
139
  # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectParticipant/Client.html#get_attachment-instance_method
129
140
  def get_attachment: (
130
141
  attachment_id: ::String,
131
- connection_token: ::String
142
+ connection_token: ::String,
143
+ ?url_expiry_in_seconds: ::Integer
132
144
  ) -> _GetAttachmentResponseSuccess
133
145
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetAttachmentResponseSuccess
134
146
 
147
+ interface _GetAuthenticationUrlResponseSuccess
148
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetAuthenticationUrlResponse]
149
+ def authentication_url: () -> ::String
150
+ end
151
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectParticipant/Client.html#get_authentication_url-instance_method
152
+ def get_authentication_url: (
153
+ session_id: ::String,
154
+ redirect_uri: ::String,
155
+ connection_token: ::String
156
+ ) -> _GetAuthenticationUrlResponseSuccess
157
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetAuthenticationUrlResponseSuccess
158
+
135
159
  interface _GetTranscriptResponseSuccess
136
160
  include ::Seahorse::Client::_ResponseSuccess[Types::GetTranscriptResponse]
137
161
  def initial_contact_id: () -> ::String
data/sig/types.rbs CHANGED
@@ -21,6 +21,15 @@ module Aws::ConnectParticipant
21
21
  SENSITIVE: []
22
22
  end
23
23
 
24
+ class CancelParticipantAuthenticationRequest
25
+ attr_accessor session_id: ::String
26
+ attr_accessor connection_token: ::String
27
+ SENSITIVE: []
28
+ end
29
+
30
+ class CancelParticipantAuthenticationResponse < Aws::EmptyStructure
31
+ end
32
+
24
33
  class CompleteAttachmentUploadRequest
25
34
  attr_accessor attachment_ids: ::Array[::String]
26
35
  attr_accessor client_token: ::String
@@ -78,12 +87,26 @@ module Aws::ConnectParticipant
78
87
  class GetAttachmentRequest
79
88
  attr_accessor attachment_id: ::String
80
89
  attr_accessor connection_token: ::String
90
+ attr_accessor url_expiry_in_seconds: ::Integer
81
91
  SENSITIVE: []
82
92
  end
83
93
 
84
94
  class GetAttachmentResponse
85
95
  attr_accessor url: ::String
86
96
  attr_accessor url_expiry: ::String
97
+ attr_accessor attachment_size_in_bytes: ::Integer
98
+ SENSITIVE: []
99
+ end
100
+
101
+ class GetAuthenticationUrlRequest
102
+ attr_accessor session_id: ::String
103
+ attr_accessor redirect_uri: ::String
104
+ attr_accessor connection_token: ::String
105
+ SENSITIVE: []
106
+ end
107
+
108
+ class GetAuthenticationUrlResponse
109
+ attr_accessor authentication_url: ::String
87
110
  SENSITIVE: []
88
111
  end
89
112
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-connectparticipant
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.56.0
4
+ version: 1.58.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-10-18 00:00:00.000000000 Z
11
+ date: 2024-12-18 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core