Skip to content

Typed dictionaries#

Index > SecretsManager > Typed dictionaries

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

CancelRotateSecretRequestRequestTypeDef#

# CancelRotateSecretRequestRequestTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import CancelRotateSecretRequestRequestTypeDef

def get_value() -> CancelRotateSecretRequestRequestTypeDef:
    return {
        "SecretId": ...,
    }
# CancelRotateSecretRequestRequestTypeDef definition

class CancelRotateSecretRequestRequestTypeDef(TypedDict):
    SecretId: str,

CancelRotateSecretResponseTypeDef#

# CancelRotateSecretResponseTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import CancelRotateSecretResponseTypeDef

def get_value() -> CancelRotateSecretResponseTypeDef:
    return {
        "ARN": ...,
        "Name": ...,
        "VersionId": ...,
        "ResponseMetadata": ...,
    }
# CancelRotateSecretResponseTypeDef definition

class CancelRotateSecretResponseTypeDef(TypedDict):
    ARN: str,
    Name: str,
    VersionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ReplicaRegionTypeTypeDef#

# ReplicaRegionTypeTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import ReplicaRegionTypeTypeDef

def get_value() -> ReplicaRegionTypeTypeDef:
    return {
        "Region": ...,
    }
# ReplicaRegionTypeTypeDef definition

class ReplicaRegionTypeTypeDef(TypedDict):
    Region: NotRequired[str],
    KmsKeyId: NotRequired[str],

TagTypeDef#

# TagTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "Key": ...,
    }
# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: NotRequired[str],
    Value: NotRequired[str],

ReplicationStatusTypeTypeDef#

# ReplicationStatusTypeTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import ReplicationStatusTypeTypeDef

def get_value() -> ReplicationStatusTypeTypeDef:
    return {
        "Region": ...,
    }
# ReplicationStatusTypeTypeDef definition

class ReplicationStatusTypeTypeDef(TypedDict):
    Region: NotRequired[str],
    KmsKeyId: NotRequired[str],
    Status: NotRequired[StatusTypeType],  # (1)
    StatusMessage: NotRequired[str],
    LastAccessedDate: NotRequired[datetime],
  1. See StatusTypeType

DeleteResourcePolicyRequestRequestTypeDef#

# DeleteResourcePolicyRequestRequestTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import DeleteResourcePolicyRequestRequestTypeDef

def get_value() -> DeleteResourcePolicyRequestRequestTypeDef:
    return {
        "SecretId": ...,
    }
# DeleteResourcePolicyRequestRequestTypeDef definition

class DeleteResourcePolicyRequestRequestTypeDef(TypedDict):
    SecretId: str,

DeleteResourcePolicyResponseTypeDef#

# DeleteResourcePolicyResponseTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import DeleteResourcePolicyResponseTypeDef

def get_value() -> DeleteResourcePolicyResponseTypeDef:
    return {
        "ARN": ...,
        "Name": ...,
        "ResponseMetadata": ...,
    }
# DeleteResourcePolicyResponseTypeDef definition

class DeleteResourcePolicyResponseTypeDef(TypedDict):
    ARN: str,
    Name: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteSecretRequestRequestTypeDef#

# DeleteSecretRequestRequestTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import DeleteSecretRequestRequestTypeDef

def get_value() -> DeleteSecretRequestRequestTypeDef:
    return {
        "SecretId": ...,
    }
# DeleteSecretRequestRequestTypeDef definition

class DeleteSecretRequestRequestTypeDef(TypedDict):
    SecretId: str,
    RecoveryWindowInDays: NotRequired[int],
    ForceDeleteWithoutRecovery: NotRequired[bool],

DeleteSecretResponseTypeDef#

# DeleteSecretResponseTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import DeleteSecretResponseTypeDef

def get_value() -> DeleteSecretResponseTypeDef:
    return {
        "ARN": ...,
        "Name": ...,
        "DeletionDate": ...,
        "ResponseMetadata": ...,
    }
