/
secrets_manager.jl
1341 lines (1255 loc) · 67.3 KB
/
secrets_manager.jl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: secrets_manager
using AWS.Compat
using AWS.UUIDs
"""
cancel_rotate_secret(secret_id)
cancel_rotate_secret(secret_id, params::Dict{String,<:Any})
Turns off automatic rotation, and if a rotation is currently in progress, cancels the
rotation. If you cancel a rotation in progress, it can leave the VersionStage labels in an
unexpected state. You might need to remove the staging label AWSPENDING from the partially
created version. You also need to determine whether to roll back to the previous version of
the secret by moving the staging label AWSCURRENT to the version that has AWSPENDING. To
determine which version has a specific staging label, call ListSecretVersionIds. Then use
UpdateSecretVersionStage to change staging labels. For more information, see How rotation
works. To turn on automatic rotation again, call RotateSecret. Secrets Manager generates a
CloudTrail log entry when you call this action. Do not include sensitive information in
request parameters because it might be logged. For more information, see Logging Secrets
Manager events with CloudTrail. Required permissions: secretsmanager:CancelRotateSecret.
For more information, see IAM policy actions for Secrets Manager and Authentication and
access control in Secrets Manager.
# Arguments
- `secret_id`: The ARN or name of the secret. For an ARN, we recommend that you specify a
complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
"""
function cancel_rotate_secret(SecretId; aws_config::AbstractAWSConfig=global_aws_config())
return secrets_manager(
"CancelRotateSecret",
Dict{String,Any}("SecretId" => SecretId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_rotate_secret(
SecretId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return secrets_manager(
"CancelRotateSecret",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SecretId" => SecretId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_secret(name)
create_secret(name, params::Dict{String,<:Any})
Creates a new secret. A secret can be a password, a set of credentials such as a user name
and password, an OAuth token, or other secret information that you store in an encrypted
form in Secrets Manager. The secret also includes the connection information to access a
database or other service, which Secrets Manager doesn't encrypt. A secret in Secrets
Manager consists of both the protected secret data and the important information needed to
manage the secret. For secrets that use managed rotation, you need to create the secret
through the managing service. For more information, see Secrets Manager secrets managed by
other Amazon Web Services services. For information about creating a secret in the
console, see Create a secret. To create a secret, you can provide the secret value to be
encrypted in either the SecretString parameter or the SecretBinary parameter, but not both.
If you include SecretString or SecretBinary then Secrets Manager creates an initial secret
version and automatically attaches the staging label AWSCURRENT to it. For database
credentials you want to rotate, for Secrets Manager to be able to rotate the secret, you
must make sure the JSON you store in the SecretString matches the JSON structure of a
database secret. If you don't specify an KMS encryption key, Secrets Manager uses the
Amazon Web Services managed key aws/secretsmanager. If this key doesn't already exist in
your account, then Secrets Manager creates it for you automatically. All users and roles in
the Amazon Web Services account automatically have access to use aws/secretsmanager.
Creating aws/secretsmanager can result in a one-time significant delay in returning the
result. If the secret is in a different Amazon Web Services account from the credentials
calling the API, then you can't use aws/secretsmanager to encrypt the secret, and you must
create and use a customer managed KMS key. Secrets Manager generates a CloudTrail log
entry when you call this action. Do not include sensitive information in request parameters
except SecretBinary or SecretString because it might be logged. For more information, see
Logging Secrets Manager events with CloudTrail. Required permissions:
secretsmanager:CreateSecret. If you include tags in the secret, you also need
secretsmanager:TagResource. For more information, see IAM policy actions for Secrets
Manager and Authentication and access control in Secrets Manager. To encrypt the secret
with a KMS key other than aws/secretsmanager, you need kms:GenerateDataKey and kms:Decrypt
permission to the key.
# Arguments
- `name`: The name of the new secret. The secret name can contain ASCII letters, numbers,
and the following characters: /_+=.@- Do not end your secret name with a hyphen followed by
six characters. If you do so, you risk confusion and unexpected results when searching for
a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random
characters after the secret name at the end of the ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AddReplicaRegions"`: A list of Regions and KMS keys to replicate secrets.
- `"ClientRequestToken"`: If you include SecretString or SecretBinary, then Secrets Manager
creates an initial version for the secret, and this parameter specifies the unique
identifier for the new version. If you use the Amazon Web Services CLI or one of the
Amazon Web Services SDKs to call this operation, then you can leave this parameter empty.
The CLI or SDK generates a random UUID for you and includes it as the value for this
parameter in the request. If you don't use the SDK and instead generate a raw HTTP request
to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request. This value helps ensure
idempotency. Secrets Manager uses this value to prevent the accidental creation of
duplicate versions if there are failures and retries during a rotation. We recommend that
you generate a UUID-type value to ensure uniqueness of your versions within the specified
secret. If the ClientRequestToken value isn't already associated with a version of the
secret then a new version of the secret is created. If a version with this value already
exists and the version SecretString and SecretBinary values are the same as those in the
request, then the request is ignored. If a version with this value already exists and
that version's SecretString and SecretBinary values are different from those in the
request, then the request fails because you cannot modify an existing version. Instead, use
PutSecretValue to create a new version. This value becomes the VersionId of the new
version.
- `"Description"`: The description of the secret.
- `"ForceOverwriteReplicaSecret"`: Specifies whether to overwrite a secret with the same
name in the destination Region. By default, secrets aren't overwritten.
- `"KmsKeyId"`: The ARN, key ID, or alias of the KMS key that Secrets Manager uses to
encrypt the secret value in the secret. An alias is always prefixed by alias/, for example
alias/aws/secretsmanager. For more information, see About aliases. To use a KMS key in a
different account, use the key ARN or the alias ARN. If you don't specify this value, then
Secrets Manager uses the key aws/secretsmanager. If that key doesn't yet exist, then
Secrets Manager creates it for you automatically the first time it encrypts the secret
value. If the secret is in a different Amazon Web Services account from the credentials
calling the API, then you can't use aws/secretsmanager to encrypt the secret, and you must
create and use a customer managed KMS key.
- `"SecretBinary"`: The binary data to encrypt and store in the new version of the secret.
We recommend that you store your binary data in a file and then pass the contents of the
file as a parameter. Either SecretString or SecretBinary must have a value, but not both.
This parameter is not available in the Secrets Manager console.
- `"SecretString"`: The text data to encrypt and store in this new version of the secret.
We recommend you use a JSON structure of key/value pairs for your secret value. Either
SecretString or SecretBinary must have a value, but not both. If you create a secret by
using the Secrets Manager console then Secrets Manager puts the protected secret text in
only the SecretString parameter. The Secrets Manager console stores the information as a
JSON structure of key/value pairs that a Lambda rotation function can parse.
- `"Tags"`: A list of tags to attach to the secret. Each tag is a key and value pair of
strings in a JSON text string, for example:
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"productio
n\"}] Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a
different tag from one with key \"abc\". If you check tags in permissions policies as part
of your security strategy, then adding or removing a tag can change permissions. If the
completion of this operation would result in you losing your permissions for this secret,
then Secrets Manager blocks the operation and returns an Access Denied error. For more
information, see Control access to secrets using tags and Limit access to identities with
tags that match secrets' tags. For information about how to format a JSON parameter for the
various command line tool environments, see Using JSON for Parameters. If your command-line
tool or SDK requires quotation marks around the parameter, you should use single quotes to
avoid confusion with the double quotes required in the JSON text. The following
restrictions apply to tags: Maximum number of tags per secret: 50 Maximum key length:
127 Unicode characters in UTF-8 Maximum value length: 255 Unicode characters in UTF-8
Tag keys and values are case sensitive. Do not use the aws: prefix in your tag names or
values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit
or delete tag names or values with this prefix. Tags with this prefix do not count against
your tags per secret limit. If you use your tagging schema across multiple services and
resources, other services might have restrictions on allowed characters. Generally allowed
characters: letters, spaces, and numbers representable in UTF-8, plus the following special
characters: + - = . _ : / @.
"""
function create_secret(Name; aws_config::AbstractAWSConfig=global_aws_config())
return secrets_manager(
"CreateSecret",
Dict{String,Any}("Name" => Name, "ClientRequestToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_secret(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return secrets_manager(
"CreateSecret",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Name" => Name, "ClientRequestToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_resource_policy(secret_id)
delete_resource_policy(secret_id, params::Dict{String,<:Any})
Deletes the resource-based permission policy attached to the secret. To attach a policy to
a secret, use PutResourcePolicy. Secrets Manager generates a CloudTrail log entry when you
call this action. Do not include sensitive information in request parameters because it
might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:DeleteResourcePolicy. For more information, see IAM
policy actions for Secrets Manager and Authentication and access control in Secrets
Manager.
# Arguments
- `secret_id`: The ARN or name of the secret to delete the attached resource-based policy
for. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
See Finding a secret from a partial ARN.
"""
function delete_resource_policy(SecretId; aws_config::AbstractAWSConfig=global_aws_config())
return secrets_manager(
"DeleteResourcePolicy",
Dict{String,Any}("SecretId" => SecretId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_resource_policy(
SecretId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return secrets_manager(
"DeleteResourcePolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SecretId" => SecretId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_secret(secret_id)
delete_secret(secret_id, params::Dict{String,<:Any})
Deletes a secret and all of its versions. You can specify a recovery window during which
you can restore the secret. The minimum recovery window is 7 days. The default recovery
window is 30 days. Secrets Manager attaches a DeletionDate stamp to the secret that
specifies the end of the recovery window. At the end of the recovery window, Secrets
Manager deletes the secret permanently. You can't delete a primary secret that is
replicated to other Regions. You must first delete the replicas using
RemoveRegionsFromReplication, and then delete the primary secret. When you delete a
replica, it is deleted immediately. You can't directly delete a version of a secret.
Instead, you remove all staging labels from the version using UpdateSecretVersionStage.
This marks the version as deprecated, and then Secrets Manager can automatically delete the
version in the background. To determine whether an application still uses a secret, you can
create an Amazon CloudWatch alarm to alert you to any attempts to access a secret during
the recovery window. For more information, see Monitor secrets scheduled for deletion.
Secrets Manager performs the permanent secret deletion at the end of the waiting period as
a background task with low priority. There is no guarantee of a specific time after the
recovery window for the permanent delete to occur. At any time before recovery window ends,
you can use RestoreSecret to remove the DeletionDate and cancel the deletion of the secret.
When a secret is scheduled for deletion, you cannot retrieve the secret value. You must
first cancel the deletion with RestoreSecret and then you can retrieve the secret. Secrets
Manager generates a CloudTrail log entry when you call this action. Do not include
sensitive information in request parameters because it might be logged. For more
information, see Logging Secrets Manager events with CloudTrail. Required permissions:
secretsmanager:DeleteSecret. For more information, see IAM policy actions for Secrets
Manager and Authentication and access control in Secrets Manager.
# Arguments
- `secret_id`: The ARN or name of the secret to delete. For an ARN, we recommend that you
specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ForceDeleteWithoutRecovery"`: Specifies whether to delete the secret without any
recovery window. You can't use both this parameter and RecoveryWindowInDays in the same
call. If you don't use either, then by default Secrets Manager uses a 30 day recovery
window. Secrets Manager performs the actual deletion with an asynchronous background
process, so there might be a short delay before the secret is permanently deleted. If you
delete a secret and then immediately create a secret with the same name, use appropriate
back off and retry logic. If you forcibly delete an already deleted or nonexistent secret,
the operation does not return ResourceNotFoundException. Use this parameter with caution.
This parameter causes the operation to skip the normal recovery window before the permanent
deletion that Secrets Manager would normally impose with the RecoveryWindowInDays
parameter. If you delete a secret with the ForceDeleteWithoutRecovery parameter, then you
have no opportunity to recover the secret. You lose the secret permanently.
- `"RecoveryWindowInDays"`: The number of days from 7 to 30 that Secrets Manager waits
before permanently deleting the secret. You can't use both this parameter and
ForceDeleteWithoutRecovery in the same call. If you don't use either, then by default
Secrets Manager uses a 30 day recovery window.
"""
function delete_secret(SecretId; aws_config::AbstractAWSConfig=global_aws_config())
return secrets_manager(
"DeleteSecret",
Dict{String,Any}("SecretId" => SecretId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_secret(
SecretId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return secrets_manager(
"DeleteSecret",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SecretId" => SecretId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_secret(secret_id)
describe_secret(secret_id, params::Dict{String,<:Any})
Retrieves the details of a secret. It does not include the encrypted secret value. Secrets
Manager only returns fields that have a value in the response. Secrets Manager generates a
CloudTrail log entry when you call this action. Do not include sensitive information in
request parameters because it might be logged. For more information, see Logging Secrets
Manager events with CloudTrail. Required permissions: secretsmanager:DescribeSecret. For
more information, see IAM policy actions for Secrets Manager and Authentication and access
control in Secrets Manager.
# Arguments
- `secret_id`: The ARN or name of the secret. For an ARN, we recommend that you specify a
complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
"""
function describe_secret(SecretId; aws_config::AbstractAWSConfig=global_aws_config())
return secrets_manager(
"DescribeSecret",
Dict{String,Any}("SecretId" => SecretId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_secret(
SecretId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return secrets_manager(
"DescribeSecret",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SecretId" => SecretId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_random_password()
get_random_password(params::Dict{String,<:Any})
Generates a random password. We recommend that you specify the maximum length and include
every character type that the system you are generating a password for can support. Secrets
Manager generates a CloudTrail log entry when you call this action. Do not include
sensitive information in request parameters because it might be logged. For more
information, see Logging Secrets Manager events with CloudTrail. Required permissions:
secretsmanager:GetRandomPassword. For more information, see IAM policy actions for Secrets
Manager and Authentication and access control in Secrets Manager.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ExcludeCharacters"`: A string of the characters that you don't want in the password.
- `"ExcludeLowercase"`: Specifies whether to exclude lowercase letters from the password.
If you don't include this switch, the password can contain lowercase letters.
- `"ExcludeNumbers"`: Specifies whether to exclude numbers from the password. If you don't
include this switch, the password can contain numbers.
- `"ExcludePunctuation"`: Specifies whether to exclude the following punctuation characters
from the password: ! \" # % & ' ( ) * + , - . / : ; < = > ? @ [ ] ^ _ ` { | }
~. If you don't include this switch, the password can contain punctuation.
- `"ExcludeUppercase"`: Specifies whether to exclude uppercase letters from the password.
If you don't include this switch, the password can contain uppercase letters.
- `"IncludeSpace"`: Specifies whether to include the space character. If you include this
switch, the password can contain space characters.
- `"PasswordLength"`: The length of the password. If you don't include this parameter, the
default length is 32 characters.
- `"RequireEachIncludedType"`: Specifies whether to include at least one upper and
lowercase letter, one number, and one punctuation. If you don't include this switch, the
password contains at least one of every character type.
"""
function get_random_password(; aws_config::AbstractAWSConfig=global_aws_config())
return secrets_manager(
"GetRandomPassword"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_random_password(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return secrets_manager(
"GetRandomPassword", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_resource_policy(secret_id)
get_resource_policy(secret_id, params::Dict{String,<:Any})
Retrieves the JSON text of the resource-based policy document attached to the secret. For
more information about permissions policies attached to a secret, see Permissions policies
attached to a secret. Secrets Manager generates a CloudTrail log entry when you call this
action. Do not include sensitive information in request parameters because it might be
logged. For more information, see Logging Secrets Manager events with CloudTrail. Required
permissions: secretsmanager:GetResourcePolicy. For more information, see IAM policy
actions for Secrets Manager and Authentication and access control in Secrets Manager.
# Arguments
- `secret_id`: The ARN or name of the secret to retrieve the attached resource-based policy
for. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
See Finding a secret from a partial ARN.
"""
function get_resource_policy(SecretId; aws_config::AbstractAWSConfig=global_aws_config())
return secrets_manager(
"GetResourcePolicy",
Dict{String,Any}("SecretId" => SecretId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_resource_policy(
SecretId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return secrets_manager(
"GetResourcePolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SecretId" => SecretId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_secret_value(secret_id)
get_secret_value(secret_id, params::Dict{String,<:Any})
Retrieves the contents of the encrypted fields SecretString or SecretBinary from the
specified version of a secret, whichever contains content. We recommend that you cache your
secret values by using client-side caching. Caching secrets improves speed and reduces your
costs. For more information, see Cache secrets for your applications. To retrieve the
previous version of a secret, use VersionStage and specify AWSPREVIOUS. To revert to the
previous version of a secret, call UpdateSecretVersionStage. Secrets Manager generates a
CloudTrail log entry when you call this action. Do not include sensitive information in
request parameters because it might be logged. For more information, see Logging Secrets
Manager events with CloudTrail. Required permissions: secretsmanager:GetSecretValue. If
the secret is encrypted using a customer-managed key instead of the Amazon Web Services
managed key aws/secretsmanager, then you also need kms:Decrypt permissions for that key.
For more information, see IAM policy actions for Secrets Manager and Authentication and
access control in Secrets Manager.
# Arguments
- `secret_id`: The ARN or name of the secret to retrieve. For an ARN, we recommend that you
specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"VersionId"`: The unique identifier of the version of the secret to retrieve. If you
include both this parameter and VersionStage, the two parameters must refer to the same
secret version. If you don't specify either a VersionStage or VersionId, then Secrets
Manager returns the AWSCURRENT version. This value is typically a UUID-type value with 32
hexadecimal digits.
- `"VersionStage"`: The staging label of the version of the secret to retrieve. Secrets
Manager uses staging labels to keep track of different versions during the rotation
process. If you include both this parameter and VersionId, the two parameters must refer to
the same secret version. If you don't specify either a VersionStage or VersionId, Secrets
Manager returns the AWSCURRENT version.
"""
function get_secret_value(SecretId; aws_config::AbstractAWSConfig=global_aws_config())
return secrets_manager(
"GetSecretValue",
Dict{String,Any}("SecretId" => SecretId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_secret_value(
SecretId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return secrets_manager(
"GetSecretValue",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SecretId" => SecretId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_secret_version_ids(secret_id)
list_secret_version_ids(secret_id, params::Dict{String,<:Any})
Lists the versions of a secret. Secrets Manager uses staging labels to indicate the
different versions of a secret. For more information, see Secrets Manager concepts:
Versions. To list the secrets in the account, use ListSecrets. Secrets Manager generates a
CloudTrail log entry when you call this action. Do not include sensitive information in
request parameters because it might be logged. For more information, see Logging Secrets
Manager events with CloudTrail. Required permissions:
secretsmanager:ListSecretVersionIds. For more information, see IAM policy actions for
Secrets Manager and Authentication and access control in Secrets Manager.
# Arguments
- `secret_id`: The ARN or name of the secret whose versions you want to list. For an ARN,
we recommend that you specify a complete ARN rather than a partial ARN. See Finding a
secret from a partial ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IncludeDeprecated"`: Specifies whether to include versions of secrets that don't have
any staging labels attached to them. Versions without staging labels are considered
deprecated and are subject to deletion by Secrets Manager. By default, versions without
staging labels aren't included.
- `"MaxResults"`: The number of results to include in the response. If there are more
results available, in the response, Secrets Manager includes NextToken. To get the next
results, call ListSecretVersionIds again with the value from NextToken.
- `"NextToken"`: A token that indicates where the output should continue from, if a
previous call did not show all results. To get the next results, call ListSecretVersionIds
again with this value.
"""
function list_secret_version_ids(
SecretId; aws_config::AbstractAWSConfig=global_aws_config()
)
return secrets_manager(
"ListSecretVersionIds",
Dict{String,Any}("SecretId" => SecretId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_secret_version_ids(
SecretId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return secrets_manager(
"ListSecretVersionIds",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SecretId" => SecretId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_secrets()
list_secrets(params::Dict{String,<:Any})
Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account,
not including secrets that are marked for deletion. To see secrets marked for deletion, use
the Secrets Manager console. ListSecrets is eventually consistent, however it might not
reflect changes from the last five minutes. To get the latest information for a specific
secret, use DescribeSecret. To list the versions of a secret, use ListSecretVersionIds. To
get the secret value from SecretString or SecretBinary, call GetSecretValue. For
information about finding secrets in the console, see Find secrets in Secrets Manager.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include
sensitive information in request parameters because it might be logged. For more
information, see Logging Secrets Manager events with CloudTrail. Required permissions:
secretsmanager:ListSecrets. For more information, see IAM policy actions for Secrets
Manager and Authentication and access control in Secrets Manager.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: The filters to apply to the list of secrets.
- `"IncludePlannedDeletion"`: Specifies whether to include secrets scheduled for deletion.
By default, secrets scheduled for deletion aren't included.
- `"MaxResults"`: The number of results to include in the response. If there are more
results available, in the response, Secrets Manager includes NextToken. To get the next
results, call ListSecrets again with the value from NextToken.
- `"NextToken"`: A token that indicates where the output should continue from, if a
previous call did not show all results. To get the next results, call ListSecrets again
with this value.
- `"SortOrder"`: Secrets are listed by CreatedDate.
"""
function list_secrets(; aws_config::AbstractAWSConfig=global_aws_config())
return secrets_manager(
"ListSecrets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_secrets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return secrets_manager(
"ListSecrets", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
put_resource_policy(resource_policy, secret_id)
put_resource_policy(resource_policy, secret_id, params::Dict{String,<:Any})
Attaches a resource-based permission policy to a secret. A resource-based policy is
optional. For more information, see Authentication and access control for Secrets Manager
For information about attaching a policy in the console, see Attach a permissions policy to
a secret. Secrets Manager generates a CloudTrail log entry when you call this action. Do
not include sensitive information in request parameters because it might be logged. For
more information, see Logging Secrets Manager events with CloudTrail. Required
permissions: secretsmanager:PutResourcePolicy. For more information, see IAM policy
actions for Secrets Manager and Authentication and access control in Secrets Manager.
# Arguments
- `resource_policy`: A JSON-formatted string for an Amazon Web Services resource-based
policy. For example policies, see Permissions policy examples.
- `secret_id`: The ARN or name of the secret to attach the resource-based policy. For an
ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a
secret from a partial ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BlockPublicPolicy"`: Specifies whether to block resource-based policies that allow
broad access to the secret, for example those that use a wildcard for the principal. By
default, public policies aren't blocked.
"""
function put_resource_policy(
ResourcePolicy, SecretId; aws_config::AbstractAWSConfig=global_aws_config()
)
return secrets_manager(
"PutResourcePolicy",
Dict{String,Any}("ResourcePolicy" => ResourcePolicy, "SecretId" => SecretId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_resource_policy(
ResourcePolicy,
SecretId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return secrets_manager(
"PutResourcePolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ResourcePolicy" => ResourcePolicy, "SecretId" => SecretId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_secret_value(secret_id)
put_secret_value(secret_id, params::Dict{String,<:Any})
Creates a new version with a new encrypted secret value and attaches it to the secret. The
version can contain a new SecretString value or a new SecretBinary value. We recommend you
avoid calling PutSecretValue at a sustained rate of more than once every 10 minutes. When
you update the secret value, Secrets Manager creates a new version of the secret. Secrets
Manager removes outdated versions when there are more than 100, but it does not remove
versions created less than 24 hours ago. If you call PutSecretValue more than once every 10
minutes, you create more versions than Secrets Manager removes, and you will reach the
quota for secret versions. You can specify the staging labels to attach to the new version
in VersionStages. If you don't include VersionStages, then Secrets Manager automatically
moves the staging label AWSCURRENT to this version. If this operation creates the first
version for the secret, then Secrets Manager automatically attaches the staging label
AWSCURRENT to it. If this operation moves the staging label AWSCURRENT from another version
to this version, then Secrets Manager also automatically moves the staging label
AWSPREVIOUS to the version that AWSCURRENT was removed from. This operation is idempotent.
If you call this operation with a ClientRequestToken that matches an existing version's
VersionId, and you specify the same secret data, the operation succeeds but does nothing.
However, if the secret data is different, then the operation fails because you can't modify
an existing version; you can only create new ones. Secrets Manager generates a CloudTrail
log entry when you call this action. Do not include sensitive information in request
parameters except SecretBinary or SecretString because it might be logged. For more
information, see Logging Secrets Manager events with CloudTrail. Required permissions:
secretsmanager:PutSecretValue. For more information, see IAM policy actions for Secrets
Manager and Authentication and access control in Secrets Manager.
# Arguments
- `secret_id`: The ARN or name of the secret to add a new version to. For an ARN, we
recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret
from a partial ARN. If the secret doesn't already exist, use CreateSecret instead.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: A unique identifier for the new version of the secret. If you
use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this
operation, then you can leave this parameter empty because they generate a random UUID for
you. If you don't use the SDK and instead generate a raw HTTP request to the Secrets
Manager service endpoint, then you must generate a ClientRequestToken yourself for new
versions and include that value in the request. This value helps ensure idempotency.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if
there are failures and retries during the Lambda rotation function processing. We recommend
that you generate a UUID-type value to ensure uniqueness within the specified secret. If
the ClientRequestToken value isn't already associated with a version of the secret then a
new version of the secret is created. If a version with this value already exists and
that version's SecretString or SecretBinary values are the same as those in the request
then the request is ignored. The operation is idempotent. If a version with this value
already exists and the version of the SecretString and SecretBinary values are different
from those in the request, then the request fails because you can't modify a secret
version. You can only create new versions to store new secret values. This value becomes
the VersionId of the new version.
- `"SecretBinary"`: The binary data to encrypt and store in the new version of the secret.
To use this parameter in the command-line tools, we recommend that you store your binary
data in a file and then pass the contents of the file as a parameter. You must include
SecretBinary or SecretString, but not both. You can't access this value from the Secrets
Manager console.
- `"SecretString"`: The text to encrypt and store in the new version of the secret. You
must include SecretBinary or SecretString, but not both. We recommend you create the secret
string as JSON key/value pairs, as shown in the example.
- `"VersionStages"`: A list of staging labels to attach to this version of the secret.
Secrets Manager uses staging labels to track versions of a secret through the rotation
process. If you specify a staging label that's already associated with a different version
of the same secret, then Secrets Manager removes the label from the other version and
attaches it to this version. If you specify AWSCURRENT, and it is already attached to
another version, then Secrets Manager also moves the staging label AWSPREVIOUS to the
version that AWSCURRENT was removed from. If you don't include VersionStages, then Secrets
Manager automatically moves the staging label AWSCURRENT to this version.
"""
function put_secret_value(SecretId; aws_config::AbstractAWSConfig=global_aws_config())
return secrets_manager(
"PutSecretValue",
Dict{String,Any}("SecretId" => SecretId, "ClientRequestToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_secret_value(
SecretId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return secrets_manager(
"PutSecretValue",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SecretId" => SecretId, "ClientRequestToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_regions_from_replication(remove_replica_regions, secret_id)
remove_regions_from_replication(remove_replica_regions, secret_id, params::Dict{String,<:Any})
For a secret that is replicated to other Regions, deletes the secret replicas from the
Regions you specify. Secrets Manager generates a CloudTrail log entry when you call this
action. Do not include sensitive information in request parameters because it might be
logged. For more information, see Logging Secrets Manager events with CloudTrail. Required
permissions: secretsmanager:RemoveRegionsFromReplication. For more information, see IAM
policy actions for Secrets Manager and Authentication and access control in Secrets
Manager.
# Arguments
- `remove_replica_regions`: The Regions of the replicas to remove.
- `secret_id`: The ARN or name of the secret.
"""
function remove_regions_from_replication(
RemoveReplicaRegions, SecretId; aws_config::AbstractAWSConfig=global_aws_config()
)
return secrets_manager(
"RemoveRegionsFromReplication",
Dict{String,Any}(
"RemoveReplicaRegions" => RemoveReplicaRegions, "SecretId" => SecretId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_regions_from_replication(
RemoveReplicaRegions,
SecretId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return secrets_manager(
"RemoveRegionsFromReplication",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"RemoveReplicaRegions" => RemoveReplicaRegions, "SecretId" => SecretId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
replicate_secret_to_regions(add_replica_regions, secret_id)
replicate_secret_to_regions(add_replica_regions, secret_id, params::Dict{String,<:Any})
Replicates the secret to a new Regions. See Multi-Region secrets. Secrets Manager generates
a CloudTrail log entry when you call this action. Do not include sensitive information in
request parameters because it might be logged. For more information, see Logging Secrets
Manager events with CloudTrail. Required permissions:
secretsmanager:ReplicateSecretToRegions. For more information, see IAM policy actions for
Secrets Manager and Authentication and access control in Secrets Manager.
# Arguments
- `add_replica_regions`: A list of Regions in which to replicate the secret.
- `secret_id`: The ARN or name of the secret to replicate.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ForceOverwriteReplicaSecret"`: Specifies whether to overwrite a secret with the same
name in the destination Region. By default, secrets aren't overwritten.
"""
function replicate_secret_to_regions(
AddReplicaRegions, SecretId; aws_config::AbstractAWSConfig=global_aws_config()
)
return secrets_manager(
"ReplicateSecretToRegions",
Dict{String,Any}("AddReplicaRegions" => AddReplicaRegions, "SecretId" => SecretId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function replicate_secret_to_regions(
AddReplicaRegions,
SecretId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return secrets_manager(
"ReplicateSecretToRegions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AddReplicaRegions" => AddReplicaRegions, "SecretId" => SecretId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
restore_secret(secret_id)
restore_secret(secret_id, params::Dict{String,<:Any})
Cancels the scheduled deletion of a secret by removing the DeletedDate time stamp. You can
access a secret again after it has been restored. Secrets Manager generates a CloudTrail
log entry when you call this action. Do not include sensitive information in request
parameters because it might be logged. For more information, see Logging Secrets Manager
events with CloudTrail. Required permissions: secretsmanager:RestoreSecret. For more
information, see IAM policy actions for Secrets Manager and Authentication and access
control in Secrets Manager.
# Arguments
- `secret_id`: The ARN or name of the secret to restore. For an ARN, we recommend that you
specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
"""
function restore_secret(SecretId; aws_config::AbstractAWSConfig=global_aws_config())
return secrets_manager(
"RestoreSecret",
Dict{String,Any}("SecretId" => SecretId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function restore_secret(
SecretId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return secrets_manager(
"RestoreSecret",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SecretId" => SecretId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
rotate_secret(secret_id)
rotate_secret(secret_id, params::Dict{String,<:Any})
Configures and starts the asynchronous process of rotating the secret. For information
about rotation, see Rotate secrets in the Secrets Manager User Guide. If you include the
configuration parameters, the operation sets the values for the secret and then immediately
starts a rotation. If you don't include the configuration parameters, the operation starts
a rotation with the values already stored in the secret. When rotation is successful, the
AWSPENDING staging label might be attached to the same version as the AWSCURRENT version,
or it might not be attached to any version. If the AWSPENDING staging label is present but
not attached to the same version as AWSCURRENT, then any later invocation of RotateSecret
assumes that a previous rotation request is still in progress and returns an error. When
rotation is unsuccessful, the AWSPENDING staging label might be attached to an empty secret
version. For more information, see Troubleshoot rotation in the Secrets Manager User Guide.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include
sensitive information in request parameters because it might be logged. For more
information, see Logging Secrets Manager events with CloudTrail. Required permissions:
secretsmanager:RotateSecret. For more information, see IAM policy actions for Secrets
Manager and Authentication and access control in Secrets Manager. You also need
lambda:InvokeFunction permissions on the rotation function. For more information, see
Permissions for rotation.
# Arguments
- `secret_id`: The ARN or name of the secret to rotate. For an ARN, we recommend that you
specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: A unique identifier for the new version of the secret that helps
ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of
duplicate versions if there are failures and retries during rotation. This value becomes
the VersionId of the new version. If you use the Amazon Web Services CLI or one of the
Amazon Web Services SDK to call this operation, then you can leave this parameter empty.
The CLI or SDK generates a random UUID for you and includes that in the request for this
parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets
Manager service endpoint, then you must generate a ClientRequestToken yourself for new
versions and include that value in the request. You only need to specify this value if you
implement your own retry logic and you want to ensure that Secrets Manager doesn't attempt
to create a secret version twice. We recommend that you generate a UUID-type value to
ensure uniqueness within the specified secret.
- `"RotateImmediately"`: Specifies whether to rotate the secret immediately or wait until
the next scheduled rotation window. The rotation schedule is defined in
RotateSecretRequestRotationRules. For secrets that use a Lambda rotation function to
rotate, if you don't immediately rotate the secret, Secrets Manager tests the rotation
configuration by running the testSecret step of the Lambda rotation function. The test
creates an AWSPENDING version of the secret and then removes it. By default, Secrets
Manager rotates the secret immediately.
- `"RotationLambdaARN"`: For secrets that use a Lambda rotation function to rotate, the ARN
of the Lambda rotation function. For secrets that use managed rotation, omit this field.
For more information, see Managed rotation in the Secrets Manager User Guide.
- `"RotationRules"`: A structure that defines the rotation configuration for this secret.
"""
function rotate_secret(SecretId; aws_config::AbstractAWSConfig=global_aws_config())
return secrets_manager(
"RotateSecret",
Dict{String,Any}("SecretId" => SecretId, "ClientRequestToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function rotate_secret(
SecretId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return secrets_manager(
"RotateSecret",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SecretId" => SecretId, "ClientRequestToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_replication_to_replica(secret_id)
stop_replication_to_replica(secret_id, params::Dict{String,<:Any})
Removes the link between the replica secret and the primary secret and promotes the replica
to a primary secret in the replica Region. You must call this operation from the Region in
which you want to promote the replica to a primary secret. Secrets Manager generates a
CloudTrail log entry when you call this action. Do not include sensitive information in
request parameters because it might be logged. For more information, see Logging Secrets
Manager events with CloudTrail. Required permissions:
secretsmanager:StopReplicationToReplica. For more information, see IAM policy actions for
Secrets Manager and Authentication and access control in Secrets Manager.
# Arguments
- `secret_id`: The ARN of the primary secret.
"""
function stop_replication_to_replica(
SecretId; aws_config::AbstractAWSConfig=global_aws_config()
)
return secrets_manager(
"StopReplicationToReplica",
Dict{String,Any}("SecretId" => SecretId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_replication_to_replica(
SecretId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return secrets_manager(
"StopReplicationToReplica",