Network.AWS.SecretsManager

AWS Secrets Manager API Reference

AWS Secrets Manager is a web service that enables 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 AWS Secrets Manager User Guide .

API Version

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

We recommend that you use the AWS SDKs to make programmatic API calls to Secrets Manager. However, you also can use the Secrets Manager HTTP Query API to make direct calls to the Secrets Manager web service. To learn more about the Secrets Manager HTTP Query API, see Making Query Requests in the AWS Secrets Manager User Guide .

Secrets Manager supports GET and POST requests for all actions. That is, the API doesn't require you to use GET for some actions and POST for others. However, GET requests are subject to the limitation size of a URL. Therefore, for operations that require larger sizes, use a POST request.

Support and Feedback for AWS Secrets Manager

We welcome your feedback. Send your comments to [e-mail] , or post your feedback and questions in the AWS Secrets Manager Discussion Forum . For more information about the AWS Discussion Forums, see Forums Help .

How examples are presented

The JSON that AWS Secrets Manager expects as your request parameters and that the service returns as a response to HTTP query requests are single, long strings without line breaks or white space formatting. The JSON shown in the examples is formatted with both line breaks and white space to improve readability. When example input parameters would also result in long strings that extend beyond the screen, we insert line breaks to enhance readability. You should always submit the input as a single JSON text string.

Logging API Requests

AWS Secrets Manager supports AWS CloudTrail, a service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information that's collected by AWS CloudTrail, you can determine which requests were successfully made to Secrets Manager, who made the request, when it was made, and so on. For more about AWS Secrets Manager and its support for AWS CloudTrail, see Logging AWS Secrets Manager Events with AWS CloudTrail in the AWS Secrets Manager User Guide . To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide .

Service Configuration

secretsManager :: Service

API version 2017-10-17 of the Amazon Secrets Manager SDK configuration.

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by SecretsManager.

MalformedPolicyDocumentException

_MalformedPolicyDocumentException :: AsError a => Getting (First ServiceError) a ServiceError

The policy document that you provided isn't valid.

InvalidParameterException

_InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError

You provided an invalid value for a parameter.

InvalidRequestException

_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError

You provided a parameter value that is not valid for the current state of the resource. For example, if you try to enable rotation on a secret, you must already have a Lambda function ARN configured or included as a parameter in this call.

DecryptionFailure

_DecryptionFailure :: AsError a => Getting (First ServiceError) a ServiceError

Secrets Manager can't decrypt the protected secret text using the provided KMS key.

EncryptionFailure

_EncryptionFailure :: AsError a => Getting (First ServiceError) a ServiceError

Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the customer master key (CMK) is available, enabled, and not in an invalid state. For more information, see How Key State Affects Use of a Customer Master Key .

InvalidNextTokenException

_InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError

You provided an invalid NextToken value.

InternalServiceError

_InternalServiceError :: AsError a => Getting (First ServiceError) a ServiceError

An error occurred on the server side.

ResourceExistsException

_ResourceExistsException :: AsError a => Getting (First ServiceError) a ServiceError

A resource with the ID you requested already exists.

ResourceNotFoundException

_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError

We can't find the resource that you asked for.

LimitExceededException

_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError

The request failed because it would exceed one of the Secrets Manager internal limits.

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

DeleteSecret

module Network.AWS.SecretsManager.DeleteSecret

ListSecrets

module Network.AWS.SecretsManager.ListSecrets

UpdateSecret

module Network.AWS.SecretsManager.UpdateSecret

RotateSecret

module Network.AWS.SecretsManager.RotateSecret

CreateSecret

module Network.AWS.SecretsManager.CreateSecret

GetSecretValue

module Network.AWS.SecretsManager.GetSecretValue

DescribeSecret

module Network.AWS.SecretsManager.DescribeSecret

RestoreSecret

module Network.AWS.SecretsManager.RestoreSecret

CancelRotateSecret

module Network.AWS.SecretsManager.CancelRotateSecret

PutSecretValue

module Network.AWS.SecretsManager.PutSecretValue

GetRandomPassword

module Network.AWS.SecretsManager.GetRandomPassword

ListSecretVersionIds

module Network.AWS.SecretsManager.ListSecretVersionIds

