Skip to content

Secretsmanager Classes

APIErrorTypeTypeDef

SecretId

  • Type: typing.Optional[str]

ErrorCode

  • Type: typing.Optional[str]

Message

  • Type: typing.Optional[str]

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

BatchGetSecretValueRequestRequestTypeDef

SecretIdList

  • Type: typing.Optional[typing.Sequence[str]]

Filters

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.secretsmanager_classes.FilterTypeDef]]

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

BatchGetSecretValueResponseTypeDef

SecretValues

  • Type: typing.List[aws_resource_validator.pydantic_models.secretsmanager_classes.SecretValueEntryTypeDef]
  • Required: Yes

Errors

  • Type: typing.List[aws_resource_validator.pydantic_models.secretsmanager_classes.APIErrorTypeTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

CancelRotateSecretRequestRequestTypeDef

SecretId

  • Type:
  • Required: Yes

CancelRotateSecretResponseTypeDef

ARN

  • Type:
  • Required: Yes

Name

  • Type:
  • Required: Yes

VersionId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateSecretRequestRequestTypeDef

Name

  • Type:
  • Required: Yes

ClientRequestToken

  • Type: typing.Optional[str]

Description

  • Type: typing.Optional[str]

KmsKeyId

  • Type: typing.Optional[str]

SecretBinary

  • Type: typing.Union[str, bytes, typing.IO[typing.Any], NoneType]

SecretString

  • Type: typing.Optional[str]

Tags

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.secretsmanager_classes.TagTypeDef]]

AddReplicaRegions

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.secretsmanager_classes.ReplicaRegionTypeTypeDef]]

ForceOverwriteReplicaSecret

  • Type: typing.Optional[bool]

CreateSecretResponseTypeDef

ARN

  • Type:
  • Required: Yes

Name

  • Type:
  • Required: Yes

VersionId

  • Type:
  • Required: Yes

ReplicationStatus

  • Type: typing.List[aws_resource_validator.pydantic_models.secretsmanager_classes.ReplicationStatusTypeTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteResourcePolicyRequestRequestTypeDef

SecretId

  • Type:
  • Required: Yes

DeleteResourcePolicyResponseTypeDef

ARN

  • Type:
  • Required: Yes

Name

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteSecretRequestRequestTypeDef

SecretId

  • Type:
  • Required: Yes

RecoveryWindowInDays

  • Type: typing.Optional[int]

ForceDeleteWithoutRecovery

  • Type: typing.Optional[bool]

DeleteSecretResponseTypeDef

ARN

  • Type:
  • Required: Yes

Name

  • Type:
  • Required: Yes

DeletionDate

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeSecretRequestRequestTypeDef

SecretId

  • Type:
  • Required: Yes

DescribeSecretResponseTypeDef

ARN

  • Type:
  • Required: Yes

Name

  • Type:
  • Required: Yes

Description

  • Type:
  • Required: Yes

KmsKeyId

  • Type:
  • Required: Yes

RotationEnabled

  • Type:
  • Required: Yes

RotationLambdaARN

  • Type:
  • Required: Yes

RotationRules

  • Type:
  • Required: Yes

LastRotatedDate

  • Type:
  • Required: Yes

LastChangedDate

  • Type:
  • Required: Yes

LastAccessedDate

  • Type:
  • Required: Yes

DeletedDate

  • Type:
  • Required: Yes

NextRotationDate

  • Type:
  • Required: Yes

Tags

  • Type: typing.List[aws_resource_validator.pydantic_models.secretsmanager_classes.TagTypeDef]
  • Required: Yes

VersionIdsToStages

  • Type: typing.Dict[str, typing.List[str]]
  • Required: Yes

OwningService

  • Type:
  • Required: Yes

CreatedDate

  • Type:
  • Required: Yes

PrimaryRegion

  • Type:
  • Required: Yes

ReplicationStatus

  • Type: typing.List[aws_resource_validator.pydantic_models.secretsmanager_classes.ReplicationStatusTypeTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

EmptyResponseMetadataTypeDef

ResponseMetadata

  • Type:
  • Required: Yes

FilterTypeDef

Key

  • Type: typing.Optional[typing.Literal['all', 'description', 'name', 'owning-service', 'primary-region', 'tag-key', 'tag-value']]

Values

  • Type: typing.Optional[typing.Sequence[str]]

GetRandomPasswordRequestRequestTypeDef

PasswordLength

  • Type: typing.Optional[int]

ExcludeCharacters

  • Type: typing.Optional[str]

ExcludeNumbers

  • Type: typing.Optional[bool]

ExcludePunctuation

  • Type: typing.Optional[bool]

ExcludeUppercase

  • Type: typing.Optional[bool]

ExcludeLowercase

  • Type: typing.Optional[bool]

IncludeSpace

  • Type: typing.Optional[bool]

RequireEachIncludedType

  • Type: typing.Optional[bool]

GetRandomPasswordResponseTypeDef

RandomPassword

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetResourcePolicyRequestRequestTypeDef

SecretId

  • Type:
  • Required: Yes

GetResourcePolicyResponseTypeDef

ARN

  • Type:
  • Required: Yes

Name

  • Type:
  • Required: Yes

ResourcePolicy

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetSecretValueRequestRequestTypeDef

SecretId

  • Type:
  • Required: Yes

VersionId

  • Type: typing.Optional[str]

VersionStage

  • Type: typing.Optional[str]

GetSecretValueResponseTypeDef

ARN

  • Type:
  • Required: Yes

Name

  • Type:
  • Required: Yes

VersionId

  • Type:
  • Required: Yes

SecretBinary

  • Type:
  • Required: Yes

SecretString

  • Type:
  • Required: Yes

VersionStages

  • Type: typing.List[str]
  • Required: Yes

CreatedDate

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListSecretVersionIdsRequestRequestTypeDef

SecretId

  • Type:
  • Required: Yes

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

IncludeDeprecated

  • Type: typing.Optional[bool]

ListSecretVersionIdsResponseTypeDef

Versions

  • Type: typing.List[aws_resource_validator.pydantic_models.secretsmanager_classes.SecretVersionsListEntryTypeDef]
  • Required: Yes

ARN

  • Type:
  • Required: Yes

Name

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListSecretsRequestListSecretsPaginateTypeDef

IncludePlannedDeletion

  • Type: typing.Optional[bool]

Filters

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.secretsmanager_classes.FilterTypeDef]]