# DeleteSecretResponseTypeDef definition

class DeleteSecretResponseTypeDef(TypedDict):
    ARN: str,
    Name: str,
    DeletionDate: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeSecretRequestRequestTypeDef#

# DescribeSecretRequestRequestTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import DescribeSecretRequestRequestTypeDef

def get_value() -> DescribeSecretRequestRequestTypeDef:
    return {
        "SecretId": ...,
    }
# DescribeSecretRequestRequestTypeDef definition

class DescribeSecretRequestRequestTypeDef(TypedDict):
    SecretId: str,

RotationRulesTypeTypeDef#

# RotationRulesTypeTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import RotationRulesTypeTypeDef

def get_value() -> RotationRulesTypeTypeDef:
    return {
        "AutomaticallyAfterDays": ...,
    }
# RotationRulesTypeTypeDef definition

class RotationRulesTypeTypeDef(TypedDict):
    AutomaticallyAfterDays: NotRequired[int],
    Duration: NotRequired[str],
    ScheduleExpression: NotRequired[str],

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import EmptyResponseMetadataTypeDef

def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }
# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

FilterTypeDef#

# FilterTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import FilterTypeDef

def get_value() -> FilterTypeDef:
    return {
        "Key": ...,
    }
# FilterTypeDef definition

class FilterTypeDef(TypedDict):
    Key: NotRequired[FilterNameStringTypeType],  # (1)
    Values: NotRequired[Sequence[str]],
  1. See FilterNameStringTypeType

GetRandomPasswordRequestRequestTypeDef#

# GetRandomPasswordRequestRequestTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import GetRandomPasswordRequestRequestTypeDef

def get_value() -> GetRandomPasswordRequestRequestTypeDef:
    return {
        "PasswordLength": ...,
    }
# GetRandomPasswordRequestRequestTypeDef 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],

GetRandomPasswordResponseTypeDef#

# GetRandomPasswordResponseTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import GetRandomPasswordResponseTypeDef

def get_value() -> GetRandomPasswordResponseTypeDef:
    return {
        "RandomPassword": ...,
        "ResponseMetadata": ...,
    }
# GetRandomPasswordResponseTypeDef definition

class GetRandomPasswordResponseTypeDef(TypedDict):
    RandomPassword: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetResourcePolicyRequestRequestTypeDef#

# GetResourcePolicyRequestRequestTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import GetResourcePolicyRequestRequestTypeDef

def get_value() -> GetResourcePolicyRequestRequestTypeDef:
    return {
        "SecretId": ...,
    }
# GetResourcePolicyRequestRequestTypeDef definition

class GetResourcePolicyRequestRequestTypeDef(TypedDict):
    SecretId: str,

GetResourcePolicyResponseTypeDef#

# GetResourcePolicyResponseTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import GetResourcePolicyResponseTypeDef

def get_value() -> GetResourcePolicyResponseTypeDef:
    return {
        "ARN": ...,
        "Name": ...,
        "ResourcePolicy": ...,
        "ResponseMetadata": ...,
    }
# GetResourcePolicyResponseTypeDef definition

class GetResourcePolicyResponseTypeDef(TypedDict):
    ARN: str,
    Name: str,
    ResourcePolicy: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetSecretValueRequestRequestTypeDef#

# GetSecretValueRequestRequestTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import GetSecretValueRequestRequestTypeDef

def get_value() -> GetSecretValueRequestRequestTypeDef:
    return {
        "SecretId": ...,
    }
# GetSecretValueRequestRequestTypeDef definition

class GetSecretValueRequestRequestTypeDef(TypedDict):
    SecretId: str,
    VersionId: NotRequired[str],
    VersionStage: NotRequired[str],

GetSecretValueResponseTypeDef#

# GetSecretValueResponseTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import GetSecretValueResponseTypeDef

def get_value() -> GetSecretValueResponseTypeDef:
    return {
        "ARN": ...,
        "Name": ...,
        "VersionId": ...,
        "SecretBinary": ...,
        "SecretString": ...,
        "VersionStages": ...,
        "CreatedDate": ...,
        "ResponseMetadata": ...,
    }
