Module Values.GetSecretValueResponseSource

Retrieves the contents of the encrypted fields SecretString or SecretBinary from the specified version of a secret, whichever contains content. To retrieve the values for a group of secrets, call BatchGetSecretValue. 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.

Sourcetype nonrec t = {
  1. aRN : SecretARNType.t option;
    (*

    The ARN of the secret.

    *)
  2. name : SecretNameType.t option;
    (*

    The friendly name of the secret.

    *)
  3. versionId : SecretVersionIdType.t option;
    (*

    The unique identifier of this version of the secret.

    *)
  4. secretBinary : SecretBinaryType.t option;
    (*

    The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. When you retrieve a SecretBinary using the HTTP API, the Python SDK, or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not encoded. If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in SecretString instead. Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

    *)
  5. secretString : SecretStringType.t option;
    (*

    The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console. If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs. Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

    *)
  6. versionStages : SecretVersionStagesType.t option;
    (*

    A list of all of the staging labels currently attached to this version of the secret.

    *)
  7. createdDate : CreatedDateType.t option;
    (*

    The date and time that this version of the secret was created. If you don't specify which version in VersionId or VersionStage, then Secrets Manager uses the AWSCURRENT version.

    *)
}
Sourcetype nonrec error = [
  1. | `DecryptionFailure of DecryptionFailure.t
  2. | `InternalServiceError of InternalServiceError.t
  3. | `InvalidParameterException of InvalidParameterException.t
  4. | `InvalidRequestException of InvalidRequestException.t
  5. | `ResourceNotFoundException of ResourceNotFoundException.t
  6. | `Unknown_operation_error of string * string option
]
Sourceval make : ?aRN:??? -> ?name:??? -> ?versionId:??? -> ?secretBinary:??? -> ?secretString:??? -> ?versionStages:??? -> ?createdDate:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `DecryptionFailure of DecryptionFailure.t | `InternalServiceError of InternalServiceError.t | `InvalidParameterException of InvalidParameterException.t | `InvalidRequestException of InvalidRequestException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `DecryptionFailure of DecryptionFailure.t | `InternalServiceError of InternalServiceError.t | `InvalidParameterException of InvalidParameterException.t | `InvalidRequestException of InvalidRequestException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Blob of SecretBinaryType.t | `List of [> `String of SecretVersionStageType.t ] list | `String of SecretARNType.t | `Timestamp of CreatedDateType.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t