SortOrder

  • Type: typing.Optional[typing.Literal['asc', 'desc']]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.secretsmanager_classes.PaginatorConfigTypeDef]

ListSecretsRequestRequestTypeDef

IncludePlannedDeletion

  • Type: typing.Optional[bool]

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

Filters

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.secretsmanager_classes.FilterTypeDef]]

SortOrder

  • Type: typing.Optional[typing.Literal['asc', 'desc']]

ListSecretsResponseTypeDef

SecretList

  • Type: typing.List[aws_resource_validator.pydantic_models.secretsmanager_classes.SecretListEntryTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

PaginatorConfigTypeDef

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

PutResourcePolicyRequestRequestTypeDef

SecretId

  • Type:
  • Required: Yes

ResourcePolicy

  • Type:
  • Required: Yes

BlockPublicPolicy

  • Type: typing.Optional[bool]

PutResourcePolicyResponseTypeDef

ARN

  • Type:
  • Required: Yes

Name

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

PutSecretValueRequestRequestTypeDef

SecretId

  • Type:
  • Required: Yes

ClientRequestToken

  • Type: typing.Optional[str]

SecretBinary

  • Type: typing.Union[str, bytes, typing.IO[typing.Any], NoneType]

SecretString

  • Type: typing.Optional[str]

VersionStages

  • Type: typing.Optional[typing.Sequence[str]]

RotationToken

  • Type: typing.Optional[str]

PutSecretValueResponseTypeDef

ARN

  • Type:
  • Required: Yes

Name

  • Type:
  • Required: Yes

VersionId

  • Type:
  • Required: Yes

VersionStages

  • Type: typing.List[str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

RemoveRegionsFromReplicationRequestRequestTypeDef

SecretId

  • Type:
  • Required: Yes

RemoveReplicaRegions

  • Type: typing.Sequence[str]
  • Required: Yes

RemoveRegionsFromReplicationResponseTypeDef

ARN

  • Type:
  • Required: Yes

ReplicationStatus

  • Type: typing.List[aws_resource_validator.pydantic_models.secretsmanager_classes.ReplicationStatusTypeTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ReplicaRegionTypeTypeDef

Region

  • Type: typing.Optional[str]

KmsKeyId

  • Type: typing.Optional[str]

ReplicateSecretToRegionsRequestRequestTypeDef

SecretId

  • Type:
  • Required: Yes

AddReplicaRegions

  • Type: typing.Sequence[aws_resource_validator.pydantic_models.secretsmanager_classes.ReplicaRegionTypeTypeDef]
  • Required: Yes

ForceOverwriteReplicaSecret

  • Type: typing.Optional[bool]

ReplicateSecretToRegionsResponseTypeDef

ARN

  • Type:
  • Required: Yes

ReplicationStatus

  • Type: typing.List[aws_resource_validator.pydantic_models.secretsmanager_classes.ReplicationStatusTypeTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ReplicationStatusTypeTypeDef

Region

  • Type: typing.Optional[str]

KmsKeyId

  • Type: typing.Optional[str]

Status

  • Type: typing.Optional[typing.Literal['Failed', 'InProgress', 'InSync']]

StatusMessage

  • Type: typing.Optional[str]

LastAccessedDate

  • Type: typing.Optional[datetime.datetime]

ResponseMetadataTypeDef

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

RestoreSecretRequestRequestTypeDef

SecretId

  • Type:
  • Required: Yes

RestoreSecretResponseTypeDef

ARN

  • Type:
  • Required: Yes

Name

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

RotateSecretRequestRequestTypeDef

SecretId

  • Type:
  • Required: Yes

ClientRequestToken

  • Type: typing.Optional[str]

RotationLambdaARN

  • Type: typing.Optional[str]

RotationRules

  • Type: typing.Optional[aws_resource_validator.pydantic_models.secretsmanager_classes.RotationRulesTypeTypeDef]

RotateImmediately

  • Type: typing.Optional[bool]

RotateSecretResponseTypeDef

ARN

  • Type:
  • Required: Yes

Name

  • Type:
  • Required: Yes

VersionId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

RotationRulesTypeTypeDef

AutomaticallyAfterDays

  • Type: typing.Optional[int]

Duration

  • Type: typing.Optional[str]

ScheduleExpression

  • Type: typing.Optional[str]

SecretListEntryTypeDef

ARN

  • Type: typing.Optional[str]

Name

  • Type: typing.Optional[str]

Description

  • Type: typing.Optional[str]

KmsKeyId

  • Type: typing.Optional[str]

RotationEnabled

  • Type: typing.Optional[bool]

RotationLambdaARN

  • Type: typing.Optional[str]

RotationRules

  • Type: typing.Optional[aws_resource_validator.pydantic_models.secretsmanager_classes.RotationRulesTypeTypeDef]

LastRotatedDate

  • Type: typing.Optional[datetime.datetime]

LastChangedDate

  • Type: typing.Optional[datetime.datetime]

LastAccessedDate

  • Type: typing.Optional[datetime.datetime]

DeletedDate

  • Type: typing.Optional[datetime.datetime]

NextRotationDate

  • Type: typing.Optional[datetime.datetime]

Tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.secretsmanager_classes.TagTypeDef]]

SecretVersionsToStages

  • Type: typing.Optional[typing.Dict[str, typing.List[str]]]

OwningService

  • Type: typing.Optional[str]

CreatedDate

  • Type: typing.Optional[datetime.datetime]

PrimaryRegion

  • Type: typing.Optional[str]

SecretValueEntryTypeDef

ARN

  • Type: typing.Optional[str]

Name

  • Type: typing.Optional[str]

VersionId

  • Type: typing.Optional[str]

SecretBinary

  • Type: typing.Optional[bytes]

SecretString

  • Type: typing.Optional[str]

VersionStages

  • Type: typing.Optional[typing.List[str]]

CreatedDate

  • Type: typing.Optional[datetime.datetime]

SecretVersionsListEntryTypeDef

VersionId

  • Type: typing.Optional[str]

VersionStages

  • Type: typing.Optional[typing.List[str]]

LastAccessedDate

  • Type: typing.Optional[datetime.datetime]

CreatedDate

  • Type: typing.Optional[datetime.datetime]

KmsKeyIds

  • Type: typing.Optional[typing.List[str]]

StopReplicationToReplicaRequestRequestTypeDef

SecretId

  • Type:
  • Required: Yes

StopReplicationToReplicaResponseTypeDef

ARN

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

TagResourceRequestRequestTypeDef

SecretId

  • Type:
  • Required: Yes

Tags

  • Type: typing.Sequence[aws_resource_validator.pydantic_models.secretsmanager_classes.TagTypeDef]
  • Required: Yes

TagTypeDef

Key

  • Type: typing.Optional[str]

Value

  • Type: typing.Optional[str]

UntagResourceRequestRequestTypeDef

SecretId

  • Type:
  • Required: Yes

TagKeys

  • Type: typing.Sequence[str]
  • Required: Yes

UpdateSecretRequestRequestTypeDef

SecretId

  • Type:
  • Required: Yes

ClientRequestToken

  • Type: typing.Optional[str]

Description

  • Type: typing.Optional[str]

KmsKeyId

  • Type: typing.Optional[str]

SecretBinary

  • Type: typing.Union[str, bytes, typing.IO[typing.Any], NoneType]

SecretString

  • Type: typing.Optional[str]

UpdateSecretResponseTypeDef

ARN

  • Type:
  • Required: Yes

Name

  • Type:
  • Required: Yes

VersionId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateSecretVersionStageRequestRequestTypeDef

SecretId

  • Type:
  • Required: Yes

VersionStage

  • Type:
  • Required: Yes

RemoveFromVersionId

  • Type: typing.Optional[str]

MoveToVersionId

  • Type: typing.Optional[str]

UpdateSecretVersionStageResponseTypeDef

ARN

  • Type:
  • Required: Yes

Name

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ValidateResourcePolicyRequestRequestTypeDef

ResourcePolicy

  • Type:
  • Required: Yes

SecretId

  • Type: typing.Optional[str]

ValidateResourcePolicyResponseTypeDef

PolicyValidationPassed

  • Type:
  • Required: Yes

ValidationErrors

  • Type: typing.List[aws_resource_validator.pydantic_models.secretsmanager_classes.ValidationErrorsEntryTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ValidationErrorsEntryTypeDef

CheckName

  • Type: typing.Optional[str]

ErrorMessage

  • Type: typing.Optional[str]