aws-sdk-paymentcryptography 1.52.0 → 1.54.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-paymentcryptography/client.rb +487 -69
- data/lib/aws-sdk-paymentcryptography/client_api.rb +177 -0
- data/lib/aws-sdk-paymentcryptography/errors.rb +16 -0
- data/lib/aws-sdk-paymentcryptography/types.rb +306 -6
- data/lib/aws-sdk-paymentcryptography.rb +1 -1
- data/sig/client.rbs +71 -3
- data/sig/errors.rbs +3 -0
- data/sig/types.rbs +90 -1
- metadata +1 -1
|
@@ -498,23 +498,25 @@ module Aws::PaymentCryptography
|
|
|
498
498
|
# add multiple regions in a single operation, and the key will be
|
|
499
499
|
# available for use in those regions once replication is complete.
|
|
500
500
|
#
|
|
501
|
-
# **Cross-account use:** This operation
|
|
502
|
-
#
|
|
501
|
+
# **Cross-account use:** This operation supports cross-account use when
|
|
502
|
+
# the key has a resource-based policy that grants access. For more
|
|
503
|
+
# information, see [Resource-based policies][2].
|
|
503
504
|
#
|
|
504
505
|
# **Related operations:**
|
|
505
506
|
#
|
|
506
|
-
# * [RemoveKeyReplicationRegions][
|
|
507
|
+
# * [RemoveKeyReplicationRegions][3]
|
|
507
508
|
#
|
|
508
|
-
# * [EnableDefaultKeyReplicationRegions][
|
|
509
|
+
# * [EnableDefaultKeyReplicationRegions][4]
|
|
509
510
|
#
|
|
510
|
-
# * [GetDefaultKeyReplicationRegions][
|
|
511
|
+
# * [GetDefaultKeyReplicationRegions][5]
|
|
511
512
|
#
|
|
512
513
|
#
|
|
513
514
|
#
|
|
514
515
|
# [1]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-multi-region-replication.html
|
|
515
|
-
# [2]: https://docs.aws.amazon.com/payment-cryptography/latest/
|
|
516
|
-
# [3]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/
|
|
517
|
-
# [4]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/
|
|
516
|
+
# [2]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/security_iam_resource-based-policies.html
|
|
517
|
+
# [3]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_RemoveKeyReplicationRegions.html
|
|
518
|
+
# [4]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_EnableDefaultKeyReplicationRegions.html
|
|
519
|
+
# [5]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetDefaultKeyReplicationRegions.html
|
|
518
520
|
#
|
|
519
521
|
# @option params [required, String] :key_identifier
|
|
520
522
|
# The key identifier (ARN or alias) of the key for which to add
|
|
@@ -576,6 +578,10 @@ module Aws::PaymentCryptography
|
|
|
576
578
|
# resp.key.replication_status["Region"].status #=> String, one of "IN_PROGRESS", "DELETE_IN_PROGRESS", "FAILED", "SYNCHRONIZED"
|
|
577
579
|
# resp.key.replication_status["Region"].status_message #=> String
|
|
578
580
|
# resp.key.using_default_replication_regions #=> Boolean
|
|
581
|
+
# resp.key.mpa_status.mpa_session_arn #=> String
|
|
582
|
+
# resp.key.mpa_status.status #=> String, one of "PENDING", "APPROVED", "FAILED", "CANCELLED"
|
|
583
|
+
# resp.key.mpa_status.initiation_date #=> Time
|
|
584
|
+
# resp.key.mpa_status.status_message #=> String
|
|
579
585
|
#
|
|
580
586
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/AddKeyReplicationRegions AWS API Documentation
|
|
581
587
|
#
|
|
@@ -586,6 +592,71 @@ module Aws::PaymentCryptography
|
|
|
586
592
|
req.send_request(options)
|
|
587
593
|
end
|
|
588
594
|
|
|
595
|
+
# Associates a Multi-Party Approval (MPA) team with a protected
|
|
596
|
+
# operation. For more information, see [Multi-Party Approval][1] in the
|
|
597
|
+
# *Amazon Web Services Payment Cryptography User Guide.*
|
|
598
|
+
#
|
|
599
|
+
# **Cross-account use:** This operation can't be used across different
|
|
600
|
+
# Amazon Web Services accounts.
|
|
601
|
+
#
|
|
602
|
+
# **Related operations:**
|
|
603
|
+
#
|
|
604
|
+
# * [DisassociateMpaTeam][2]
|
|
605
|
+
#
|
|
606
|
+
# * [GetMpaTeamAssociation][3]
|
|
607
|
+
#
|
|
608
|
+
#
|
|
609
|
+
#
|
|
610
|
+
# [1]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/mpa.html
|
|
611
|
+
# [2]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DisassociateMpaTeam.html
|
|
612
|
+
# [3]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetMpaTeamAssociation.html
|
|
613
|
+
#
|
|
614
|
+
# @option params [required, String] :action
|
|
615
|
+
# The protected operation to associate with the MPA team. Currently, the
|
|
616
|
+
# only supported value is `IMPORT_ROOT_PUBLIC_KEY_CERTIFICATE`.
|
|
617
|
+
#
|
|
618
|
+
# @option params [required, String] :mpa_team_arn
|
|
619
|
+
# The ARN of the MPA team to associate with the protected operation.
|
|
620
|
+
#
|
|
621
|
+
# @option params [String] :requester_comment
|
|
622
|
+
# The comment from the requester explaining the reason for the
|
|
623
|
+
# association.
|
|
624
|
+
#
|
|
625
|
+
# Don't include personal, confidential or sensitive information in this
|
|
626
|
+
# field. This field may be displayed in plaintext in CloudTrail logs and
|
|
627
|
+
# other output.
|
|
628
|
+
#
|
|
629
|
+
# @return [Types::AssociateMpaTeamOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
630
|
+
#
|
|
631
|
+
# * {Types::AssociateMpaTeamOutput#mpa_team_association #mpa_team_association} => Types::MpaTeamAssociation
|
|
632
|
+
#
|
|
633
|
+
# @example Request syntax with placeholder values
|
|
634
|
+
#
|
|
635
|
+
# resp = client.associate_mpa_team({
|
|
636
|
+
# action: "IMPORT_ROOT_PUBLIC_KEY_CERTIFICATE", # required, accepts IMPORT_ROOT_PUBLIC_KEY_CERTIFICATE
|
|
637
|
+
# mpa_team_arn: "MpaTeamArn", # required
|
|
638
|
+
# requester_comment: "MpaRequesterComment",
|
|
639
|
+
# })
|
|
640
|
+
#
|
|
641
|
+
# @example Response structure
|
|
642
|
+
#
|
|
643
|
+
# resp.mpa_team_association.action #=> String, one of "IMPORT_ROOT_PUBLIC_KEY_CERTIFICATE"
|
|
644
|
+
# resp.mpa_team_association.mpa_team_arn #=> String
|
|
645
|
+
# resp.mpa_team_association.association_state #=> String, one of "ACTIVE", "UPDATE_PENDING", "DELETE_PENDING"
|
|
646
|
+
# resp.mpa_team_association.mpa_status.mpa_session_arn #=> String
|
|
647
|
+
# resp.mpa_team_association.mpa_status.status #=> String, one of "PENDING", "APPROVED", "FAILED", "CANCELLED"
|
|
648
|
+
# resp.mpa_team_association.mpa_status.initiation_date #=> Time
|
|
649
|
+
# resp.mpa_team_association.mpa_status.status_message #=> String
|
|
650
|
+
#
|
|
651
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/AssociateMpaTeam AWS API Documentation
|
|
652
|
+
#
|
|
653
|
+
# @overload associate_mpa_team(params = {})
|
|
654
|
+
# @param [Hash] params ({})
|
|
655
|
+
def associate_mpa_team(params = {}, options = {})
|
|
656
|
+
req = build_request(:associate_mpa_team, params)
|
|
657
|
+
req.send_request(options)
|
|
658
|
+
end
|
|
659
|
+
|
|
589
660
|
# Creates an *alias*, or a friendly name, for an Amazon Web Services
|
|
590
661
|
# Payment Cryptography key. You can use an alias to identify a key in
|
|
591
662
|
# the console and when you call cryptographic operations such as
|
|
@@ -857,6 +928,10 @@ module Aws::PaymentCryptography
|
|
|
857
928
|
# resp.key.replication_status["Region"].status #=> String, one of "IN_PROGRESS", "DELETE_IN_PROGRESS", "FAILED", "SYNCHRONIZED"
|
|
858
929
|
# resp.key.replication_status["Region"].status_message #=> String
|
|
859
930
|
# resp.key.using_default_replication_regions #=> Boolean
|
|
931
|
+
# resp.key.mpa_status.mpa_session_arn #=> String
|
|
932
|
+
# resp.key.mpa_status.status #=> String, one of "PENDING", "APPROVED", "FAILED", "CANCELLED"
|
|
933
|
+
# resp.key.mpa_status.initiation_date #=> Time
|
|
934
|
+
# resp.key.mpa_status.status_message #=> String
|
|
860
935
|
#
|
|
861
936
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/CreateKey AWS API Documentation
|
|
862
937
|
#
|
|
@@ -939,22 +1014,24 @@ module Aws::PaymentCryptography
|
|
|
939
1014
|
# aren't sure, consider deactivating it instead by calling
|
|
940
1015
|
# [StopKeyUsage][1].
|
|
941
1016
|
#
|
|
942
|
-
# **Cross-account use:** This operation
|
|
943
|
-
#
|
|
1017
|
+
# **Cross-account use:** This operation supports cross-account use when
|
|
1018
|
+
# the key has a resource-based policy that grants access. For more
|
|
1019
|
+
# information, see [Resource-based policies][2].
|
|
944
1020
|
#
|
|
945
1021
|
# **Related operations:**
|
|
946
1022
|
#
|
|
947
|
-
# * [RestoreKey][
|
|
1023
|
+
# * [RestoreKey][3]
|
|
948
1024
|
#
|
|
949
|
-
# * [StartKeyUsage][
|
|
1025
|
+
# * [StartKeyUsage][4]
|
|
950
1026
|
#
|
|
951
1027
|
# * [StopKeyUsage][1]
|
|
952
1028
|
#
|
|
953
1029
|
#
|
|
954
1030
|
#
|
|
955
1031
|
# [1]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StopKeyUsage.html
|
|
956
|
-
# [2]: https://docs.aws.amazon.com/payment-cryptography/latest/
|
|
957
|
-
# [3]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/
|
|
1032
|
+
# [2]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/security_iam_resource-based-policies.html
|
|
1033
|
+
# [3]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_RestoreKey.html
|
|
1034
|
+
# [4]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StartKeyUsage.html
|
|
958
1035
|
#
|
|
959
1036
|
# @option params [required, String] :key_identifier
|
|
960
1037
|
# The `KeyARN` of the key that is scheduled for deletion.
|
|
@@ -1006,6 +1083,10 @@ module Aws::PaymentCryptography
|
|
|
1006
1083
|
# resp.key.replication_status["Region"].status #=> String, one of "IN_PROGRESS", "DELETE_IN_PROGRESS", "FAILED", "SYNCHRONIZED"
|
|
1007
1084
|
# resp.key.replication_status["Region"].status_message #=> String
|
|
1008
1085
|
# resp.key.using_default_replication_regions #=> Boolean
|
|
1086
|
+
# resp.key.mpa_status.mpa_session_arn #=> String
|
|
1087
|
+
# resp.key.mpa_status.status #=> String, one of "PENDING", "APPROVED", "FAILED", "CANCELLED"
|
|
1088
|
+
# resp.key.mpa_status.initiation_date #=> Time
|
|
1089
|
+
# resp.key.mpa_status.status_message #=> String
|
|
1009
1090
|
#
|
|
1010
1091
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/DeleteKey AWS API Documentation
|
|
1011
1092
|
#
|
|
@@ -1016,6 +1097,44 @@ module Aws::PaymentCryptography
|
|
|
1016
1097
|
req.send_request(options)
|
|
1017
1098
|
end
|
|
1018
1099
|
|
|
1100
|
+
# Removes the resource-based policy attached to an Amazon Web Services
|
|
1101
|
+
# Payment Cryptography key.
|
|
1102
|
+
#
|
|
1103
|
+
# **Cross-account use:** This operation can't be used across different
|
|
1104
|
+
# Amazon Web Services accounts.
|
|
1105
|
+
#
|
|
1106
|
+
# **Related operations:**
|
|
1107
|
+
#
|
|
1108
|
+
# * [PutResourcePolicy][1]
|
|
1109
|
+
#
|
|
1110
|
+
# * [GetResourcePolicy][2]
|
|
1111
|
+
#
|
|
1112
|
+
#
|
|
1113
|
+
#
|
|
1114
|
+
# [1]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_PutResourcePolicy.html
|
|
1115
|
+
# [2]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetResourcePolicy.html
|
|
1116
|
+
#
|
|
1117
|
+
# @option params [required, String] :resource_arn
|
|
1118
|
+
# The `KeyARN` of the key whose resource-based policy you want to
|
|
1119
|
+
# delete.
|
|
1120
|
+
#
|
|
1121
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1122
|
+
#
|
|
1123
|
+
# @example Request syntax with placeholder values
|
|
1124
|
+
#
|
|
1125
|
+
# resp = client.delete_resource_policy({
|
|
1126
|
+
# resource_arn: "ResourceArn", # required
|
|
1127
|
+
# })
|
|
1128
|
+
#
|
|
1129
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/DeleteResourcePolicy AWS API Documentation
|
|
1130
|
+
#
|
|
1131
|
+
# @overload delete_resource_policy(params = {})
|
|
1132
|
+
# @param [Hash] params ({})
|
|
1133
|
+
def delete_resource_policy(params = {}, options = {})
|
|
1134
|
+
req = build_request(:delete_resource_policy, params)
|
|
1135
|
+
req.send_request(options)
|
|
1136
|
+
end
|
|
1137
|
+
|
|
1019
1138
|
# Disables [Multi-Region key replication][1] settings for the specified
|
|
1020
1139
|
# Amazon Web Services Regions in your Amazon Web Services account,
|
|
1021
1140
|
# preventing new keys from being automatically replicated to those
|
|
@@ -1077,6 +1196,65 @@ module Aws::PaymentCryptography
|
|
|
1077
1196
|
req.send_request(options)
|
|
1078
1197
|
end
|
|
1079
1198
|
|
|
1199
|
+
# Removes the association between a Multi-Party Approval (MPA) team and
|
|
1200
|
+
# a protected operation.
|
|
1201
|
+
#
|
|
1202
|
+
# **Cross-account use:** This operation can't be used across different
|
|
1203
|
+
# Amazon Web Services accounts.
|
|
1204
|
+
#
|
|
1205
|
+
# **Related operations:**
|
|
1206
|
+
#
|
|
1207
|
+
# * [AssociateMpaTeam][1]
|
|
1208
|
+
#
|
|
1209
|
+
# * [GetMpaTeamAssociation][2]
|
|
1210
|
+
#
|
|
1211
|
+
#
|
|
1212
|
+
#
|
|
1213
|
+
# [1]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_AssociateMpaTeam.html
|
|
1214
|
+
# [2]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetMpaTeamAssociation.html
|
|
1215
|
+
#
|
|
1216
|
+
# @option params [required, String] :action
|
|
1217
|
+
# The protected operation to disassociate from the MPA team. Currently,
|
|
1218
|
+
# the only supported value is `IMPORT_ROOT_PUBLIC_KEY_CERTIFICATE`.
|
|
1219
|
+
#
|
|
1220
|
+
# @option params [String] :requester_comment
|
|
1221
|
+
# The comment from the requester explaining the reason for the
|
|
1222
|
+
# disassociation.
|
|
1223
|
+
#
|
|
1224
|
+
# Don't include personal, confidential or sensitive information in this
|
|
1225
|
+
# field. This field may be displayed in plaintext in CloudTrail logs and
|
|
1226
|
+
# other output.
|
|
1227
|
+
#
|
|
1228
|
+
# @return [Types::DisassociateMpaTeamOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1229
|
+
#
|
|
1230
|
+
# * {Types::DisassociateMpaTeamOutput#mpa_team_association #mpa_team_association} => Types::MpaTeamAssociation
|
|
1231
|
+
#
|
|
1232
|
+
# @example Request syntax with placeholder values
|
|
1233
|
+
#
|
|
1234
|
+
# resp = client.disassociate_mpa_team({
|
|
1235
|
+
# action: "IMPORT_ROOT_PUBLIC_KEY_CERTIFICATE", # required, accepts IMPORT_ROOT_PUBLIC_KEY_CERTIFICATE
|
|
1236
|
+
# requester_comment: "MpaRequesterComment",
|
|
1237
|
+
# })
|
|
1238
|
+
#
|
|
1239
|
+
# @example Response structure
|
|
1240
|
+
#
|
|
1241
|
+
# resp.mpa_team_association.action #=> String, one of "IMPORT_ROOT_PUBLIC_KEY_CERTIFICATE"
|
|
1242
|
+
# resp.mpa_team_association.mpa_team_arn #=> String
|
|
1243
|
+
# resp.mpa_team_association.association_state #=> String, one of "ACTIVE", "UPDATE_PENDING", "DELETE_PENDING"
|
|
1244
|
+
# resp.mpa_team_association.mpa_status.mpa_session_arn #=> String
|
|
1245
|
+
# resp.mpa_team_association.mpa_status.status #=> String, one of "PENDING", "APPROVED", "FAILED", "CANCELLED"
|
|
1246
|
+
# resp.mpa_team_association.mpa_status.initiation_date #=> Time
|
|
1247
|
+
# resp.mpa_team_association.mpa_status.status_message #=> String
|
|
1248
|
+
#
|
|
1249
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/DisassociateMpaTeam AWS API Documentation
|
|
1250
|
+
#
|
|
1251
|
+
# @overload disassociate_mpa_team(params = {})
|
|
1252
|
+
# @param [Hash] params ({})
|
|
1253
|
+
def disassociate_mpa_team(params = {}, options = {})
|
|
1254
|
+
req = build_request(:disassociate_mpa_team, params)
|
|
1255
|
+
req.send_request(options)
|
|
1256
|
+
end
|
|
1257
|
+
|
|
1080
1258
|
# Enables [Multi-Region key replication][1] settings for your Amazon Web
|
|
1081
1259
|
# Services account, causing new keys to be automatically replicated to
|
|
1082
1260
|
# the specified Amazon Web Services Regions when created.
|
|
@@ -1334,8 +1512,9 @@ module Aws::PaymentCryptography
|
|
|
1334
1512
|
# Cryptography returns the working key as a TR-31 WrappedKeyBlock, where
|
|
1335
1513
|
# the wrapping key is the ECDH derived key.
|
|
1336
1514
|
#
|
|
1337
|
-
# **Cross-account use:** This operation
|
|
1338
|
-
#
|
|
1515
|
+
# **Cross-account use:** This operation supports cross-account use when
|
|
1516
|
+
# the key has a resource-based policy that grants access. For more
|
|
1517
|
+
# information, see [Resource-based policies][8].
|
|
1339
1518
|
#
|
|
1340
1519
|
# **Related operations:**
|
|
1341
1520
|
#
|
|
@@ -1352,6 +1531,7 @@ module Aws::PaymentCryptography
|
|
|
1352
1531
|
# [5]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-export.html
|
|
1353
1532
|
# [6]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetParametersForImport.html
|
|
1354
1533
|
# [7]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html
|
|
1534
|
+
# [8]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/security_iam_resource-based-policies.html
|
|
1355
1535
|
#
|
|
1356
1536
|
# @option params [required, Types::ExportKeyMaterial] :key_material
|
|
1357
1537
|
# The key block format type, for example, TR-34 or TR-31, to use during
|
|
@@ -1626,22 +1806,24 @@ module Aws::PaymentCryptography
|
|
|
1626
1806
|
# key was created. Returns key metadata including attributes, state, and
|
|
1627
1807
|
# timestamps, but does not return the actual cryptographic key material.
|
|
1628
1808
|
#
|
|
1629
|
-
# **Cross-account use:** This operation
|
|
1630
|
-
#
|
|
1809
|
+
# **Cross-account use:** This operation supports cross-account use when
|
|
1810
|
+
# the key has a resource-based policy that grants access. For more
|
|
1811
|
+
# information, see [Resource-based policies][1].
|
|
1631
1812
|
#
|
|
1632
1813
|
# **Related operations:**
|
|
1633
1814
|
#
|
|
1634
|
-
# * [CreateKey][
|
|
1815
|
+
# * [CreateKey][2]
|
|
1635
1816
|
#
|
|
1636
|
-
# * [DeleteKey][
|
|
1817
|
+
# * [DeleteKey][3]
|
|
1637
1818
|
#
|
|
1638
|
-
# * [ListKeys][
|
|
1819
|
+
# * [ListKeys][4]
|
|
1639
1820
|
#
|
|
1640
1821
|
#
|
|
1641
1822
|
#
|
|
1642
|
-
# [1]: https://docs.aws.amazon.com/payment-cryptography/latest/
|
|
1643
|
-
# [2]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/
|
|
1644
|
-
# [3]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/
|
|
1823
|
+
# [1]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/security_iam_resource-based-policies.html
|
|
1824
|
+
# [2]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html
|
|
1825
|
+
# [3]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteKey.html
|
|
1826
|
+
# [4]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListKeys.html
|
|
1645
1827
|
#
|
|
1646
1828
|
# @option params [required, String] :key_identifier
|
|
1647
1829
|
# The `KeyARN` of the Amazon Web Services Payment Cryptography key.
|
|
@@ -1689,6 +1871,10 @@ module Aws::PaymentCryptography
|
|
|
1689
1871
|
# resp.key.replication_status["Region"].status #=> String, one of "IN_PROGRESS", "DELETE_IN_PROGRESS", "FAILED", "SYNCHRONIZED"
|
|
1690
1872
|
# resp.key.replication_status["Region"].status_message #=> String
|
|
1691
1873
|
# resp.key.using_default_replication_regions #=> Boolean
|
|
1874
|
+
# resp.key.mpa_status.mpa_session_arn #=> String
|
|
1875
|
+
# resp.key.mpa_status.status #=> String, one of "PENDING", "APPROVED", "FAILED", "CANCELLED"
|
|
1876
|
+
# resp.key.mpa_status.initiation_date #=> Time
|
|
1877
|
+
# resp.key.mpa_status.status_message #=> String
|
|
1692
1878
|
#
|
|
1693
1879
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/GetKey AWS API Documentation
|
|
1694
1880
|
#
|
|
@@ -1699,6 +1885,57 @@ module Aws::PaymentCryptography
|
|
|
1699
1885
|
req.send_request(options)
|
|
1700
1886
|
end
|
|
1701
1887
|
|
|
1888
|
+
# Returns the Multi-Party Approval (MPA) team association for a
|
|
1889
|
+
# protected operation.
|
|
1890
|
+
#
|
|
1891
|
+
# **Cross-account use:** This operation can't be used across different
|
|
1892
|
+
# Amazon Web Services accounts.
|
|
1893
|
+
#
|
|
1894
|
+
# **Related operations:**
|
|
1895
|
+
#
|
|
1896
|
+
# * [AssociateMpaTeam][1]
|
|
1897
|
+
#
|
|
1898
|
+
# * [DisassociateMpaTeam][2]
|
|
1899
|
+
#
|
|
1900
|
+
#
|
|
1901
|
+
#
|
|
1902
|
+
# [1]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_AssociateMpaTeam.html
|
|
1903
|
+
# [2]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DisassociateMpaTeam.html
|
|
1904
|
+
#
|
|
1905
|
+
# @option params [required, String] :action
|
|
1906
|
+
# The protected operation whose MPA team association you want to
|
|
1907
|
+
# retrieve. Currently, the only supported value is
|
|
1908
|
+
# `IMPORT_ROOT_PUBLIC_KEY_CERTIFICATE`.
|
|
1909
|
+
#
|
|
1910
|
+
# @return [Types::GetMpaTeamAssociationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1911
|
+
#
|
|
1912
|
+
# * {Types::GetMpaTeamAssociationOutput#mpa_team_association #mpa_team_association} => Types::MpaTeamAssociation
|
|
1913
|
+
#
|
|
1914
|
+
# @example Request syntax with placeholder values
|
|
1915
|
+
#
|
|
1916
|
+
# resp = client.get_mpa_team_association({
|
|
1917
|
+
# action: "IMPORT_ROOT_PUBLIC_KEY_CERTIFICATE", # required, accepts IMPORT_ROOT_PUBLIC_KEY_CERTIFICATE
|
|
1918
|
+
# })
|
|
1919
|
+
#
|
|
1920
|
+
# @example Response structure
|
|
1921
|
+
#
|
|
1922
|
+
# resp.mpa_team_association.action #=> String, one of "IMPORT_ROOT_PUBLIC_KEY_CERTIFICATE"
|
|
1923
|
+
# resp.mpa_team_association.mpa_team_arn #=> String
|
|
1924
|
+
# resp.mpa_team_association.association_state #=> String, one of "ACTIVE", "UPDATE_PENDING", "DELETE_PENDING"
|
|
1925
|
+
# resp.mpa_team_association.mpa_status.mpa_session_arn #=> String
|
|
1926
|
+
# resp.mpa_team_association.mpa_status.status #=> String, one of "PENDING", "APPROVED", "FAILED", "CANCELLED"
|
|
1927
|
+
# resp.mpa_team_association.mpa_status.initiation_date #=> Time
|
|
1928
|
+
# resp.mpa_team_association.mpa_status.status_message #=> String
|
|
1929
|
+
#
|
|
1930
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/GetMpaTeamAssociation AWS API Documentation
|
|
1931
|
+
#
|
|
1932
|
+
# @overload get_mpa_team_association(params = {})
|
|
1933
|
+
# @param [Hash] params ({})
|
|
1934
|
+
def get_mpa_team_association(params = {}, options = {})
|
|
1935
|
+
req = build_request(:get_mpa_team_association, params)
|
|
1936
|
+
req.send_request(options)
|
|
1937
|
+
end
|
|
1938
|
+
|
|
1702
1939
|
# Gets the export token and the signing key certificate to initiate a
|
|
1703
1940
|
# TR-34 key export from Amazon Web Services Payment Cryptography.
|
|
1704
1941
|
#
|
|
@@ -1708,6 +1945,10 @@ module Aws::PaymentCryptography
|
|
|
1708
1945
|
# export token expires in 30 days. You can use the same export token to
|
|
1709
1946
|
# export multiple keys from your service account.
|
|
1710
1947
|
#
|
|
1948
|
+
# To return a previously generated export token and signing key
|
|
1949
|
+
# certificate instead of generating new ones, set
|
|
1950
|
+
# `ReuseLastGeneratedToken` to `true`.
|
|
1951
|
+
#
|
|
1711
1952
|
# **Cross-account use:** This operation can't be used across different
|
|
1712
1953
|
# Amazon Web Services accounts.
|
|
1713
1954
|
#
|
|
@@ -1733,6 +1974,16 @@ module Aws::PaymentCryptography
|
|
|
1733
1974
|
# certificate signs the wrapped key under export within the TR-34 key
|
|
1734
1975
|
# block. `RSA_2048` is the only signing key algorithm allowed.
|
|
1735
1976
|
#
|
|
1977
|
+
# @option params [Boolean] :reuse_last_generated_token
|
|
1978
|
+
# Specifies whether to reuse the existing export token and signing key
|
|
1979
|
+
# certificate. If set to `true` and a valid export token exists for the
|
|
1980
|
+
# same key material type and signing key algorithm with at least 7 days
|
|
1981
|
+
# of remaining validity, the existing token and signing key certificate
|
|
1982
|
+
# are returned. Otherwise, a new export token and signing key
|
|
1983
|
+
# certificate are generated. The default value is `false`, which
|
|
1984
|
+
# generates a new export token and signing key certificate on every
|
|
1985
|
+
# call.
|
|
1986
|
+
#
|
|
1736
1987
|
# @return [Types::GetParametersForExportOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1737
1988
|
#
|
|
1738
1989
|
# * {Types::GetParametersForExportOutput#signing_key_certificate #signing_key_certificate} => String
|
|
@@ -1746,6 +1997,7 @@ module Aws::PaymentCryptography
|
|
|
1746
1997
|
# resp = client.get_parameters_for_export({
|
|
1747
1998
|
# key_material_type: "TR34_KEY_BLOCK", # required, accepts TR34_KEY_BLOCK, TR31_KEY_BLOCK, ROOT_PUBLIC_KEY_CERTIFICATE, TRUSTED_PUBLIC_KEY_CERTIFICATE, KEY_CRYPTOGRAM
|
|
1748
1999
|
# signing_key_algorithm: "TDES_2KEY", # required, accepts TDES_2KEY, TDES_3KEY, AES_128, AES_192, AES_256, HMAC_SHA256, HMAC_SHA384, HMAC_SHA512, HMAC_SHA224, RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521
|
|
2000
|
+
# reuse_last_generated_token: false,
|
|
1749
2001
|
# })
|
|
1750
2002
|
#
|
|
1751
2003
|
# @example Response structure
|
|
@@ -1776,6 +2028,10 @@ module Aws::PaymentCryptography
|
|
|
1776
2028
|
# You can use the same import token to import multiple keys into your
|
|
1777
2029
|
# service account.
|
|
1778
2030
|
#
|
|
2031
|
+
# To return a previously generated import token and wrapping key
|
|
2032
|
+
# certificate instead of generating new ones, set
|
|
2033
|
+
# `ReuseLastGeneratedToken` to `true`.
|
|
2034
|
+
#
|
|
1779
2035
|
# **Cross-account use:** This operation can't be used across different
|
|
1780
2036
|
# Amazon Web Services accounts.
|
|
1781
2037
|
#
|
|
@@ -1807,6 +2063,16 @@ module Aws::PaymentCryptography
|
|
|
1807
2063
|
# `RSA_4096` are the allowed algorithms for RSA WrappedKeyCryptogram
|
|
1808
2064
|
# import.
|
|
1809
2065
|
#
|
|
2066
|
+
# @option params [Boolean] :reuse_last_generated_token
|
|
2067
|
+
# Specifies whether to reuse the existing import token and wrapping key
|
|
2068
|
+
# certificate. If set to `true` and a valid import token exists for the
|
|
2069
|
+
# same key material type and wrapping key algorithm with at least 7 days
|
|
2070
|
+
# of remaining validity, the existing token and wrapping key certificate
|
|
2071
|
+
# are returned. Otherwise, a new import token and wrapping key
|
|
2072
|
+
# certificate are generated. The default value is `false`, which
|
|
2073
|
+
# generates a new import token and wrapping key certificate on every
|
|
2074
|
+
# call.
|
|
2075
|
+
#
|
|
1810
2076
|
# @return [Types::GetParametersForImportOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1811
2077
|
#
|
|
1812
2078
|
# * {Types::GetParametersForImportOutput#wrapping_key_certificate #wrapping_key_certificate} => String
|
|
@@ -1820,6 +2086,7 @@ module Aws::PaymentCryptography
|
|
|
1820
2086
|
# resp = client.get_parameters_for_import({
|
|
1821
2087
|
# key_material_type: "TR34_KEY_BLOCK", # required, accepts TR34_KEY_BLOCK, TR31_KEY_BLOCK, ROOT_PUBLIC_KEY_CERTIFICATE, TRUSTED_PUBLIC_KEY_CERTIFICATE, KEY_CRYPTOGRAM
|
|
1822
2088
|
# wrapping_key_algorithm: "TDES_2KEY", # required, accepts TDES_2KEY, TDES_3KEY, AES_128, AES_192, AES_256, HMAC_SHA256, HMAC_SHA384, HMAC_SHA512, HMAC_SHA224, RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521
|
|
2089
|
+
# reuse_last_generated_token: false,
|
|
1823
2090
|
# })
|
|
1824
2091
|
#
|
|
1825
2092
|
# @example Response structure
|
|
@@ -1849,8 +2116,13 @@ module Aws::PaymentCryptography
|
|
|
1849
2116
|
# certificate to allow others to encrypt messages and verify signatures
|
|
1850
2117
|
# outside of Amazon Web Services Payment Cryptography
|
|
1851
2118
|
#
|
|
1852
|
-
# **Cross-account use:** This operation
|
|
1853
|
-
#
|
|
2119
|
+
# **Cross-account use:** This operation supports cross-account use when
|
|
2120
|
+
# the key has a resource-based policy that grants access. For more
|
|
2121
|
+
# information, see [Resource-based policies][1].
|
|
2122
|
+
#
|
|
2123
|
+
#
|
|
2124
|
+
#
|
|
2125
|
+
# [1]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/security_iam_resource-based-policies.html
|
|
1854
2126
|
#
|
|
1855
2127
|
# @option params [required, String] :key_identifier
|
|
1856
2128
|
# The `KeyARN` of the asymmetric key pair.
|
|
@@ -1880,6 +2152,52 @@ module Aws::PaymentCryptography
|
|
|
1880
2152
|
req.send_request(options)
|
|
1881
2153
|
end
|
|
1882
2154
|
|
|
2155
|
+
# Returns the resource-based policy attached to an Amazon Web Services
|
|
2156
|
+
# Payment Cryptography key.
|
|
2157
|
+
#
|
|
2158
|
+
# **Cross-account use:** This operation can't be used across different
|
|
2159
|
+
# Amazon Web Services accounts.
|
|
2160
|
+
#
|
|
2161
|
+
# **Related operations:**
|
|
2162
|
+
#
|
|
2163
|
+
# * [PutResourcePolicy][1]
|
|
2164
|
+
#
|
|
2165
|
+
# * [DeleteResourcePolicy][2]
|
|
2166
|
+
#
|
|
2167
|
+
#
|
|
2168
|
+
#
|
|
2169
|
+
# [1]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_PutResourcePolicy.html
|
|
2170
|
+
# [2]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteResourcePolicy.html
|
|
2171
|
+
#
|
|
2172
|
+
# @option params [required, String] :resource_arn
|
|
2173
|
+
# The `KeyARN` of the key whose resource-based policy you want to
|
|
2174
|
+
# retrieve.
|
|
2175
|
+
#
|
|
2176
|
+
# @return [Types::GetResourcePolicyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2177
|
+
#
|
|
2178
|
+
# * {Types::GetResourcePolicyOutput#resource_arn #resource_arn} => String
|
|
2179
|
+
# * {Types::GetResourcePolicyOutput#policy #policy} => String
|
|
2180
|
+
#
|
|
2181
|
+
# @example Request syntax with placeholder values
|
|
2182
|
+
#
|
|
2183
|
+
# resp = client.get_resource_policy({
|
|
2184
|
+
# resource_arn: "ResourceArn", # required
|
|
2185
|
+
# })
|
|
2186
|
+
#
|
|
2187
|
+
# @example Response structure
|
|
2188
|
+
#
|
|
2189
|
+
# resp.resource_arn #=> String
|
|
2190
|
+
# resp.policy #=> String
|
|
2191
|
+
#
|
|
2192
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/GetResourcePolicy AWS API Documentation
|
|
2193
|
+
#
|
|
2194
|
+
# @overload get_resource_policy(params = {})
|
|
2195
|
+
# @param [Hash] params ({})
|
|
2196
|
+
def get_resource_policy(params = {}, options = {})
|
|
2197
|
+
req = build_request(:get_resource_policy, params)
|
|
2198
|
+
req.send_request(options)
|
|
2199
|
+
end
|
|
2200
|
+
|
|
1883
2201
|
# Imports symmetric keys and public key certificates in PEM format
|
|
1884
2202
|
# (base64 encoded) into Amazon Web Services Payment Cryptography.
|
|
1885
2203
|
#
|
|
@@ -2070,12 +2388,13 @@ module Aws::PaymentCryptography
|
|
|
2070
2388
|
# that signed the public key certificate of the receiving ECC key
|
|
2071
2389
|
# pair.
|
|
2072
2390
|
#
|
|
2073
|
-
# **Cross-account use:** This operation
|
|
2074
|
-
#
|
|
2391
|
+
# **Cross-account use:** This operation supports cross-account use when
|
|
2392
|
+
# the key has a resource-based policy that grants access. For more
|
|
2393
|
+
# information, see [Resource-based policies][5].
|
|
2075
2394
|
#
|
|
2076
2395
|
# **Related operations:**
|
|
2077
2396
|
#
|
|
2078
|
-
# * [ExportKey][
|
|
2397
|
+
# * [ExportKey][6]
|
|
2079
2398
|
#
|
|
2080
2399
|
# * [GetParametersForImport][2]
|
|
2081
2400
|
#
|
|
@@ -2085,7 +2404,8 @@ module Aws::PaymentCryptography
|
|
|
2085
2404
|
# [2]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetParametersForImport.html
|
|
2086
2405
|
# [3]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-import.html
|
|
2087
2406
|
# [4]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html
|
|
2088
|
-
# [5]: https://docs.aws.amazon.com/payment-cryptography/latest/
|
|
2407
|
+
# [5]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/security_iam_resource-based-policies.html
|
|
2408
|
+
# [6]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ExportKey.html
|
|
2089
2409
|
#
|
|
2090
2410
|
# @option params [required, Types::ImportKeyMaterial] :key_material
|
|
2091
2411
|
# The key or public key certificate type to use during key material
|
|
@@ -2140,6 +2460,13 @@ module Aws::PaymentCryptography
|
|
|
2140
2460
|
# available. This list is used to specify which regions should be added
|
|
2141
2461
|
# to or removed from a key's replication configuration.
|
|
2142
2462
|
#
|
|
2463
|
+
# @option params [String] :requester_comment
|
|
2464
|
+
# The comment from the requester explaining the reason for the import.
|
|
2465
|
+
#
|
|
2466
|
+
# Don't include personal, confidential or sensitive information in this
|
|
2467
|
+
# field. This field may be displayed in plaintext in CloudTrail logs and
|
|
2468
|
+
# other output.
|
|
2469
|
+
#
|
|
2143
2470
|
# @return [Types::ImportKeyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2144
2471
|
#
|
|
2145
2472
|
# * {Types::ImportKeyOutput#key #key} => Types::Key
|
|
@@ -2263,6 +2590,7 @@ module Aws::PaymentCryptography
|
|
|
2263
2590
|
# },
|
|
2264
2591
|
# ],
|
|
2265
2592
|
# replication_regions: ["Region"],
|
|
2593
|
+
# requester_comment: "MpaRequesterComment",
|
|
2266
2594
|
# })
|
|
2267
2595
|
#
|
|
2268
2596
|
# @example Response structure
|
|
@@ -2298,6 +2626,10 @@ module Aws::PaymentCryptography
|
|
|
2298
2626
|
# resp.key.replication_status["Region"].status #=> String, one of "IN_PROGRESS", "DELETE_IN_PROGRESS", "FAILED", "SYNCHRONIZED"
|
|
2299
2627
|
# resp.key.replication_status["Region"].status_message #=> String
|
|
2300
2628
|
# resp.key.using_default_replication_regions #=> Boolean
|
|
2629
|
+
# resp.key.mpa_status.mpa_session_arn #=> String
|
|
2630
|
+
# resp.key.mpa_status.status #=> String, one of "PENDING", "APPROVED", "FAILED", "CANCELLED"
|
|
2631
|
+
# resp.key.mpa_status.initiation_date #=> Time
|
|
2632
|
+
# resp.key.mpa_status.status_message #=> String
|
|
2301
2633
|
#
|
|
2302
2634
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/ImportKey AWS API Documentation
|
|
2303
2635
|
#
|
|
@@ -2490,19 +2822,21 @@ module Aws::PaymentCryptography
|
|
|
2490
2822
|
# receive a response with no NextToken (or an empty or null value), that
|
|
2491
2823
|
# means there are no more tags to get.
|
|
2492
2824
|
#
|
|
2493
|
-
# **Cross-account use:** This operation
|
|
2494
|
-
#
|
|
2825
|
+
# **Cross-account use:** This operation supports cross-account use when
|
|
2826
|
+
# the key has a resource-based policy that grants access. For more
|
|
2827
|
+
# information, see [Resource-based policies][1].
|
|
2495
2828
|
#
|
|
2496
2829
|
# **Related operations:**
|
|
2497
2830
|
#
|
|
2498
|
-
# * [TagResource][
|
|
2831
|
+
# * [TagResource][2]
|
|
2499
2832
|
#
|
|
2500
|
-
# * [UntagResource][
|
|
2833
|
+
# * [UntagResource][3]
|
|
2501
2834
|
#
|
|
2502
2835
|
#
|
|
2503
2836
|
#
|
|
2504
|
-
# [1]: https://docs.aws.amazon.com/payment-cryptography/latest/
|
|
2505
|
-
# [2]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/
|
|
2837
|
+
# [1]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/security_iam_resource-based-policies.html
|
|
2838
|
+
# [2]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_TagResource.html
|
|
2839
|
+
# [3]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UntagResource.html
|
|
2506
2840
|
#
|
|
2507
2841
|
# @option params [required, String] :resource_arn
|
|
2508
2842
|
# The `KeyARN` of the key whose tags you are getting.
|
|
@@ -2552,6 +2886,62 @@ module Aws::PaymentCryptography
|
|
|
2552
2886
|
req.send_request(options)
|
|
2553
2887
|
end
|
|
2554
2888
|
|
|
2889
|
+
# Attaches or replaces a resource-based policy on an Amazon Web Services
|
|
2890
|
+
# Payment Cryptography key. A resource-based policy can grant
|
|
2891
|
+
# cross-account access to your key.
|
|
2892
|
+
#
|
|
2893
|
+
# If the policy would grant public access, the request fails with a
|
|
2894
|
+
# `PublicPolicyException`.
|
|
2895
|
+
#
|
|
2896
|
+
# To remove a resource-based policy from a key, use
|
|
2897
|
+
# [DeleteResourcePolicy][1].
|
|
2898
|
+
#
|
|
2899
|
+
# **Cross-account use:** This operation can't be used across different
|
|
2900
|
+
# Amazon Web Services accounts.
|
|
2901
|
+
#
|
|
2902
|
+
# **Related operations:**
|
|
2903
|
+
#
|
|
2904
|
+
# * [GetResourcePolicy][2]
|
|
2905
|
+
#
|
|
2906
|
+
# * [DeleteResourcePolicy][1]
|
|
2907
|
+
#
|
|
2908
|
+
#
|
|
2909
|
+
#
|
|
2910
|
+
# [1]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteResourcePolicy.html
|
|
2911
|
+
# [2]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetResourcePolicy.html
|
|
2912
|
+
#
|
|
2913
|
+
# @option params [required, String] :resource_arn
|
|
2914
|
+
# The `KeyARN` of the key to attach the resource-based policy to.
|
|
2915
|
+
#
|
|
2916
|
+
# @option params [required, String] :policy
|
|
2917
|
+
# The resource-based policy to attach to the key, in JSON format.
|
|
2918
|
+
#
|
|
2919
|
+
# @return [Types::PutResourcePolicyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2920
|
+
#
|
|
2921
|
+
# * {Types::PutResourcePolicyOutput#resource_arn #resource_arn} => String
|
|
2922
|
+
# * {Types::PutResourcePolicyOutput#policy #policy} => String
|
|
2923
|
+
#
|
|
2924
|
+
# @example Request syntax with placeholder values
|
|
2925
|
+
#
|
|
2926
|
+
# resp = client.put_resource_policy({
|
|
2927
|
+
# resource_arn: "ResourceArn", # required
|
|
2928
|
+
# policy: "ResourcePolicy", # required
|
|
2929
|
+
# })
|
|
2930
|
+
#
|
|
2931
|
+
# @example Response structure
|
|
2932
|
+
#
|
|
2933
|
+
# resp.resource_arn #=> String
|
|
2934
|
+
# resp.policy #=> String
|
|
2935
|
+
#
|
|
2936
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/PutResourcePolicy AWS API Documentation
|
|
2937
|
+
#
|
|
2938
|
+
# @overload put_resource_policy(params = {})
|
|
2939
|
+
# @param [Hash] params ({})
|
|
2940
|
+
def put_resource_policy(params = {}, options = {})
|
|
2941
|
+
req = build_request(:put_resource_policy, params)
|
|
2942
|
+
req.send_request(options)
|
|
2943
|
+
end
|
|
2944
|
+
|
|
2555
2945
|
# Removes Replication Regions from an existing Amazon Web Services
|
|
2556
2946
|
# Payment Cryptography key, disabling the key's availability for
|
|
2557
2947
|
# cryptographic operations in the specified Amazon Web Services Regions.
|
|
@@ -2566,20 +2956,22 @@ module Aws::PaymentCryptography
|
|
|
2566
2956
|
# on the key in the regions you're removing before performing this
|
|
2567
2957
|
# operation.
|
|
2568
2958
|
#
|
|
2569
|
-
# **Cross-account use:** This operation
|
|
2570
|
-
#
|
|
2959
|
+
# **Cross-account use:** This operation supports cross-account use when
|
|
2960
|
+
# the key has a resource-based policy that grants access. For more
|
|
2961
|
+
# information, see [Resource-based policies][2].
|
|
2571
2962
|
#
|
|
2572
2963
|
# **Related operations:**
|
|
2573
2964
|
#
|
|
2574
|
-
# * [AddKeyReplicationRegions][
|
|
2965
|
+
# * [AddKeyReplicationRegions][3]
|
|
2575
2966
|
#
|
|
2576
|
-
# * [DisableDefaultKeyReplicationRegions][
|
|
2967
|
+
# * [DisableDefaultKeyReplicationRegions][4]
|
|
2577
2968
|
#
|
|
2578
2969
|
#
|
|
2579
2970
|
#
|
|
2580
2971
|
# [1]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-multi-region-replication.html
|
|
2581
|
-
# [2]: https://docs.aws.amazon.com/payment-cryptography/latest/
|
|
2582
|
-
# [3]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/
|
|
2972
|
+
# [2]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/security_iam_resource-based-policies.html
|
|
2973
|
+
# [3]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_AddKeyReplicationRegions.html
|
|
2974
|
+
# [4]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DisableDefaultKeyReplicationRegions.html
|
|
2583
2975
|
#
|
|
2584
2976
|
# @option params [required, String] :key_identifier
|
|
2585
2977
|
# The key identifier (ARN or alias) of the key from which to remove
|
|
@@ -2640,6 +3032,10 @@ module Aws::PaymentCryptography
|
|
|
2640
3032
|
# resp.key.replication_status["Region"].status #=> String, one of "IN_PROGRESS", "DELETE_IN_PROGRESS", "FAILED", "SYNCHRONIZED"
|
|
2641
3033
|
# resp.key.replication_status["Region"].status_message #=> String
|
|
2642
3034
|
# resp.key.using_default_replication_regions #=> Boolean
|
|
3035
|
+
# resp.key.mpa_status.mpa_session_arn #=> String
|
|
3036
|
+
# resp.key.mpa_status.status #=> String, one of "PENDING", "APPROVED", "FAILED", "CANCELLED"
|
|
3037
|
+
# resp.key.mpa_status.initiation_date #=> Time
|
|
3038
|
+
# resp.key.mpa_status.status_message #=> String
|
|
2643
3039
|
#
|
|
2644
3040
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/RemoveKeyReplicationRegions AWS API Documentation
|
|
2645
3041
|
#
|
|
@@ -2659,22 +3055,24 @@ module Aws::PaymentCryptography
|
|
|
2659
3055
|
# `CREATE_COMPLETE`, and the value for `deletePendingTimestamp` is
|
|
2660
3056
|
# removed.
|
|
2661
3057
|
#
|
|
2662
|
-
# **Cross-account use:** This operation
|
|
2663
|
-
#
|
|
3058
|
+
# **Cross-account use:** This operation supports cross-account use when
|
|
3059
|
+
# the key has a resource-based policy that grants access. For more
|
|
3060
|
+
# information, see [Resource-based policies][1].
|
|
2664
3061
|
#
|
|
2665
3062
|
# **Related operations:**
|
|
2666
3063
|
#
|
|
2667
|
-
# * [DeleteKey][
|
|
3064
|
+
# * [DeleteKey][2]
|
|
2668
3065
|
#
|
|
2669
|
-
# * [StartKeyUsage][
|
|
3066
|
+
# * [StartKeyUsage][3]
|
|
2670
3067
|
#
|
|
2671
|
-
# * [StopKeyUsage][
|
|
3068
|
+
# * [StopKeyUsage][4]
|
|
2672
3069
|
#
|
|
2673
3070
|
#
|
|
2674
3071
|
#
|
|
2675
|
-
# [1]: https://docs.aws.amazon.com/payment-cryptography/latest/
|
|
2676
|
-
# [2]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/
|
|
2677
|
-
# [3]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/
|
|
3072
|
+
# [1]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/security_iam_resource-based-policies.html
|
|
3073
|
+
# [2]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteKey.html
|
|
3074
|
+
# [3]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StartKeyUsage.html
|
|
3075
|
+
# [4]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StopKeyUsage.html
|
|
2678
3076
|
#
|
|
2679
3077
|
# @option params [required, String] :key_identifier
|
|
2680
3078
|
# The `KeyARN` of the key to be restored within Amazon Web Services
|
|
@@ -2723,6 +3121,10 @@ module Aws::PaymentCryptography
|
|
|
2723
3121
|
# resp.key.replication_status["Region"].status #=> String, one of "IN_PROGRESS", "DELETE_IN_PROGRESS", "FAILED", "SYNCHRONIZED"
|
|
2724
3122
|
# resp.key.replication_status["Region"].status_message #=> String
|
|
2725
3123
|
# resp.key.using_default_replication_regions #=> Boolean
|
|
3124
|
+
# resp.key.mpa_status.mpa_session_arn #=> String
|
|
3125
|
+
# resp.key.mpa_status.status #=> String, one of "PENDING", "APPROVED", "FAILED", "CANCELLED"
|
|
3126
|
+
# resp.key.mpa_status.initiation_date #=> Time
|
|
3127
|
+
# resp.key.mpa_status.status_message #=> String
|
|
2726
3128
|
#
|
|
2727
3129
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/RestoreKey AWS API Documentation
|
|
2728
3130
|
#
|
|
@@ -2737,18 +3139,20 @@ module Aws::PaymentCryptography
|
|
|
2737
3139
|
# it active for cryptographic operations within Amazon Web Services
|
|
2738
3140
|
# Payment Cryptography
|
|
2739
3141
|
#
|
|
2740
|
-
# **Cross-account use:** This operation
|
|
2741
|
-
#
|
|
3142
|
+
# **Cross-account use:** This operation supports cross-account use when
|
|
3143
|
+
# the key has a resource-based policy that grants access. For more
|
|
3144
|
+
# information, see [Resource-based policies][1].
|
|
2742
3145
|
#
|
|
2743
3146
|
# **Related operations:**
|
|
2744
3147
|
#
|
|
2745
|
-
# * [StopKeyUsage][
|
|
3148
|
+
# * [StopKeyUsage][2]
|
|
2746
3149
|
#
|
|
2747
3150
|
# ^
|
|
2748
3151
|
#
|
|
2749
3152
|
#
|
|
2750
3153
|
#
|
|
2751
|
-
# [1]: https://docs.aws.amazon.com/payment-cryptography/latest/
|
|
3154
|
+
# [1]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/security_iam_resource-based-policies.html
|
|
3155
|
+
# [2]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StopKeyUsage.html
|
|
2752
3156
|
#
|
|
2753
3157
|
# @option params [required, String] :key_identifier
|
|
2754
3158
|
# The `KeyArn` of the key.
|
|
@@ -2796,6 +3200,10 @@ module Aws::PaymentCryptography
|
|
|
2796
3200
|
# resp.key.replication_status["Region"].status #=> String, one of "IN_PROGRESS", "DELETE_IN_PROGRESS", "FAILED", "SYNCHRONIZED"
|
|
2797
3201
|
# resp.key.replication_status["Region"].status_message #=> String
|
|
2798
3202
|
# resp.key.using_default_replication_regions #=> Boolean
|
|
3203
|
+
# resp.key.mpa_status.mpa_session_arn #=> String
|
|
3204
|
+
# resp.key.mpa_status.status #=> String, one of "PENDING", "APPROVED", "FAILED", "CANCELLED"
|
|
3205
|
+
# resp.key.mpa_status.initiation_date #=> Time
|
|
3206
|
+
# resp.key.mpa_status.status_message #=> String
|
|
2799
3207
|
#
|
|
2800
3208
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/StartKeyUsage AWS API Documentation
|
|
2801
3209
|
#
|
|
@@ -2813,8 +3221,9 @@ module Aws::PaymentCryptography
|
|
|
2813
3221
|
# key. You can enable the key in the future by calling
|
|
2814
3222
|
# [StartKeyUsage][2].
|
|
2815
3223
|
#
|
|
2816
|
-
# **Cross-account use:** This operation
|
|
2817
|
-
#
|
|
3224
|
+
# **Cross-account use:** This operation supports cross-account use when
|
|
3225
|
+
# the key has a resource-based policy that grants access. For more
|
|
3226
|
+
# information, see [Resource-based policies][3].
|
|
2818
3227
|
#
|
|
2819
3228
|
# **Related operations:**
|
|
2820
3229
|
#
|
|
@@ -2826,6 +3235,7 @@ module Aws::PaymentCryptography
|
|
|
2826
3235
|
#
|
|
2827
3236
|
# [1]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteKey.html
|
|
2828
3237
|
# [2]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StartKeyUsage.html
|
|
3238
|
+
# [3]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/security_iam_resource-based-policies.html
|
|
2829
3239
|
#
|
|
2830
3240
|
# @option params [required, String] :key_identifier
|
|
2831
3241
|
# The `KeyArn` of the key.
|
|
@@ -2873,6 +3283,10 @@ module Aws::PaymentCryptography
|
|
|
2873
3283
|
# resp.key.replication_status["Region"].status #=> String, one of "IN_PROGRESS", "DELETE_IN_PROGRESS", "FAILED", "SYNCHRONIZED"
|
|
2874
3284
|
# resp.key.replication_status["Region"].status_message #=> String
|
|
2875
3285
|
# resp.key.using_default_replication_regions #=> Boolean
|
|
3286
|
+
# resp.key.mpa_status.mpa_session_arn #=> String
|
|
3287
|
+
# resp.key.mpa_status.status #=> String, one of "PENDING", "APPROVED", "FAILED", "CANCELLED"
|
|
3288
|
+
# resp.key.mpa_status.initiation_date #=> Time
|
|
3289
|
+
# resp.key.mpa_status.status_message #=> String
|
|
2876
3290
|
#
|
|
2877
3291
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/StopKeyUsage AWS API Documentation
|
|
2878
3292
|
#
|
|
@@ -2897,20 +3311,22 @@ module Aws::PaymentCryptography
|
|
|
2897
3311
|
# to an Amazon Web Services Payment Cryptography key when you create it
|
|
2898
3312
|
# with [CreateKey][1].
|
|
2899
3313
|
#
|
|
2900
|
-
# **Cross-account use:** This operation
|
|
2901
|
-
#
|
|
3314
|
+
# **Cross-account use:** This operation supports cross-account use when
|
|
3315
|
+
# the key has a resource-based policy that grants access. For more
|
|
3316
|
+
# information, see [Resource-based policies][2].
|
|
2902
3317
|
#
|
|
2903
3318
|
# **Related operations:**
|
|
2904
3319
|
#
|
|
2905
|
-
# * [ListTagsForResource][
|
|
3320
|
+
# * [ListTagsForResource][3]
|
|
2906
3321
|
#
|
|
2907
|
-
# * [UntagResource][
|
|
3322
|
+
# * [UntagResource][4]
|
|
2908
3323
|
#
|
|
2909
3324
|
#
|
|
2910
3325
|
#
|
|
2911
3326
|
# [1]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html
|
|
2912
|
-
# [2]: https://docs.aws.amazon.com/payment-cryptography/latest/
|
|
2913
|
-
# [3]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/
|
|
3327
|
+
# [2]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/security_iam_resource-based-policies.html
|
|
3328
|
+
# [3]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListTagsForResource.html
|
|
3329
|
+
# [4]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UntagResource.html
|
|
2914
3330
|
#
|
|
2915
3331
|
# @option params [required, String] :resource_arn
|
|
2916
3332
|
# The `KeyARN` of the key whose tags are being updated.
|
|
@@ -2968,19 +3384,21 @@ module Aws::PaymentCryptography
|
|
|
2968
3384
|
#
|
|
2969
3385
|
# </note>
|
|
2970
3386
|
#
|
|
2971
|
-
# **Cross-account use:** This operation
|
|
2972
|
-
#
|
|
3387
|
+
# **Cross-account use:** This operation supports cross-account use when
|
|
3388
|
+
# the key has a resource-based policy that grants access. For more
|
|
3389
|
+
# information, see [Resource-based policies][1].
|
|
2973
3390
|
#
|
|
2974
3391
|
# **Related operations:**
|
|
2975
3392
|
#
|
|
2976
|
-
# * [ListTagsForResource][
|
|
3393
|
+
# * [ListTagsForResource][2]
|
|
2977
3394
|
#
|
|
2978
|
-
# * [TagResource][
|
|
3395
|
+
# * [TagResource][3]
|
|
2979
3396
|
#
|
|
2980
3397
|
#
|
|
2981
3398
|
#
|
|
2982
|
-
# [1]: https://docs.aws.amazon.com/payment-cryptography/latest/
|
|
2983
|
-
# [2]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/
|
|
3399
|
+
# [1]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/security_iam_resource-based-policies.html
|
|
3400
|
+
# [2]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListTagsForResource.html
|
|
3401
|
+
# [3]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_TagResource.html
|
|
2984
3402
|
#
|
|
2985
3403
|
# @option params [required, String] :resource_arn
|
|
2986
3404
|
# The `KeyARN` of the key whose tags are being removed.
|
|
@@ -3092,7 +3510,7 @@ module Aws::PaymentCryptography
|
|
|
3092
3510
|
tracer: tracer
|
|
3093
3511
|
)
|
|
3094
3512
|
context[:gem_name] = 'aws-sdk-paymentcryptography'
|
|
3095
|
-
context[:gem_version] = '1.
|
|
3513
|
+
context[:gem_version] = '1.54.0'
|
|
3096
3514
|
Seahorse::Client::Request.new(handlers, context)
|
|
3097
3515
|
end
|
|
3098
3516
|
|