Smaws_Client_SecretsManager (smaws-clients.Smaws_Client

Types

module Types : sig ... end

Builders

val make_validation_errors_entry : 
  ?error_message:Types.error_message ->
  ?check_name:Types.name_type ->
  unit ->
  Types.validation_errors_entry

val make_validate_resource_policy_response : 
  ?validation_errors:Types.validation_errors_type ->
  ?policy_validation_passed:Types.boolean_type ->
  unit ->
  Types.validate_resource_policy_response

val make_validate_resource_policy_request : 
  ?secret_id:Types.secret_id_type ->
  resource_policy:Types.non_empty_resource_policy_type ->
  unit ->
  Types.validate_resource_policy_request

val make_update_secret_version_stage_response : 
  ?name:Types.secret_name_type ->
  ?ar_n:Types.secret_arn_type ->
  unit ->
  Types.update_secret_version_stage_response

val make_update_secret_version_stage_request : 
  ?move_to_version_id:Types.secret_version_id_type ->
  ?remove_from_version_id:Types.secret_version_id_type ->
  version_stage:Types.secret_version_stage_type ->
  secret_id:Types.secret_id_type ->
  unit ->
  Types.update_secret_version_stage_request

val make_update_secret_response : 
  ?version_id:Types.secret_version_id_type ->
  ?name:Types.secret_name_type ->
  ?ar_n:Types.secret_arn_type ->
  unit ->
  Types.update_secret_response

val make_update_secret_request : 
  ?type_:Types.medea_type_type ->
  ?secret_string:Types.secret_string_type ->
  ?secret_binary:Types.secret_binary_type ->
  ?kms_key_id:Types.kms_key_id_type ->
  ?description:Types.description_type ->
  ?client_request_token:Types.client_request_token_type ->
  secret_id:Types.secret_id_type ->
  unit ->
  Types.update_secret_request

val make_untag_resource_request : 
  tag_keys:Types.tag_key_list_type ->
  secret_id:Types.secret_id_type ->
  unit ->
  Types.untag_resource_request

val make_tag : 
  ?value:Types.tag_value_type ->
  ?key:Types.tag_key_type ->
  unit ->
  Types.tag

val make_tag_resource_request : 
  tags:Types.tag_list_type ->
  secret_id:Types.secret_id_type ->
  unit ->
  Types.tag_resource_request

val make_stop_replication_to_replica_response : 
  ?ar_n:Types.secret_arn_type ->
  unit ->
  Types.stop_replication_to_replica_response

val make_stop_replication_to_replica_request : 
  secret_id:Types.secret_id_type ->
  unit ->
  Types.stop_replication_to_replica_request

val make_rotate_secret_response : 
  ?version_id:Types.secret_version_id_type ->
  ?name:Types.secret_name_type ->
  ?ar_n:Types.secret_arn_type ->
  unit ->
  Types.rotate_secret_response

val make_rotation_rules_type : 
  ?schedule_expression:Types.schedule_expression_type ->
  ?duration:Types.duration_type ->
  ?automatically_after_days:Types.automatically_rotate_after_days_type ->
  unit ->
  Types.rotation_rules_type

val make_external_secret_rotation_metadata_item : 
  ?value:Types.external_secret_rotation_metadata_item_value_type ->
  ?key:Types.external_secret_rotation_metadata_item_key_type ->
  unit ->
  Types.external_secret_rotation_metadata_item

val make_rotate_secret_request : 
  ?rotate_immediately:Types.boolean_type ->
  ?external_secret_rotation_role_arn:Types.role_arn_type ->
  ?external_secret_rotation_metadata:
    Types.external_secret_rotation_metadata_type ->
  ?rotation_rules:Types.rotation_rules_type ->
  ?rotation_lambda_ar_n:Types.rotation_lambda_arn_type ->
  ?client_request_token:Types.client_request_token_type ->
  secret_id:Types.secret_id_type ->
  unit ->
  Types.rotate_secret_request

val make_restore_secret_response : 
  ?name:Types.secret_name_type ->
  ?ar_n:Types.secret_arn_type ->
  unit ->
  Types.restore_secret_response

val make_restore_secret_request : 
  secret_id:Types.secret_id_type ->
  unit ->
  Types.restore_secret_request

val make_replication_status_type : 
  ?last_accessed_date:Types.last_accessed_date_type ->
  ?status_message:Types.status_message_type ->
  ?status:Types.status_type ->
  ?kms_key_id:Types.kms_key_id_type ->
  ?region:Types.region_type ->
  unit ->
  Types.replication_status_type

val make_replicate_secret_to_regions_response : 
  ?replication_status:Types.replication_status_list_type ->
  ?ar_n:Types.secret_arn_type ->
  unit ->
  Types.replicate_secret_to_regions_response

val make_replica_region_type : 
  ?kms_key_id:Types.kms_key_id_type ->
  ?region:Types.region_type ->
  unit ->
  Types.replica_region_type

val make_replicate_secret_to_regions_request : 
  ?force_overwrite_replica_secret:Types.boolean_type ->
  add_replica_regions:Types.add_replica_region_list_type ->
  secret_id:Types.secret_id_type ->
  unit ->
  Types.replicate_secret_to_regions_request

val make_remove_regions_from_replication_response : 
  ?replication_status:Types.replication_status_list_type ->
  ?ar_n:Types.secret_arn_type ->
  unit ->
  Types.remove_regions_from_replication_response

val make_remove_regions_from_replication_request : 
  remove_replica_regions:Types.remove_replica_region_list_type ->
  secret_id:Types.secret_id_type ->
  unit ->
  Types.remove_regions_from_replication_request

val make_put_secret_value_response : 
  ?version_stages:Types.secret_version_stages_type ->
  ?version_id:Types.secret_version_id_type ->
  ?name:Types.secret_name_type ->
  ?ar_n:Types.secret_arn_type ->
  unit ->
  Types.put_secret_value_response

val make_put_secret_value_request : 
  ?rotation_token:Types.rotation_token_type ->
  ?version_stages:Types.secret_version_stages_type ->
  ?secret_string:Types.secret_string_type ->
  ?secret_binary:Types.secret_binary_type ->
  ?client_request_token:Types.client_request_token_type ->
  secret_id:Types.secret_id_type ->
  unit ->
  Types.put_secret_value_request

val make_put_resource_policy_response : 
  ?name:Types.name_type ->
  ?ar_n:Types.secret_arn_type ->
  unit ->
  Types.put_resource_policy_response

val make_put_resource_policy_request : 
  ?block_public_policy:Types.boolean_type ->
  resource_policy:Types.non_empty_resource_policy_type ->
  secret_id:Types.secret_id_type ->
  unit ->
  Types.put_resource_policy_request

val make_secret_versions_list_entry : 
  ?kms_key_ids:Types.kms_key_id_list_type ->
  ?created_date:Types.created_date_type ->
  ?last_accessed_date:Types.last_accessed_date_type ->
  ?version_stages:Types.secret_version_stages_type ->
  ?version_id:Types.secret_version_id_type ->
  unit ->
  Types.secret_versions_list_entry

val make_list_secret_version_ids_response : 
  ?name:Types.secret_name_type ->
  ?ar_n:Types.secret_arn_type ->
  ?next_token:Types.next_token_type ->
  ?versions:Types.secret_versions_list_type ->
  unit ->
  Types.list_secret_version_ids_response

val make_list_secret_version_ids_request : 
  ?include_deprecated:Types.boolean_type ->
  ?next_token:Types.next_token_type ->
  ?max_results:Types.max_results_type ->
  secret_id:Types.secret_id_type ->
  unit ->
  Types.list_secret_version_ids_request

val make_secret_list_entry : 
  ?primary_region:Types.region_type ->
  ?created_date:Types.timestamp_type ->
  ?owning_service:Types.owning_service_type ->
  ?secret_versions_to_stages:Types.secret_versions_to_stages_map_type ->
  ?tags:Types.tag_list_type ->
  ?next_rotation_date:Types.next_rotation_date_type ->
  ?deleted_date:Types.deleted_date_type ->
  ?last_accessed_date:Types.last_accessed_date_type ->
  ?last_changed_date:Types.last_changed_date_type ->
  ?last_rotated_date:Types.last_rotated_date_type ->
  ?external_secret_rotation_role_arn:Types.role_arn_type ->
  ?external_secret_rotation_metadata:
    Types.external_secret_rotation_metadata_type ->
  ?rotation_rules:Types.rotation_rules_type ->
  ?rotation_lambda_ar_n:Types.rotation_lambda_arn_type ->
  ?rotation_enabled:Types.rotation_enabled_type ->
  ?kms_key_id:Types.kms_key_id_type ->
  ?description:Types.description_type ->
  ?type_:Types.medea_type_type ->
  ?name:Types.secret_name_type ->
  ?ar_n:Types.secret_arn_type ->
  unit ->
  Types.secret_list_entry

val make_list_secrets_response : 
  ?next_token:Types.next_token_type ->
  ?secret_list:Types.secret_list_type ->
  unit ->
  Types.list_secrets_response

val make_filter : 
  ?values:Types.filter_values_string_list ->
  ?key:Types.filter_name_string_type ->
  unit ->
  Types.filter

val make_list_secrets_request : 
  ?sort_by:Types.sort_by_type ->
  ?sort_order:Types.sort_order_type ->
  ?filters:Types.filters_list_type ->
  ?next_token:Types.next_token_type ->
  ?max_results:Types.max_results_type ->
  ?include_planned_deletion:Types.boolean_type ->
  unit ->
  Types.list_secrets_request

val make_get_secret_value_response : 
  ?created_date:Types.created_date_type ->
  ?version_stages:Types.secret_version_stages_type ->
  ?secret_string:Types.secret_string_type ->
  ?secret_binary:Types.secret_binary_type ->
  ?version_id:Types.secret_version_id_type ->
  ?name:Types.secret_name_type ->
  ?ar_n:Types.secret_arn_type ->
  unit ->
  Types.get_secret_value_response

val make_get_secret_value_request : 
  ?version_stage:Types.secret_version_stage_type ->
  ?version_id:Types.secret_version_id_type ->
  secret_id:Types.secret_id_type ->
  unit ->
  Types.get_secret_value_request

val make_get_resource_policy_response : 
  ?resource_policy:Types.non_empty_resource_policy_type ->
  ?name:Types.name_type ->
  ?ar_n:Types.secret_arn_type ->
  unit ->
  Types.get_resource_policy_response

val make_get_resource_policy_request : 
  secret_id:Types.secret_id_type ->
  unit ->
  Types.get_resource_policy_request

val make_get_random_password_response : 
  ?random_password:Types.random_password_type ->
  unit ->
  Types.get_random_password_response

val make_get_random_password_request : 
  ?require_each_included_type:Types.require_each_included_type_type ->
  ?include_space:Types.include_space_type ->
  ?exclude_lowercase:Types.exclude_lowercase_type ->
  ?exclude_uppercase:Types.exclude_uppercase_type ->
  ?exclude_punctuation:Types.exclude_punctuation_type ->
  ?exclude_numbers:Types.exclude_numbers_type ->
  ?exclude_characters:Types.exclude_characters_type ->
  ?password_length:Types.password_length_type ->
  unit ->
  Types.get_random_password_request

val make_describe_secret_response : 
  ?replication_status:Types.replication_status_list_type ->
  ?primary_region:Types.region_type ->
  ?created_date:Types.timestamp_type ->
  ?owning_service:Types.owning_service_type ->
  ?version_ids_to_stages:Types.secret_versions_to_stages_map_type ->
  ?tags:Types.tag_list_type ->
  ?next_rotation_date:Types.next_rotation_date_type ->
  ?deleted_date:Types.deleted_date_type ->
  ?last_accessed_date:Types.last_accessed_date_type ->
  ?last_changed_date:Types.last_changed_date_type ->
  ?last_rotated_date:Types.last_rotated_date_type ->
  ?external_secret_rotation_role_arn:Types.role_arn_type ->
  ?external_secret_rotation_metadata:
    Types.external_secret_rotation_metadata_type ->
  ?rotation_rules:Types.rotation_rules_type ->
  ?rotation_lambda_ar_n:Types.rotation_lambda_arn_type ->
  ?rotation_enabled:Types.rotation_enabled_type ->
  ?kms_key_id:Types.kms_key_id_type ->
  ?description:Types.description_type ->
  ?type_:Types.medea_type_type ->
  ?name:Types.secret_name_type ->
  ?ar_n:Types.secret_arn_type ->
  unit ->
  Types.describe_secret_response

val make_describe_secret_request : 
  secret_id:Types.secret_id_type ->
  unit ->
  Types.describe_secret_request

val make_delete_secret_response : 
  ?deletion_date:Types.deletion_date_type ->
  ?name:Types.secret_name_type ->
  ?ar_n:Types.secret_arn_type ->
  unit ->
  Types.delete_secret_response

val make_delete_secret_request : 
  ?force_delete_without_recovery:Types.boolean_type ->
  ?recovery_window_in_days:Types.recovery_window_in_days_type ->
  secret_id:Types.secret_id_type ->
  unit ->
  Types.delete_secret_request

val make_delete_resource_policy_response : 
  ?name:Types.name_type ->
  ?ar_n:Types.secret_arn_type ->
  unit ->
  Types.delete_resource_policy_response

val make_delete_resource_policy_request : 
  secret_id:Types.secret_id_type ->
  unit ->
  Types.delete_resource_policy_request

val make_create_secret_response : 
  ?replication_status:Types.replication_status_list_type ->
  ?version_id:Types.secret_version_id_type ->
  ?name:Types.secret_name_type ->
  ?ar_n:Types.secret_arn_type ->
  unit ->
  Types.create_secret_response

val make_create_secret_request : 
  ?type_:Types.medea_type_type ->
  ?force_overwrite_replica_secret:Types.boolean_type ->
  ?add_replica_regions:Types.add_replica_region_list_type ->
  ?tags:Types.tag_list_type ->
  ?secret_string:Types.secret_string_type ->
  ?secret_binary:Types.secret_binary_type ->
  ?kms_key_id:Types.kms_key_id_type ->
  ?description:Types.description_type ->
  ?client_request_token:Types.client_request_token_type ->
  name:Types.name_type ->
  unit ->
  Types.create_secret_request

val make_cancel_rotate_secret_response : 
  ?version_id:Types.secret_version_id_type ->
  ?name:Types.secret_name_type ->
  ?ar_n:Types.secret_arn_type ->
  unit ->
  Types.cancel_rotate_secret_response

val make_cancel_rotate_secret_request : 
  secret_id:Types.secret_id_type ->
  unit ->
  Types.cancel_rotate_secret_request

val make_secret_value_entry : 
  ?created_date:Types.created_date_type ->
  ?version_stages:Types.secret_version_stages_type ->
  ?secret_string:Types.secret_string_type ->
  ?secret_binary:Types.secret_binary_type ->
  ?version_id:Types.secret_version_id_type ->
  ?name:Types.secret_name_type ->
  ?ar_n:Types.secret_arn_type ->
  unit ->
  Types.secret_value_entry

val make_api_error_type : 
  ?message:Types.error_message ->
  ?error_code:Types.error_code ->
  ?secret_id:Types.secret_id_type ->
  unit ->
  Types.api_error_type

val make_batch_get_secret_value_response : 
  ?errors:Types.api_error_list_type ->
  ?next_token:Types.next_token_type ->
  ?secret_values:Types.secret_values_type ->
  unit ->
  Types.batch_get_secret_value_response

val make_batch_get_secret_value_request : 
  ?next_token:Types.next_token_type ->
  ?max_results:Types.max_results_batch_type ->
  ?filters:Types.filters_list_type ->
  ?secret_id_list:Types.secret_id_list_type ->
  unit ->
  Types.batch_get_secret_value_request

Operations

module BatchGetSecretValue : sig ... end

Retrieves the contents of the encrypted fields SecretString or SecretBinary for up to 20 secrets. To retrieve a single secret, call GetSecretValue.

module CancelRotateSecret : sig ... end

Turns off automatic rotation, and if a rotation is currently in progress, cancels the rotation.

module CreateSecret : sig ... end

Creates a new secret. A secret can be a password, a set of credentials such as a user name and password, an OAuth token, or other secret information that you store in an encrypted form in Secrets Manager. The secret also includes the connection information to access a database or other service, which Secrets Manager doesn't encrypt. A secret in Secrets Manager consists of both the protected secret data and the important information needed to manage the secret.

module DeleteResourcePolicy : sig ... end

Deletes the resource-based permission policy attached to the secret. To attach a policy to a secret, use PutResourcePolicy.

module DeleteSecret : sig ... end

Deletes a secret and all of its versions. You can specify a recovery window during which you can restore the secret. The minimum recovery window is 7 days. The default recovery window is 30 days. Secrets Manager attaches a DeletionDate stamp to the secret that specifies the end of the recovery window. At the end of the recovery window, Secrets Manager deletes the secret permanently.

module DescribeSecret : sig ... end

Retrieves the details of a secret. It does not include the encrypted secret value. Secrets Manager only returns fields that have a value in the response.

module GetRandomPassword : sig ... end

Generates a random password. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support. By default, Secrets Manager uses uppercase and lowercase letters, numbers, and the following characters in passwords: !\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~

module GetResourcePolicy : sig ... end

Retrieves the JSON text of the resource-based policy document attached to the secret. For more information about permissions policies attached to a secret, see Permissions policies attached to a secret.

module GetSecretValue : sig ... end

Retrieves the contents of the encrypted fields SecretString or SecretBinary from the specified version of a secret, whichever contains content.

module ListSecrets : sig ... end

Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets that are marked for deletion. To see secrets marked for deletion, use the Secrets Manager console.

module ListSecretVersionIds : sig ... end

Lists the versions of a secret. Secrets Manager uses staging labels to indicate the different versions of a secret. For more information, see Secrets Manager concepts: Versions.

module PutResourcePolicy : sig ... end

Attaches a resource-based permission policy to a secret. A resource-based policy is optional. For more information, see Authentication and access control for Secrets Manager

module PutSecretValue : sig ... end

Creates a new version of your secret by creating a new encrypted value and attaching it to the secret. version can contain a new SecretString value or a new SecretBinary value.

module RemoveRegionsFromReplication : sig ... end

For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.

module ReplicateSecretToRegions : sig ... end

Replicates the secret to a new Regions. See Multi-Region secrets.

module RestoreSecret : sig ... end

Cancels the scheduled deletion of a secret by removing the DeletedDate time stamp. You can access a secret again after it has been restored.

module RotateSecret : sig ... end

Configures and starts the asynchronous process of rotating the secret. For information about rotation, see Rotate secrets in the Secrets Manager User Guide. If you include the configuration parameters, the operation sets the values for the secret and then immediately starts a rotation. If you don't include the configuration parameters, the operation starts a rotation with the values already stored in the secret.

module StopReplicationToReplica : sig ... end

Removes the link between the replica secret and the primary secret and promotes the replica to a primary secret in the replica Region.

module TagResource : sig ... end

Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of the secret's metadata. They are not associated with specific versions of the secret. This operation appends tags to the existing list of tags.

module UntagResource : sig ... end

Removes specific tags from a secret.

module UpdateSecret : sig ... end

Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use PutSecretValue.

module UpdateSecretVersionStage : sig ... end

Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging labels to track a version as it progresses through the secret rotation process. Each staging label can be attached to only one version at a time. To add a staging label to a version when it is already attached to another version, Secrets Manager first removes it from the other version first and then attaches it to this one. For more information about versions and staging labels, see Concepts: Version.

module ValidateResourcePolicy : sig ... end

module Json_serializers : sig ... end

module Json_deserializers : sig ... end