TagResource

module Network.AWS.SecretsManager.TagResource

UntagResource

module Network.AWS.SecretsManager.UntagResource

UpdateSecretVersionStage

module Network.AWS.SecretsManager.UpdateSecretVersionStage

Types

RotationRulesType

data RotationRulesType

A structure that defines the rotation configuration for the secret.

See: rotationRulesType smart constructor.

Instances

Eq RotationRulesType

Methods

(==) :: RotationRulesType -> RotationRulesType -> Bool

(/=) :: RotationRulesType -> RotationRulesType -> Bool

Data RotationRulesType

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RotationRulesType -> c RotationRulesType

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RotationRulesType

toConstr :: RotationRulesType -> Constr

dataTypeOf :: RotationRulesType -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c RotationRulesType)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RotationRulesType)

gmapT :: (forall b. Data b => b -> b) -> RotationRulesType -> RotationRulesType

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RotationRulesType -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RotationRulesType -> r

gmapQ :: (forall d. Data d => d -> u) -> RotationRulesType -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> RotationRulesType -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RotationRulesType -> m RotationRulesType

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RotationRulesType -> m RotationRulesType

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RotationRulesType -> m RotationRulesType

Read RotationRulesType

Methods

readsPrec :: Int -> ReadS RotationRulesType

readList :: ReadS [RotationRulesType]

readPrec :: ReadPrec RotationRulesType

readListPrec :: ReadPrec [RotationRulesType]

Show RotationRulesType

Methods

showsPrec :: Int -> RotationRulesType -> ShowS

show :: RotationRulesType -> String

showList :: [RotationRulesType] -> ShowS

Generic RotationRulesType

Associated Types

type Rep RotationRulesType :: * -> *

Methods

from :: RotationRulesType -> Rep RotationRulesType x

to :: Rep RotationRulesType x -> RotationRulesType

Hashable RotationRulesType

Methods

hashWithSalt :: Int -> RotationRulesType -> Int

hash :: RotationRulesType -> Int

ToJSON RotationRulesType

Methods

toJSON :: RotationRulesType -> Value

toEncoding :: RotationRulesType -> Encoding

toJSONList :: [RotationRulesType] -> Value

toEncodingList :: [RotationRulesType] -> Encoding

FromJSON RotationRulesType

Methods

parseJSON :: Value -> Parser RotationRulesType

parseJSONList :: Value -> Parser [RotationRulesType]

NFData RotationRulesType

Methods

rnf :: RotationRulesType -> ()

type Rep RotationRulesType

type Rep RotationRulesType = D1 * (MetaData "RotationRulesType" "Network.AWS.SecretsManager.Types.Product" "amazonka-secretsmanager-1.6.0-K7nD2j5oEj0GsgMw0kPUxD" True) (C1 * (MetaCons "RotationRulesType'" PrefixI True) (S1 * (MetaSel (Just Symbol "_rrtAutomaticallyAfterDays") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Nat))))

rotationRulesType :: RotationRulesType

Creates a value of RotationRulesType with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rrtAutomaticallyAfterDays - Specifies the number of days between automatic scheduled rotations of the secret.

rrtAutomaticallyAfterDays :: Lens' RotationRulesType (Maybe Natural)

Specifies the number of days between automatic scheduled rotations of the secret.

SecretListEntry

data SecretListEntry

A structure that contains the details about a secret. It does not include the encrypted SecretString and SecretBinary values. To get those values, use the GetSecretValue operation.

See: secretListEntry smart constructor.

Instances

Eq SecretListEntry

Methods

(==) :: SecretListEntry -> SecretListEntry -> Bool

(/=) :: SecretListEntry -> SecretListEntry -> Bool

Data SecretListEntry

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SecretListEntry -> c SecretListEntry

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SecretListEntry

toConstr :: SecretListEntry -> Constr

dataTypeOf :: SecretListEntry -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SecretListEntry)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SecretListEntry)

gmapT :: (forall b. Data b => b -> b) -> SecretListEntry -> SecretListEntry

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SecretListEntry -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SecretListEntry -> r

