AwsSecretsManagerApi
Attributes
- Graph
-
- Supertypes
- Self type
-
AwsSecretsManagerApi.type
Members list
Value members
Concrete methods
Retrieves the contents of the encrypted fields SecretString from the specified version of a secret.
Retrieves the contents of the encrypted fields SecretString from the specified version of a secret.
To retrieve the values for a group of secrets, call BatchGetSecretValue.
**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.
Value parameters
- secretId
-
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.
Attributes
Retrieves the contents of the encrypted fields SecretString or SecretBinary for up to 20 secrets. To retrieve a single secret, call GetSecretValue.
Retrieves the contents of the encrypted fields SecretString or SecretBinary for up to 20 secrets. To retrieve a single secret, call GetSecretValue.
To choose which secrets to retrieve, you can specify a list of secrets by name or ARN, or you can use filters. If Secrets Manager encounters errors such as AccessDeniedException while attempting to retrieve any of the secrets, you can see the errors in Errors in the response.
Value parameters
- secretIds
-
The ARN or names of the secrets to retrieve
Attributes
Retrieves the contents of the encrypted fields SecretBinary from the specified version of a secret.
Retrieves the contents of the encrypted fields SecretBinary from the specified version of a secret.
To retrieve the values for a group of secrets, call BatchGetSecretValue.
**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.
Value parameters
- secretId
-
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.
Attributes
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.
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.
Value parameters
- secret
-
The text to encrypt and store in the new version of the secret.
- secretId
-
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.