# GetSecretValueResponseTypeDef 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

ListSecretVersionIdsRequestRequestTypeDef#

# ListSecretVersionIdsRequestRequestTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import ListSecretVersionIdsRequestRequestTypeDef

def get_value() -> ListSecretVersionIdsRequestRequestTypeDef:
    return {
        "SecretId": ...,
    }
# ListSecretVersionIdsRequestRequestTypeDef definition

class ListSecretVersionIdsRequestRequestTypeDef(TypedDict):
    SecretId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    IncludeDeprecated: NotRequired[bool],

SecretVersionsListEntryTypeDef#

# SecretVersionsListEntryTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import SecretVersionsListEntryTypeDef

def get_value() -> SecretVersionsListEntryTypeDef:
    return {
        "VersionId": ...,
    }
# SecretVersionsListEntryTypeDef definition

class SecretVersionsListEntryTypeDef(TypedDict):
    VersionId: NotRequired[str],
    VersionStages: NotRequired[List[str]],
    LastAccessedDate: NotRequired[datetime],
    CreatedDate: NotRequired[datetime],
    KmsKeyIds: NotRequired[List[str]],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }
# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

PutResourcePolicyRequestRequestTypeDef#

# PutResourcePolicyRequestRequestTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import PutResourcePolicyRequestRequestTypeDef

def get_value() -> PutResourcePolicyRequestRequestTypeDef:
    return {
        "SecretId": ...,
        "ResourcePolicy": ...,
    }
# PutResourcePolicyRequestRequestTypeDef definition

class PutResourcePolicyRequestRequestTypeDef(TypedDict):
    SecretId: str,
    ResourcePolicy: str,
    BlockPublicPolicy: NotRequired[bool],

PutResourcePolicyResponseTypeDef#

# PutResourcePolicyResponseTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import PutResourcePolicyResponseTypeDef

def get_value() -> PutResourcePolicyResponseTypeDef:
    return {
        "ARN": ...,
        "Name": ...,
        "ResponseMetadata": ...,
    }
# PutResourcePolicyResponseTypeDef definition

class PutResourcePolicyResponseTypeDef(TypedDict):
    ARN: str,
    Name: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PutSecretValueRequestRequestTypeDef#

# PutSecretValueRequestRequestTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import PutSecretValueRequestRequestTypeDef

def get_value() -> PutSecretValueRequestRequestTypeDef:
    return {
        "SecretId": ...,
    }
# PutSecretValueRequestRequestTypeDef definition

class PutSecretValueRequestRequestTypeDef(TypedDict):
    SecretId: str,
    ClientRequestToken: NotRequired[str],
    SecretBinary: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
    SecretString: NotRequired[str],
    VersionStages: NotRequired[Sequence[str]],

PutSecretValueResponseTypeDef#

# PutSecretValueResponseTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import PutSecretValueResponseTypeDef

def get_value() -> PutSecretValueResponseTypeDef:
    return {
        "ARN": ...,
        "Name": ...,
        "VersionId": ...,
        "VersionStages": ...,
        "ResponseMetadata": ...,
    }
# PutSecretValueResponseTypeDef definition

class PutSecretValueResponseTypeDef(TypedDict):
    ARN: str,
    Name: str,
    VersionId: str,
    VersionStages: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RemoveRegionsFromReplicationRequestRequestTypeDef#

# RemoveRegionsFromReplicationRequestRequestTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import RemoveRegionsFromReplicationRequestRequestTypeDef

def get_value() -> RemoveRegionsFromReplicationRequestRequestTypeDef:
    return {
        "SecretId": ...,
        "RemoveReplicaRegions": ...,
    }
# RemoveRegionsFromReplicationRequestRequestTypeDef definition