gmapQ :: (forall d. Data d => d -> u) -> SecretListEntry -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SecretListEntry -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SecretListEntry -> m SecretListEntry

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SecretListEntry -> m SecretListEntry

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SecretListEntry -> m SecretListEntry

Read SecretListEntry

Methods

readsPrec :: Int -> ReadS SecretListEntry

readList :: ReadS [SecretListEntry]

readPrec :: ReadPrec SecretListEntry

readListPrec :: ReadPrec [SecretListEntry]

Show SecretListEntry

Methods

showsPrec :: Int -> SecretListEntry -> ShowS

show :: SecretListEntry -> String

showList :: [SecretListEntry] -> ShowS

Generic SecretListEntry

Associated Types

type Rep SecretListEntry :: * -> *

Methods

from :: SecretListEntry -> Rep SecretListEntry x

to :: Rep SecretListEntry x -> SecretListEntry

Hashable SecretListEntry

Methods

hashWithSalt :: Int -> SecretListEntry -> Int

hash :: SecretListEntry -> Int

FromJSON SecretListEntry

Methods

parseJSON :: Value -> Parser SecretListEntry

parseJSONList :: Value -> Parser [SecretListEntry]

NFData SecretListEntry

Methods

rnf :: SecretListEntry -> ()

type Rep SecretListEntry

