@aws-sdk/client-sts 3.296.0 → 3.297.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.
@@ -733,10 +733,7 @@ const serializeAws_querytagListType = (input, context) => {
733
733
  return entries;
734
734
  };
735
735
  const deserializeAws_queryAssumedRoleUser = (output, context) => {
736
- const contents = {
737
- AssumedRoleId: undefined,
738
- Arn: undefined,
739
- };
736
+ const contents = {};
740
737
  if (output["AssumedRoleId"] !== undefined) {
741
738
  contents.AssumedRoleId = (0, smithy_client_1.expectString)(output["AssumedRoleId"]);
742
739
  }
@@ -746,12 +743,7 @@ const deserializeAws_queryAssumedRoleUser = (output, context) => {
746
743
  return contents;
747
744
  };
748
745
  const deserializeAws_queryAssumeRoleResponse = (output, context) => {
749
- const contents = {
750
- Credentials: undefined,
751
- AssumedRoleUser: undefined,
752
- PackedPolicySize: undefined,
753
- SourceIdentity: undefined,
754
- };
746
+ const contents = {};
755
747
  if (output["Credentials"] !== undefined) {
756
748
  contents.Credentials = deserializeAws_queryCredentials(output["Credentials"], context);
757
749
  }
@@ -767,17 +759,7 @@ const deserializeAws_queryAssumeRoleResponse = (output, context) => {
767
759
  return contents;
768
760
  };
769
761
  const deserializeAws_queryAssumeRoleWithSAMLResponse = (output, context) => {
770
- const contents = {
771
- Credentials: undefined,
772
- AssumedRoleUser: undefined,
773
- PackedPolicySize: undefined,
774
- Subject: undefined,
775
- SubjectType: undefined,
776
- Issuer: undefined,
777
- Audience: undefined,
778
- NameQualifier: undefined,
779
- SourceIdentity: undefined,
780
- };
762
+ const contents = {};
781
763
  if (output["Credentials"] !== undefined) {
782
764
  contents.Credentials = deserializeAws_queryCredentials(output["Credentials"], context);
783
765
  }
@@ -808,15 +790,7 @@ const deserializeAws_queryAssumeRoleWithSAMLResponse = (output, context) => {
808
790
  return contents;
809
791
  };
810
792
  const deserializeAws_queryAssumeRoleWithWebIdentityResponse = (output, context) => {
811
- const contents = {
812
- Credentials: undefined,
813
- SubjectFromWebIdentityToken: undefined,
814
- AssumedRoleUser: undefined,
815
- PackedPolicySize: undefined,
816
- Provider: undefined,
817
- Audience: undefined,
818
- SourceIdentity: undefined,
819
- };
793
+ const contents = {};
820
794
  if (output["Credentials"] !== undefined) {
821
795
  contents.Credentials = deserializeAws_queryCredentials(output["Credentials"], context);
822
796
  }
@@ -841,12 +815,7 @@ const deserializeAws_queryAssumeRoleWithWebIdentityResponse = (output, context)
841
815
  return contents;
842
816
  };
843
817
  const deserializeAws_queryCredentials = (output, context) => {
844
- const contents = {
845
- AccessKeyId: undefined,
846
- SecretAccessKey: undefined,
847
- SessionToken: undefined,
848
- Expiration: undefined,
849
- };
818
+ const contents = {};
850
819
  if (output["AccessKeyId"] !== undefined) {
851
820
  contents.AccessKeyId = (0, smithy_client_1.expectString)(output["AccessKeyId"]);
852
821
  }
@@ -862,28 +831,21 @@ const deserializeAws_queryCredentials = (output, context) => {
862
831
  return contents;
863
832
  };
864
833
  const deserializeAws_queryDecodeAuthorizationMessageResponse = (output, context) => {
865
- const contents = {
866
- DecodedMessage: undefined,
867
- };
834
+ const contents = {};
868
835
  if (output["DecodedMessage"] !== undefined) {
869
836
  contents.DecodedMessage = (0, smithy_client_1.expectString)(output["DecodedMessage"]);
870
837
  }
871
838
  return contents;
872
839
  };
873
840
  const deserializeAws_queryExpiredTokenException = (output, context) => {
874
- const contents = {
875
- message: undefined,
876
- };
841
+ const contents = {};
877
842
  if (output["message"] !== undefined) {
878
843
  contents.message = (0, smithy_client_1.expectString)(output["message"]);
879
844
  }
880
845
  return contents;
881
846
  };
882
847
  const deserializeAws_queryFederatedUser = (output, context) => {
883
- const contents = {
884
- FederatedUserId: undefined,
885
- Arn: undefined,
886
- };
848
+ const contents = {};
887
849
  if (output["FederatedUserId"] !== undefined) {
888
850
  contents.FederatedUserId = (0, smithy_client_1.expectString)(output["FederatedUserId"]);
889
851
  }
@@ -893,20 +855,14 @@ const deserializeAws_queryFederatedUser = (output, context) => {
893
855
  return contents;
894
856
  };
895
857
  const deserializeAws_queryGetAccessKeyInfoResponse = (output, context) => {
896
- const contents = {
897
- Account: undefined,
898
- };
858
+ const contents = {};
899
859
  if (output["Account"] !== undefined) {
900
860
  contents.Account = (0, smithy_client_1.expectString)(output["Account"]);
901
861
  }
902
862
  return contents;
903
863
  };
904
864
  const deserializeAws_queryGetCallerIdentityResponse = (output, context) => {
905
- const contents = {
906
- UserId: undefined,
907
- Account: undefined,
908
- Arn: undefined,
909
- };
865
+ const contents = {};
910
866
  if (output["UserId"] !== undefined) {
911
867
  contents.UserId = (0, smithy_client_1.expectString)(output["UserId"]);
912
868
  }
@@ -919,11 +875,7 @@ const deserializeAws_queryGetCallerIdentityResponse = (output, context) => {
919
875
  return contents;
920
876
  };
921
877
  const deserializeAws_queryGetFederationTokenResponse = (output, context) => {
922
- const contents = {
923
- Credentials: undefined,
924
- FederatedUser: undefined,
925
- PackedPolicySize: undefined,
926
- };
878
+ const contents = {};
927
879
  if (output["Credentials"] !== undefined) {
928
880
  contents.Credentials = deserializeAws_queryCredentials(output["Credentials"], context);
929
881
  }
@@ -936,72 +888,56 @@ const deserializeAws_queryGetFederationTokenResponse = (output, context) => {
936
888
  return contents;
937
889
  };
938
890
  const deserializeAws_queryGetSessionTokenResponse = (output, context) => {
939
- const contents = {
940
- Credentials: undefined,
941
- };
891
+ const contents = {};
942
892
  if (output["Credentials"] !== undefined) {
943
893
  contents.Credentials = deserializeAws_queryCredentials(output["Credentials"], context);
944
894
  }
945
895
  return contents;
946
896
  };
947
897
  const deserializeAws_queryIDPCommunicationErrorException = (output, context) => {
948
- const contents = {
949
- message: undefined,
950
- };
898
+ const contents = {};
951
899
  if (output["message"] !== undefined) {
952
900
  contents.message = (0, smithy_client_1.expectString)(output["message"]);
953
901
  }
954
902
  return contents;
955
903
  };
956
904
  const deserializeAws_queryIDPRejectedClaimException = (output, context) => {
957
- const contents = {
958
- message: undefined,
959
- };
905
+ const contents = {};
960
906
  if (output["message"] !== undefined) {
961
907
  contents.message = (0, smithy_client_1.expectString)(output["message"]);
962
908
  }
963
909
  return contents;
964
910
  };
965
911
  const deserializeAws_queryInvalidAuthorizationMessageException = (output, context) => {
966
- const contents = {
967
- message: undefined,
968
- };
912
+ const contents = {};
969
913
  if (output["message"] !== undefined) {
970
914
  contents.message = (0, smithy_client_1.expectString)(output["message"]);
971
915
  }
972
916
  return contents;
973
917
  };
974
918
  const deserializeAws_queryInvalidIdentityTokenException = (output, context) => {
975
- const contents = {
976
- message: undefined,
977
- };
919
+ const contents = {};
978
920
  if (output["message"] !== undefined) {
979
921
  contents.message = (0, smithy_client_1.expectString)(output["message"]);
980
922
  }
981
923
  return contents;
982
924
  };
983
925
  const deserializeAws_queryMalformedPolicyDocumentException = (output, context) => {
984
- const contents = {
985
- message: undefined,
986
- };
926
+ const contents = {};
987
927
  if (output["message"] !== undefined) {
988
928
  contents.message = (0, smithy_client_1.expectString)(output["message"]);
989
929
  }
990
930
  return contents;
991
931
  };
992
932
  const deserializeAws_queryPackedPolicyTooLargeException = (output, context) => {
993
- const contents = {
994
- message: undefined,
995
- };
933
+ const contents = {};
996
934
  if (output["message"] !== undefined) {
997
935
  contents.message = (0, smithy_client_1.expectString)(output["message"]);
998
936
  }
999
937
  return contents;
1000
938
  };
1001
939
  const deserializeAws_queryRegionDisabledException = (output, context) => {
1002
- const contents = {
1003
- message: undefined,
1004
- };
940
+ const contents = {};
1005
941
  if (output["message"] !== undefined) {
1006
942
  contents.message = (0, smithy_client_1.expectString)(output["message"]);
1007
943
  }
@@ -714,10 +714,7 @@ const serializeAws_querytagListType = (input, context) => {
714
714
  return entries;
715
715
  };
716
716
  const deserializeAws_queryAssumedRoleUser = (output, context) => {
717
- const contents = {
718
- AssumedRoleId: undefined,
719
- Arn: undefined,
720
- };
717
+ const contents = {};
721
718
  if (output["AssumedRoleId"] !== undefined) {
722
719
  contents.AssumedRoleId = __expectString(output["AssumedRoleId"]);
723
720
  }
@@ -727,12 +724,7 @@ const deserializeAws_queryAssumedRoleUser = (output, context) => {
727
724
  return contents;
728
725
  };
729
726
  const deserializeAws_queryAssumeRoleResponse = (output, context) => {
730
- const contents = {
731
- Credentials: undefined,
732
- AssumedRoleUser: undefined,
733
- PackedPolicySize: undefined,
734
- SourceIdentity: undefined,
735
- };
727
+ const contents = {};
736
728
  if (output["Credentials"] !== undefined) {
737
729
  contents.Credentials = deserializeAws_queryCredentials(output["Credentials"], context);
738
730
  }
@@ -748,17 +740,7 @@ const deserializeAws_queryAssumeRoleResponse = (output, context) => {
748
740
  return contents;
749
741
  };
750
742
  const deserializeAws_queryAssumeRoleWithSAMLResponse = (output, context) => {
751
- const contents = {
752
- Credentials: undefined,
753
- AssumedRoleUser: undefined,
754
- PackedPolicySize: undefined,
755
- Subject: undefined,
756
- SubjectType: undefined,
757
- Issuer: undefined,
758
- Audience: undefined,
759
- NameQualifier: undefined,
760
- SourceIdentity: undefined,
761
- };
743
+ const contents = {};
762
744
  if (output["Credentials"] !== undefined) {
763
745
  contents.Credentials = deserializeAws_queryCredentials(output["Credentials"], context);
764
746
  }
@@ -789,15 +771,7 @@ const deserializeAws_queryAssumeRoleWithSAMLResponse = (output, context) => {
789
771
  return contents;
790
772
  };
791
773
  const deserializeAws_queryAssumeRoleWithWebIdentityResponse = (output, context) => {
792
- const contents = {
793
- Credentials: undefined,
794
- SubjectFromWebIdentityToken: undefined,
795
- AssumedRoleUser: undefined,
796
- PackedPolicySize: undefined,
797
- Provider: undefined,
798
- Audience: undefined,
799
- SourceIdentity: undefined,
800
- };
774
+ const contents = {};
801
775
  if (output["Credentials"] !== undefined) {
802
776
  contents.Credentials = deserializeAws_queryCredentials(output["Credentials"], context);
803
777
  }
@@ -822,12 +796,7 @@ const deserializeAws_queryAssumeRoleWithWebIdentityResponse = (output, context)
822
796
  return contents;
823
797
  };
824
798
  const deserializeAws_queryCredentials = (output, context) => {
825
- const contents = {
826
- AccessKeyId: undefined,
827
- SecretAccessKey: undefined,
828
- SessionToken: undefined,
829
- Expiration: undefined,
830
- };
799
+ const contents = {};
831
800
  if (output["AccessKeyId"] !== undefined) {
832
801
  contents.AccessKeyId = __expectString(output["AccessKeyId"]);
833
802
  }
@@ -843,28 +812,21 @@ const deserializeAws_queryCredentials = (output, context) => {
843
812
  return contents;
844
813
  };
845
814
  const deserializeAws_queryDecodeAuthorizationMessageResponse = (output, context) => {
846
- const contents = {
847
- DecodedMessage: undefined,
848
- };
815
+ const contents = {};
849
816
  if (output["DecodedMessage"] !== undefined) {
850
817
  contents.DecodedMessage = __expectString(output["DecodedMessage"]);
851
818
  }
852
819
  return contents;
853
820
  };
854
821
  const deserializeAws_queryExpiredTokenException = (output, context) => {
855
- const contents = {
856
- message: undefined,
857
- };
822
+ const contents = {};
858
823
  if (output["message"] !== undefined) {
859
824
  contents.message = __expectString(output["message"]);
860
825
  }
861
826
  return contents;
862
827
  };
863
828
  const deserializeAws_queryFederatedUser = (output, context) => {
864
- const contents = {
865
- FederatedUserId: undefined,
866
- Arn: undefined,
867
- };
829
+ const contents = {};
868
830
  if (output["FederatedUserId"] !== undefined) {
869
831
  contents.FederatedUserId = __expectString(output["FederatedUserId"]);
870
832
  }
@@ -874,20 +836,14 @@ const deserializeAws_queryFederatedUser = (output, context) => {
874
836
  return contents;
875
837
  };
876
838
  const deserializeAws_queryGetAccessKeyInfoResponse = (output, context) => {
877
- const contents = {
878
- Account: undefined,
879
- };
839
+ const contents = {};
880
840
  if (output["Account"] !== undefined) {
881
841
  contents.Account = __expectString(output["Account"]);
882
842
  }
883
843
  return contents;
884
844
  };
885
845
  const deserializeAws_queryGetCallerIdentityResponse = (output, context) => {
886
- const contents = {
887
- UserId: undefined,
888
- Account: undefined,
889
- Arn: undefined,
890
- };
846
+ const contents = {};
891
847
  if (output["UserId"] !== undefined) {
892
848
  contents.UserId = __expectString(output["UserId"]);
893
849
  }
@@ -900,11 +856,7 @@ const deserializeAws_queryGetCallerIdentityResponse = (output, context) => {
900
856
  return contents;
901
857
  };
902
858
  const deserializeAws_queryGetFederationTokenResponse = (output, context) => {
903
- const contents = {
904
- Credentials: undefined,
905
- FederatedUser: undefined,
906
- PackedPolicySize: undefined,
907
- };
859
+ const contents = {};
908
860
  if (output["Credentials"] !== undefined) {
909
861
  contents.Credentials = deserializeAws_queryCredentials(output["Credentials"], context);
910
862
  }
@@ -917,72 +869,56 @@ const deserializeAws_queryGetFederationTokenResponse = (output, context) => {
917
869
  return contents;
918
870
  };
919
871
  const deserializeAws_queryGetSessionTokenResponse = (output, context) => {
920
- const contents = {
921
- Credentials: undefined,
922
- };
872
+ const contents = {};
923
873
  if (output["Credentials"] !== undefined) {
924
874
  contents.Credentials = deserializeAws_queryCredentials(output["Credentials"], context);
925
875
  }
926
876
  return contents;
927
877
  };
928
878
  const deserializeAws_queryIDPCommunicationErrorException = (output, context) => {
929
- const contents = {
930
- message: undefined,
931
- };
879
+ const contents = {};
932
880
  if (output["message"] !== undefined) {
933
881
  contents.message = __expectString(output["message"]);
934
882
  }
935
883
  return contents;
936
884
  };
937
885
  const deserializeAws_queryIDPRejectedClaimException = (output, context) => {
938
- const contents = {
939
- message: undefined,
940
- };
886
+ const contents = {};
941
887
  if (output["message"] !== undefined) {
942
888
  contents.message = __expectString(output["message"]);
943
889
  }
944
890
  return contents;
945
891
  };
946
892
  const deserializeAws_queryInvalidAuthorizationMessageException = (output, context) => {
947
- const contents = {
948
- message: undefined,
949
- };
893
+ const contents = {};
950
894
  if (output["message"] !== undefined) {
951
895
  contents.message = __expectString(output["message"]);
952
896
  }
953
897
  return contents;
954
898
  };
955
899
  const deserializeAws_queryInvalidIdentityTokenException = (output, context) => {
956
- const contents = {
957
- message: undefined,
958
- };
900
+ const contents = {};
959
901
  if (output["message"] !== undefined) {
960
902
  contents.message = __expectString(output["message"]);
961
903
  }
962
904
  return contents;
963
905
  };
964
906
  const deserializeAws_queryMalformedPolicyDocumentException = (output, context) => {
965
- const contents = {
966
- message: undefined,
967
- };
907
+ const contents = {};
968
908
  if (output["message"] !== undefined) {
969
909
  contents.message = __expectString(output["message"]);
970
910
  }
971
911
  return contents;
972
912
  };
973
913
  const deserializeAws_queryPackedPolicyTooLargeException = (output, context) => {
974
- const contents = {
975
- message: undefined,
976
- };
914
+ const contents = {};
977
915
  if (output["message"] !== undefined) {
978
916
  contents.message = __expectString(output["message"]);
979
917
  }
980
918
  return contents;
981
919
  };
982
920
  const deserializeAws_queryRegionDisabledException = (output, context) => {
983
- const contents = {
984
- message: undefined,
985
- };
921
+ const contents = {};
986
922
  if (output["message"] !== undefined) {
987
923
  contents.message = __expectString(output["message"]);
988
924
  }
@@ -9,6 +9,7 @@ import { GetFederationTokenCommandInput, GetFederationTokenCommandOutput } from
9
9
  import { GetSessionTokenCommandInput, GetSessionTokenCommandOutput } from "./commands/GetSessionTokenCommand";
10
10
  import { STSClient } from "./STSClient";
11
11
  /**
12
+ * @public
12
13
  * <fullname>Security Token Service</fullname>
13
14
  * <p>Security Token Service (STS) enables you to request temporary, limited-privilege
14
15
  * credentials for Identity and Access Management (IAM) users or for users that you
@@ -17,6 +18,7 @@ import { STSClient } from "./STSClient";
17
18
  */
18
19
  export declare class STS extends STSClient {
19
20
  /**
21
+ * @public
20
22
  * <p>Returns a set of temporary security credentials that you can use to access Amazon Web Services
21
23
  * resources. These temporary credentials consist of an access key ID, a secret access key,
22
24
  * and a security token. Typically, you use <code>AssumeRole</code> within your account or for
@@ -96,7 +98,7 @@ export declare class STS extends STSClient {
96
98
  * assume the role is denied. The condition in a trust policy that tests for MFA
97
99
  * authentication might look like the following example.</p>
98
100
  * <p>
99
- * <code>"Condition": {"Bool": {"aws:MultiFactorAuthPresent": true}}</code>
101
+ * <code>"Condition": \{"Bool": \{"aws:MultiFactorAuthPresent": true\}\}</code>
100
102
  * </p>
101
103
  * <p>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/MFAProtectedAPI.html">Configuring MFA-Protected API Access</a>
102
104
  * in the <i>IAM User Guide</i> guide.</p>
@@ -110,6 +112,7 @@ export declare class STS extends STSClient {
110
112
  assumeRole(args: AssumeRoleCommandInput, cb: (err: any, data?: AssumeRoleCommandOutput) => void): void;
111
113
  assumeRole(args: AssumeRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssumeRoleCommandOutput) => void): void;
112
114
  /**
115
+ * @public
113
116
  * <p>Returns a set of temporary security credentials for users who have been authenticated
114
117
  * via a SAML authentication response. This operation provides a mechanism for tying an
115
118
  * enterprise identity store or directory to role-based Amazon Web Services access without user-specific
@@ -244,6 +247,7 @@ export declare class STS extends STSClient {
244
247
  assumeRoleWithSAML(args: AssumeRoleWithSAMLCommandInput, cb: (err: any, data?: AssumeRoleWithSAMLCommandOutput) => void): void;
245
248
  assumeRoleWithSAML(args: AssumeRoleWithSAMLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssumeRoleWithSAMLCommandOutput) => void): void;
246
249
  /**
250
+ * @public
247
251
  * <p>Returns a set of temporary security credentials for users who have been authenticated in
248
252
  * a mobile or web application with a web identity provider. Example providers include the
249
253
  * OAuth 2.0 providers Login with Amazon and Facebook, or any OpenID Connect-compatible
@@ -382,6 +386,7 @@ export declare class STS extends STSClient {
382
386
  assumeRoleWithWebIdentity(args: AssumeRoleWithWebIdentityCommandInput, cb: (err: any, data?: AssumeRoleWithWebIdentityCommandOutput) => void): void;
383
387
  assumeRoleWithWebIdentity(args: AssumeRoleWithWebIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssumeRoleWithWebIdentityCommandOutput) => void): void;
384
388
  /**
389
+ * @public
385
390
  * <p>Decodes additional information about the authorization status of a request from an
386
391
  * encoded message returned in response to an Amazon Web Services request.</p>
387
392
  * <p>For example, if a user is not authorized to perform an operation that he or she has
@@ -423,6 +428,7 @@ export declare class STS extends STSClient {
423
428
  decodeAuthorizationMessage(args: DecodeAuthorizationMessageCommandInput, cb: (err: any, data?: DecodeAuthorizationMessageCommandOutput) => void): void;
424
429
  decodeAuthorizationMessage(args: DecodeAuthorizationMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DecodeAuthorizationMessageCommandOutput) => void): void;
425
430
  /**
431
+ * @public
426
432
  * <p>Returns the account identifier for the specified access key ID.</p>
427
433
  * <p>Access keys consist of two parts: an access key ID (for example,
428
434
  * <code>AKIAIOSFODNN7EXAMPLE</code>) and a secret access key (for example,
@@ -446,6 +452,7 @@ export declare class STS extends STSClient {
446
452
  getAccessKeyInfo(args: GetAccessKeyInfoCommandInput, cb: (err: any, data?: GetAccessKeyInfoCommandOutput) => void): void;
447
453
  getAccessKeyInfo(args: GetAccessKeyInfoCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccessKeyInfoCommandOutput) => void): void;
448
454
  /**
455
+ * @public
449
456
  * <p>Returns details about the IAM user or role whose credentials are used to call the
450
457
  * operation.</p>
451
458
  * <note>
@@ -461,6 +468,7 @@ export declare class STS extends STSClient {
461
468
  getCallerIdentity(args: GetCallerIdentityCommandInput, cb: (err: any, data?: GetCallerIdentityCommandOutput) => void): void;
462
469
  getCallerIdentity(args: GetCallerIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCallerIdentityCommandOutput) => void): void;
463
470
  /**
471
+ * @public
464
472
  * <p>Returns a set of temporary security credentials (consisting of an access key ID, a
465
473
  * secret access key, and a security token) for a federated user. A typical use is in a proxy
466
474
  * application that gets temporary security credentials on behalf of distributed applications
@@ -553,6 +561,7 @@ export declare class STS extends STSClient {
553
561
  getFederationToken(args: GetFederationTokenCommandInput, cb: (err: any, data?: GetFederationTokenCommandOutput) => void): void;
554
562
  getFederationToken(args: GetFederationTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFederationTokenCommandOutput) => void): void;
555
563
  /**
564
+ * @public
556
565
  * <p>Returns a set of temporary credentials for an Amazon Web Services account or IAM user. The
557
566
  * credentials consist of an access key ID, a secret access key, and a security token.
558
567
  * Typically, you use <code>GetSessionToken</code> if you want to use MFA to protect
@@ -16,15 +16,24 @@ import { GetCallerIdentityCommandInput, GetCallerIdentityCommandOutput } from ".
16
16
  import { GetFederationTokenCommandInput, GetFederationTokenCommandOutput } from "./commands/GetFederationTokenCommand";
17
17
  import { GetSessionTokenCommandInput, GetSessionTokenCommandOutput } from "./commands/GetSessionTokenCommand";
18
18
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
19
+ /**
20
+ * @public
21
+ */
19
22
  export type ServiceInputTypes = AssumeRoleCommandInput | AssumeRoleWithSAMLCommandInput | AssumeRoleWithWebIdentityCommandInput | DecodeAuthorizationMessageCommandInput | GetAccessKeyInfoCommandInput | GetCallerIdentityCommandInput | GetFederationTokenCommandInput | GetSessionTokenCommandInput;
23
+ /**
24
+ * @public
25
+ */
20
26
  export type ServiceOutputTypes = AssumeRoleCommandOutput | AssumeRoleWithSAMLCommandOutput | AssumeRoleWithWebIdentityCommandOutput | DecodeAuthorizationMessageCommandOutput | GetAccessKeyInfoCommandOutput | GetCallerIdentityCommandOutput | GetFederationTokenCommandOutput | GetSessionTokenCommandOutput;
27
+ /**
28
+ * @public
29
+ */
21
30
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
22
31
  /**
23
32
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
24
33
  */
25
34
  requestHandler?: __HttpHandler;
26
35
  /**
27
- * A constructor for a class implementing the {@link __Checksum} interface
36
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
28
37
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
29
38
  * @internal
30
39
  */
@@ -114,23 +123,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
114
123
  */
115
124
  logger?: __Logger;
116
125
  /**
117
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
126
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
118
127
  */
119
128
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
120
129
  }
130
+ /**
131
+ * @public
132
+ */
121
133
  type STSClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & StsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
122
134
  /**
123
- * The configuration interface of STSClient class constructor that set the region, credentials and other options.
135
+ * @public
136
+ *
137
+ * The configuration interface of STSClient class constructor that set the region, credentials and other options.
124
138
  */
125
139
  export interface STSClientConfig extends STSClientConfigType {
126
140
  }
141
+ /**
142
+ * @public
143
+ */
127
144
  type STSClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & StsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
128
145
  /**
129
- * The resolved configuration interface of STSClient class. This is resolved and normalized from the {@link STSClientConfig | constructor configuration interface}.
146
+ * @public
147
+ *
148
+ * The resolved configuration interface of STSClient class. This is resolved and normalized from the {@link STSClientConfig | constructor configuration interface}.
130
149
  */
131
150
  export interface STSClientResolvedConfig extends STSClientResolvedConfigType {
132
151
  }
133
152
  /**
153
+ * @public
134
154
  * <fullname>Security Token Service</fullname>
135
155
  * <p>Security Token Service (STS) enables you to request temporary, limited-privilege
136
156
  * credentials for Identity and Access Management (IAM) users or for users that you
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AssumeRoleRequest, AssumeRoleResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, STSClientResolvedConfig } from "../STSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AssumeRoleCommand}.
8
10
  */
9
11
  export interface AssumeRoleCommandInput extends AssumeRoleRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AssumeRoleCommand}.
13
17
  */
14
18
  export interface AssumeRoleCommandOutput extends AssumeRoleResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a set of temporary security credentials that you can use to access Amazon Web Services
18
23
  * resources. These temporary credentials consist of an access key ID, a secret access key,
19
24
  * and a security token. Typically, you use <code>AssumeRole</code> within your account or for
@@ -93,7 +98,7 @@ export interface AssumeRoleCommandOutput extends AssumeRoleResponse, __MetadataB
93
98
  * assume the role is denied. The condition in a trust policy that tests for MFA
94
99
  * authentication might look like the following example.</p>
95
100
  * <p>
96
- * <code>"Condition": {"Bool": {"aws:MultiFactorAuthPresent": true}}</code>
101
+ * <code>"Condition": \{"Bool": \{"aws:MultiFactorAuthPresent": true\}\}</code>
97
102
  * </p>
98
103
  * <p>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/MFAProtectedAPI.html">Configuring MFA-Protected API Access</a>
99
104
  * in the <i>IAM User Guide</i> guide.</p>
@@ -112,6 +117,8 @@ export interface AssumeRoleCommandOutput extends AssumeRoleResponse, __MetadataB
112
117
  * const response = await client.send(command);
113
118
  * ```
114
119
  *
120
+ * @param AssumeRoleCommandInput - {@link AssumeRoleCommandInput}
121
+ * @returns {@link AssumeRoleCommandOutput}
115
122
  * @see {@link AssumeRoleCommandInput} for command's `input` shape.
116
123
  * @see {@link AssumeRoleCommandOutput} for command's `response` shape.
117
124
  * @see {@link STSClientResolvedConfig | config} for STSClient's `config` shape.
@@ -194,11 +201,20 @@ export interface AssumeRoleCommandOutput extends AssumeRoleResponse, __MetadataB
194
201
  export declare class AssumeRoleCommand extends $Command<AssumeRoleCommandInput, AssumeRoleCommandOutput, STSClientResolvedConfig> {
195
202
  readonly input: AssumeRoleCommandInput;
196
203
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
204
+ /**
205
+ * @public
206
+ */
197
207
  constructor(input: AssumeRoleCommandInput);
198
208
  /**
199
209
  * @internal
200
210
  */
201
211
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: STSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AssumeRoleCommandInput, AssumeRoleCommandOutput>;
212
+ /**
213
+ * @internal
214
+ */
202
215
  private serialize;
216
+ /**
217
+ * @internal
218
+ */
203
219
  private deserialize;
204
220
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AssumeRoleWithSAMLRequest, AssumeRoleWithSAMLResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, STSClientResolvedConfig } from "../STSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AssumeRoleWithSAMLCommand}.
8
10
  */
9
11
  export interface AssumeRoleWithSAMLCommandInput extends AssumeRoleWithSAMLRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AssumeRoleWithSAMLCommand}.
13
17
  */
14
18
  export interface AssumeRoleWithSAMLCommandOutput extends AssumeRoleWithSAMLResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a set of temporary security credentials for users who have been authenticated
18
23
  * via a SAML authentication response. This operation provides a mechanism for tying an
19
24
  * enterprise identity store or directory to role-based Amazon Web Services access without user-specific
@@ -153,6 +158,8 @@ export interface AssumeRoleWithSAMLCommandOutput extends AssumeRoleWithSAMLRespo
153
158
  * const response = await client.send(command);
154
159
  * ```
155
160
  *
161
+ * @param AssumeRoleWithSAMLCommandInput - {@link AssumeRoleWithSAMLCommandInput}
162
+ * @returns {@link AssumeRoleWithSAMLCommandOutput}
156
163
  * @see {@link AssumeRoleWithSAMLCommandInput} for command's `input` shape.
157
164
  * @see {@link AssumeRoleWithSAMLCommandOutput} for command's `response` shape.
158
165
  * @see {@link STSClientResolvedConfig | config} for STSClient's `config` shape.
@@ -232,11 +239,20 @@ export interface AssumeRoleWithSAMLCommandOutput extends AssumeRoleWithSAMLRespo
232
239
  export declare class AssumeRoleWithSAMLCommand extends $Command<AssumeRoleWithSAMLCommandInput, AssumeRoleWithSAMLCommandOutput, STSClientResolvedConfig> {
233
240
  readonly input: AssumeRoleWithSAMLCommandInput;
234
241
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
242
+ /**
243
+ * @public
244
+ */
235
245
  constructor(input: AssumeRoleWithSAMLCommandInput);
236
246
  /**
237
247
  * @internal
238
248
  */
239
249
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: STSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AssumeRoleWithSAMLCommandInput, AssumeRoleWithSAMLCommandOutput>;
250
+ /**
251
+ * @internal
252
+ */
240
253
  private serialize;
254
+ /**
255
+ * @internal
256
+ */
241
257
  private deserialize;
242
258
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AssumeRoleWithWebIdentityRequest, AssumeRoleWithWebIdentityResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, STSClientResolvedConfig } from "../STSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AssumeRoleWithWebIdentityCommand}.
8
10
  */
9
11
  export interface AssumeRoleWithWebIdentityCommandInput extends AssumeRoleWithWebIdentityRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AssumeRoleWithWebIdentityCommand}.
13
17
  */
14
18
  export interface AssumeRoleWithWebIdentityCommandOutput extends AssumeRoleWithWebIdentityResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a set of temporary security credentials for users who have been authenticated in
18
23
  * a mobile or web application with a web identity provider. Example providers include the
19
24
  * OAuth 2.0 providers Login with Amazon and Facebook, or any OpenID Connect-compatible
@@ -157,6 +162,8 @@ export interface AssumeRoleWithWebIdentityCommandOutput extends AssumeRoleWithWe
157
162
  * const response = await client.send(command);
158
163
  * ```
159
164
  *
165
+ * @param AssumeRoleWithWebIdentityCommandInput - {@link AssumeRoleWithWebIdentityCommandInput}
166
+ * @returns {@link AssumeRoleWithWebIdentityCommandOutput}
160
167
  * @see {@link AssumeRoleWithWebIdentityCommandInput} for command's `input` shape.
161
168
  * @see {@link AssumeRoleWithWebIdentityCommandOutput} for command's `response` shape.
162
169
  * @see {@link STSClientResolvedConfig | config} for STSClient's `config` shape.
@@ -243,11 +250,20 @@ export interface AssumeRoleWithWebIdentityCommandOutput extends AssumeRoleWithWe
243
250
  export declare class AssumeRoleWithWebIdentityCommand extends $Command<AssumeRoleWithWebIdentityCommandInput, AssumeRoleWithWebIdentityCommandOutput, STSClientResolvedConfig> {
244
251
  readonly input: AssumeRoleWithWebIdentityCommandInput;
245
252
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
253
+ /**
254
+ * @public
255
+ */
246
256
  constructor(input: AssumeRoleWithWebIdentityCommandInput);
247
257
  /**
248
258
  * @internal
249
259
  */
250
260
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: STSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AssumeRoleWithWebIdentityCommandInput, AssumeRoleWithWebIdentityCommandOutput>;
261
+ /**
262
+ * @internal
263
+ */
251
264
  private serialize;
265
+ /**
266
+ * @internal
267
+ */
252
268
  private deserialize;
253
269
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DecodeAuthorizationMessageRequest, DecodeAuthorizationMessageResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, STSClientResolvedConfig } from "../STSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DecodeAuthorizationMessageCommand}.
8
10
  */
9
11
  export interface DecodeAuthorizationMessageCommandInput extends DecodeAuthorizationMessageRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DecodeAuthorizationMessageCommand}.
13
17
  */
14
18
  export interface DecodeAuthorizationMessageCommandOutput extends DecodeAuthorizationMessageResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Decodes additional information about the authorization status of a request from an
18
23
  * encoded message returned in response to an Amazon Web Services request.</p>
19
24
  * <p>For example, if a user is not authorized to perform an operation that he or she has
@@ -60,6 +65,8 @@ export interface DecodeAuthorizationMessageCommandOutput extends DecodeAuthoriza
60
65
  * const response = await client.send(command);
61
66
  * ```
62
67
  *
68
+ * @param DecodeAuthorizationMessageCommandInput - {@link DecodeAuthorizationMessageCommandInput}
69
+ * @returns {@link DecodeAuthorizationMessageCommandOutput}
63
70
  * @see {@link DecodeAuthorizationMessageCommandInput} for command's `input` shape.
64
71
  * @see {@link DecodeAuthorizationMessageCommandOutput} for command's `response` shape.
65
72
  * @see {@link STSClientResolvedConfig | config} for STSClient's `config` shape.
@@ -90,11 +97,20 @@ export interface DecodeAuthorizationMessageCommandOutput extends DecodeAuthoriza
90
97
  export declare class DecodeAuthorizationMessageCommand extends $Command<DecodeAuthorizationMessageCommandInput, DecodeAuthorizationMessageCommandOutput, STSClientResolvedConfig> {
91
98
  readonly input: DecodeAuthorizationMessageCommandInput;
92
99
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
100
+ /**
101
+ * @public
102
+ */
93
103
  constructor(input: DecodeAuthorizationMessageCommandInput);
94
104
  /**
95
105
  * @internal
96
106
  */
97
107
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: STSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DecodeAuthorizationMessageCommandInput, DecodeAuthorizationMessageCommandOutput>;
108
+ /**
109
+ * @internal
110
+ */
98
111
  private serialize;
112
+ /**
113
+ * @internal
114
+ */
99
115
  private deserialize;
100
116
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetAccessKeyInfoRequest, GetAccessKeyInfoResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, STSClientResolvedConfig } from "../STSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetAccessKeyInfoCommand}.
8
10
  */
9
11
  export interface GetAccessKeyInfoCommandInput extends GetAccessKeyInfoRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetAccessKeyInfoCommand}.
13
17
  */
14
18
  export interface GetAccessKeyInfoCommandOutput extends GetAccessKeyInfoResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the account identifier for the specified access key ID.</p>
18
23
  * <p>Access keys consist of two parts: an access key ID (for example,
19
24
  * <code>AKIAIOSFODNN7EXAMPLE</code>) and a secret access key (for example,
@@ -42,6 +47,8 @@ export interface GetAccessKeyInfoCommandOutput extends GetAccessKeyInfoResponse,
42
47
  * const response = await client.send(command);
43
48
  * ```
44
49
  *
50
+ * @param GetAccessKeyInfoCommandInput - {@link GetAccessKeyInfoCommandInput}
51
+ * @returns {@link GetAccessKeyInfoCommandOutput}
45
52
  * @see {@link GetAccessKeyInfoCommandInput} for command's `input` shape.
46
53
  * @see {@link GetAccessKeyInfoCommandOutput} for command's `response` shape.
47
54
  * @see {@link STSClientResolvedConfig | config} for STSClient's `config` shape.
@@ -51,11 +58,20 @@ export interface GetAccessKeyInfoCommandOutput extends GetAccessKeyInfoResponse,
51
58
  export declare class GetAccessKeyInfoCommand extends $Command<GetAccessKeyInfoCommandInput, GetAccessKeyInfoCommandOutput, STSClientResolvedConfig> {
52
59
  readonly input: GetAccessKeyInfoCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: GetAccessKeyInfoCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: STSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetAccessKeyInfoCommandInput, GetAccessKeyInfoCommandOutput>;
69
+ /**
70
+ * @internal
71
+ */
59
72
  private serialize;
73
+ /**
74
+ * @internal
75
+ */
60
76
  private deserialize;
61
77
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetCallerIdentityRequest, GetCallerIdentityResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, STSClientResolvedConfig } from "../STSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetCallerIdentityCommand}.
8
10
  */
9
11
  export interface GetCallerIdentityCommandInput extends GetCallerIdentityRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetCallerIdentityCommand}.
13
17
  */
14
18
  export interface GetCallerIdentityCommandOutput extends GetCallerIdentityResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns details about the IAM user or role whose credentials are used to call the
18
23
  * operation.</p>
19
24
  * <note>
@@ -34,6 +39,8 @@ export interface GetCallerIdentityCommandOutput extends GetCallerIdentityRespons
34
39
  * const response = await client.send(command);
35
40
  * ```
36
41
  *
42
+ * @param GetCallerIdentityCommandInput - {@link GetCallerIdentityCommandInput}
43
+ * @returns {@link GetCallerIdentityCommandOutput}
37
44
  * @see {@link GetCallerIdentityCommandInput} for command's `input` shape.
38
45
  * @see {@link GetCallerIdentityCommandOutput} for command's `response` shape.
39
46
  * @see {@link STSClientResolvedConfig | config} for STSClient's `config` shape.
@@ -91,11 +98,20 @@ export interface GetCallerIdentityCommandOutput extends GetCallerIdentityRespons
91
98
  export declare class GetCallerIdentityCommand extends $Command<GetCallerIdentityCommandInput, GetCallerIdentityCommandOutput, STSClientResolvedConfig> {
92
99
  readonly input: GetCallerIdentityCommandInput;
93
100
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
101
+ /**
102
+ * @public
103
+ */
94
104
  constructor(input: GetCallerIdentityCommandInput);
95
105
  /**
96
106
  * @internal
97
107
  */
98
108
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: STSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetCallerIdentityCommandInput, GetCallerIdentityCommandOutput>;
109
+ /**
110
+ * @internal
111
+ */
99
112
  private serialize;
113
+ /**
114
+ * @internal
115
+ */
100
116
  private deserialize;
101
117
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetFederationTokenRequest, GetFederationTokenResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, STSClientResolvedConfig } from "../STSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetFederationTokenCommand}.
8
10
  */
9
11
  export interface GetFederationTokenCommandInput extends GetFederationTokenRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetFederationTokenCommand}.
13
17
  */
14
18
  export interface GetFederationTokenCommandOutput extends GetFederationTokenResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a set of temporary security credentials (consisting of an access key ID, a
18
23
  * secret access key, and a security token) for a federated user. A typical use is in a proxy
19
24
  * application that gets temporary security credentials on behalf of distributed applications
@@ -111,6 +116,8 @@ export interface GetFederationTokenCommandOutput extends GetFederationTokenRespo
111
116
  * const response = await client.send(command);
112
117
  * ```
113
118
  *
119
+ * @param GetFederationTokenCommandInput - {@link GetFederationTokenCommandInput}
120
+ * @returns {@link GetFederationTokenCommandOutput}
114
121
  * @see {@link GetFederationTokenCommandInput} for command's `input` shape.
115
122
  * @see {@link GetFederationTokenCommandOutput} for command's `response` shape.
116
123
  * @see {@link STSClientResolvedConfig | config} for STSClient's `config` shape.
@@ -180,11 +187,20 @@ export interface GetFederationTokenCommandOutput extends GetFederationTokenRespo
180
187
  export declare class GetFederationTokenCommand extends $Command<GetFederationTokenCommandInput, GetFederationTokenCommandOutput, STSClientResolvedConfig> {
181
188
  readonly input: GetFederationTokenCommandInput;
182
189
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
190
+ /**
191
+ * @public
192
+ */
183
193
  constructor(input: GetFederationTokenCommandInput);
184
194
  /**
185
195
  * @internal
186
196
  */
187
197
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: STSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetFederationTokenCommandInput, GetFederationTokenCommandOutput>;
198
+ /**
199
+ * @internal
200
+ */
188
201
  private serialize;
202
+ /**
203
+ * @internal
204
+ */
189
205
  private deserialize;
190
206
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetSessionTokenRequest, GetSessionTokenResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, STSClientResolvedConfig } from "../STSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetSessionTokenCommand}.
8
10
  */
9
11
  export interface GetSessionTokenCommandInput extends GetSessionTokenRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetSessionTokenCommand}.
13
17
  */
14
18
  export interface GetSessionTokenCommandOutput extends GetSessionTokenResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a set of temporary credentials for an Amazon Web Services account or IAM user. The
18
23
  * credentials consist of an access key ID, a secret access key, and a security token.
19
24
  * Typically, you use <code>GetSessionToken</code> if you want to use MFA to protect
@@ -83,6 +88,8 @@ export interface GetSessionTokenCommandOutput extends GetSessionTokenResponse, _
83
88
  * const response = await client.send(command);
84
89
  * ```
85
90
  *
91
+ * @param GetSessionTokenCommandInput - {@link GetSessionTokenCommandInput}
92
+ * @returns {@link GetSessionTokenCommandOutput}
86
93
  * @see {@link GetSessionTokenCommandInput} for command's `input` shape.
87
94
  * @see {@link GetSessionTokenCommandOutput} for command's `response` shape.
88
95
  * @see {@link STSClientResolvedConfig | config} for STSClient's `config` shape.
@@ -122,11 +129,20 @@ export interface GetSessionTokenCommandOutput extends GetSessionTokenResponse, _
122
129
  export declare class GetSessionTokenCommand extends $Command<GetSessionTokenCommandInput, GetSessionTokenCommandOutput, STSClientResolvedConfig> {
123
130
  readonly input: GetSessionTokenCommandInput;
124
131
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
132
+ /**
133
+ * @public
134
+ */
125
135
  constructor(input: GetSessionTokenCommandInput);
126
136
  /**
127
137
  * @internal
128
138
  */
129
139
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: STSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetSessionTokenCommandInput, GetSessionTokenCommandOutput>;
140
+ /**
141
+ * @internal
142
+ */
130
143
  private serialize;
144
+ /**
145
+ * @internal
146
+ */
131
147
  private deserialize;
132
148
  }
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from STS service.
4
6
  */
5
7
  export declare class STSServiceException extends __ServiceException {
@@ -1,6 +1,7 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { STSServiceException as __BaseException } from "./STSServiceException";
3
3
  /**
4
+ * @public
4
5
  * <p>The identifiers for the temporary security credentials that the operation
5
6
  * returns.</p>
6
7
  */
@@ -18,6 +19,7 @@ export interface AssumedRoleUser {
18
19
  Arn: string | undefined;
19
20
  }
20
21
  /**
22
+ * @public
21
23
  * <p>A reference to the IAM managed policy that is passed as a session policy for a role
22
24
  * session or a federated user session.</p>
23
25
  */
@@ -30,6 +32,7 @@ export interface PolicyDescriptorType {
30
32
  arn?: string;
31
33
  }
32
34
  /**
35
+ * @public
33
36
  * <p>You can pass custom key-value pair attributes when you assume a role or federate a user.
34
37
  * These are called session tags. You can then use the session tags to control access to
35
38
  * resources. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html">Tagging Amazon Web Services STS Sessions</a> in the
@@ -51,6 +54,9 @@ export interface Tag {
51
54
  */
52
55
  Value: string | undefined;
53
56
  }
57
+ /**
58
+ * @public
59
+ */
54
60
  export interface AssumeRoleRequest {
55
61
  /**
56
62
  * <p>The Amazon Resource Name (ARN) of the role to assume.</p>
@@ -242,6 +248,7 @@ export interface AssumeRoleRequest {
242
248
  SourceIdentity?: string;
243
249
  }
244
250
  /**
251
+ * @public
245
252
  * <p>Amazon Web Services credentials for API authentication.</p>
246
253
  */
247
254
  export interface Credentials {
@@ -264,6 +271,7 @@ export interface Credentials {
264
271
  Expiration: Date | undefined;
265
272
  }
266
273
  /**
274
+ * @public
267
275
  * <p>Contains the response to a successful <a>AssumeRole</a> request, including
268
276
  * temporary Amazon Web Services credentials that can be used to make Amazon Web Services requests. </p>
269
277
  */
@@ -309,6 +317,7 @@ export interface AssumeRoleResponse {
309
317
  SourceIdentity?: string;
310
318
  }
311
319
  /**
320
+ * @public
312
321
  * <p>The web identity token that was passed is expired or is not valid. Get a new identity
313
322
  * token from the identity provider and then retry the request.</p>
314
323
  */
@@ -321,6 +330,7 @@ export declare class ExpiredTokenException extends __BaseException {
321
330
  constructor(opts: __ExceptionOptionType<ExpiredTokenException, __BaseException>);
322
331
  }
323
332
  /**
333
+ * @public
324
334
  * <p>The request was rejected because the policy document was malformed. The error message
325
335
  * describes the specific error.</p>
326
336
  */
@@ -333,6 +343,7 @@ export declare class MalformedPolicyDocumentException extends __BaseException {
333
343
  constructor(opts: __ExceptionOptionType<MalformedPolicyDocumentException, __BaseException>);
334
344
  }
335
345
  /**
346
+ * @public
336
347
  * <p>The request was rejected because the total packed size of the session policies and
337
348
  * session tags combined was too large. An Amazon Web Services conversion compresses the session policy
338
349
  * document, session policy ARNs, and session tags into a packed binary format that has a
@@ -352,6 +363,7 @@ export declare class PackedPolicyTooLargeException extends __BaseException {
352
363
  constructor(opts: __ExceptionOptionType<PackedPolicyTooLargeException, __BaseException>);
353
364
  }
354
365
  /**
366
+ * @public
355
367
  * <p>STS is not activated in the requested region for the account that is being asked to
356
368
  * generate credentials. The account administrator must use the IAM console to activate STS
357
369
  * in that region. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and
@@ -366,6 +378,9 @@ export declare class RegionDisabledException extends __BaseException {
366
378
  */
367
379
  constructor(opts: __ExceptionOptionType<RegionDisabledException, __BaseException>);
368
380
  }
381
+ /**
382
+ * @public
383
+ */
369
384
  export interface AssumeRoleWithSAMLRequest {
370
385
  /**
371
386
  * <p>The Amazon Resource Name (ARN) of the role that the caller is assuming.</p>
@@ -456,6 +471,7 @@ export interface AssumeRoleWithSAMLRequest {
456
471
  DurationSeconds?: number;
457
472
  }
458
473
  /**
474
+ * @public
459
475
  * <p>Contains the response to a successful <a>AssumeRoleWithSAML</a> request,
460
476
  * including temporary Amazon Web Services credentials that can be used to make Amazon Web Services requests. </p>
461
477
  */
@@ -546,6 +562,7 @@ export interface AssumeRoleWithSAMLResponse {
546
562
  SourceIdentity?: string;
547
563
  }
548
564
  /**
565
+ * @public
549
566
  * <p>The identity provider (IdP) reported that authentication failed. This might be because
550
567
  * the claim is invalid.</p>
551
568
  * <p>If this error is returned for the <code>AssumeRoleWithWebIdentity</code> operation, it
@@ -560,6 +577,7 @@ export declare class IDPRejectedClaimException extends __BaseException {
560
577
  constructor(opts: __ExceptionOptionType<IDPRejectedClaimException, __BaseException>);
561
578
  }
562
579
  /**
580
+ * @public
563
581
  * <p>The web identity token that was passed could not be validated by Amazon Web Services. Get a new
564
582
  * identity token from the identity provider and then retry the request.</p>
565
583
  */
@@ -571,6 +589,9 @@ export declare class InvalidIdentityTokenException extends __BaseException {
571
589
  */
572
590
  constructor(opts: __ExceptionOptionType<InvalidIdentityTokenException, __BaseException>);
573
591
  }
592
+ /**
593
+ * @public
594
+ */
574
595
  export interface AssumeRoleWithWebIdentityRequest {
575
596
  /**
576
597
  * <p>The Amazon Resource Name (ARN) of the role that the caller is assuming.</p>
@@ -674,6 +695,7 @@ export interface AssumeRoleWithWebIdentityRequest {
674
695
  DurationSeconds?: number;
675
696
  }
676
697
  /**
698
+ * @public
677
699
  * <p>Contains the response to a successful <a>AssumeRoleWithWebIdentity</a>
678
700
  * request, including temporary Amazon Web Services credentials that can be used to make Amazon Web Services requests. </p>
679
701
  */
@@ -745,6 +767,7 @@ export interface AssumeRoleWithWebIdentityResponse {
745
767
  SourceIdentity?: string;
746
768
  }
747
769
  /**
770
+ * @public
748
771
  * <p>The request could not be fulfilled because the identity provider (IDP) that
749
772
  * was asked to verify the incoming identity token could not be reached. This is often a
750
773
  * transient error caused by network conditions. Retry the request a limited number of
@@ -759,6 +782,9 @@ export declare class IDPCommunicationErrorException extends __BaseException {
759
782
  */
760
783
  constructor(opts: __ExceptionOptionType<IDPCommunicationErrorException, __BaseException>);
761
784
  }
785
+ /**
786
+ * @public
787
+ */
762
788
  export interface DecodeAuthorizationMessageRequest {
763
789
  /**
764
790
  * <p>The encoded message that was returned with the response.</p>
@@ -766,6 +792,7 @@ export interface DecodeAuthorizationMessageRequest {
766
792
  EncodedMessage: string | undefined;
767
793
  }
768
794
  /**
795
+ * @public
769
796
  * <p>A document that contains additional information about the authorization status of a
770
797
  * request from an encoded message that is returned in response to an Amazon Web Services request.</p>
771
798
  */
@@ -776,6 +803,7 @@ export interface DecodeAuthorizationMessageResponse {
776
803
  DecodedMessage?: string;
777
804
  }
778
805
  /**
806
+ * @public
779
807
  * <p>The error returned if the message passed to <code>DecodeAuthorizationMessage</code>
780
808
  * was invalid. This can happen if the token contains invalid characters, such as
781
809
  * linebreaks. </p>
@@ -788,6 +816,9 @@ export declare class InvalidAuthorizationMessageException extends __BaseExceptio
788
816
  */
789
817
  constructor(opts: __ExceptionOptionType<InvalidAuthorizationMessageException, __BaseException>);
790
818
  }
819
+ /**
820
+ * @public
821
+ */
791
822
  export interface GetAccessKeyInfoRequest {
792
823
  /**
793
824
  * <p>The identifier of an access key.</p>
@@ -796,15 +827,22 @@ export interface GetAccessKeyInfoRequest {
796
827
  */
797
828
  AccessKeyId: string | undefined;
798
829
  }
830
+ /**
831
+ * @public
832
+ */
799
833
  export interface GetAccessKeyInfoResponse {
800
834
  /**
801
835
  * <p>The number used to identify the Amazon Web Services account.</p>
802
836
  */
803
837
  Account?: string;
804
838
  }
839
+ /**
840
+ * @public
841
+ */
805
842
  export interface GetCallerIdentityRequest {
806
843
  }
807
844
  /**
845
+ * @public
808
846
  * <p>Contains the response to a successful <a>GetCallerIdentity</a> request,
809
847
  * including information about the entity making the request.</p>
810
848
  */
@@ -826,6 +864,9 @@ export interface GetCallerIdentityResponse {
826
864
  */
827
865
  Arn?: string;
828
866
  }
867
+ /**
868
+ * @public
869
+ */
829
870
  export interface GetFederationTokenRequest {
830
871
  /**
831
872
  * <p>The name of the federated user. The name is used as an identifier for the temporary
@@ -938,6 +979,7 @@ export interface GetFederationTokenRequest {
938
979
  Tags?: Tag[];
939
980
  }
940
981
  /**
982
+ * @public
941
983
  * <p>Identifiers for the federated user that is associated with the credentials.</p>
942
984
  */
943
985
  export interface FederatedUser {
@@ -954,6 +996,7 @@ export interface FederatedUser {
954
996
  Arn: string | undefined;
955
997
  }
956
998
  /**
999
+ * @public
957
1000
  * <p>Contains the response to a successful <a>GetFederationToken</a> request,
958
1001
  * including temporary Amazon Web Services credentials that can be used to make Amazon Web Services requests. </p>
959
1002
  */
@@ -981,6 +1024,9 @@ export interface GetFederationTokenResponse {
981
1024
  */
982
1025
  PackedPolicySize?: number;
983
1026
  }
1027
+ /**
1028
+ * @public
1029
+ */
984
1030
  export interface GetSessionTokenRequest {
985
1031
  /**
986
1032
  * <p>The duration, in seconds, that the credentials should remain valid. Acceptable durations
@@ -1015,6 +1061,7 @@ export interface GetSessionTokenRequest {
1015
1061
  TokenCode?: string;
1016
1062
  }
1017
1063
  /**
1064
+ * @public
1018
1065
  * <p>Contains the response to a successful <a>GetSessionToken</a> request,
1019
1066
  * including temporary Amazon Web Services credentials that can be used to make Amazon Web Services requests. </p>
1020
1067
  */
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-sts",
3
3
  "description": "AWS SDK for JavaScript Sts Client for Node.js, Browser and React Native",
4
- "version": "3.296.0",
4
+ "version": "3.297.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -23,7 +23,7 @@
23
23
  "@aws-crypto/sha256-browser": "3.0.0",
24
24
  "@aws-crypto/sha256-js": "3.0.0",
25
25
  "@aws-sdk/config-resolver": "3.296.0",
26
- "@aws-sdk/credential-provider-node": "3.296.0",
26
+ "@aws-sdk/credential-provider-node": "3.297.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.296.0",
28
28
  "@aws-sdk/hash-node": "3.296.0",
29
29
  "@aws-sdk/invalid-dependency": "3.296.0",