class RemoveRegionsFromReplicationRequestRequestTypeDef(TypedDict):
    SecretId: str,
    RemoveReplicaRegions: Sequence[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

RestoreSecretRequestRequestTypeDef#

# RestoreSecretRequestRequestTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import RestoreSecretRequestRequestTypeDef

def get_value() -> RestoreSecretRequestRequestTypeDef:
    return {
        "SecretId": ...,
    }
# RestoreSecretRequestRequestTypeDef definition

class RestoreSecretRequestRequestTypeDef(TypedDict):
    SecretId: str,

RestoreSecretResponseTypeDef#

# RestoreSecretResponseTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import RestoreSecretResponseTypeDef

def get_value() -> RestoreSecretResponseTypeDef:
    return {
        "ARN": ...,
        "Name": ...,
        "ResponseMetadata": ...,
    }
# RestoreSecretResponseTypeDef definition

class RestoreSecretResponseTypeDef(TypedDict):
    ARN: str,
    Name: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RotateSecretResponseTypeDef#

# RotateSecretResponseTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import RotateSecretResponseTypeDef

def get_value() -> RotateSecretResponseTypeDef:
    return {
        "ARN": ...,
        "Name": ...,
        "VersionId": ...,
        "ResponseMetadata": ...,
    }
# RotateSecretResponseTypeDef definition

class RotateSecretResponseTypeDef(TypedDict):
    ARN: str,
    Name: str,
    VersionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StopReplicationToReplicaRequestRequestTypeDef#

# StopReplicationToReplicaRequestRequestTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import StopReplicationToReplicaRequestRequestTypeDef

def get_value() -> StopReplicationToReplicaRequestRequestTypeDef:
    return {
        "SecretId": ...,
    }
# StopReplicationToReplicaRequestRequestTypeDef definition

class StopReplicationToReplicaRequestRequestTypeDef(TypedDict):
    SecretId: str,

StopReplicationToReplicaResponseTypeDef#

# StopReplicationToReplicaResponseTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import StopReplicationToReplicaResponseTypeDef

def get_value() -> StopReplicationToReplicaResponseTypeDef:
    return {
        "ARN": ...,
        "ResponseMetadata": ...,
    }
# StopReplicationToReplicaResponseTypeDef definition

class StopReplicationToReplicaResponseTypeDef(TypedDict):
    ARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "SecretId": ...,
        "TagKeys": ...,
    }
# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    SecretId: str,
    TagKeys: Sequence[str],

UpdateSecretRequestRequestTypeDef#

# UpdateSecretRequestRequestTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import UpdateSecretRequestRequestTypeDef

def get_value() -> UpdateSecretRequestRequestTypeDef:
    return {
        "SecretId": ...,
    }
# UpdateSecretRequestRequestTypeDef 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],

UpdateSecretResponseTypeDef#

# UpdateSecretResponseTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import UpdateSecretResponseTypeDef

def get_value() -> UpdateSecretResponseTypeDef:
    return {
        "ARN": ...,
        "Name": ...,
        "VersionId": ...,
        "ResponseMetadata": ...,
    }
# UpdateSecretResponseTypeDef definition

class UpdateSecretResponseTypeDef(TypedDict):
    ARN: str,
    Name: str,
    VersionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateSecretVersionStageRequestRequestTypeDef#

# UpdateSecretVersionStageRequestRequestTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import UpdateSecretVersionStageRequestRequestTypeDef

def get_value() -> UpdateSecretVersionStageRequestRequestTypeDef:
    return {
        "SecretId": ...,
        "VersionStage": ...,
    }
# UpdateSecretVersionStageRequestRequestTypeDef definition

class UpdateSecretVersionStageRequestRequestTypeDef(TypedDict):
    SecretId: str,
    VersionStage: str,
    RemoveFromVersionId: NotRequired[str],
    MoveToVersionId: NotRequired[str],

UpdateSecretVersionStageResponseTypeDef#

# UpdateSecretVersionStageResponseTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import UpdateSecretVersionStageResponseTypeDef

