Skip to content

Typed dictionaries

Index > SecretsManager > Typed dictionaries

Auto-generated documentation for SecretsManager type annotations stubs module mypy-boto3-secretsmanager.

CancelRotateSecretRequestRequestTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import CancelRotateSecretRequestRequestTypeDef

def get_value() -> CancelRotateSecretRequestRequestTypeDef:
    return {
        "SecretId": ...,
    }
Definition
class CancelRotateSecretRequestRequestTypeDef(TypedDict):
    SecretId: str,

ResponseMetadataTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
Definition
class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

ReplicaRegionTypeTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import ReplicaRegionTypeTypeDef

def get_value() -> ReplicaRegionTypeTypeDef:
    return {
        "Region": ...,
    }
Definition
class ReplicaRegionTypeTypeDef(TypedDict):
    Region: NotRequired[str],
    KmsKeyId: NotRequired[str],

TagTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "Key": ...,
    }
Definition
class TagTypeDef(TypedDict):
    Key: NotRequired[str],
    Value: NotRequired[str],

ReplicationStatusTypeTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import ReplicationStatusTypeTypeDef

def get_value() -> ReplicationStatusTypeTypeDef:
    return {
        "Region": ...,
    }
Definition
class ReplicationStatusTypeTypeDef(TypedDict):
    Region: NotRequired[str],
    KmsKeyId: NotRequired[str],
    Status: NotRequired[StatusTypeType],  # (1)
    StatusMessage: NotRequired[str],
    LastAccessedDate: NotRequired[datetime],
  1. See StatusTypeType

DeleteResourcePolicyRequestRequestTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import DeleteResourcePolicyRequestRequestTypeDef

def get_value() -> DeleteResourcePolicyRequestRequestTypeDef:
    return {
        "SecretId": ...,
    }
Definition
class DeleteResourcePolicyRequestRequestTypeDef(TypedDict):
    SecretId: str,

DeleteSecretRequestRequestTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import DeleteSecretRequestRequestTypeDef

def get_value() -> DeleteSecretRequestRequestTypeDef:
    return {
        "SecretId": ...,
    }
Definition
class DeleteSecretRequestRequestTypeDef(TypedDict):
    SecretId: str,
    RecoveryWindowInDays: NotRequired[int],
    ForceDeleteWithoutRecovery: NotRequired[bool],

DescribeSecretRequestRequestTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import DescribeSecretRequestRequestTypeDef

def get_value() -> DescribeSecretRequestRequestTypeDef:
    return {
        "SecretId": ...,
    }
Definition
class DescribeSecretRequestRequestTypeDef(TypedDict):
    SecretId: str,

RotationRulesTypeTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import RotationRulesTypeTypeDef

def get_value() -> RotationRulesTypeTypeDef:
    return {
        "AutomaticallyAfterDays": ...,
    }
Definition
class RotationRulesTypeTypeDef(TypedDict):
    AutomaticallyAfterDays: NotRequired[int],
    Duration: NotRequired[str],
    ScheduleExpression: NotRequired[str],

FilterTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import FilterTypeDef

def get_value() -> FilterTypeDef:
    return {
        "Key": ...,
    }
Definition
class FilterTypeDef(TypedDict):
    Key: NotRequired[FilterNameStringTypeType],  # (1)
    Values: NotRequired[Sequence[str]],
  1. See FilterNameStringTypeType

GetRandomPasswordRequestRequestTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import GetRandomPasswordRequestRequestTypeDef

def get_value() -> GetRandomPasswordRequestRequestTypeDef:
    return {
        "PasswordLength": ...,
    }
Definition
class GetRandomPasswordRequestRequestTypeDef(TypedDict):
    PasswordLength: NotRequired[int],
    ExcludeCharacters: NotRequired[str],
    ExcludeNumbers: NotRequired[bool],
    ExcludePunctuation: NotRequired[bool],
    ExcludeUppercase: NotRequired[bool],
    ExcludeLowercase: NotRequired[bool],
    IncludeSpace: NotRequired[bool],
    RequireEachIncludedType: NotRequired[bool],

GetResourcePolicyRequestRequestTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import GetResourcePolicyRequestRequestTypeDef

def get_value() -> GetResourcePolicyRequestRequestTypeDef:
    return {
        "SecretId": ...,
    }
Definition
class GetResourcePolicyRequestRequestTypeDef(TypedDict):
    SecretId: str,

GetSecretValueRequestRequestTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import GetSecretValueRequestRequestTypeDef

def get_value() -> GetSecretValueRequestRequestTypeDef:
    return {
        "SecretId": ...,
    }
Definition
class GetSecretValueRequestRequestTypeDef(TypedDict):
    SecretId: str,
    VersionId: NotRequired[str],
    VersionStage: NotRequired[str],

ListSecretVersionIdsRequestRequestTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import ListSecretVersionIdsRequestRequestTypeDef

def get_value() -> ListSecretVersionIdsRequestRequestTypeDef:
    return {
        "SecretId": ...,
    }
Definition
class ListSecretVersionIdsRequestRequestTypeDef(TypedDict):
    SecretId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    IncludeDeprecated: NotRequired[bool],

SecretVersionsListEntryTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import SecretVersionsListEntryTypeDef

def get_value() -> SecretVersionsListEntryTypeDef:
    return {
        "VersionId": ...,
    }
Definition
class SecretVersionsListEntryTypeDef(TypedDict):
    VersionId: NotRequired[str],
    VersionStages: NotRequired[List[str]],
    LastAccessedDate: NotRequired[datetime],
    CreatedDate: NotRequired[datetime],
    KmsKeyIds: NotRequired[List[str]],

PaginatorConfigTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }
Definition
class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

PutResourcePolicyRequestRequestTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import PutResourcePolicyRequestRequestTypeDef

def get_value() -> PutResourcePolicyRequestRequestTypeDef:
    return {
        "SecretId": ...,
        "ResourcePolicy": ...,
    }
Definition
class PutResourcePolicyRequestRequestTypeDef(TypedDict):
    SecretId: str,
    ResourcePolicy: str,
    BlockPublicPolicy: NotRequired[bool],

PutSecretValueRequestRequestTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import PutSecretValueRequestRequestTypeDef

def get_value() -> PutSecretValueRequestRequestTypeDef:
    return {
        "SecretId": ...,
    }
Definition
class PutSecretValueRequestRequestTypeDef(TypedDict):
    SecretId: str,
    ClientRequestToken: NotRequired[str],
    SecretBinary: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
    SecretString: NotRequired[str],
    VersionStages: NotRequired[Sequence[str]],

RemoveRegionsFromReplicationRequestRequestTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import RemoveRegionsFromReplicationRequestRequestTypeDef

def get_value() -> RemoveRegionsFromReplicationRequestRequestTypeDef:
    return {
        "SecretId": ...,
        "RemoveReplicaRegions": ...,
    }
Definition
class RemoveRegionsFromReplicationRequestRequestTypeDef(TypedDict):
    SecretId: str,
    RemoveReplicaRegions: Sequence[str],

RestoreSecretRequestRequestTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import RestoreSecretRequestRequestTypeDef

def get_value() -> RestoreSecretRequestRequestTypeDef:
    return {
        "SecretId": ...,
    }
Definition
class RestoreSecretRequestRequestTypeDef(TypedDict):
    SecretId: str,

StopReplicationToReplicaRequestRequestTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import StopReplicationToReplicaRequestRequestTypeDef

def get_value() -> StopReplicationToReplicaRequestRequestTypeDef:
    return {
        "SecretId": ...,
    }
Definition
class StopReplicationToReplicaRequestRequestTypeDef(TypedDict):
    SecretId: str,

UntagResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "SecretId": ...,
        "TagKeys": ...,
    }
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
    SecretId: str,
    TagKeys: Sequence[str],

UpdateSecretRequestRequestTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import UpdateSecretRequestRequestTypeDef

def get_value() -> UpdateSecretRequestRequestTypeDef:
    return {
        "SecretId": ...,
    }
Definition
class UpdateSecretRequestRequestTypeDef(TypedDict):
    SecretId: str,
    ClientRequestToken: NotRequired[str],
    Description: NotRequired[str],
    KmsKeyId: NotRequired[str],
    SecretBinary: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
    SecretString: NotRequired[str],

UpdateSecretVersionStageRequestRequestTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import UpdateSecretVersionStageRequestRequestTypeDef

def get_value() -> UpdateSecretVersionStageRequestRequestTypeDef:
    return {
        "SecretId": ...,
        "VersionStage": ...,
    }
Definition
class UpdateSecretVersionStageRequestRequestTypeDef(TypedDict):
    SecretId: str,
    VersionStage: str,
    RemoveFromVersionId: NotRequired[str],
    MoveToVersionId: NotRequired[str],

ValidateResourcePolicyRequestRequestTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import ValidateResourcePolicyRequestRequestTypeDef

def get_value() -> ValidateResourcePolicyRequestRequestTypeDef:
    return {
        "ResourcePolicy": ...,
    }
Definition
class ValidateResourcePolicyRequestRequestTypeDef(TypedDict):
    ResourcePolicy: str,
    SecretId: NotRequired[str],

ValidationErrorsEntryTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import ValidationErrorsEntryTypeDef

def get_value() -> ValidationErrorsEntryTypeDef:
    return {
        "CheckName": ...,
    }
Definition
class ValidationErrorsEntryTypeDef(TypedDict):
    CheckName: NotRequired[str],
    ErrorMessage: NotRequired[str],

CancelRotateSecretResponseTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import CancelRotateSecretResponseTypeDef

def get_value() -> CancelRotateSecretResponseTypeDef:
    return {
        "ARN": ...,
        "Name": ...,
        "VersionId": ...,
        "ResponseMetadata": ...,
    }
Definition
class CancelRotateSecretResponseTypeDef(TypedDict):
    ARN: str,
    Name: str,
    VersionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteResourcePolicyResponseTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import DeleteResourcePolicyResponseTypeDef

def get_value() -> DeleteResourcePolicyResponseTypeDef:
    return {
        "ARN": ...,
        "Name": ...,
        "ResponseMetadata": ...,
    }
Definition
class DeleteResourcePolicyResponseTypeDef(TypedDict):
    ARN: str,
    Name: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteSecretResponseTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import DeleteSecretResponseTypeDef

def get_value() -> DeleteSecretResponseTypeDef:
    return {
        "ARN": ...,
        "Name": ...,
        "DeletionDate": ...,
        "ResponseMetadata": ...,
    }
Definition
class DeleteSecretResponseTypeDef(TypedDict):
    ARN: str,
    Name: str,
    DeletionDate: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import EmptyResponseMetadataTypeDef

def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }
Definition
class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetRandomPasswordResponseTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import GetRandomPasswordResponseTypeDef

