

**************
SecretsManager
**************



======
Client
======



.. py:class:: SecretsManager.Client

  A low-level client representing AWS Secrets Manager
   

  Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.

   

  This guide provides descriptions of the Secrets Manager API. For more information about using this service, see the `Amazon Web Services Secrets Manager User Guide <https://docs.aws.amazon.com/secretsmanager/latest/userguide/introduction.html>`__.

   

  **API Version**

   

  This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.

   

  For a list of endpoints, see `Amazon Web Services Secrets Manager endpoints <https://docs.aws.amazon.com/secretsmanager/latest/userguide/asm_access.html#endpoints>`__.

   

  **Support and Feedback for Amazon Web Services Secrets Manager**

   

  We welcome your feedback. Send your comments to `awssecretsmanager-feedback@amazon.com <mailto:awssecretsmanager-feedback@amazon.com>`__, or post your feedback and questions in the `Amazon Web Services Secrets Manager Discussion Forum <http://forums.aws.amazon.com/forum.jspa?forumID=296>`__. For more information about the Amazon Web Services Discussion Forums, see `Forums Help <http://forums.aws.amazon.com/help.jspa>`__.

   

  **Logging API Requests**

   

  Amazon Web Services Secrets Manager supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information that's collected by Amazon Web Services CloudTrail, you can determine the requests successfully made to Secrets Manager, who made the request, when it was made, and so on. For more about Amazon Web Services Secrets Manager and support for Amazon Web Services CloudTrail, see `Logging Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail <https://docs.aws.amazon.com/secretsmanager/latest/userguide/monitoring.html#monitoring_cloudtrail>`__ in the *Amazon Web Services Secrets Manager User Guide*. To learn more about CloudTrail, including enabling it and find your log files, see the `Amazon Web Services CloudTrail User Guide <https://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html>`__.

  ::

    
    import boto3
    
    client = boto3.client('secretsmanager')

  

These are the available methods:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  secretsmanager/client/batch_get_secret_value
  secretsmanager/client/can_paginate
  secretsmanager/client/cancel_rotate_secret
  secretsmanager/client/close
  secretsmanager/client/create_secret
  secretsmanager/client/delete_resource_policy
  secretsmanager/client/delete_secret
  secretsmanager/client/describe_secret
  secretsmanager/client/get_paginator
  secretsmanager/client/get_random_password
  secretsmanager/client/get_resource_policy
  secretsmanager/client/get_secret_value
  secretsmanager/client/get_waiter
  secretsmanager/client/list_secret_version_ids
  secretsmanager/client/list_secrets
  secretsmanager/client/put_resource_policy
  secretsmanager/client/put_secret_value
  secretsmanager/client/remove_regions_from_replication
  secretsmanager/client/replicate_secret_to_regions
  secretsmanager/client/restore_secret
  secretsmanager/client/rotate_secret
  secretsmanager/client/stop_replication_to_replica
  secretsmanager/client/tag_resource
  secretsmanager/client/untag_resource
  secretsmanager/client/update_secret
  secretsmanager/client/update_secret_version_stage
  secretsmanager/client/validate_resource_policy


==========
Paginators
==========


Paginators are available on a client instance via the ``get_paginator`` method. For more detailed instructions and examples on the usage of paginators, see the paginators `user guide <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/paginators.html>`_.

The available paginators are:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  secretsmanager/paginator/ListSecrets