def get_value() -> UpdateSecretVersionStageResponseTypeDef:
    return {
        "ARN": ...,
        "Name": ...,
        "ResponseMetadata": ...,
    }
# UpdateSecretVersionStageResponseTypeDef definition

class UpdateSecretVersionStageResponseTypeDef(TypedDict):
    ARN: str,
    Name: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ValidateResourcePolicyRequestRequestTypeDef#

# ValidateResourcePolicyRequestRequestTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import ValidateResourcePolicyRequestRequestTypeDef

def get_value() -> ValidateResourcePolicyRequestRequestTypeDef:
    return {
        "ResourcePolicy": ...,
    }
# ValidateResourcePolicyRequestRequestTypeDef definition

class ValidateResourcePolicyRequestRequestTypeDef(TypedDict):
    ResourcePolicy: str,
    SecretId: NotRequired[str],

ValidationErrorsEntryTypeDef#

# ValidationErrorsEntryTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import ValidationErrorsEntryTypeDef

def get_value() -> ValidationErrorsEntryTypeDef:
    return {
        "CheckName": ...,
    }
# ValidationErrorsEntryTypeDef definition

class ValidationErrorsEntryTypeDef(TypedDict):
    CheckName: NotRequired[str],
    ErrorMessage: NotRequired[str],

ReplicateSecretToRegionsRequestRequestTypeDef#

# ReplicateSecretToRegionsRequestRequestTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import ReplicateSecretToRegionsRequestRequestTypeDef

def get_value() -> ReplicateSecretToRegionsRequestRequestTypeDef:
    return {
        "SecretId": ...,
        "AddReplicaRegions": ...,
    }
# ReplicateSecretToRegionsRequestRequestTypeDef definition

class ReplicateSecretToRegionsRequestRequestTypeDef(TypedDict):
    SecretId: str,
    AddReplicaRegions: Sequence[ReplicaRegionTypeTypeDef],  # (1)
    ForceOverwriteReplicaSecret: NotRequired[bool],
  1. See ReplicaRegionTypeTypeDef

CreateSecretRequestRequestTypeDef#

# CreateSecretRequestRequestTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import CreateSecretRequestRequestTypeDef

def get_value() -> CreateSecretRequestRequestTypeDef:
    return {
        "Name": ...,
    }
# CreateSecretRequestRequestTypeDef 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#

# TagResourceRequestRequestTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
        "SecretId": ...,
        "Tags": ...,
    }
# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    SecretId: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CreateSecretResponseTypeDef#

# CreateSecretResponseTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import CreateSecretResponseTypeDef

def get_value() -> CreateSecretResponseTypeDef:
    return {
        "ARN": ...,
        "Name": ...,
        "VersionId": ...,
        "ReplicationStatus": ...,
        "ResponseMetadata": ...,
    }
# CreateSecretResponseTypeDef definition

