SecretsManager module#
Index > SecretsManager
Auto-generated documentation for SecretsManager type annotations stubs module types-boto3-secretsmanager.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy-boto3-builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.36.26' mypy-boto3-builder
- Select
boto3
AWS SDK. - Add
SecretsManager
service. - Use provided commands to install generated packages.
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and SecretsManager
.
From PyPI with pip#
Install types-boto3
for SecretsManager
service.
# install with boto3 type annotations
python -m pip install 'types-boto3[secretsmanager]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[secretsmanager]'
# standalone installation
python -m pip install types-boto3-secretsmanager
How to uninstall#
python -m pip uninstall -y types-boto3-secretsmanager
Usage#
Code samples can be found in Examples.
SecretsManagerClient#
Type annotations and code completion for boto3.client("secretsmanager")
as SecretsManagerClient
boto3 documentation
# SecretsManagerClient usage example
from boto3.session import Session
from types_boto3_secretsmanager.client import SecretsManagerClient
def get_client() -> SecretsManagerClient:
return Session().client("secretsmanager")
Paginators#
Type annotations and code completion for paginators
from boto3.client("secretsmanager").get_paginator("...")
.
# ListSecretsPaginator usage example
from boto3.session import Session
from types_boto3_secretsmanager.paginator import ListSecretsPaginator
def get_list_secrets_paginator() -> ListSecretsPaginator:
return Session().client("secretsmanager").get_paginator("list_secrets"))
Literals#
Type annotations for literals used in methods and schema.
# FilterNameStringTypeType usage example
from types_boto3_secretsmanager.literals import FilterNameStringTypeType
def get_value() -> FilterNameStringTypeType:
return "all"
- FilterNameStringTypeType
- ListSecretsPaginatorName
- SortOrderTypeType
- StatusTypeType
- SecretsManagerServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- APIErrorTypeTypeDef
- FilterTypeDef
- ResponseMetadataTypeDef
- SecretValueEntryTypeDef
- BlobTypeDef
- CancelRotateSecretRequestTypeDef
- ReplicaRegionTypeTypeDef
- TagTypeDef
- ReplicationStatusTypeTypeDef
- DeleteResourcePolicyRequestTypeDef
- DeleteSecretRequestTypeDef
- DescribeSecretRequestTypeDef
- RotationRulesTypeTypeDef
- GetRandomPasswordRequestTypeDef
- GetResourcePolicyRequestTypeDef
- GetSecretValueRequestTypeDef
- ListSecretVersionIdsRequestTypeDef
- SecretVersionsListEntryTypeDef
- PaginatorConfigTypeDef
- PutResourcePolicyRequestTypeDef
- RemoveRegionsFromReplicationRequestTypeDef
- RestoreSecretRequestTypeDef
- StopReplicationToReplicaRequestTypeDef
- UntagResourceRequestTypeDef
- UpdateSecretVersionStageRequestTypeDef
- ValidateResourcePolicyRequestTypeDef
- ValidationErrorsEntryTypeDef
- BatchGetSecretValueRequestTypeDef
- ListSecretsRequestTypeDef
- CancelRotateSecretResponseTypeDef
- DeleteResourcePolicyResponseTypeDef
- DeleteSecretResponseTypeDef
- EmptyResponseMetadataTypeDef
- GetRandomPasswordResponseTypeDef
- GetResourcePolicyResponseTypeDef
- GetSecretValueResponseTypeDef
- PutResourcePolicyResponseTypeDef
- PutSecretValueResponseTypeDef
- RestoreSecretResponseTypeDef
- RotateSecretResponseTypeDef
- StopReplicationToReplicaResponseTypeDef
- UpdateSecretResponseTypeDef
- UpdateSecretVersionStageResponseTypeDef
- BatchGetSecretValueResponseTypeDef
- PutSecretValueRequestTypeDef
- UpdateSecretRequestTypeDef
- ReplicateSecretToRegionsRequestTypeDef
- CreateSecretRequestTypeDef
- TagResourceRequestTypeDef
- CreateSecretResponseTypeDef
- RemoveRegionsFromReplicationResponseTypeDef
- ReplicateSecretToRegionsResponseTypeDef
- DescribeSecretResponseTypeDef
- RotateSecretRequestTypeDef
- SecretListEntryTypeDef
- ListSecretVersionIdsResponseTypeDef
- ListSecretsRequestPaginateTypeDef
- ValidateResourcePolicyResponseTypeDef
- ListSecretsResponseTypeDef