@aws-sdk/client-secrets-manager 3.321.1 → 3.326.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.
- package/dist-types/commands/CancelRotateSecretCommand.d.ts +8 -0
- package/dist-types/commands/CreateSecretCommand.d.ts +17 -0
- package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +7 -0
- package/dist-types/commands/DeleteSecretCommand.d.ts +8 -0
- package/dist-types/commands/DescribeSecretCommand.d.ts +44 -0
- package/dist-types/commands/GetRandomPasswordCommand.d.ts +6 -0
- package/dist-types/commands/GetResourcePolicyCommand.d.ts +8 -0
- package/dist-types/commands/GetSecretValueCommand.d.ts +14 -0
- package/dist-types/commands/ListSecretVersionIdsCommand.d.ts +21 -0
- package/dist-types/commands/ListSecretsCommand.d.ts +40 -0
- package/dist-types/commands/PutResourcePolicyCommand.d.ts +7 -0
- package/dist-types/commands/PutSecretValueCommand.d.ts +11 -0
- package/dist-types/commands/RemoveRegionsFromReplicationCommand.d.ts +15 -0
- package/dist-types/commands/ReplicateSecretToRegionsCommand.d.ts +15 -0
- package/dist-types/commands/RestoreSecretCommand.d.ts +7 -0
- package/dist-types/commands/RotateSecretCommand.d.ts +8 -0
- package/dist-types/commands/StopReplicationToReplicaCommand.d.ts +6 -0
- package/dist-types/commands/TagResourceCommand.d.ts +4 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
- package/dist-types/commands/UpdateSecretCommand.d.ts +8 -0
- package/dist-types/commands/UpdateSecretVersionStageCommand.d.ts +7 -0
- package/dist-types/commands/ValidateResourcePolicyCommand.d.ts +12 -0
- package/package.json +16 -16
|
@@ -49,6 +49,12 @@ export interface CancelRotateSecretCommandOutput extends CancelRotateSecretRespo
|
|
|
49
49
|
* };
|
|
50
50
|
* const command = new CancelRotateSecretCommand(input);
|
|
51
51
|
* const response = await client.send(command);
|
|
52
|
+
* // { // CancelRotateSecretResponse
|
|
53
|
+
* // ARN: "STRING_VALUE",
|
|
54
|
+
* // Name: "STRING_VALUE",
|
|
55
|
+
* // VersionId: "STRING_VALUE",
|
|
56
|
+
* // };
|
|
57
|
+
*
|
|
52
58
|
* ```
|
|
53
59
|
*
|
|
54
60
|
* @param CancelRotateSecretCommandInput - {@link CancelRotateSecretCommandInput}
|
|
@@ -84,6 +90,8 @@ export interface CancelRotateSecretCommandOutput extends CancelRotateSecretRespo
|
|
|
84
90
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
85
91
|
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
86
92
|
*
|
|
93
|
+
* @throws {@link SecretsManagerServiceException}
|
|
94
|
+
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
87
95
|
*
|
|
88
96
|
* @example To cancel scheduled rotation for a secret
|
|
89
97
|
* ```javascript
|
|
@@ -84,6 +84,21 @@ export interface CreateSecretCommandOutput extends CreateSecretResponse, __Metad
|
|
|
84
84
|
* };
|
|
85
85
|
* const command = new CreateSecretCommand(input);
|
|
86
86
|
* const response = await client.send(command);
|
|
87
|
+
* // { // CreateSecretResponse
|
|
88
|
+
* // ARN: "STRING_VALUE",
|
|
89
|
+
* // Name: "STRING_VALUE",
|
|
90
|
+
* // VersionId: "STRING_VALUE",
|
|
91
|
+
* // ReplicationStatus: [ // ReplicationStatusListType
|
|
92
|
+
* // { // ReplicationStatusType
|
|
93
|
+
* // Region: "STRING_VALUE",
|
|
94
|
+
* // KmsKeyId: "STRING_VALUE",
|
|
95
|
+
* // Status: "InSync" || "Failed" || "InProgress",
|
|
96
|
+
* // StatusMessage: "STRING_VALUE",
|
|
97
|
+
* // LastAccessedDate: new Date("TIMESTAMP"),
|
|
98
|
+
* // },
|
|
99
|
+
* // ],
|
|
100
|
+
* // };
|
|
101
|
+
*
|
|
87
102
|
* ```
|
|
88
103
|
*
|
|
89
104
|
* @param CreateSecretCommandInput - {@link CreateSecretCommandInput}
|
|
@@ -139,6 +154,8 @@ export interface CreateSecretCommandOutput extends CreateSecretResponse, __Metad
|
|
|
139
154
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
140
155
|
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
141
156
|
*
|
|
157
|
+
* @throws {@link SecretsManagerServiceException}
|
|
158
|
+
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
142
159
|
*
|
|
143
160
|
* @example To create a basic secret
|
|
144
161
|
* ```javascript
|
|
@@ -39,6 +39,11 @@ export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyR
|
|
|
39
39
|
* };
|
|
40
40
|
* const command = new DeleteResourcePolicyCommand(input);
|
|
41
41
|
* const response = await client.send(command);
|
|
42
|
+
* // { // DeleteResourcePolicyResponse
|
|
43
|
+
* // ARN: "STRING_VALUE",
|
|
44
|
+
* // Name: "STRING_VALUE",
|
|
45
|
+
* // };
|
|
46
|
+
*
|
|
42
47
|
* ```
|
|
43
48
|
*
|
|
44
49
|
* @param DeleteResourcePolicyCommandInput - {@link DeleteResourcePolicyCommandInput}
|
|
@@ -74,6 +79,8 @@ export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyR
|
|
|
74
79
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
75
80
|
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
76
81
|
*
|
|
82
|
+
* @throws {@link SecretsManagerServiceException}
|
|
83
|
+
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
77
84
|
*
|
|
78
85
|
* @example To delete the resource-based policy attached to a secret
|
|
79
86
|
* ```javascript
|
|
@@ -61,6 +61,12 @@ export interface DeleteSecretCommandOutput extends DeleteSecretResponse, __Metad
|
|
|
61
61
|
* };
|
|
62
62
|
* const command = new DeleteSecretCommand(input);
|
|
63
63
|
* const response = await client.send(command);
|
|
64
|
+
* // { // DeleteSecretResponse
|
|
65
|
+
* // ARN: "STRING_VALUE",
|
|
66
|
+
* // Name: "STRING_VALUE",
|
|
67
|
+
* // DeletionDate: new Date("TIMESTAMP"),
|
|
68
|
+
* // };
|
|
69
|
+
*
|
|
64
70
|
* ```
|
|
65
71
|
*
|
|
66
72
|
* @param DeleteSecretCommandInput - {@link DeleteSecretCommandInput}
|
|
@@ -96,6 +102,8 @@ export interface DeleteSecretCommandOutput extends DeleteSecretResponse, __Metad
|
|
|
96
102
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
97
103
|
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
98
104
|
*
|
|
105
|
+
* @throws {@link SecretsManagerServiceException}
|
|
106
|
+
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
99
107
|
*
|
|
100
108
|
* @example To delete a secret
|
|
101
109
|
* ```javascript
|
|
@@ -39,6 +39,48 @@ export interface DescribeSecretCommandOutput extends DescribeSecretResponse, __M
|
|
|
39
39
|
* };
|
|
40
40
|
* const command = new DescribeSecretCommand(input);
|
|
41
41
|
* const response = await client.send(command);
|
|
42
|
+
* // { // DescribeSecretResponse
|
|
43
|
+
* // ARN: "STRING_VALUE",
|
|
44
|
+
* // Name: "STRING_VALUE",
|
|
45
|
+
* // Description: "STRING_VALUE",
|
|
46
|
+
* // KmsKeyId: "STRING_VALUE",
|
|
47
|
+
* // RotationEnabled: true || false,
|
|
48
|
+
* // RotationLambdaARN: "STRING_VALUE",
|
|
49
|
+
* // RotationRules: { // RotationRulesType
|
|
50
|
+
* // AutomaticallyAfterDays: Number("long"),
|
|
51
|
+
* // Duration: "STRING_VALUE",
|
|
52
|
+
* // ScheduleExpression: "STRING_VALUE",
|
|
53
|
+
* // },
|
|
54
|
+
* // LastRotatedDate: new Date("TIMESTAMP"),
|
|
55
|
+
* // LastChangedDate: new Date("TIMESTAMP"),
|
|
56
|
+
* // LastAccessedDate: new Date("TIMESTAMP"),
|
|
57
|
+
* // DeletedDate: new Date("TIMESTAMP"),
|
|
58
|
+
* // NextRotationDate: new Date("TIMESTAMP"),
|
|
59
|
+
* // Tags: [ // TagListType
|
|
60
|
+
* // { // Tag
|
|
61
|
+
* // Key: "STRING_VALUE",
|
|
62
|
+
* // Value: "STRING_VALUE",
|
|
63
|
+
* // },
|
|
64
|
+
* // ],
|
|
65
|
+
* // VersionIdsToStages: { // SecretVersionsToStagesMapType
|
|
66
|
+
* // "<keys>": [ // SecretVersionStagesType
|
|
67
|
+
* // "STRING_VALUE",
|
|
68
|
+
* // ],
|
|
69
|
+
* // },
|
|
70
|
+
* // OwningService: "STRING_VALUE",
|
|
71
|
+
* // CreatedDate: new Date("TIMESTAMP"),
|
|
72
|
+
* // PrimaryRegion: "STRING_VALUE",
|
|
73
|
+
* // ReplicationStatus: [ // ReplicationStatusListType
|
|
74
|
+
* // { // ReplicationStatusType
|
|
75
|
+
* // Region: "STRING_VALUE",
|
|
76
|
+
* // KmsKeyId: "STRING_VALUE",
|
|
77
|
+
* // Status: "InSync" || "Failed" || "InProgress",
|
|
78
|
+
* // StatusMessage: "STRING_VALUE",
|
|
79
|
+
* // LastAccessedDate: new Date("TIMESTAMP"),
|
|
80
|
+
* // },
|
|
81
|
+
* // ],
|
|
82
|
+
* // };
|
|
83
|
+
*
|
|
42
84
|
* ```
|
|
43
85
|
*
|
|
44
86
|
* @param DescribeSecretCommandInput - {@link DescribeSecretCommandInput}
|
|
@@ -56,6 +98,8 @@ export interface DescribeSecretCommandOutput extends DescribeSecretResponse, __M
|
|
|
56
98
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
57
99
|
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
58
100
|
*
|
|
101
|
+
* @throws {@link SecretsManagerServiceException}
|
|
102
|
+
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
59
103
|
*
|
|
60
104
|
* @example To retrieve the details of a secret
|
|
61
105
|
* ```javascript
|
|
@@ -47,6 +47,10 @@ export interface GetRandomPasswordCommandOutput extends GetRandomPasswordRespons
|
|
|
47
47
|
* };
|
|
48
48
|
* const command = new GetRandomPasswordCommand(input);
|
|
49
49
|
* const response = await client.send(command);
|
|
50
|
+
* // { // GetRandomPasswordResponse
|
|
51
|
+
* // RandomPassword: "STRING_VALUE",
|
|
52
|
+
* // };
|
|
53
|
+
*
|
|
50
54
|
* ```
|
|
51
55
|
*
|
|
52
56
|
* @param GetRandomPasswordCommandInput - {@link GetRandomPasswordCommandInput}
|
|
@@ -79,6 +83,8 @@ export interface GetRandomPasswordCommandOutput extends GetRandomPasswordRespons
|
|
|
79
83
|
* </li>
|
|
80
84
|
* </ul>
|
|
81
85
|
*
|
|
86
|
+
* @throws {@link SecretsManagerServiceException}
|
|
87
|
+
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
82
88
|
*
|
|
83
89
|
* @example To generate a random password
|
|
84
90
|
* ```javascript
|
|
@@ -41,6 +41,12 @@ export interface GetResourcePolicyCommandOutput extends GetResourcePolicyRespons
|
|
|
41
41
|
* };
|
|
42
42
|
* const command = new GetResourcePolicyCommand(input);
|
|
43
43
|
* const response = await client.send(command);
|
|
44
|
+
* // { // GetResourcePolicyResponse
|
|
45
|
+
* // ARN: "STRING_VALUE",
|
|
46
|
+
* // Name: "STRING_VALUE",
|
|
47
|
+
* // ResourcePolicy: "STRING_VALUE",
|
|
48
|
+
* // };
|
|
49
|
+
*
|
|
44
50
|
* ```
|
|
45
51
|
*
|
|
46
52
|
* @param GetResourcePolicyCommandInput - {@link GetResourcePolicyCommandInput}
|
|
@@ -76,6 +82,8 @@ export interface GetResourcePolicyCommandOutput extends GetResourcePolicyRespons
|
|
|
76
82
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
77
83
|
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
78
84
|
*
|
|
85
|
+
* @throws {@link SecretsManagerServiceException}
|
|
86
|
+
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
79
87
|
*
|
|
80
88
|
* @example To retrieve the resource-based policy attached to a secret
|
|
81
89
|
* ```javascript
|
|
@@ -49,6 +49,18 @@ export interface GetSecretValueCommandOutput extends GetSecretValueResponse, __M
|
|
|
49
49
|
* };
|
|
50
50
|
* const command = new GetSecretValueCommand(input);
|
|
51
51
|
* const response = await client.send(command);
|
|
52
|
+
* // { // GetSecretValueResponse
|
|
53
|
+
* // ARN: "STRING_VALUE",
|
|
54
|
+
* // Name: "STRING_VALUE",
|
|
55
|
+
* // VersionId: "STRING_VALUE",
|
|
56
|
+
* // SecretBinary: "BLOB_VALUE",
|
|
57
|
+
* // SecretString: "STRING_VALUE",
|
|
58
|
+
* // VersionStages: [ // SecretVersionStagesType
|
|
59
|
+
* // "STRING_VALUE",
|
|
60
|
+
* // ],
|
|
61
|
+
* // CreatedDate: new Date("TIMESTAMP"),
|
|
62
|
+
* // };
|
|
63
|
+
*
|
|
52
64
|
* ```
|
|
53
65
|
*
|
|
54
66
|
* @param GetSecretValueCommandInput - {@link GetSecretValueCommandInput}
|
|
@@ -87,6 +99,8 @@ export interface GetSecretValueCommandOutput extends GetSecretValueResponse, __M
|
|
|
87
99
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
88
100
|
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
89
101
|
*
|
|
102
|
+
* @throws {@link SecretsManagerServiceException}
|
|
103
|
+
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
90
104
|
*
|
|
91
105
|
* @example To retrieve the encrypted secret value of a secret
|
|
92
106
|
* ```javascript
|
|
@@ -44,6 +44,25 @@ export interface ListSecretVersionIdsCommandOutput extends ListSecretVersionIdsR
|
|
|
44
44
|
* };
|
|
45
45
|
* const command = new ListSecretVersionIdsCommand(input);
|
|
46
46
|
* const response = await client.send(command);
|
|
47
|
+
* // { // ListSecretVersionIdsResponse
|
|
48
|
+
* // Versions: [ // SecretVersionsListType
|
|
49
|
+
* // { // SecretVersionsListEntry
|
|
50
|
+
* // VersionId: "STRING_VALUE",
|
|
51
|
+
* // VersionStages: [ // SecretVersionStagesType
|
|
52
|
+
* // "STRING_VALUE",
|
|
53
|
+
* // ],
|
|
54
|
+
* // LastAccessedDate: new Date("TIMESTAMP"),
|
|
55
|
+
* // CreatedDate: new Date("TIMESTAMP"),
|
|
56
|
+
* // KmsKeyIds: [ // KmsKeyIdListType
|
|
57
|
+
* // "STRING_VALUE",
|
|
58
|
+
* // ],
|
|
59
|
+
* // },
|
|
60
|
+
* // ],
|
|
61
|
+
* // NextToken: "STRING_VALUE",
|
|
62
|
+
* // ARN: "STRING_VALUE",
|
|
63
|
+
* // Name: "STRING_VALUE",
|
|
64
|
+
* // };
|
|
65
|
+
*
|
|
47
66
|
* ```
|
|
48
67
|
*
|
|
49
68
|
* @param ListSecretVersionIdsCommandInput - {@link ListSecretVersionIdsCommandInput}
|
|
@@ -64,6 +83,8 @@ export interface ListSecretVersionIdsCommandOutput extends ListSecretVersionIdsR
|
|
|
64
83
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
65
84
|
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
66
85
|
*
|
|
86
|
+
* @throws {@link SecretsManagerServiceException}
|
|
87
|
+
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
67
88
|
*
|
|
68
89
|
* @example To list all of the secret versions associated with a secret
|
|
69
90
|
* ```javascript
|
|
@@ -56,6 +56,44 @@ export interface ListSecretsCommandOutput extends ListSecretsResponse, __Metadat
|
|
|
56
56
|
* };
|
|
57
57
|
* const command = new ListSecretsCommand(input);
|
|
58
58
|
* const response = await client.send(command);
|
|
59
|
+
* // { // ListSecretsResponse
|
|
60
|
+
* // SecretList: [ // SecretListType
|
|
61
|
+
* // { // SecretListEntry
|
|
62
|
+
* // ARN: "STRING_VALUE",
|
|
63
|
+
* // Name: "STRING_VALUE",
|
|
64
|
+
* // Description: "STRING_VALUE",
|
|
65
|
+
* // KmsKeyId: "STRING_VALUE",
|
|
66
|
+
* // RotationEnabled: true || false,
|
|
67
|
+
* // RotationLambdaARN: "STRING_VALUE",
|
|
68
|
+
* // RotationRules: { // RotationRulesType
|
|
69
|
+
* // AutomaticallyAfterDays: Number("long"),
|
|
70
|
+
* // Duration: "STRING_VALUE",
|
|
71
|
+
* // ScheduleExpression: "STRING_VALUE",
|
|
72
|
+
* // },
|
|
73
|
+
* // LastRotatedDate: new Date("TIMESTAMP"),
|
|
74
|
+
* // LastChangedDate: new Date("TIMESTAMP"),
|
|
75
|
+
* // LastAccessedDate: new Date("TIMESTAMP"),
|
|
76
|
+
* // DeletedDate: new Date("TIMESTAMP"),
|
|
77
|
+
* // NextRotationDate: new Date("TIMESTAMP"),
|
|
78
|
+
* // Tags: [ // TagListType
|
|
79
|
+
* // { // Tag
|
|
80
|
+
* // Key: "STRING_VALUE",
|
|
81
|
+
* // Value: "STRING_VALUE",
|
|
82
|
+
* // },
|
|
83
|
+
* // ],
|
|
84
|
+
* // SecretVersionsToStages: { // SecretVersionsToStagesMapType
|
|
85
|
+
* // "<keys>": [ // SecretVersionStagesType
|
|
86
|
+
* // "STRING_VALUE",
|
|
87
|
+
* // ],
|
|
88
|
+
* // },
|
|
89
|
+
* // OwningService: "STRING_VALUE",
|
|
90
|
+
* // CreatedDate: new Date("TIMESTAMP"),
|
|
91
|
+
* // PrimaryRegion: "STRING_VALUE",
|
|
92
|
+
* // },
|
|
93
|
+
* // ],
|
|
94
|
+
* // NextToken: "STRING_VALUE",
|
|
95
|
+
* // };
|
|
96
|
+
*
|
|
59
97
|
* ```
|
|
60
98
|
*
|
|
61
99
|
* @param ListSecretsCommandInput - {@link ListSecretsCommandInput}
|
|
@@ -73,6 +111,8 @@ export interface ListSecretsCommandOutput extends ListSecretsResponse, __Metadat
|
|
|
73
111
|
* @throws {@link InvalidParameterException} (client fault)
|
|
74
112
|
* <p>The parameter name or value is invalid.</p>
|
|
75
113
|
*
|
|
114
|
+
* @throws {@link SecretsManagerServiceException}
|
|
115
|
+
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
76
116
|
*
|
|
77
117
|
* @example To list the secrets in your account
|
|
78
118
|
* ```javascript
|
|
@@ -44,6 +44,11 @@ export interface PutResourcePolicyCommandOutput extends PutResourcePolicyRespons
|
|
|
44
44
|
* };
|
|
45
45
|
* const command = new PutResourcePolicyCommand(input);
|
|
46
46
|
* const response = await client.send(command);
|
|
47
|
+
* // { // PutResourcePolicyResponse
|
|
48
|
+
* // ARN: "STRING_VALUE",
|
|
49
|
+
* // Name: "STRING_VALUE",
|
|
50
|
+
* // };
|
|
51
|
+
*
|
|
47
52
|
* ```
|
|
48
53
|
*
|
|
49
54
|
* @param PutResourcePolicyCommandInput - {@link PutResourcePolicyCommandInput}
|
|
@@ -85,6 +90,8 @@ export interface PutResourcePolicyCommandOutput extends PutResourcePolicyRespons
|
|
|
85
90
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
86
91
|
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
87
92
|
*
|
|
93
|
+
* @throws {@link SecretsManagerServiceException}
|
|
94
|
+
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
88
95
|
*
|
|
89
96
|
* @example To add a resource-based policy to a secret
|
|
90
97
|
* ```javascript
|
|
@@ -64,6 +64,15 @@ export interface PutSecretValueCommandOutput extends PutSecretValueResponse, __M
|
|
|
64
64
|
* };
|
|
65
65
|
* const command = new PutSecretValueCommand(input);
|
|
66
66
|
* const response = await client.send(command);
|
|
67
|
+
* // { // PutSecretValueResponse
|
|
68
|
+
* // ARN: "STRING_VALUE",
|
|
69
|
+
* // Name: "STRING_VALUE",
|
|
70
|
+
* // VersionId: "STRING_VALUE",
|
|
71
|
+
* // VersionStages: [ // SecretVersionStagesType
|
|
72
|
+
* // "STRING_VALUE",
|
|
73
|
+
* // ],
|
|
74
|
+
* // };
|
|
75
|
+
*
|
|
67
76
|
* ```
|
|
68
77
|
*
|
|
69
78
|
* @param PutSecretValueCommandInput - {@link PutSecretValueCommandInput}
|
|
@@ -113,6 +122,8 @@ export interface PutSecretValueCommandOutput extends PutSecretValueResponse, __M
|
|
|
113
122
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
114
123
|
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
115
124
|
*
|
|
125
|
+
* @throws {@link SecretsManagerServiceException}
|
|
126
|
+
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
116
127
|
*
|
|
117
128
|
* @example To store a secret value in a new version of a secret
|
|
118
129
|
* ```javascript
|
|
@@ -41,6 +41,19 @@ export interface RemoveRegionsFromReplicationCommandOutput extends RemoveRegions
|
|
|
41
41
|
* };
|
|
42
42
|
* const command = new RemoveRegionsFromReplicationCommand(input);
|
|
43
43
|
* const response = await client.send(command);
|
|
44
|
+
* // { // RemoveRegionsFromReplicationResponse
|
|
45
|
+
* // ARN: "STRING_VALUE",
|
|
46
|
+
* // ReplicationStatus: [ // ReplicationStatusListType
|
|
47
|
+
* // { // ReplicationStatusType
|
|
48
|
+
* // Region: "STRING_VALUE",
|
|
49
|
+
* // KmsKeyId: "STRING_VALUE",
|
|
50
|
+
* // Status: "InSync" || "Failed" || "InProgress",
|
|
51
|
+
* // StatusMessage: "STRING_VALUE",
|
|
52
|
+
* // LastAccessedDate: new Date("TIMESTAMP"),
|
|
53
|
+
* // },
|
|
54
|
+
* // ],
|
|
55
|
+
* // };
|
|
56
|
+
*
|
|
44
57
|
* ```
|
|
45
58
|
*
|
|
46
59
|
* @param RemoveRegionsFromReplicationCommandInput - {@link RemoveRegionsFromReplicationCommandInput}
|
|
@@ -76,6 +89,8 @@ export interface RemoveRegionsFromReplicationCommandOutput extends RemoveRegions
|
|
|
76
89
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
77
90
|
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
78
91
|
*
|
|
92
|
+
* @throws {@link SecretsManagerServiceException}
|
|
93
|
+
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
79
94
|
*
|
|
80
95
|
*/
|
|
81
96
|
export declare class RemoveRegionsFromReplicationCommand extends $Command<RemoveRegionsFromReplicationCommandInput, RemoveRegionsFromReplicationCommandOutput, SecretsManagerClientResolvedConfig> {
|
|
@@ -45,6 +45,19 @@ export interface ReplicateSecretToRegionsCommandOutput extends ReplicateSecretTo
|
|
|
45
45
|
* };
|
|
46
46
|
* const command = new ReplicateSecretToRegionsCommand(input);
|
|
47
47
|
* const response = await client.send(command);
|
|
48
|
+
* // { // ReplicateSecretToRegionsResponse
|
|
49
|
+
* // ARN: "STRING_VALUE",
|
|
50
|
+
* // ReplicationStatus: [ // ReplicationStatusListType
|
|
51
|
+
* // { // ReplicationStatusType
|
|
52
|
+
* // Region: "STRING_VALUE",
|
|
53
|
+
* // KmsKeyId: "STRING_VALUE",
|
|
54
|
+
* // Status: "InSync" || "Failed" || "InProgress",
|
|
55
|
+
* // StatusMessage: "STRING_VALUE",
|
|
56
|
+
* // LastAccessedDate: new Date("TIMESTAMP"),
|
|
57
|
+
* // },
|
|
58
|
+
* // ],
|
|
59
|
+
* // };
|
|
60
|
+
*
|
|
48
61
|
* ```
|
|
49
62
|
*
|
|
50
63
|
* @param ReplicateSecretToRegionsCommandInput - {@link ReplicateSecretToRegionsCommandInput}
|
|
@@ -80,6 +93,8 @@ export interface ReplicateSecretToRegionsCommandOutput extends ReplicateSecretTo
|
|
|
80
93
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
81
94
|
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
82
95
|
*
|
|
96
|
+
* @throws {@link SecretsManagerServiceException}
|
|
97
|
+
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
83
98
|
*
|
|
84
99
|
* @example Example
|
|
85
100
|
* ```javascript
|
|
@@ -39,6 +39,11 @@ export interface RestoreSecretCommandOutput extends RestoreSecretResponse, __Met
|
|
|
39
39
|
* };
|
|
40
40
|
* const command = new RestoreSecretCommand(input);
|
|
41
41
|
* const response = await client.send(command);
|
|
42
|
+
* // { // RestoreSecretResponse
|
|
43
|
+
* // ARN: "STRING_VALUE",
|
|
44
|
+
* // Name: "STRING_VALUE",
|
|
45
|
+
* // };
|
|
46
|
+
*
|
|
42
47
|
* ```
|
|
43
48
|
*
|
|
44
49
|
* @param RestoreSecretCommandInput - {@link RestoreSecretCommandInput}
|
|
@@ -74,6 +79,8 @@ export interface RestoreSecretCommandOutput extends RestoreSecretResponse, __Met
|
|
|
74
79
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
75
80
|
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
76
81
|
*
|
|
82
|
+
* @throws {@link SecretsManagerServiceException}
|
|
83
|
+
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
77
84
|
*
|
|
78
85
|
* @example To restore a previously deleted secret
|
|
79
86
|
* ```javascript
|
|
@@ -54,6 +54,12 @@ export interface RotateSecretCommandOutput extends RotateSecretResponse, __Metad
|
|
|
54
54
|
* };
|
|
55
55
|
* const command = new RotateSecretCommand(input);
|
|
56
56
|
* const response = await client.send(command);
|
|
57
|
+
* // { // RotateSecretResponse
|
|
58
|
+
* // ARN: "STRING_VALUE",
|
|
59
|
+
* // Name: "STRING_VALUE",
|
|
60
|
+
* // VersionId: "STRING_VALUE",
|
|
61
|
+
* // };
|
|
62
|
+
*
|
|
57
63
|
* ```
|
|
58
64
|
*
|
|
59
65
|
* @param RotateSecretCommandInput - {@link RotateSecretCommandInput}
|
|
@@ -89,6 +95,8 @@ export interface RotateSecretCommandOutput extends RotateSecretResponse, __Metad
|
|
|
89
95
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
90
96
|
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
91
97
|
*
|
|
98
|
+
* @throws {@link SecretsManagerServiceException}
|
|
99
|
+
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
92
100
|
*
|
|
93
101
|
* @example To configure rotation for a secret
|
|
94
102
|
* ```javascript
|
|
@@ -39,6 +39,10 @@ export interface StopReplicationToReplicaCommandOutput extends StopReplicationTo
|
|
|
39
39
|
* };
|
|
40
40
|
* const command = new StopReplicationToReplicaCommand(input);
|
|
41
41
|
* const response = await client.send(command);
|
|
42
|
+
* // { // StopReplicationToReplicaResponse
|
|
43
|
+
* // ARN: "STRING_VALUE",
|
|
44
|
+
* // };
|
|
45
|
+
*
|
|
42
46
|
* ```
|
|
43
47
|
*
|
|
44
48
|
* @param StopReplicationToReplicaCommandInput - {@link StopReplicationToReplicaCommandInput}
|
|
@@ -74,6 +78,8 @@ export interface StopReplicationToReplicaCommandOutput extends StopReplicationTo
|
|
|
74
78
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
75
79
|
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
76
80
|
*
|
|
81
|
+
* @throws {@link SecretsManagerServiceException}
|
|
82
|
+
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
77
83
|
*
|
|
78
84
|
*/
|
|
79
85
|
export declare class StopReplicationToReplicaCommand extends $Command<StopReplicationToReplicaCommandInput, StopReplicationToReplicaCommandOutput, SecretsManagerClientResolvedConfig> {
|
|
@@ -77,6 +77,8 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
|
|
|
77
77
|
* };
|
|
78
78
|
* const command = new TagResourceCommand(input);
|
|
79
79
|
* const response = await client.send(command);
|
|
80
|
+
* // {};
|
|
81
|
+
*
|
|
80
82
|
* ```
|
|
81
83
|
*
|
|
82
84
|
* @param TagResourceCommandInput - {@link TagResourceCommandInput}
|
|
@@ -112,6 +114,8 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
|
|
|
112
114
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
113
115
|
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
114
116
|
*
|
|
117
|
+
* @throws {@link SecretsManagerServiceException}
|
|
118
|
+
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
115
119
|
*
|
|
116
120
|
* @example To add tags to a secret
|
|
117
121
|
* ```javascript
|
|
@@ -49,6 +49,8 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
|
|
|
49
49
|
* };
|
|
50
50
|
* const command = new UntagResourceCommand(input);
|
|
51
51
|
* const response = await client.send(command);
|
|
52
|
+
* // {};
|
|
53
|
+
*
|
|
52
54
|
* ```
|
|
53
55
|
*
|
|
54
56
|
* @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
|
|
@@ -84,6 +86,8 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
|
|
|
84
86
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
85
87
|
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
86
88
|
*
|
|
89
|
+
* @throws {@link SecretsManagerServiceException}
|
|
90
|
+
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
87
91
|
*
|
|
88
92
|
* @example To remove tags from a secret
|
|
89
93
|
* ```javascript
|
|
@@ -62,6 +62,12 @@ export interface UpdateSecretCommandOutput extends UpdateSecretResponse, __Metad
|
|
|
62
62
|
* };
|
|
63
63
|
* const command = new UpdateSecretCommand(input);
|
|
64
64
|
* const response = await client.send(command);
|
|
65
|
+
* // { // UpdateSecretResponse
|
|
66
|
+
* // ARN: "STRING_VALUE",
|
|
67
|
+
* // Name: "STRING_VALUE",
|
|
68
|
+
* // VersionId: "STRING_VALUE",
|
|
69
|
+
* // };
|
|
70
|
+
*
|
|
65
71
|
* ```
|
|
66
72
|
*
|
|
67
73
|
* @param UpdateSecretCommandInput - {@link UpdateSecretCommandInput}
|
|
@@ -117,6 +123,8 @@ export interface UpdateSecretCommandOutput extends UpdateSecretResponse, __Metad
|
|
|
117
123
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
118
124
|
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
119
125
|
*
|
|
126
|
+
* @throws {@link SecretsManagerServiceException}
|
|
127
|
+
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
120
128
|
*
|
|
121
129
|
* @example To update the description of a secret
|
|
122
130
|
* ```javascript
|
|
@@ -55,6 +55,11 @@ export interface UpdateSecretVersionStageCommandOutput extends UpdateSecretVersi
|
|
|
55
55
|
* };
|
|
56
56
|
* const command = new UpdateSecretVersionStageCommand(input);
|
|
57
57
|
* const response = await client.send(command);
|
|
58
|
+
* // { // UpdateSecretVersionStageResponse
|
|
59
|
+
* // ARN: "STRING_VALUE",
|
|
60
|
+
* // Name: "STRING_VALUE",
|
|
61
|
+
* // };
|
|
62
|
+
*
|
|
58
63
|
* ```
|
|
59
64
|
*
|
|
60
65
|
* @param UpdateSecretVersionStageCommandInput - {@link UpdateSecretVersionStageCommandInput}
|
|
@@ -93,6 +98,8 @@ export interface UpdateSecretVersionStageCommandOutput extends UpdateSecretVersi
|
|
|
93
98
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
94
99
|
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
95
100
|
*
|
|
101
|
+
* @throws {@link SecretsManagerServiceException}
|
|
102
|
+
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
96
103
|
*
|
|
97
104
|
* @example To add a staging label attached to a version of a secret
|
|
98
105
|
* ```javascript
|
|
@@ -53,6 +53,16 @@ export interface ValidateResourcePolicyCommandOutput extends ValidateResourcePol
|
|
|
53
53
|
* };
|
|
54
54
|
* const command = new ValidateResourcePolicyCommand(input);
|
|
55
55
|
* const response = await client.send(command);
|
|
56
|
+
* // { // ValidateResourcePolicyResponse
|
|
57
|
+
* // PolicyValidationPassed: true || false,
|
|
58
|
+
* // ValidationErrors: [ // ValidationErrorsType
|
|
59
|
+
* // { // ValidationErrorsEntry
|
|
60
|
+
* // CheckName: "STRING_VALUE",
|
|
61
|
+
* // ErrorMessage: "STRING_VALUE",
|
|
62
|
+
* // },
|
|
63
|
+
* // ],
|
|
64
|
+
* // };
|
|
65
|
+
*
|
|
56
66
|
* ```
|
|
57
67
|
*
|
|
58
68
|
* @param ValidateResourcePolicyCommandInput - {@link ValidateResourcePolicyCommandInput}
|
|
@@ -91,6 +101,8 @@ export interface ValidateResourcePolicyCommandOutput extends ValidateResourcePol
|
|
|
91
101
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
92
102
|
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
93
103
|
*
|
|
104
|
+
* @throws {@link SecretsManagerServiceException}
|
|
105
|
+
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
94
106
|
*
|
|
95
107
|
* @example To validate a resource-based policy to a secret
|
|
96
108
|
* ```javascript
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-secrets-manager",
|
|
3
3
|
"description": "AWS SDK for JavaScript Secrets Manager Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.326.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -21,33 +21,33 @@
|
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
23
23
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
24
|
+
"@aws-sdk/client-sts": "3.326.0",
|
|
25
25
|
"@aws-sdk/config-resolver": "3.310.0",
|
|
26
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
26
|
+
"@aws-sdk/credential-provider-node": "3.326.0",
|
|
27
27
|
"@aws-sdk/fetch-http-handler": "3.310.0",
|
|
28
28
|
"@aws-sdk/hash-node": "3.310.0",
|
|
29
29
|
"@aws-sdk/invalid-dependency": "3.310.0",
|
|
30
|
-
"@aws-sdk/middleware-content-length": "3.
|
|
31
|
-
"@aws-sdk/middleware-endpoint": "3.
|
|
32
|
-
"@aws-sdk/middleware-host-header": "3.
|
|
33
|
-
"@aws-sdk/middleware-logger": "3.
|
|
34
|
-
"@aws-sdk/middleware-recursion-detection": "3.
|
|
35
|
-
"@aws-sdk/middleware-retry": "3.
|
|
36
|
-
"@aws-sdk/middleware-serde": "3.
|
|
37
|
-
"@aws-sdk/middleware-signing": "3.
|
|
38
|
-
"@aws-sdk/middleware-stack": "3.
|
|
39
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
30
|
+
"@aws-sdk/middleware-content-length": "3.325.0",
|
|
31
|
+
"@aws-sdk/middleware-endpoint": "3.325.0",
|
|
32
|
+
"@aws-sdk/middleware-host-header": "3.325.0",
|
|
33
|
+
"@aws-sdk/middleware-logger": "3.325.0",
|
|
34
|
+
"@aws-sdk/middleware-recursion-detection": "3.325.0",
|
|
35
|
+
"@aws-sdk/middleware-retry": "3.325.0",
|
|
36
|
+
"@aws-sdk/middleware-serde": "3.325.0",
|
|
37
|
+
"@aws-sdk/middleware-signing": "3.325.0",
|
|
38
|
+
"@aws-sdk/middleware-stack": "3.325.0",
|
|
39
|
+
"@aws-sdk/middleware-user-agent": "3.325.0",
|
|
40
40
|
"@aws-sdk/node-config-provider": "3.310.0",
|
|
41
41
|
"@aws-sdk/node-http-handler": "3.321.1",
|
|
42
42
|
"@aws-sdk/protocol-http": "3.310.0",
|
|
43
|
-
"@aws-sdk/smithy-client": "3.
|
|
43
|
+
"@aws-sdk/smithy-client": "3.325.0",
|
|
44
44
|
"@aws-sdk/types": "3.310.0",
|
|
45
45
|
"@aws-sdk/url-parser": "3.310.0",
|
|
46
46
|
"@aws-sdk/util-base64": "3.310.0",
|
|
47
47
|
"@aws-sdk/util-body-length-browser": "3.310.0",
|
|
48
48
|
"@aws-sdk/util-body-length-node": "3.310.0",
|
|
49
|
-
"@aws-sdk/util-defaults-mode-browser": "3.
|
|
50
|
-
"@aws-sdk/util-defaults-mode-node": "3.
|
|
49
|
+
"@aws-sdk/util-defaults-mode-browser": "3.325.0",
|
|
50
|
+
"@aws-sdk/util-defaults-mode-node": "3.325.0",
|
|
51
51
|
"@aws-sdk/util-endpoints": "3.319.0",
|
|
52
52
|
"@aws-sdk/util-retry": "3.310.0",
|
|
53
53
|
"@aws-sdk/util-user-agent-browser": "3.310.0",
|