class CreateSecretResponseTypeDef(TypedDict):
    ARN: str,
    Name: str,
    VersionId: str,
    ReplicationStatus: List[ReplicationStatusTypeTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ReplicationStatusTypeTypeDef
  2. See ResponseMetadataTypeDef

RemoveRegionsFromReplicationResponseTypeDef#

# RemoveRegionsFromReplicationResponseTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import RemoveRegionsFromReplicationResponseTypeDef

def get_value() -> RemoveRegionsFromReplicationResponseTypeDef:
    return {
        "ARN": ...,
        "ReplicationStatus": ...,
        "ResponseMetadata": ...,
    }
# RemoveRegionsFromReplicationResponseTypeDef definition

class RemoveRegionsFromReplicationResponseTypeDef(TypedDict):
    ARN: str,
    ReplicationStatus: List[ReplicationStatusTypeTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ReplicationStatusTypeTypeDef
  2. See ResponseMetadataTypeDef

ReplicateSecretToRegionsResponseTypeDef#

# ReplicateSecretToRegionsResponseTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import ReplicateSecretToRegionsResponseTypeDef

def get_value() -> ReplicateSecretToRegionsResponseTypeDef:
    return {
        "ARN": ...,
        "ReplicationStatus": ...,
        "ResponseMetadata": ...,
    }
# ReplicateSecretToRegionsResponseTypeDef definition

class ReplicateSecretToRegionsResponseTypeDef(TypedDict):
    ARN: str,
    ReplicationStatus: List[ReplicationStatusTypeTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ReplicationStatusTypeTypeDef
  2. See ResponseMetadataTypeDef

DescribeSecretResponseTypeDef#

# 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": ...,
    }
# DescribeSecretResponseTypeDef 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#

# RotateSecretRequestRequestTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import RotateSecretRequestRequestTypeDef

def get_value() -> RotateSecretRequestRequestTypeDef:
    return {
        "SecretId": ...,
    }
# RotateSecretRequestRequestTypeDef definition

class RotateSecretRequestRequestTypeDef(TypedDict):
    SecretId: str,
    ClientRequestToken: NotRequired[str],
    RotationLambdaARN: NotRequired[str],
    RotationRules: NotRequired[RotationRulesTypeTypeDef],  # (1)
    RotateImmediately: NotRequired[bool],
  1. See RotationRulesTypeTypeDef

SecretListEntryTypeDef#

# SecretListEntryTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import SecretListEntryTypeDef

def get_value() -> SecretListEntryTypeDef:
    return {
        "ARN": ...,
    }
# SecretListEntryTypeDef 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

ListSecretsRequestListSecretsPaginateTypeDef#

# ListSecretsRequestListSecretsPaginateTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import ListSecretsRequestListSecretsPaginateTypeDef

def get_value() -> ListSecretsRequestListSecretsPaginateTypeDef:
    return {
        "IncludePlannedDeletion": ...,
    }
# ListSecretsRequestListSecretsPaginateTypeDef 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

ListSecretsRequestRequestTypeDef#

# ListSecretsRequestRequestTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import ListSecretsRequestRequestTypeDef

def get_value() -> ListSecretsRequestRequestTypeDef:
    return {
        "IncludePlannedDeletion": ...,
    }
# ListSecretsRequestRequestTypeDef 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#

# ListSecretVersionIdsResponseTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import ListSecretVersionIdsResponseTypeDef

def get_value() -> ListSecretVersionIdsResponseTypeDef:
    return {
        "Versions": ...,
        "NextToken": ...,
        "ARN": ...,
        "Name": ...,
        "ResponseMetadata": ...,
    }
# ListSecretVersionIdsResponseTypeDef definition

class ListSecretVersionIdsResponseTypeDef(TypedDict):
    Versions: List[SecretVersionsListEntryTypeDef],  # (1)
    NextToken: str,
    ARN: str,
    Name: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SecretVersionsListEntryTypeDef
  2. See ResponseMetadataTypeDef

ValidateResourcePolicyResponseTypeDef#

# ValidateResourcePolicyResponseTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import ValidateResourcePolicyResponseTypeDef

def get_value() -> ValidateResourcePolicyResponseTypeDef:
    return {
        "PolicyValidationPassed": ...,
        "ValidationErrors": ...,
        "ResponseMetadata": ...,
    }
# ValidateResourcePolicyResponseTypeDef definition

class ValidateResourcePolicyResponseTypeDef(TypedDict):
    PolicyValidationPassed: bool,
    ValidationErrors: List[ValidationErrorsEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ValidationErrorsEntryTypeDef
  2. See ResponseMetadataTypeDef

ListSecretsResponseTypeDef#

# ListSecretsResponseTypeDef usage example

from mypy_boto3_secretsmanager.type_defs import ListSecretsResponseTypeDef

def get_value() -> ListSecretsResponseTypeDef:
    return {
        "SecretList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListSecretsResponseTypeDef definition

class ListSecretsResponseTypeDef(TypedDict):
    SecretList: List[SecretListEntryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SecretListEntryTypeDef
  2. See ResponseMetadataTypeDef