Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- secretsManager :: Service
- _MalformedPolicyDocumentException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- _DecryptionFailure :: AsError a => Getting (First ServiceError) a ServiceError
- _EncryptionFailure :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServiceError :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- data RotationRulesType
- rotationRulesType :: RotationRulesType
- rrtAutomaticallyAfterDays :: Lens' RotationRulesType (Maybe Natural)
- data SecretListEntry
- secretListEntry :: SecretListEntry
- sleLastChangedDate :: Lens' SecretListEntry (Maybe UTCTime)
- sleARN :: Lens' SecretListEntry (Maybe Text)
- sleSecretVersionsToStages :: Lens' SecretListEntry (HashMap Text (NonEmpty Text))
- sleRotationRules :: Lens' SecretListEntry (Maybe RotationRulesType)
- sleDeletedDate :: Lens' SecretListEntry (Maybe UTCTime)
- sleRotationEnabled :: Lens' SecretListEntry (Maybe Bool)
- sleKMSKeyId :: Lens' SecretListEntry (Maybe Text)
- sleName :: Lens' SecretListEntry (Maybe Text)
- sleLastRotatedDate :: Lens' SecretListEntry (Maybe UTCTime)
- sleLastAccessedDate :: Lens' SecretListEntry (Maybe UTCTime)
- sleDescription :: Lens' SecretListEntry (Maybe Text)
- sleRotationLambdaARN :: Lens' SecretListEntry (Maybe Text)
- sleTags :: Lens' SecretListEntry [Tag]
- data SecretVersionsListEntry
- secretVersionsListEntry :: SecretVersionsListEntry
- svleVersionId :: Lens' SecretVersionsListEntry (Maybe Text)
- svleVersionStages :: Lens' SecretVersionsListEntry (Maybe (NonEmpty Text))
- svleCreatedDate :: Lens' SecretVersionsListEntry (Maybe UTCTime)
- svleLastAccessedDate :: Lens' SecretVersionsListEntry (Maybe UTCTime)
- data Tag
- tag :: Tag
- tagValue :: Lens' Tag (Maybe Text)
- tagKey :: Lens' Tag (Maybe Text)
Service Configuration
secretsManager :: Service Source #
API version 2017-10-17
of the Amazon Secrets Manager SDK configuration.
Errors
_MalformedPolicyDocumentException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The policy document that you provided isn't valid.
_InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You provided an invalid value for a parameter.
_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
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 :: AsError a => Getting (First ServiceError) a ServiceError Source #
Secrets Manager can't decrypt the protected secret text using the provided KMS key.
_EncryptionFailure :: AsError a => Getting (First ServiceError) a ServiceError Source #
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 :: AsError a => Getting (First ServiceError) a ServiceError Source #
You provided an invalid NextToken
value.
_InternalServiceError :: AsError a => Getting (First ServiceError) a ServiceError Source #
An error occurred on the server side.
_ResourceExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A resource with the ID you requested already exists.
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
We can't find the resource that you asked for.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request failed because it would exceed one of the Secrets Manager internal limits.
RotationRulesType
data RotationRulesType Source #
A structure that defines the rotation configuration for the secret.
See: rotationRulesType
smart constructor.
rotationRulesType :: RotationRulesType Source #
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) Source #
Specifies the number of days between automatic scheduled rotations of the secret.
SecretListEntry
data SecretListEntry Source #
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.
secretListEntry :: SecretListEntry Source #
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 assignedSecretVersionStage
staging labels and theSecretVersionId
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 theRecoveryWindowInDays
parameter of theDeleteSecret
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 theSecretString
andSecretBinary
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 namedawssecretsmanager
) 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 nameddbserver1
in the folderdatabases
in the folderprod
.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 toRotateSecret
.sleTags
- The list of user-defined tags that are associated with the secret. To add tags to a secret, useTagResource
. To remove tags, useUntagResource
.
sleLastChangedDate :: Lens' SecretListEntry (Maybe UTCTime) Source #
The last date and time that this secret was modified in any way.
sleARN :: Lens' SecretListEntry (Maybe Text) Source #
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)) Source #
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) Source #
A structure that defines the rotation configuration for the secret.
sleDeletedDate :: Lens' SecretListEntry (Maybe UTCTime) Source #
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) Source #
Indicated whether automatic, scheduled rotation is enabled for this secret.
sleKMSKeyId :: Lens' SecretListEntry (Maybe Text) Source #
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) Source #
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) Source #
The last date and time that the rotation process for this secret was invoked.
sleLastAccessedDate :: Lens' SecretListEntry (Maybe UTCTime) Source #
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) Source #
The user-provided description of the secret.
sleRotationLambdaARN :: Lens' SecretListEntry (Maybe Text) Source #
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] Source #
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 Source #
A structure that contains information about one version of a secret.
See: secretVersionsListEntry
smart constructor.
secretVersionsListEntry :: SecretVersionsListEntry Source #
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) Source #
The unique version identifier of this version of the secret.
svleVersionStages :: Lens' SecretVersionsListEntry (Maybe (NonEmpty Text)) Source #
An array of staging labels that are currently associated with this version of the secret.
svleCreatedDate :: Lens' SecretVersionsListEntry (Maybe UTCTime) Source #
The date and time this version of the secret was created.
svleLastAccessedDate :: Lens' SecretVersionsListEntry (Maybe UTCTime) Source #
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
A structure that contains information about a tag.
See: tag
smart constructor.