type Rep SecretListEntry = D1 * (MetaData "SecretListEntry" "Network.AWS.SecretsManager.Types.Product" "amazonka-secretsmanager-1.6.0-K7nD2j5oEj0GsgMw0kPUxD" False) (C1 * (MetaCons "SecretListEntry'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_sleLastChangedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_sleSecretVersionsToStages") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text (List1 Text))))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sleRotationRules") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe RotationRulesType))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sleDeletedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX))) (S1 * (MetaSel (Just Symbol "_sleRotationEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_sleKMSKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sleName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_sleLastRotatedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_sleLastAccessedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX))) (S1 * (MetaSel (Just Symbol "_sleDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sleRotationLambdaARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_sleTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Tag]))))))))

secretListEntry :: SecretListEntry

Creates a value of SecretListEntry with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sleLastChangedDate - The last date and time that this secret was modified in any way.
• sleARN - The Amazon Resource Name (ARN) of the secret. For more information about ARNs in Secrets Manager, see Policy Resources in the AWS Secrets Manager User Guide .
• sleSecretVersionsToStages - A list of all of the currently assigned SecretVersionStage staging labels and the SecretVersionId that each is attached to. Staging labels are used to keep track of the different versions during the rotation process.
• sleRotationRules - A structure that defines the rotation configuration for the secret.
• sleDeletedDate - The date and time on which this secret was deleted. Not present on active secrets. The secret can be recovered until the number of days in the recovery window has passed, as specified in the RecoveryWindowInDays parameter of the DeleteSecret operation.
• sleRotationEnabled - Indicated whether automatic, scheduled rotation is enabled for this secret.
• sleKMSKeyId - The ARN or alias of the AWS KMS customer master key (CMK) that's used to encrypt the SecretString and SecretBinary fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK (the one named awssecretsmanager ) for this account.
• sleName - The friendly name of the secret. You can use forward slashes in the name to represent a path hierarchy. For example, proddatabases/dbserver1 could represent the secret for a server named dbserver1 in the folder databases in the folder prod .
• sleLastRotatedDate - The last date and time that the rotation process for this secret was invoked.
• sleLastAccessedDate - The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows only the date, not the time.
• sleDescription - The user-provided description of the secret.
• sleRotationLambdaARN - The ARN of an AWS Lambda function that's invoked by Secrets Manager to rotate and expire the secret either automatically per the schedule or manually by a call to RotateSecret .
• sleTags - The list of user-defined tags that are associated with the secret. To add tags to a secret, use TagResource . To remove tags, use UntagResource .

sleLastChangedDate :: Lens' SecretListEntry (Maybe UTCTime)

The last date and time that this secret was modified in any way.

sleARN :: Lens' SecretListEntry (Maybe Text)

The Amazon Resource Name (ARN) of the secret. For more information about ARNs in Secrets Manager, see Policy Resources in the AWS Secrets Manager User Guide .

sleSecretVersionsToStages :: Lens' SecretListEntry (HashMap Text (NonEmpty Text))

A list of all of the currently assigned SecretVersionStage staging labels and the SecretVersionId that each is attached to. Staging labels are used to keep track of the different versions during the rotation process.

sleRotationRules :: Lens' SecretListEntry (Maybe RotationRulesType)

A structure that defines the rotation configuration for the secret.

sleDeletedDate :: Lens' SecretListEntry (Maybe UTCTime)

The date and time on which this secret was deleted. Not present on active secrets. The secret can be recovered until the number of days in the recovery window has passed, as specified in the RecoveryWindowInDays parameter of the DeleteSecret operation.

sleRotationEnabled :: Lens' SecretListEntry (Maybe Bool)

Indicated whether automatic, scheduled rotation is enabled for this secret.

sleKMSKeyId :: Lens' SecretListEntry (Maybe Text)

The ARN or alias of the AWS KMS customer master key (CMK) that's used to encrypt the SecretString and SecretBinary fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK (the one named awssecretsmanager ) for this account.

sleName :: Lens' SecretListEntry (Maybe Text)

The friendly name of the secret. You can use forward slashes in the name to represent a path hierarchy. For example, proddatabases/dbserver1 could represent the secret for a server named dbserver1 in the folder databases in the folder prod .

sleLastRotatedDate :: Lens' SecretListEntry (Maybe UTCTime)

The last date and time that the rotation process for this secret was invoked.

sleLastAccessedDate :: Lens' SecretListEntry (Maybe UTCTime)

The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows only the date, not the time.

sleDescription :: Lens' SecretListEntry (Maybe Text)

The user-provided description of the secret.

sleRotationLambdaARN :: Lens' SecretListEntry (Maybe Text)

The ARN of an AWS Lambda function that's invoked by Secrets Manager to rotate and expire the secret either automatically per the schedule or manually by a call to RotateSecret .

sleTags :: Lens' SecretListEntry [Tag]

The list of user-defined tags that are associated with the secret. To add tags to a secret, use TagResource . To remove tags, use UntagResource .

SecretVersionsListEntry

data SecretVersionsListEntry

A structure that contains information about one version of a secret.

See: secretVersionsListEntry smart constructor.

Instances

Eq SecretVersionsListEntry

Methods

(==) :: SecretVersionsListEntry -> SecretVersionsListEntry -> Bool

(/=) :: SecretVersionsListEntry -> SecretVersionsListEntry -> Bool

Data SecretVersionsListEntry

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SecretVersionsListEntry -> c SecretVersionsListEntry

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SecretVersionsListEntry

toConstr :: SecretVersionsListEntry -> Constr

dataTypeOf :: SecretVersionsListEntry -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SecretVersionsListEntry)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SecretVersionsListEntry)

gmapT :: (forall b. Data b => b -> b) -> SecretVersionsListEntry -> SecretVersionsListEntry

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SecretVersionsListEntry -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SecretVersionsListEntry -> r

gmapQ :: (forall d. Data d => d -> u) -> SecretVersionsListEntry -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SecretVersionsListEntry -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SecretVersionsListEntry -> m SecretVersionsListEntry

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SecretVersionsListEntry -> m SecretVersionsListEntry

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SecretVersionsListEntry -> m SecretVersionsListEntry

Read SecretVersionsListEntry

Methods

readsPrec :: Int -> ReadS SecretVersionsListEntry

readList :: ReadS [SecretVersionsListEntry]

readPrec :: ReadPrec SecretVersionsListEntry

readListPrec :: ReadPrec [SecretVersionsListEntry]

Show SecretVersionsListEntry

Methods

showsPrec :: Int -> SecretVersionsListEntry -> ShowS

show :: SecretVersionsListEntry -> String

showList :: [SecretVersionsListEntry] -> ShowS

Generic SecretVersionsListEntry

Associated Types

type Rep SecretVersionsListEntry :: * -> *

Methods

from :: SecretVersionsListEntry -> Rep SecretVersionsListEntry x

to :: Rep SecretVersionsListEntry x -> SecretVersionsListEntry

Hashable SecretVersionsListEntry

Methods

hashWithSalt :: Int -> SecretVersionsListEntry -> Int

hash :: SecretVersionsListEntry -> Int

FromJSON SecretVersionsListEntry

Methods

parseJSON :: Value -> Parser SecretVersionsListEntry

parseJSONList :: Value -> Parser [SecretVersionsListEntry]

NFData SecretVersionsListEntry

Methods

rnf :: SecretVersionsListEntry -> ()

type Rep SecretVersionsListEntry

type Rep SecretVersionsListEntry = D1 * (MetaData "SecretVersionsListEntry" "Network.AWS.SecretsManager.Types.Product" "amazonka-secretsmanager-1.6.0-K7nD2j5oEj0GsgMw0kPUxD" False) (C1 * (MetaCons "SecretVersionsListEntry'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_svleVersionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_svleVersionStages") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (List1 Text))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_svleCreatedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX))) (S1 * (MetaSel (Just Symbol "_svleLastAccessedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX))))))

secretVersionsListEntry :: SecretVersionsListEntry

Creates a value of SecretVersionsListEntry with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• svleVersionId - The unique version identifier of this version of the secret.
• svleVersionStages - An array of staging labels that are currently associated with this version of the secret.
• svleCreatedDate - The date and time this version of the secret was created.
• svleLastAccessedDate - The date that this version of the secret was last accessed. Note that the resolution of this field is at the date level and does not include the time.

svleVersionId :: Lens' SecretVersionsListEntry (Maybe Text)

The unique version identifier of this version of the secret.

svleVersionStages :: Lens' SecretVersionsListEntry (Maybe (NonEmpty Text))

An array of staging labels that are currently associated with this version of the secret.

svleCreatedDate :: Lens' SecretVersionsListEntry (Maybe UTCTime)

The date and time this version of the secret was created.

svleLastAccessedDate :: Lens' SecretVersionsListEntry (Maybe UTCTime)

The date that this version of the secret was last accessed. Note that the resolution of this field is at the date level and does not include the time.

Tag

data Tag

A structure that contains information about a tag.

See: tag smart constructor.

Instances

Eq Tag

Methods

(==) :: Tag -> Tag -> Bool

(/=) :: Tag -> Tag -> Bool

Data Tag

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Tag -> c Tag

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Tag

toConstr :: Tag -> Constr

dataTypeOf :: Tag -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Tag)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Tag)

gmapT :: (forall b. Data b => b -> b) -> Tag -> Tag

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Tag -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Tag -> r

gmapQ :: (forall d. Data d => d -> u) -> Tag -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Tag -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Tag -> m Tag

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Tag -> m Tag

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Tag -> m Tag

Read Tag

Methods

readsPrec :: Int -> ReadS Tag

readList :: ReadS [Tag]

readPrec :: ReadPrec Tag

readListPrec :: ReadPrec [Tag]

Show Tag

Methods

showsPrec :: Int -> Tag -> ShowS

show :: Tag -> String

showList :: [Tag] -> ShowS

Generic Tag

Associated Types

type Rep Tag :: * -> *

Methods

from :: Tag -> Rep Tag x

to :: Rep Tag x -> Tag

Hashable Tag

Methods

hashWithSalt :: Int -> Tag -> Int

hash :: Tag -> Int

ToJSON Tag

Methods

toJSON :: Tag -> Value

toEncoding :: Tag -> Encoding

toJSONList :: [Tag] -> Value

toEncodingList :: [Tag] -> Encoding

FromJSON Tag

Methods

parseJSON :: Value -> Parser Tag

parseJSONList :: Value -> Parser [Tag]

NFData Tag

Methods

rnf :: Tag -> ()

type Rep Tag

type Rep Tag = D1 * (MetaData "Tag" "Network.AWS.SecretsManager.Types.Product" "amazonka-secretsmanager-1.6.0-K7nD2j5oEj0GsgMw0kPUxD" False) (C1 * (MetaCons "Tag'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_tagValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_tagKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))

tag :: Tag

Creates a value of Tag with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• tagValue - The string value that's associated with the key of the tag.
• tagKey - The key identifier, or name, of the tag.

tagValue :: Lens' Tag (Maybe Text)

The string value that's associated with the key of the tag.

tagKey :: Lens' Tag (Maybe Text)

The key identifier, or name, of the tag.