def get_value() -> GetRandomPasswordResponseTypeDef:
    return {
        "RandomPassword": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetRandomPasswordResponseTypeDef(TypedDict):
    RandomPassword: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetResourcePolicyResponseTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import GetResourcePolicyResponseTypeDef

def get_value() -> GetResourcePolicyResponseTypeDef:
    return {
        "ARN": ...,
        "Name": ...,
        "ResourcePolicy": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetResourcePolicyResponseTypeDef(TypedDict):
    ARN: str,
    Name: str,
    ResourcePolicy: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetSecretValueResponseTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import GetSecretValueResponseTypeDef

def get_value() -> GetSecretValueResponseTypeDef:
    return {
        "ARN": ...,
        "Name": ...,
        "VersionId": ...,
        "SecretBinary": ...,
        "SecretString": ...,
        "VersionStages": ...,
        "CreatedDate": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetSecretValueResponseTypeDef(TypedDict):
    ARN: str,
    Name: str,
    VersionId: str,
    SecretBinary: bytes,
    SecretString: str,
    VersionStages: List[str],
    CreatedDate: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PutResourcePolicyResponseTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import PutResourcePolicyResponseTypeDef

def get_value() -> PutResourcePolicyResponseTypeDef:
    return {
        "ARN": ...,
        "Name": ...,
        "ResponseMetadata": ...,
    }
Definition
class PutResourcePolicyResponseTypeDef(TypedDict):
    ARN: str,
    Name: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PutSecretValueResponseTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import PutSecretValueResponseTypeDef

def get_value() -> PutSecretValueResponseTypeDef:
    return {
        "ARN": ...,
        "Name": ...,
        "VersionId": ...,
        "VersionStages": ...,
        "ResponseMetadata": ...,
    }
Definition
class PutSecretValueResponseTypeDef(TypedDict):
    ARN: str,
    Name: str,
    VersionId: str,
    VersionStages: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RestoreSecretResponseTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import RestoreSecretResponseTypeDef

def get_value() -> RestoreSecretResponseTypeDef:
    return {
        "ARN": ...,
        "Name": ...,
        "ResponseMetadata": ...,
    }
Definition
class RestoreSecretResponseTypeDef(TypedDict):
    ARN: str,
    Name: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RotateSecretResponseTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import RotateSecretResponseTypeDef

def get_value() -> RotateSecretResponseTypeDef:
    return {
        "ARN": ...,
        "Name": ...,
        "VersionId": ...,
        "ResponseMetadata": ...,
    }
Definition
class RotateSecretResponseTypeDef(TypedDict):
    ARN: str,
    Name: str,
    VersionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StopReplicationToReplicaResponseTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import StopReplicationToReplicaResponseTypeDef

def get_value() -> StopReplicationToReplicaResponseTypeDef:
    return {
        "ARN": ...,
        "ResponseMetadata": ...,
    }
Definition
class StopReplicationToReplicaResponseTypeDef(TypedDict):
    ARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateSecretResponseTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import UpdateSecretResponseTypeDef

def get_value() -> UpdateSecretResponseTypeDef:
    return {
        "ARN": ...,
        "Name": ...,
        "VersionId": ...,
        "ResponseMetadata": ...,
    }
Definition
class UpdateSecretResponseTypeDef(TypedDict):
    ARN: str,
    Name: str,
    VersionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateSecretVersionStageResponseTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import UpdateSecretVersionStageResponseTypeDef

def get_value() -> UpdateSecretVersionStageResponseTypeDef:
    return {
        "ARN": ...,
        "Name": ...,
        "ResponseMetadata": ...,
    }
Definition
class UpdateSecretVersionStageResponseTypeDef(TypedDict):
    ARN: str,
    Name: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ReplicateSecretToRegionsRequestRequestTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import ReplicateSecretToRegionsRequestRequestTypeDef

def get_value() -> ReplicateSecretToRegionsRequestRequestTypeDef:
    return {
        "SecretId": ...,
        "AddReplicaRegions": ...,
    }
Definition
class ReplicateSecretToRegionsRequestRequestTypeDef(TypedDict):
    SecretId: str,
    AddReplicaRegions: Sequence[ReplicaRegionTypeTypeDef],  # (1)
    ForceOverwriteReplicaSecret: NotRequired[bool],
  1. See ReplicaRegionTypeTypeDef

CreateSecretRequestRequestTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import CreateSecretRequestRequestTypeDef

def get_value() -> CreateSecretRequestRequestTypeDef:
    return {
        "Name": ...,
    }
Definition
class CreateSecretRequestRequestTypeDef(TypedDict):
    Name: str,
    ClientRequestToken: NotRequired[str],
    Description: NotRequired[str],
    KmsKeyId: NotRequired[str],
    SecretBinary: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
    SecretString: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
    AddReplicaRegions: NotRequired[Sequence[ReplicaRegionTypeTypeDef]],  # (2)
    ForceOverwriteReplicaSecret: NotRequired[bool],
  1. See TagTypeDef
  2. See ReplicaRegionTypeTypeDef

TagResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
        "SecretId": ...,
        "Tags": ...,
    }
Definition
class TagResourceRequestRequestTypeDef(TypedDict):
    SecretId: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CreateSecretResponseTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import CreateSecretResponseTypeDef

def get_value() -> CreateSecretResponseTypeDef:
    return {
        "ARN": ...,
        "Name": ...,
        "VersionId": ...,
        "ReplicationStatus": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateSecretResponseTypeDef(TypedDict):
    ARN: str,
    Name: str,
    VersionId: str,
    ReplicationStatus: List[ReplicationStatusTypeTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ReplicationStatusTypeTypeDef
  2. See ResponseMetadataTypeDef

RemoveRegionsFromReplicationResponseTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import RemoveRegionsFromReplicationResponseTypeDef

def get_value() -> RemoveRegionsFromReplicationResponseTypeDef:
    return {
        "ARN": ...,
        "ReplicationStatus": ...,
        "ResponseMetadata": ...,
    }
Definition
class RemoveRegionsFromReplicationResponseTypeDef(TypedDict):
    ARN: str,
    ReplicationStatus: List[ReplicationStatusTypeTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ReplicationStatusTypeTypeDef
  2. See ResponseMetadataTypeDef

ReplicateSecretToRegionsResponseTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import ReplicateSecretToRegionsResponseTypeDef

def get_value() -> ReplicateSecretToRegionsResponseTypeDef:
    return {
        "ARN": ...,
        "ReplicationStatus": ...,
        "ResponseMetadata": ...,
    }
Definition
class ReplicateSecretToRegionsResponseTypeDef(TypedDict):
    ARN: str,
    ReplicationStatus: List[ReplicationStatusTypeTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ReplicationStatusTypeTypeDef
  2. See ResponseMetadataTypeDef

DescribeSecretResponseTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import DescribeSecretResponseTypeDef

def get_value() -> DescribeSecretResponseTypeDef:
    return {
        "ARN": ...,
        "Name": ...,
        "Description": ...,
        "KmsKeyId": ...,
        "RotationEnabled": ...,
        "RotationLambdaARN": ...,
        "RotationRules": ...,
        "LastRotatedDate": ...,
        "LastChangedDate": ...,
        "LastAccessedDate": ...,
        "DeletedDate": ...,
        "NextRotationDate": ...,
        "Tags": ...,
        "VersionIdsToStages": ...,
        "OwningService": ...,
        "CreatedDate": ...,
        "PrimaryRegion": ...,
        "ReplicationStatus": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeSecretResponseTypeDef(TypedDict):
    ARN: str,
    Name: str,
    Description: str,
    KmsKeyId: str,
    RotationEnabled: bool,
    RotationLambdaARN: str,
    RotationRules: RotationRulesTypeTypeDef,  # (1)
    LastRotatedDate: datetime,
    LastChangedDate: datetime,
    LastAccessedDate: datetime,
    DeletedDate: datetime,
    NextRotationDate: datetime,
    Tags: List[TagTypeDef],  # (2)
    VersionIdsToStages: Dict[str, List[str]],
    OwningService: str,
    CreatedDate: datetime,
    PrimaryRegion: str,
    ReplicationStatus: List[ReplicationStatusTypeTypeDef],  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See RotationRulesTypeTypeDef
  2. See TagTypeDef
  3. See ReplicationStatusTypeTypeDef
  4. See ResponseMetadataTypeDef

RotateSecretRequestRequestTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import RotateSecretRequestRequestTypeDef

def get_value() -> RotateSecretRequestRequestTypeDef:
    return {
        "SecretId": ...,
    }
Definition
class RotateSecretRequestRequestTypeDef(TypedDict):
    SecretId: str,
    ClientRequestToken: NotRequired[str],
    RotationLambdaARN: NotRequired[str],
    RotationRules: NotRequired[RotationRulesTypeTypeDef],  # (1)
    RotateImmediately: NotRequired[bool],
  1. See RotationRulesTypeTypeDef

SecretListEntryTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import SecretListEntryTypeDef

def get_value() -> SecretListEntryTypeDef:
    return {
        "ARN": ...,
    }
Definition
class SecretListEntryTypeDef(TypedDict):
    ARN: NotRequired[str],
    Name: NotRequired[str],
    Description: NotRequired[str],
    KmsKeyId: NotRequired[str],
    RotationEnabled: NotRequired[bool],
    RotationLambdaARN: NotRequired[str],
    RotationRules: NotRequired[RotationRulesTypeTypeDef],  # (1)
    LastRotatedDate: NotRequired[datetime],
    LastChangedDate: NotRequired[datetime],
    LastAccessedDate: NotRequired[datetime],
    DeletedDate: NotRequired[datetime],
    NextRotationDate: NotRequired[datetime],
    Tags: NotRequired[List[TagTypeDef]],  # (2)
    SecretVersionsToStages: NotRequired[Dict[str, List[str]]],
    OwningService: NotRequired[str],
    CreatedDate: NotRequired[datetime],
    PrimaryRegion: NotRequired[str],
  1. See RotationRulesTypeTypeDef
  2. See TagTypeDef

ListSecretsRequestRequestTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import ListSecretsRequestRequestTypeDef

def get_value() -> ListSecretsRequestRequestTypeDef:
    return {
        "IncludePlannedDeletion": ...,
    }
Definition
class ListSecretsRequestRequestTypeDef(TypedDict):
    IncludePlannedDeletion: NotRequired[bool],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    SortOrder: NotRequired[SortOrderTypeType],  # (2)
  1. See FilterTypeDef
  2. See SortOrderTypeType

ListSecretVersionIdsResponseTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import ListSecretVersionIdsResponseTypeDef

def get_value() -> ListSecretVersionIdsResponseTypeDef:
    return {
        "Versions": ...,
        "NextToken": ...,
        "ARN": ...,
        "Name": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListSecretVersionIdsResponseTypeDef(TypedDict):
    Versions: List[SecretVersionsListEntryTypeDef],  # (1)
    NextToken: str,
    ARN: str,
    Name: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SecretVersionsListEntryTypeDef
  2. See ResponseMetadataTypeDef

ListSecretsRequestListSecretsPaginateTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import ListSecretsRequestListSecretsPaginateTypeDef

def get_value() -> ListSecretsRequestListSecretsPaginateTypeDef:
    return {
        "IncludePlannedDeletion": ...,
    }
Definition
class ListSecretsRequestListSecretsPaginateTypeDef(TypedDict):
    IncludePlannedDeletion: NotRequired[bool],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    SortOrder: NotRequired[SortOrderTypeType],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See FilterTypeDef
  2. See SortOrderTypeType
  3. See PaginatorConfigTypeDef

ValidateResourcePolicyResponseTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import ValidateResourcePolicyResponseTypeDef

def get_value() -> ValidateResourcePolicyResponseTypeDef:
    return {
        "PolicyValidationPassed": ...,
        "ValidationErrors": ...,
        "ResponseMetadata": ...,
    }
Definition
class ValidateResourcePolicyResponseTypeDef(TypedDict):
    PolicyValidationPassed: bool,
    ValidationErrors: List[ValidationErrorsEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ValidationErrorsEntryTypeDef
  2. See ResponseMetadataTypeDef

ListSecretsResponseTypeDef

Usage Example
from mypy_boto3_secretsmanager.type_defs import ListSecretsResponseTypeDef

def get_value() -> ListSecretsResponseTypeDef:
    return {
        "SecretList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListSecretsResponseTypeDef(TypedDict):
    SecretList: List[SecretListEntryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SecretListEntryTypeDef
  2. See ResponseMetadataTypeDef