Smaws_Client_SecretsManager.TypesSecrets Manager can't find the resource that you asked for.
The resource policy has syntax errors.
A parameter value is not valid for the current state of the resource.
Possible causes:
The parameter name or value is invalid.
An error occurred on the server side.
type nonrec validation_errors_entry = {error_message : error_message option;Displays error messages if validation encounters problems during validation of the resource policy.
*)check_name : name_type option;Checks the name of the policy.
*)}Displays errors that occurred during validation of the resource policy.
type nonrec validation_errors_type = validation_errors_entry listtype nonrec validate_resource_policy_response = {validation_errors : validation_errors_type option;Validation errors if your policy didn't pass validation.
*)policy_validation_passed : boolean_type option;True if your policy passes validation, otherwise false.
*)}type nonrec validate_resource_policy_request = {resource_policy : non_empty_resource_policy_type;A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For example policies, see Permissions policy examples.
*)secret_id : secret_id_type option;The ARN or name of the secret with the resource-based policy you want to validate.
*)}The request failed because it would exceed one of the Secrets Manager quotas.
type nonrec update_secret_version_stage_response = {name : secret_name_type option;The name of the secret that was updated.
*)ar_n : secret_arn_type option;The ARN of the secret that was updated.
*)}type nonrec update_secret_version_stage_request = {move_to_version_id : secret_version_id_type option;The ID of the version to add the staging label to. To remove a label from a version, then do not specify this parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId parameter.
remove_from_version_id : secret_version_id_type option;The ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.
*)version_stage : secret_version_stage_type;The staging label to add to this version.
*)secret_id : secret_id_type;The ARN or the name of the secret with the version and staging labelsto modify.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
*)}A resource with the ID you requested already exists.
The request failed because you did not complete all the prerequisite steps.
Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the KMS key is available, enabled, and not in an invalid state. For more information, see Key state: Effect on your KMS key.
Secrets Manager can't decrypt the protected secret text using the provided KMS key.
type nonrec update_secret_response = {version_id : secret_version_id_type option;If Secrets Manager created a new version of the secret during this operation, then VersionId contains the unique identifier of the new version.
name : secret_name_type option;The name of the secret that was updated.
*)ar_n : secret_arn_type option;The ARN of the secret that was updated.
*)}type nonrec update_secret_request = {type_ : medea_type_type option;The exact string that identifies the third-party partner that holds the external secret. For more information, see Managed external secret partners.
*)secret_string : secret_string_type option;The text data to encrypt and store in the new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
Either SecretBinary or SecretString must have a value, but not both.
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.
*)secret_binary : secret_binary_type option;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 SecretBinary or SecretString must have a value, but not both.
You can't access this parameter in the Secrets Manager console.
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.
*)kms_key_id : kms_key_id_type option;The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt new secret versions as well as any existing versions with the staging labels AWSCURRENT, AWSPENDING, or AWSPREVIOUS. If you don't have kms:Encrypt permission to the new key, Secrets Manager does not re-encrypt existing secret versions with the new key. For more information about versions and staging labels, see Concepts: Version.
A key alias is always prefixed by alias/, for example alias/aws/secretsmanager. For more information, see About aliases.
If you set this to an empty string, 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.
You can only use the Amazon Web Services managed key aws/secretsmanager if you call this operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user making the call must have permissions to both the secret and the KMS key in their respective accounts.
description : description_type option;The description of the secret.
*)client_request_token : client_request_token_type option;If you include SecretString or SecretBinary, then Secrets Manager creates a new 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 generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken and include it 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.
*)secret_id : secret_id_type;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.
*)}type nonrec tag_key_list_type = tag_key_type listtype nonrec untag_resource_request = {tag_keys : tag_key_list_type;A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.
This parameter requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
*)secret_id : secret_id_type;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.
*)}type nonrec tag = {value : tag_value_type option;The string value associated with the key of the tag.
*)key : tag_key_type option;The key identifier, or name, of the tag.
*)}A structure that contains information about a tag.
type nonrec tag_list_type = tag listtype nonrec tag_resource_request = {secret_id : secret_id_type;The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly 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.
*)}type nonrec stop_replication_to_replica_response = {ar_n : secret_arn_type option;The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.
*)}type nonrec stop_replication_to_replica_request = {secret_id : secret_id_type;The name of the secret or the replica ARN. The replica ARN is the same as the original primary secret ARN expect the Region is changed to the replica Region.
*)}type nonrec rotate_secret_response = {version_id : secret_version_id_type option;The ID of the new version of the secret.
*)name : secret_name_type option;The name of the secret.
*)ar_n : secret_arn_type option;The ARN of the secret.
*)}type nonrec automatically_rotate_after_days_type = Smaws_Lib.CoreTypes.Int64.ttype nonrec rotation_rules_type = {schedule_expression : schedule_expression_type option;A cron() or rate() expression that defines the schedule for rotating your secret. Secrets Manager rotation schedules use UTC time zone. Secrets Manager rotates your secret any time during a rotation window.
Secrets Manager rate() expressions represent the interval in hours or days that you want to rotate your secret, for example rate(12 hours) or rate(10 days). You can rotate a secret as often as every four hours. If you use a rate() expression, the rotation window starts at midnight. For a rate in hours, the default rotation window closes after one hour. For a rate in days, the default rotation window closes at the end of the day. You can set the Duration to change the rotation window. The rotation window must not extend into the next UTC day or into the next rotation window.
You can use a cron() expression to create a rotation schedule that is more detailed than a rotation interval. For more information, including examples, see Schedule expressions in Secrets Manager rotation in the Secrets Manager Users Guide. For a cron expression that represents a schedule in hours, the default rotation window closes after one hour. For a cron expression that represents a schedule in days, the default rotation window closes at the end of the day. You can set the Duration to change the rotation window. The rotation window must not extend into the next UTC day or into the next rotation window.
duration : duration_type option;The length of the rotation window in hours, for example 3h for a three hour window. Secrets Manager rotates your secret at any time during this window. The window must not extend into the next rotation window or the next UTC day. The window starts according to the ScheduleExpression. If you don't specify a Duration, for a ScheduleExpression in hours, the window automatically closes after one hour. For a ScheduleExpression in days, the window automatically closes at the end of the UTC day. For more information, including examples, see Schedule expressions in Secrets Manager rotation in the Secrets Manager Users Guide.
automatically_after_days : automatically_rotate_after_days_type option;The number of days between rotations of the secret. You can use this value to check that your secret meets your compliance guidelines for how often secrets must be rotated. If you use this field to set the rotation schedule, Secrets Manager calculates the next rotation date based on the previous rotation. Manually updating the secret value by calling PutSecretValue or UpdateSecret is considered a valid rotation.
In DescribeSecret and ListSecrets, this value is calculated from the rotation schedule after every successful rotation. In RotateSecret, you can set the rotation schedule in RotationRules with AutomaticallyAfterDays or ScheduleExpression, but not both. To set a rotation schedule in hours, use ScheduleExpression.
}A structure that defines the rotation configuration for the secret.
type nonrec external_secret_rotation_metadata_item = {value : external_secret_rotation_metadata_item_value_type option;The value of the specified item.
*)key : external_secret_rotation_metadata_item_key_type option;The key that identifies the item.
*)}The metadata needed to successfully rotate a managed external secret. A list of key value pairs in JSON format specified by the partner. For more information, see Managed external secret partners.
type nonrec external_secret_rotation_metadata_type =
external_secret_rotation_metadata_item listtype nonrec rotate_secret_request = {rotate_immediately : boolean_type option;Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window. The rotation schedule is defined in RotateSecretRequest$RotationRules.
The default for RotateImmediately is true. If you don't specify this value, Secrets Manager rotates the secret immediately.
If you set RotateImmediately to false, Secrets Manager tests the rotation configuration by running the testSecret step of the Lambda rotation function. This test creates an AWSPENDING version of the secret and then removes it.
When changing an existing rotation schedule and setting RotateImmediately to false:
AutomaticallyAfterDays or a ScheduleExpression with rate(), the previously scheduled rotation might still occur.ScheduleExpression with cron() for granular control over rotation windows.Rotation is an asynchronous process. For more information, see How rotation works.
*)external_secret_rotation_role_arn : role_arn_type option;The Amazon Resource Name (ARN) of the role that allows Secrets Manager to rotate a secret held by a third-party partner. For more information, see Security and permissions.
*)external_secret_rotation_metadata : external_secret_rotation_metadata_type
option;The metadata needed to successfully rotate a managed external secret. A list of key value pairs in JSON format specified by the partner. For more information about the required information, see Using Secrets Manager managed external secrets
*)rotation_rules : rotation_rules_type option;A structure that defines the rotation configuration for this secret.
When changing an existing rotation schedule and setting RotateImmediately to false:
AutomaticallyAfterDays or a ScheduleExpression with rate(), the previously scheduled rotation might still occur.ScheduleExpression with cron() for granular control over rotation windows.rotation_lambda_ar_n : rotation_lambda_arn_type option;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.
*)client_request_token : client_request_token_type option;A unique identifier for the new version of the secret. 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.
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 generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken and include it 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.
*)secret_id : secret_id_type;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.
*)}type nonrec restore_secret_response = {name : secret_name_type option;The name of the secret that was restored.
*)ar_n : secret_arn_type option;The ARN of the secret that was restored.
*)}type nonrec restore_secret_request = {secret_id : secret_id_type;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.
*)}type nonrec replication_status_type = {last_accessed_date : last_accessed_date_type option;The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.
*)status_message : status_message_type option;Status message such as "Secret with this name already exists in this region".
*)status : status_type option;The status can be InProgress, Failed, or InSync.
kms_key_id : kms_key_id_type option;Can be an ARN, Key ID, or Alias.
region : region_type option;The Region where replication occurs.
*)}A replication object consisting of a RegionReplicationStatus object and includes a Region, KMSKeyId, status, and status message.
type nonrec replication_status_list_type = replication_status_type listtype nonrec replicate_secret_to_regions_response = {replication_status : replication_status_list_type option;The status of replication.
*)ar_n : secret_arn_type option;The ARN of the primary secret.
*)}type nonrec replica_region_type = {kms_key_id : kms_key_id_type option;The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses aws/secretsmanager.
region : region_type option;}A custom type that specifies a Region and the KmsKeyId for a replica secret.
type nonrec add_replica_region_list_type = replica_region_type listtype nonrec replicate_secret_to_regions_request = {force_overwrite_replica_secret : boolean_type option;Specifies whether to overwrite a secret with the same name in the destination Region. By default, secrets aren't overwritten.
*)add_replica_regions : add_replica_region_list_type;A list of Regions in which to replicate the secret.
*)secret_id : secret_id_type;The ARN or name of the secret to replicate.
*)}type nonrec remove_regions_from_replication_response = {replication_status : replication_status_list_type option;The status of replicas for this secret after you remove Regions.
*)ar_n : secret_arn_type option;The ARN of the primary secret.
*)}type nonrec remove_replica_region_list_type = region_type listtype nonrec remove_regions_from_replication_request = {remove_replica_regions : remove_replica_region_list_type;The Regions of the replicas to remove.
*)secret_id : secret_id_type;The ARN or name of the secret.
*)}type nonrec secret_version_stages_type = secret_version_stage_type listtype nonrec put_secret_value_response = {version_stages : secret_version_stages_type option;The list of staging labels that are currently attached to this version of the secret. Secrets Manager uses staging labels to track a version as it progresses through the secret rotation process.
*)version_id : secret_version_id_type option;The unique identifier of the version of the secret.
*)name : secret_name_type option;The name of the secret.
*)ar_n : secret_arn_type option;The ARN of the secret.
*)}type nonrec put_secret_value_request = {rotation_token : rotation_token_type option;A unique identifier that indicates the source of the request. Required for secret rotations using an IAM assumed role or cross-account rotation, in which you rotate a secret in one account by using a Lambda rotation function in another account. In both cases, the rotation function assumes an IAM role to call Secrets Manager, and then Secrets Manager validates the identity using the token. For more information, see How rotation works and Rotation by Lambda functions.
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.
*)version_stages : secret_version_stages_type option;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.
secret_string : secret_string_type option;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.
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.
*)secret_binary : secret_binary_type option;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.
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.
*)client_request_token : client_request_token_type option;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. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.
If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken and include it 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.
ClientRequestToken value isn't already associated with a version of the secret then a new version of the secret is created.SecretString or SecretBinary values are the same as those in the request then the request is ignored. The operation is idempotent.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.
secret_id : secret_id_type;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.
}The BlockPublicPolicy parameter is set to true, and the resource policy did not prevent broad access to the secret.
type nonrec put_resource_policy_response = {name : name_type option;The name of the secret.
*)ar_n : secret_arn_type option;The ARN of the secret.
*)}type nonrec put_resource_policy_request = {block_public_policy : boolean_type option;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.
Resource policy validation and the BlockPublicPolicy parameter help protect your resources by preventing public access from being granted through the resource policies that are directly attached to your secrets. In addition to using these features, carefully inspect the following policies to confirm that they do not grant public access:
To review permissions to your secrets, see Determine who has permissions to your secrets.
*)resource_policy : non_empty_resource_policy_type;A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.
*)secret_id : secret_id_type;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.
*)}The NextToken value is invalid.
type nonrec kms_key_id_list_type = kms_key_id_type listtype nonrec secret_versions_list_entry = {kms_key_ids : kms_key_id_list_type option;The KMS keys used to encrypt the secret version.
*)created_date : created_date_type option;The date and time this version of the secret was created.
*)last_accessed_date : last_accessed_date_type option;The date that this version of the secret was last accessed. Note that the resolution of this field is at the date level and does not include the time.
*)version_stages : secret_version_stages_type option;An array of staging labels that are currently associated with this version of the secret.
*)version_id : secret_version_id_type option;The unique version identifier of this version of the secret.
*)}A structure that contains information about one version of a secret.
type nonrec secret_versions_list_type = secret_versions_list_entry listtype nonrec list_secret_version_ids_response = {name : secret_name_type option;The name of the secret.
*)ar_n : secret_arn_type option;The ARN of the secret.
*)next_token : next_token_type option;Secrets Manager includes this value if there's more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call ListSecretVersionIds again with this value.
versions : secret_versions_list_type option;A list of the versions of the secret.
*)}type nonrec list_secret_version_ids_request = {include_deprecated : boolean_type option;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.
*)next_token : next_token_type option;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.
max_results : max_results_type option;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.
secret_id : secret_id_type;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.
*)}type nonrec secret_versions_to_stages_map_type =
(secret_version_id_type * secret_version_stages_type) listtype nonrec secret_list_entry = {primary_region : region_type option;The Region where Secrets Manager originated the secret.
*)created_date : timestamp_type option;The date and time when a secret was created.
*)owning_service : owning_service_type option;Returns the name of the service that created the secret.
*)secret_versions_to_stages : secret_versions_to_stages_map_type option;A list of all of the currently assigned SecretVersionStage staging labels and the SecretVersionId attached to each one. Staging labels are used to keep track of the different versions during the rotation process.
A version that does not have any SecretVersionStage is considered deprecated and subject to deletion. Such versions are not included in this list.
next_rotation_date : next_rotation_date_type option;The next rotation is scheduled to occur on or before this date. If the secret isn't configured for rotation or rotation has been disabled, Secrets Manager returns null.
*)deleted_date : deleted_date_type option;The date and time the deletion of the secret occurred. Not present on active secrets. The secret can be recovered until the number of days in the recovery window has passed, as specified in the RecoveryWindowInDays parameter of the DeleteSecret operation.
last_accessed_date : last_accessed_date_type option;The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.
*)last_changed_date : last_changed_date_type option;The last date and time that this secret was modified in any way.
*)last_rotated_date : last_rotated_date_type option;The most recent date and time that the Secrets Manager rotation process was successfully completed. This value is null if the secret hasn't ever rotated.
*)external_secret_rotation_role_arn : role_arn_type option;The role that Secrets Manager assumes to call APIs required to perform the rotation. For more information about the required information, see Managed external secrets partners.
*)external_secret_rotation_metadata : external_secret_rotation_metadata_type
option;The metadata needed to successfully rotate a managed external secret. A list of key value pairs in JSON format specified by the partner. For more information about the required information, see Managed external secrets partners.
*)rotation_rules : rotation_rules_type option;A structure that defines the rotation configuration for the secret.
*)rotation_lambda_ar_n : rotation_lambda_arn_type option;The ARN of an Amazon Web Services Lambda function invoked by Secrets Manager to rotate and expire the secret either automatically per the schedule or manually by a call to RotateSecret.
rotation_enabled : rotation_enabled_type option;Indicates whether automatic, scheduled rotation is enabled for this secret.
*)kms_key_id : kms_key_id_type option;The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager, this field is omitted.
description : description_type option;The user-provided description of the secret.
*)type_ : medea_type_type option;The exact string that identifies the third-party partner that holds the external secret. For more information, see Managed external secret partners.
*)name : secret_name_type option;The friendly name of the secret.
*)ar_n : secret_arn_type option;The Amazon Resource Name (ARN) of the secret.
*)}A structure that contains the details about a secret. It does not include the encrypted SecretString and SecretBinary values. To get those values, use GetSecretValue .
type nonrec secret_list_type = secret_list_entry listtype nonrec list_secrets_response = {next_token : next_token_type option;Secrets Manager includes this value if there's more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call ListSecrets again with this value.
secret_list : secret_list_type option;A list of the secrets in the account.
*)}type nonrec filter_values_string_list = filter_value_string_type listtype nonrec filter = {values : filter_values_string_list option;The keyword to filter for.
You can prefix your search value with an exclamation mark (!) in order to perform negation filters.
key : filter_name_string_type option;The following are keys you can use:
}Allows you to add filters when you use the search function in Secrets Manager. For more information, see Find secrets in Secrets Manager.
type nonrec filters_list_type = filter listtype nonrec list_secrets_request = {sort_by : sort_by_type option;If not specified, secrets are listed by CreatedDate.
sort_order : sort_order_type option;Secrets are listed by CreatedDate.
filters : filters_list_type option;The filters to apply to the list of secrets.
*)next_token : next_token_type option;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.
max_results : max_results_type option;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.
include_planned_deletion : boolean_type option;Specifies whether to include secrets scheduled for deletion. By default, secrets scheduled for deletion aren't included.
*)}type nonrec get_secret_value_response = {created_date : created_date_type 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.
version_stages : secret_version_stages_type option;A list of all of the staging labels currently attached to this version of the secret.
*)secret_string : secret_string_type 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.
*)secret_binary : secret_binary_type 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.
*)version_id : secret_version_id_type option;The unique identifier of this version of the secret.
*)name : secret_name_type option;The friendly name of the secret.
*)ar_n : secret_arn_type option;The ARN of the secret.
*)}type nonrec get_secret_value_request = {version_stage : secret_version_stage_type option;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.
version_id : secret_version_id_type option;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.
*)secret_id : secret_id_type;The ARN or name of the secret to retrieve. To retrieve a secret from another account, you must use an ARN.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
*)}type nonrec get_resource_policy_response = {resource_policy : non_empty_resource_policy_type option;A JSON-formatted string that contains the permissions policy attached to the secret. For more information about permissions policies, see Authentication and access control for Secrets Manager.
*)name : name_type option;The name of the secret that the resource-based policy was retrieved for.
*)ar_n : secret_arn_type option;The ARN of the secret that the resource-based policy was retrieved for.
*)}type nonrec get_resource_policy_request = {secret_id : secret_id_type;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.
*)}type nonrec get_random_password_response = {random_password : random_password_type option;A string with the password.
*)}type nonrec password_length_type = Smaws_Lib.CoreTypes.Int64.ttype nonrec get_random_password_request = {require_each_included_type : require_each_included_type_type option;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.
*)include_space : include_space_type option;Specifies whether to include the space character. If you include this switch, the password can contain space characters.
*)exclude_lowercase : exclude_lowercase_type option;Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.
*)exclude_uppercase : exclude_uppercase_type option;Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.
*)exclude_punctuation : exclude_punctuation_type option;Specifies whether to exclude the following punctuation characters from the password: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~. If you don't include this switch, the password can contain punctuation.
exclude_numbers : exclude_numbers_type option;Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.
*)exclude_characters : exclude_characters_type option;A string of the characters that you don't want in the password.
*)password_length : password_length_type option;The length of the password. If you don't include this parameter, the default length is 32 characters.
*)}type nonrec describe_secret_response = {replication_status : replication_status_list_type option;A list of the replicas of this secret and their status:
Failed, which indicates that the replica was not created.InProgress, which indicates that Secrets Manager is in the process of creating the replica.InSync, which indicates that the replica was created.primary_region : region_type option;The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in ReplicationStatus.
created_date : timestamp_type option;The date the secret was created.
*)owning_service : owning_service_type option;The ID of the service that created this secret. For more information, see Secrets managed by other Amazon Web Services services.
*)version_ids_to_stages : secret_versions_to_stages_map_type option;A list of the versions of the secret that have staging labels attached. Versions that don't have staging labels are considered deprecated and Secrets Manager can delete them.
Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging labels for rotation are:
AWSCURRENT, which indicates the current version of the secret.AWSPENDING, which indicates the version of the secret that contains new secret information that will become the next current version when rotation finishes.
During rotation, Secrets Manager creates an AWSPENDING version ID before creating the new secret version. To check if a secret version exists, call GetSecretValue.
AWSPREVIOUS, which indicates the previous current version of the secret. You can use this as the last known good version.For more information about rotation and staging labels, see How rotation works.
*)next_rotation_date : next_rotation_date_type option;The next rotation is scheduled to occur on or before this date. If the secret isn't configured for rotation or rotation has been disabled, Secrets Manager returns null. If rotation fails, Secrets Manager retries the entire rotation process multiple times. If rotation is unsuccessful, this date may be in the past.
This date represents the latest date that rotation will occur, but it is not an approximate rotation date. In some cases, for example if you turn off automatic rotation and then turn it back on, the next rotation may occur much sooner than this date.
*)deleted_date : deleted_date_type option;The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.
last_accessed_date : last_accessed_date_type option;The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.
*)last_changed_date : last_changed_date_type option;The last date and time that this secret was modified in any way.
*)last_rotated_date : last_rotated_date_type option;The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation or rotation has been disabled, Secrets Manager returns null.
*)external_secret_rotation_role_arn : role_arn_type option;The Amazon Resource Name (ARN) of the role that allows Secrets Manager to rotate a secret held by a third-party partner. For more information, see Security and permissions.
*)external_secret_rotation_metadata : external_secret_rotation_metadata_type
option;The metadata needed to successfully rotate a managed external secret. A list of key value pairs in JSON format specified by the partner. For more information about the required information, see Managed external secrets partners.
*)rotation_rules : rotation_rules_type option;The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had rotation turned on, this field is omitted.
*)rotation_lambda_ar_n : rotation_lambda_arn_type option;The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
*)rotation_enabled : rotation_enabled_type option;Specifies whether automatic rotation is turned on for this secret. If the secret has never been configured for rotation, Secrets Manager returns null.
To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
kms_key_id : kms_key_id_type option;The key ID or alias ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager, this field is omitted. Secrets created using the console use an KMS key ID.
description : description_type option;The description of the secret.
*)type_ : medea_type_type option;The exact string that identifies the partner that holds the external secret. For more information, see Using Secrets Manager managed external secrets.
*)name : secret_name_type option;The name of the secret.
*)ar_n : secret_arn_type option;The ARN of the secret.
*)}type nonrec describe_secret_request = {secret_id : secret_id_type;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.
*)}type nonrec delete_secret_response = {deletion_date : deletion_date_type option;The date and time after which this secret Secrets Manager can permanently delete this secret, and it can no longer be restored. This value is the date and time of the delete request plus the number of days in RecoveryWindowInDays.
name : secret_name_type option;The name of the secret.
*)ar_n : secret_arn_type option;The ARN of the secret.
*)}type nonrec recovery_window_in_days_type = Smaws_Lib.CoreTypes.Int64.ttype nonrec delete_secret_request = {force_delete_without_recovery : boolean_type option;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.
recovery_window_in_days : recovery_window_in_days_type option;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.
secret_id : secret_id_type;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.
*)}type nonrec delete_resource_policy_response = {name : name_type option;The name of the secret that the resource-based policy was deleted for.
*)ar_n : secret_arn_type option;The ARN of the secret that the resource-based policy was deleted for.
*)}type nonrec delete_resource_policy_request = {secret_id : secret_id_type;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.
*)}type nonrec create_secret_response = {replication_status : replication_status_list_type option;A list of the replicas of this secret and their status:
Failed, which indicates that the replica was not created.InProgress, which indicates that Secrets Manager is in the process of creating the replica.InSync, which indicates that the replica was created.version_id : secret_version_id_type option;The unique identifier associated with the version of the new secret.
*)name : secret_name_type option;The name of the new secret.
*)ar_n : secret_arn_type option;The ARN of the new secret. The ARN includes the name of the secret followed by six random characters. This ensures that if you create a new secret with the same name as a deleted secret, then users with access to the old secret don't get access to the new secret because the ARNs are different.
*)}type nonrec create_secret_request = {type_ : medea_type_type option;The exact string that identifies the partner that holds the external secret. For more information, see Using Secrets Manager managed external secrets.
*)force_overwrite_replica_secret : boolean_type option;Specifies whether to overwrite a secret with the same name in the destination Region. By default, secrets aren't overwritten.
*)add_replica_regions : add_replica_region_list_type option;A list of Regions and KMS keys to replicate secrets.
*)secret_string : secret_string_type option;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.
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.
*)secret_binary : secret_binary_type option;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.
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.
*)kms_key_id : kms_key_id_type option;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.
description : description_type option;The description of the secret.
*)client_request_token : client_request_token_type option;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 generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken and include it 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.
ClientRequestToken value isn't already associated with a version of the secret then a new version of the secret is created.SecretString and SecretBinary values are the same as those in the request, then the request is ignored.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.
name : name_type;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.
*)}type nonrec cancel_rotate_secret_response = {version_id : secret_version_id_type option;The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion. We recommend that you remove the VersionStage value AWSPENDING from this version so that Secrets Manager can delete it. Failing to clean up a cancelled rotation can block you from starting future rotations.
name : secret_name_type option;The name of the secret.
*)ar_n : secret_arn_type option;The ARN of the secret.
*)}type nonrec cancel_rotate_secret_request = {secret_id : secret_id_type;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.
*)}type nonrec secret_value_entry = {created_date : created_date_type option;The date the secret was created.
*)version_stages : secret_version_stages_type option;A list of all of the staging labels currently attached to this version of the secret.
*)secret_string : secret_string_type option;The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.
*)secret_binary : secret_binary_type option;The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. The parameter represents the binary data as a base64-encoded string.
*)version_id : secret_version_id_type option;The unique version identifier of this version of the secret.
*)name : secret_name_type option;The friendly name of the secret.
*)ar_n : secret_arn_type option;The Amazon Resource Name (ARN) of the secret.
*)}A structure that contains the secret value and other details for a secret.
type nonrec secret_values_type = secret_value_entry listtype nonrec api_error_type = {message : error_message option;A message describing the error.
*)error_code : error_code option;The error Secrets Manager encountered while retrieving an individual secret as part of BatchGetSecretValue, for example ResourceNotFoundException,InvalidParameterException, InvalidRequestException, DecryptionFailure, or AccessDeniedException.
secret_id : secret_id_type option;The ARN or name of the secret.
*)}The error Secrets Manager encountered while retrieving an individual secret as part of BatchGetSecretValue.
type nonrec api_error_list_type = api_error_type listtype nonrec batch_get_secret_value_response = {errors : api_error_list_type option;A list of errors Secrets Manager encountered while attempting to retrieve individual secrets.
*)next_token : next_token_type option;Secrets Manager includes this value if there's more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call BatchGetSecretValue again with this value.
secret_values : secret_values_type option;A list of secret values.
*)}type nonrec secret_id_list_type = secret_id_type listtype nonrec batch_get_secret_value_request = {next_token : next_token_type option;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 BatchGetSecretValue again with this value.
max_results : max_results_batch_type option;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 BatchGetSecretValue again with the value from NextToken. To use this parameter, you must also use the Filters parameter.
filters : filters_list_type option;The filters to choose which secrets to retrieve. You must include Filters or SecretIdList, but not both.
secret_id_list : secret_id_list_type option;The ARN or names of the secrets to retrieve. You must include Filters or SecretIdList, but not both.
}