| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.SecretsManager
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- CancelRotateSecret
- CreateSecret
- DeleteResourcePolicy
- DeleteSecret
- DescribeSecret
- GetRandomPassword
- GetResourcePolicy
- GetSecretValue
- ListSecretVersionIds (Paginated)
- ListSecrets (Paginated)
- PutResourcePolicy
- PutSecretValue
- RemoveRegionsFromReplication
- ReplicateSecretToRegions
- RestoreSecret
- RotateSecret
- StopReplicationToReplica
- TagResource
- UntagResource
- UpdateSecret
- UpdateSecretVersionStage
- ValidateResourcePolicy
- Types
Description
Derived from API version 2017-10-17 of the AWS service descriptions, licensed under Apache 2.0.
Amazon Web Services Secrets Manager
Amazon Web Services Secrets Manager provides a service to enable 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 Amazon Web Services Secrets Manager User Guide.
API Version
This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.
Support and Feedback for Amazon Web Services Secrets Manager
We welcome your feedback. Send your comments to awssecretsmanager-feedback@amazon.com, or post your feedback and questions in the Amazon Web Services Secrets Manager Discussion Forum. For more information about the Amazon Web Services Discussion Forums, see Forums Help.
Logging API Requests
Amazon Web Services Secrets Manager supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information that's collected by Amazon Web Services CloudTrail, you can determine the requests successfully made to Secrets Manager, who made the request, when it was made, and so on. For more about Amazon Web Services Secrets Manager and support for Amazon Web Services CloudTrail, see Logging Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail in the Amazon Web Services Secrets Manager User Guide. To learn more about CloudTrail, including enabling it and find your log files, see the Amazon Web Services CloudTrail User Guide.
Synopsis
- defaultService :: Service
- _DecryptionFailure :: AsError a => Fold a ServiceError
- _EncryptionFailure :: AsError a => Fold a ServiceError
- _InternalServiceError :: AsError a => Fold a ServiceError
- _InvalidNextTokenException :: AsError a => Fold a ServiceError
- _InvalidParameterException :: AsError a => Fold a ServiceError
- _InvalidRequestException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _MalformedPolicyDocumentException :: AsError a => Fold a ServiceError
- _PreconditionNotMetException :: AsError a => Fold a ServiceError
- _PublicPolicyException :: AsError a => Fold a ServiceError
- _ResourceExistsException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- data CancelRotateSecret = CancelRotateSecret' Text
- newCancelRotateSecret :: Text -> CancelRotateSecret
- data CancelRotateSecretResponse = CancelRotateSecretResponse' (Maybe Text) (Maybe Text) (Maybe Text) Int
- newCancelRotateSecretResponse :: Int -> CancelRotateSecretResponse
- data CreateSecret = CreateSecret' (Maybe (NonEmpty ReplicaRegionType)) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe (Sensitive Base64)) (Maybe (Sensitive Text)) (Maybe [Tag]) Text
- newCreateSecret :: Text -> CreateSecret
- data CreateSecretResponse = CreateSecretResponse' (Maybe Text) (Maybe Text) (Maybe [ReplicationStatusType]) (Maybe Text) Int
- newCreateSecretResponse :: Int -> CreateSecretResponse
- data DeleteResourcePolicy = DeleteResourcePolicy' Text
- newDeleteResourcePolicy :: Text -> DeleteResourcePolicy
- data DeleteResourcePolicyResponse = DeleteResourcePolicyResponse' (Maybe Text) (Maybe Text) Int
- newDeleteResourcePolicyResponse :: Int -> DeleteResourcePolicyResponse
- data DeleteSecret = DeleteSecret' (Maybe Bool) (Maybe Integer) Text
- newDeleteSecret :: Text -> DeleteSecret
- data DeleteSecretResponse = DeleteSecretResponse' (Maybe Text) (Maybe POSIX) (Maybe Text) Int
- newDeleteSecretResponse :: Int -> DeleteSecretResponse
- data DescribeSecret = DescribeSecret' Text
- newDescribeSecret :: Text -> DescribeSecret
- data DescribeSecretResponse = DescribeSecretResponse' (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [ReplicationStatusType]) (Maybe Bool) (Maybe Text) (Maybe RotationRulesType) (Maybe [Tag]) (Maybe (HashMap Text (NonEmpty Text))) Int
- newDescribeSecretResponse :: Int -> DescribeSecretResponse
- data GetRandomPassword = GetRandomPassword' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Natural) (Maybe Bool)
- newGetRandomPassword :: GetRandomPassword
- data GetRandomPasswordResponse = GetRandomPasswordResponse' (Maybe (Sensitive Text)) Int
- newGetRandomPasswordResponse :: Int -> GetRandomPasswordResponse
- data GetResourcePolicy = GetResourcePolicy' Text
- newGetResourcePolicy :: Text -> GetResourcePolicy
- data GetResourcePolicyResponse = GetResourcePolicyResponse' (Maybe Text) (Maybe Text) (Maybe Text) Int
- newGetResourcePolicyResponse :: Int -> GetResourcePolicyResponse
- data GetSecretValue = GetSecretValue' (Maybe Text) (Maybe Text) Text
- newGetSecretValue :: Text -> GetSecretValue
- data GetSecretValueResponse = GetSecretValueResponse' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe (Sensitive Base64)) (Maybe (Sensitive Text)) (Maybe Text) (Maybe (NonEmpty Text)) Int
- newGetSecretValueResponse :: Int -> GetSecretValueResponse
- data ListSecretVersionIds = ListSecretVersionIds' (Maybe Bool) (Maybe Natural) (Maybe Text) Text
- newListSecretVersionIds :: Text -> ListSecretVersionIds
- data ListSecretVersionIdsResponse = ListSecretVersionIdsResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [SecretVersionsListEntry]) Int
- newListSecretVersionIdsResponse :: Int -> ListSecretVersionIdsResponse
- data ListSecrets = ListSecrets' (Maybe [Filter]) (Maybe Bool) (Maybe Natural) (Maybe Text) (Maybe SortOrderType)
- newListSecrets :: ListSecrets
- data ListSecretsResponse = ListSecretsResponse' (Maybe Text) (Maybe [SecretListEntry]) Int
- newListSecretsResponse :: Int -> ListSecretsResponse
- data PutResourcePolicy = PutResourcePolicy' (Maybe Bool) Text Text
- newPutResourcePolicy :: Text -> Text -> PutResourcePolicy
- data PutResourcePolicyResponse = PutResourcePolicyResponse' (Maybe Text) (Maybe Text) Int
- newPutResourcePolicyResponse :: Int -> PutResourcePolicyResponse
- data PutSecretValue = PutSecretValue' (Maybe Text) (Maybe (Sensitive Base64)) (Maybe (Sensitive Text)) (Maybe (NonEmpty Text)) Text
- newPutSecretValue :: Text -> PutSecretValue
- data PutSecretValueResponse = PutSecretValueResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) Int
- newPutSecretValueResponse :: Int -> PutSecretValueResponse
- data RemoveRegionsFromReplication = RemoveRegionsFromReplication' Text (NonEmpty Text)
- newRemoveRegionsFromReplication :: Text -> NonEmpty Text -> RemoveRegionsFromReplication
- data RemoveRegionsFromReplicationResponse = RemoveRegionsFromReplicationResponse' (Maybe Text) (Maybe [ReplicationStatusType]) Int
- newRemoveRegionsFromReplicationResponse :: Int -> RemoveRegionsFromReplicationResponse
- data ReplicateSecretToRegions = ReplicateSecretToRegions' (Maybe Bool) Text (NonEmpty ReplicaRegionType)
- newReplicateSecretToRegions :: Text -> NonEmpty ReplicaRegionType -> ReplicateSecretToRegions
- data ReplicateSecretToRegionsResponse = ReplicateSecretToRegionsResponse' (Maybe Text) (Maybe [ReplicationStatusType]) Int
- newReplicateSecretToRegionsResponse :: Int -> ReplicateSecretToRegionsResponse
- data RestoreSecret = RestoreSecret' Text
- newRestoreSecret :: Text -> RestoreSecret
- data RestoreSecretResponse = RestoreSecretResponse' (Maybe Text) (Maybe Text) Int
- newRestoreSecretResponse :: Int -> RestoreSecretResponse
- data RotateSecret = RotateSecret' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe RotationRulesType) Text
- newRotateSecret :: Text -> RotateSecret
- data RotateSecretResponse = RotateSecretResponse' (Maybe Text) (Maybe Text) (Maybe Text) Int
- newRotateSecretResponse :: Int -> RotateSecretResponse
- data StopReplicationToReplica = StopReplicationToReplica' Text
- newStopReplicationToReplica :: Text -> StopReplicationToReplica
- data StopReplicationToReplicaResponse = StopReplicationToReplicaResponse' (Maybe Text) Int
- newStopReplicationToReplicaResponse :: Int -> StopReplicationToReplicaResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' {
- newTagResourceResponse :: TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' {
- newUntagResourceResponse :: UntagResourceResponse
- data UpdateSecret = UpdateSecret' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (Sensitive Base64)) (Maybe (Sensitive Text)) Text
- newUpdateSecret :: Text -> UpdateSecret
- data UpdateSecretResponse = UpdateSecretResponse' (Maybe Text) (Maybe Text) (Maybe Text) Int
- newUpdateSecretResponse :: Int -> UpdateSecretResponse
- data UpdateSecretVersionStage = UpdateSecretVersionStage' (Maybe Text) (Maybe Text) Text Text
- newUpdateSecretVersionStage :: Text -> Text -> UpdateSecretVersionStage
- data UpdateSecretVersionStageResponse = UpdateSecretVersionStageResponse' (Maybe Text) (Maybe Text) Int
- newUpdateSecretVersionStageResponse :: Int -> UpdateSecretVersionStageResponse
- data ValidateResourcePolicy = ValidateResourcePolicy' (Maybe Text) Text
- newValidateResourcePolicy :: Text -> ValidateResourcePolicy
- data ValidateResourcePolicyResponse = ValidateResourcePolicyResponse' (Maybe Bool) (Maybe [ValidationErrorsEntry]) Int
- newValidateResourcePolicyResponse :: Int -> ValidateResourcePolicyResponse
- newtype FilterNameStringType where
- FilterNameStringType' { }
- pattern FilterNameStringType_All :: FilterNameStringType
- pattern FilterNameStringType_Description :: FilterNameStringType
- pattern FilterNameStringType_Name :: FilterNameStringType
- pattern FilterNameStringType_Owning_service :: FilterNameStringType
- pattern FilterNameStringType_Primary_region :: FilterNameStringType
- pattern FilterNameStringType_Tag_key :: FilterNameStringType
- pattern FilterNameStringType_Tag_value :: FilterNameStringType
- newtype SortOrderType where
- SortOrderType' { }
- pattern SortOrderType_Asc :: SortOrderType
- pattern SortOrderType_Desc :: SortOrderType
- newtype StatusType where
- StatusType' { }
- pattern StatusType_Failed :: StatusType
- pattern StatusType_InProgress :: StatusType
- pattern StatusType_InSync :: StatusType
- data Filter = Filter' (Maybe FilterNameStringType) (Maybe (NonEmpty Text))
- newFilter :: Filter
- data ReplicaRegionType = ReplicaRegionType' (Maybe Text) (Maybe Text)
- newReplicaRegionType :: ReplicaRegionType
- data ReplicationStatusType = ReplicationStatusType' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe StatusType) (Maybe Text)
- newReplicationStatusType :: ReplicationStatusType
- data RotationRulesType = RotationRulesType' (Maybe Natural) (Maybe Text) (Maybe Text)
- newRotationRulesType :: RotationRulesType
- data SecretListEntry = SecretListEntry' (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe RotationRulesType) (Maybe (HashMap Text (NonEmpty Text))) (Maybe [Tag])
- newSecretListEntry :: SecretListEntry
- data SecretVersionsListEntry = SecretVersionsListEntry' (Maybe POSIX) (Maybe [Text]) (Maybe POSIX) (Maybe Text) (Maybe (NonEmpty Text))
- newSecretVersionsListEntry :: SecretVersionsListEntry
- data Tag = Tag' (Maybe Text) (Maybe Text)
- newTag :: Tag
- data ValidationErrorsEntry = ValidationErrorsEntry' (Maybe Text) (Maybe Text)
- newValidationErrorsEntry :: ValidationErrorsEntry
Service Configuration
defaultService :: Service Source #
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.
DecryptionFailure
_DecryptionFailure :: AsError a => Fold a ServiceError Source #
Secrets Manager can't decrypt the protected secret text using the provided KMS key.
EncryptionFailure
_EncryptionFailure :: AsError a => Fold a ServiceError Source #
Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the KMS key is available, enabled, and not in an invalid state. For more information, see Key state: Effect on your KMS key.
InternalServiceError
_InternalServiceError :: AsError a => Fold a ServiceError Source #
An error occurred on the server side.
InvalidNextTokenException
_InvalidNextTokenException :: AsError a => Fold a ServiceError Source #
The NextToken value is invalid.
InvalidParameterException
_InvalidParameterException :: AsError a => Fold a ServiceError Source #
The parameter name or value is invalid.
InvalidRequestException
_InvalidRequestException :: AsError a => Fold a ServiceError Source #
A parameter value is not valid for the current state of the resource.
Possible causes:
- The secret is scheduled for deletion.
- You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
- The secret is managed by another service, and you must use that service to update it. For more information, see Secrets managed by other Amazon Web Services services.
LimitExceededException
_LimitExceededException :: AsError a => Fold a ServiceError Source #
The request failed because it would exceed one of the Secrets Manager quotas.
MalformedPolicyDocumentException
_MalformedPolicyDocumentException :: AsError a => Fold a ServiceError Source #
The resource policy has syntax errors.
PreconditionNotMetException
_PreconditionNotMetException :: AsError a => Fold a ServiceError Source #
The request failed because you did not complete all the prerequisite steps.
PublicPolicyException
_PublicPolicyException :: AsError a => Fold a ServiceError Source #
The BlockPublicPolicy parameter is set to true, and the resource
policy did not prevent broad access to the secret.
ResourceExistsException
_ResourceExistsException :: AsError a => Fold a ServiceError Source #
A resource with the ID you requested already exists.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
Secrets Manager can't find the resource that you asked for.
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.
CancelRotateSecret
data CancelRotateSecret Source #
See: newCancelRotateSecret smart constructor.
Constructors
| CancelRotateSecret' Text |
Instances
newCancelRotateSecret Source #
Arguments
| :: Text | |
| -> CancelRotateSecret |
Create a value of CancelRotateSecret with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:secretId:CancelRotateSecret', cancelRotateSecret_secretId - The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
data CancelRotateSecretResponse Source #
See: newCancelRotateSecretResponse smart constructor.
Instances
newCancelRotateSecretResponse Source #
Create a value of CancelRotateSecretResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CancelRotateSecretResponse, cancelRotateSecretResponse_arn - The ARN of the secret.
CancelRotateSecretResponse, cancelRotateSecretResponse_name - The name of the secret.
CancelRotateSecretResponse, cancelRotateSecretResponse_versionId - The unique identifier of the version of the secret created during the
rotation. This version might not be complete, and should be evaluated
for possible deletion. We recommend that you remove the VersionStage
value AWSPENDING from this version so that Secrets Manager can delete
it. Failing to clean up a cancelled rotation can block you from starting
future rotations.
$sel:httpStatus:CancelRotateSecretResponse', cancelRotateSecretResponse_httpStatus - The response's http status code.
CreateSecret
data CreateSecret Source #
See: newCreateSecret smart constructor.
Constructors
| CreateSecret' (Maybe (NonEmpty ReplicaRegionType)) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe (Sensitive Base64)) (Maybe (Sensitive Text)) (Maybe [Tag]) Text |
Instances
Arguments
| :: Text | |
| -> CreateSecret |
Create a value of CreateSecret with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:addReplicaRegions:CreateSecret', createSecret_addReplicaRegions - A list of Regions and KMS keys to replicate secrets.
$sel:clientRequestToken:CreateSecret', createSecret_clientRequestToken - If you include SecretString or SecretBinary, then Secrets Manager
creates an initial version for the secret, and this parameter specifies
the unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services
SDKs to call this operation, then you can leave this parameter empty.
The CLI or SDK generates a random UUID for you and includes it as the
value for this parameter in the request. If you don't use the SDK and
instead generate a raw HTTP request to the Secrets Manager service
endpoint, then you must generate a ClientRequestToken yourself for the
new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
- If the
ClientRequestTokenvalue isn't already associated with a version of the secret then a new version of the secret is created. - If a version with this value already exists and the version
SecretStringandSecretBinaryvalues are the same as those in the request, then the request is ignored. - If a version with this value already exists and that version's
SecretStringandSecretBinaryvalues are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId of the new version.
CreateSecret, createSecret_description - The description of the secret.
$sel:forceOverwriteReplicaSecret:CreateSecret', createSecret_forceOverwriteReplicaSecret - Specifies whether to overwrite a secret with the same name in the
destination Region.
CreateSecret, createSecret_kmsKeyId - The ARN, key ID, or alias of the KMS key that Secrets Manager uses to
encrypt the secret value in the secret. An alias is always prefixed by
alias/, for example alias/aws/secretsmanager. For more
information, see
About aliases.
To use a KMS key in a different account, use the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager uses the key
aws/secretsmanager. If that key doesn't yet exist, then Secrets
Manager creates it for you automatically the first time it encrypts the
secret value.
If the secret is in a different Amazon Web Services account from the
credentials calling the API, then you can't use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed
KMS key.
$sel:secretBinary:CreateSecret', createSecret_secretBinary - The binary data to encrypt and store in the new version of the secret.
We recommend that you store your binary data in a file and then pass the
contents of the file as a parameter.
Either SecretString or SecretBinary must have a value, but not both.
This parameter is not available in the Secrets Manager console.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
$sel:secretString:CreateSecret', createSecret_secretString - The text data to encrypt and store in this new version of the secret. We
recommend you use a JSON structure of key/value pairs for your secret
value.
Either SecretString or SecretBinary must have a value, but not both.
If you create a secret by using the Secrets Manager console then Secrets
Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON
structure of key/value pairs that a Lambda rotation function can parse.
CreateSecret, createSecret_tags - A list of tags to attach to the secret. Each tag is a key and value pair
of strings in a JSON text string, for example:
[{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag from one with key "abc".
If you check tags in permissions policies as part of your security
strategy, then adding or removing a tag can change permissions. If the
completion of this operation would result in you losing your permissions
for this secret, then Secrets Manager blocks the operation and returns
an Access Denied error. For more information, see
Control access to secrets using tags
and
Limit access to identities with tags that match secrets' tags.
For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters. If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following restrictions apply to tags:
- Maximum number of tags per secret: 50
- Maximum key length: 127 Unicode characters in UTF-8
- Maximum value length: 255 Unicode characters in UTF-8
- Tag keys and values are case sensitive.
- Do not use the
aws:prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit. - If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
CreateSecret, createSecret_name - The name of the new secret.
The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
data CreateSecretResponse Source #
See: newCreateSecretResponse smart constructor.
Constructors
| CreateSecretResponse' (Maybe Text) (Maybe Text) (Maybe [ReplicationStatusType]) (Maybe Text) Int |
Instances
newCreateSecretResponse Source #
Arguments
| :: Int | |
| -> CreateSecretResponse |
Create a value of CreateSecretResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateSecretResponse, createSecretResponse_arn - The ARN of the new secret. The ARN includes the name of the secret
followed by six random characters. This ensures that if you create a new
secret with the same name as a deleted secret, then users with access to
the old secret don't get access to the new secret because the ARNs are
different.
CreateSecret, createSecretResponse_name - The name of the new secret.
$sel:replicationStatus:CreateSecretResponse', createSecretResponse_replicationStatus - A list of the replicas of this secret and their status:
Failed, which indicates that the replica was not created.InProgress, which indicates that Secrets Manager is in the process of creating the replica.InSync, which indicates that the replica was created.
CreateSecretResponse, createSecretResponse_versionId - The unique identifier associated with the version of the new secret.
$sel:httpStatus:CreateSecretResponse', createSecretResponse_httpStatus - The response's http status code.
DeleteResourcePolicy
data DeleteResourcePolicy Source #
See: newDeleteResourcePolicy smart constructor.
Constructors
| DeleteResourcePolicy' Text |
Instances
newDeleteResourcePolicy Source #
Arguments
| :: Text | |
| -> DeleteResourcePolicy |
Create a value of DeleteResourcePolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:secretId:DeleteResourcePolicy', deleteResourcePolicy_secretId - The ARN or name of the secret to delete the attached resource-based
policy for.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
data DeleteResourcePolicyResponse Source #
See: newDeleteResourcePolicyResponse smart constructor.
Instances
newDeleteResourcePolicyResponse Source #
Create a value of DeleteResourcePolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteResourcePolicyResponse, deleteResourcePolicyResponse_arn - The ARN of the secret that the resource-based policy was deleted for.
DeleteResourcePolicyResponse, deleteResourcePolicyResponse_name - The name of the secret that the resource-based policy was deleted for.
$sel:httpStatus:DeleteResourcePolicyResponse', deleteResourcePolicyResponse_httpStatus - The response's http status code.
DeleteSecret
data DeleteSecret Source #
See: newDeleteSecret smart constructor.
Instances
Arguments
| :: Text | |
| -> DeleteSecret |
Create a value of DeleteSecret with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:forceDeleteWithoutRecovery:DeleteSecret', deleteSecret_forceDeleteWithoutRecovery - Specifies whether to delete the secret without any recovery window. You
can't use both this parameter and RecoveryWindowInDays in the same
call. If you don't use either, then Secrets Manager defaults to a 30
day recovery window.
Secrets Manager performs the actual deletion with an asynchronous background process, so there might be a short delay before the secret is permanently deleted. If you delete a secret and then immediately create a secret with the same name, use appropriate back off and retry logic.
Use this parameter with caution. This parameter causes the operation to
skip the normal recovery window before the permanent deletion that
Secrets Manager would normally impose with the RecoveryWindowInDays
parameter. If you delete a secret with the ForceDeleteWithoutRecovery
parameter, then you have no opportunity to recover the secret. You lose
the secret permanently.
$sel:recoveryWindowInDays:DeleteSecret', deleteSecret_recoveryWindowInDays - The number of days from 7 to 30 that Secrets Manager waits before
permanently deleting the secret. You can't use both this parameter and
ForceDeleteWithoutRecovery in the same call. If you don't use either,
then Secrets Manager defaults to a 30 day recovery window.
$sel:secretId:DeleteSecret', deleteSecret_secretId - The ARN or name of the secret to delete.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
data DeleteSecretResponse Source #
See: newDeleteSecretResponse smart constructor.
Instances
newDeleteSecretResponse Source #
Arguments
| :: Int | |
| -> DeleteSecretResponse |
Create a value of DeleteSecretResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteSecretResponse, deleteSecretResponse_arn - The ARN of the secret.
$sel:deletionDate:DeleteSecretResponse', deleteSecretResponse_deletionDate - The date and time after which this secret Secrets Manager can
permanently delete this secret, and it can no longer be restored. This
value is the date and time of the delete request plus the number of days
in RecoveryWindowInDays.
DeleteSecretResponse, deleteSecretResponse_name - The name of the secret.
$sel:httpStatus:DeleteSecretResponse', deleteSecretResponse_httpStatus - The response's http status code.
DescribeSecret
data DescribeSecret Source #
See: newDescribeSecret smart constructor.
Constructors
| DescribeSecret' Text |
Instances
Arguments
| :: Text | |
| -> DescribeSecret |
Create a value of DescribeSecret with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:secretId:DescribeSecret', describeSecret_secretId - The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
data DescribeSecretResponse Source #
See: newDescribeSecretResponse smart constructor.
Constructors
| DescribeSecretResponse' (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [ReplicationStatusType]) (Maybe Bool) (Maybe Text) (Maybe RotationRulesType) (Maybe [Tag]) (Maybe (HashMap Text (NonEmpty Text))) Int |
Instances
newDescribeSecretResponse Source #
Create a value of DescribeSecretResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeSecretResponse, describeSecretResponse_arn - The ARN of the secret.
DescribeSecretResponse, describeSecretResponse_createdDate - The date the secret was created.
DescribeSecretResponse, describeSecretResponse_deletedDate - The date the secret is scheduled for deletion. If it is not scheduled
for deletion, this field is omitted. When you delete a secret, Secrets
Manager requires a recovery window of at least 7 days before deleting
the secret. Some time after the deleted date, Secrets Manager deletes
the secret, including all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.
DescribeSecretResponse, describeSecretResponse_description - The description of the secret.
DescribeSecretResponse, describeSecretResponse_kmsKeyId - The key ID or alias ARN of the KMS key that Secrets Manager uses to
encrypt the secret value. If the secret is encrypted with the Amazon Web
Services managed key aws/secretsmanager, this field is omitted.
Secrets created using the console use an KMS key ID.
DescribeSecretResponse, describeSecretResponse_lastAccessedDate - The date that the secret was last accessed in the Region. This field is
omitted if the secret has never been retrieved in the Region.
DescribeSecretResponse, describeSecretResponse_lastChangedDate - The last date and time that this secret was modified in any way.
DescribeSecretResponse, describeSecretResponse_lastRotatedDate - The last date and time that Secrets Manager rotated the secret. If the
secret isn't configured for rotation, Secrets Manager returns null.
DescribeSecretResponse, describeSecretResponse_name - The name of the secret.
DescribeSecretResponse, describeSecretResponse_nextRotationDate - Undocumented member.
DescribeSecretResponse, describeSecretResponse_owningService - The ID of the service that created this secret. For more information,
see
Secrets managed by other Amazon Web Services services.
DescribeSecretResponse, describeSecretResponse_primaryRegion - The Region the secret is in. If a secret is replicated to other Regions,
the replicas are listed in ReplicationStatus.
$sel:replicationStatus:DescribeSecretResponse', describeSecretResponse_replicationStatus - A list of the replicas of this secret and their status:
Failed, which indicates that the replica was not created.InProgress, which indicates that Secrets Manager is in the process of creating the replica.InSync, which indicates that the replica was created.
DescribeSecretResponse, describeSecretResponse_rotationEnabled - Specifies whether automatic rotation is turned on for this secret.
To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
DescribeSecretResponse, describeSecretResponse_rotationLambdaARN - The ARN of the Lambda function that Secrets Manager invokes to rotate
the secret.
DescribeSecretResponse, describeSecretResponse_rotationRules - The rotation schedule and Lambda function for this secret. If the secret
previously had rotation turned on, but it is now turned off, this field
shows the previous rotation schedule and rotation function. If the
secret never had rotation turned on, this field is omitted.
DescribeSecretResponse, describeSecretResponse_tags - The list of tags attached to the secret. To add tags to a secret, use
TagResource. To remove tags, use UntagResource.
$sel:versionIdsToStages:DescribeSecretResponse', describeSecretResponse_versionIdsToStages - A list of the versions of the secret that have staging labels attached.
Versions that don't have staging labels are considered deprecated and
Secrets Manager can delete them.
Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging labels for rotation are:
AWSCURRENT, which indicates the current version of the secret.AWSPENDING, which indicates the version of the secret that contains new secret information that will become the next current version when rotation finishes.During rotation, Secrets Manager creates an
AWSPENDINGversion ID before creating the new secret version. To check if a secret version exists, call GetSecretValue.AWSPREVIOUS, which indicates the previous current version of the secret. You can use this as the last known good version.
For more information about rotation and staging labels, see How rotation works.
$sel:httpStatus:DescribeSecretResponse', describeSecretResponse_httpStatus - The response's http status code.
GetRandomPassword
data GetRandomPassword Source #
See: newGetRandomPassword smart constructor.
Constructors
| GetRandomPassword' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Natural) (Maybe Bool) |
Instances
newGetRandomPassword :: GetRandomPassword Source #
Create a value of GetRandomPassword with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:excludeCharacters:GetRandomPassword', getRandomPassword_excludeCharacters - A string of the characters that you don't want in the password.
$sel:excludeLowercase:GetRandomPassword', getRandomPassword_excludeLowercase - Specifies whether to exclude lowercase letters from the password. If you
don't include this switch, the password can contain lowercase letters.
$sel:excludeNumbers:GetRandomPassword', getRandomPassword_excludeNumbers - Specifies whether to exclude numbers from the password. If you don't
include this switch, the password can contain numbers.
$sel:excludePunctuation:GetRandomPassword', getRandomPassword_excludePunctuation - Specifies whether to exclude the following punctuation characters from
the password:
! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~.
If you don't include this switch, the password can contain punctuation.
$sel:excludeUppercase:GetRandomPassword', getRandomPassword_excludeUppercase - Specifies whether to exclude uppercase letters from the password. If you
don't include this switch, the password can contain uppercase letters.
$sel:includeSpace:GetRandomPassword', getRandomPassword_includeSpace - Specifies whether to include the space character. If you include this
switch, the password can contain space characters.
$sel:passwordLength:GetRandomPassword', getRandomPassword_passwordLength - The length of the password. If you don't include this parameter, the
default length is 32 characters.
$sel:requireEachIncludedType:GetRandomPassword', getRandomPassword_requireEachIncludedType - Specifies whether to include at least one upper and lowercase letter,
one number, and one punctuation. If you don't include this switch, the
password contains at least one of every character type.
data GetRandomPasswordResponse Source #
See: newGetRandomPasswordResponse smart constructor.
Constructors
| GetRandomPasswordResponse' (Maybe (Sensitive Text)) Int |
Instances
newGetRandomPasswordResponse Source #
Create a value of GetRandomPasswordResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:randomPassword:GetRandomPasswordResponse', getRandomPasswordResponse_randomPassword - A string with the password.
$sel:httpStatus:GetRandomPasswordResponse', getRandomPasswordResponse_httpStatus - The response's http status code.
GetResourcePolicy
data GetResourcePolicy Source #
See: newGetResourcePolicy smart constructor.
Constructors
| GetResourcePolicy' Text |
Instances
Arguments
| :: Text | |
| -> GetResourcePolicy |
Create a value of GetResourcePolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:secretId:GetResourcePolicy', getResourcePolicy_secretId - The ARN or name of the secret to retrieve the attached resource-based
policy for.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
data GetResourcePolicyResponse Source #
See: newGetResourcePolicyResponse smart constructor.
Instances
newGetResourcePolicyResponse Source #
Create a value of GetResourcePolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetResourcePolicyResponse, getResourcePolicyResponse_arn - The ARN of the secret that the resource-based policy was retrieved for.
GetResourcePolicyResponse, getResourcePolicyResponse_name - The name of the secret that the resource-based policy was retrieved for.
$sel:resourcePolicy:GetResourcePolicyResponse', getResourcePolicyResponse_resourcePolicy - A JSON-formatted string that contains the permissions policy attached to
the secret. For more information about permissions policies, see
Authentication and access control for Secrets Manager.
$sel:httpStatus:GetResourcePolicyResponse', getResourcePolicyResponse_httpStatus - The response's http status code.
GetSecretValue
data GetSecretValue Source #
See: newGetSecretValue smart constructor.
Instances
Arguments
| :: Text | |
| -> GetSecretValue |
Create a value of GetSecretValue with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetSecretValue, getSecretValue_versionId - The unique identifier of the version of the secret to retrieve. If you
include both this parameter and VersionStage, the two parameters must
refer to the same secret version. If you don't specify either a
VersionStage or VersionId, then Secrets Manager returns the
AWSCURRENT version.
This value is typically a UUID-type value with 32 hexadecimal digits.
$sel:versionStage:GetSecretValue', getSecretValue_versionStage - The staging label of the version of the secret to retrieve.
Secrets Manager uses staging labels to keep track of different versions
during the rotation process. If you include both this parameter and
VersionId, the two parameters must refer to the same secret version.
If you don't specify either a VersionStage or VersionId, Secrets
Manager returns the AWSCURRENT version.
$sel:secretId:GetSecretValue', getSecretValue_secretId - The ARN or name of the secret to retrieve.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
data GetSecretValueResponse Source #
See: newGetSecretValueResponse smart constructor.
Constructors
| GetSecretValueResponse' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe (Sensitive Base64)) (Maybe (Sensitive Text)) (Maybe Text) (Maybe (NonEmpty Text)) Int |
Instances
newGetSecretValueResponse Source #
Create a value of GetSecretValueResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetSecretValueResponse, getSecretValueResponse_arn - The ARN of the secret.
GetSecretValueResponse, getSecretValueResponse_createdDate - The date and time that this version of the secret was created. If you
don't specify which version in VersionId or VersionStage, then
Secrets Manager uses the AWSCURRENT version.
GetSecretValueResponse, getSecretValueResponse_name - The friendly name of the secret.
$sel:secretBinary:GetSecretValueResponse', getSecretValueResponse_secretBinary - The decrypted secret value, if the secret value was originally provided
as binary data in the form of a byte array. The response parameter
represents the binary data as a
base64-encoded string.
If the secret was created by using the Secrets Manager console, or if
the secret value was originally provided as a string, then this field is
omitted. The secret value appears in SecretString instead.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
$sel:secretString:GetSecretValueResponse', getSecretValueResponse_secretString - The decrypted secret value, if the secret value was originally provided
as a string or through the Secrets Manager console.
If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.
GetSecretValue, getSecretValueResponse_versionId - The unique identifier of this version of the secret.
GetSecretValueResponse, getSecretValueResponse_versionStages - A list of all of the staging labels currently attached to this version
of the secret.
$sel:httpStatus:GetSecretValueResponse', getSecretValueResponse_httpStatus - The response's http status code.
ListSecretVersionIds (Paginated)
data ListSecretVersionIds Source #
See: newListSecretVersionIds smart constructor.
Instances
newListSecretVersionIds Source #
Arguments
| :: Text | |
| -> ListSecretVersionIds |
Create a value of ListSecretVersionIds with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:includeDeprecated:ListSecretVersionIds', listSecretVersionIds_includeDeprecated - Specifies whether to include versions of secrets that don't have any
staging labels attached to them. Versions without staging labels are
considered deprecated and are subject to deletion by Secrets Manager.
$sel:maxResults:ListSecretVersionIds', listSecretVersionIds_maxResults - The number of results to include in the response.
If there are more results available, in the response, Secrets Manager
includes NextToken. To get the next results, call
ListSecretVersionIds again with the value from NextToken.
ListSecretVersionIds, listSecretVersionIds_nextToken - A token that indicates where the output should continue from, if a
previous call did not show all results. To get the next results, call
ListSecretVersionIds again with this value.
$sel:secretId:ListSecretVersionIds', listSecretVersionIds_secretId - The ARN or name of the secret whose versions you want to list.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
data ListSecretVersionIdsResponse Source #
See: newListSecretVersionIdsResponse smart constructor.
Constructors
| ListSecretVersionIdsResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [SecretVersionsListEntry]) Int |
Instances
newListSecretVersionIdsResponse Source #
Create a value of ListSecretVersionIdsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListSecretVersionIdsResponse, listSecretVersionIdsResponse_arn - The ARN of the secret.
ListSecretVersionIdsResponse, listSecretVersionIdsResponse_name - The name of the secret.
ListSecretVersionIds, listSecretVersionIdsResponse_nextToken - Secrets Manager includes this value if there's more output available
than what is included in the current response. This can occur even when
the response includes no values at all, such as when you ask for a
filtered view of a long list. To get the next results, call
ListSecretVersionIds again with this value.
$sel:versions:ListSecretVersionIdsResponse', listSecretVersionIdsResponse_versions - A list of the versions of the secret.
$sel:httpStatus:ListSecretVersionIdsResponse', listSecretVersionIdsResponse_httpStatus - The response's http status code.
ListSecrets (Paginated)
data ListSecrets Source #
See: newListSecrets smart constructor.
Constructors
| ListSecrets' (Maybe [Filter]) (Maybe Bool) (Maybe Natural) (Maybe Text) (Maybe SortOrderType) |
Instances
newListSecrets :: ListSecrets Source #
Create a value of ListSecrets with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListSecrets', listSecrets_filters - The filters to apply to the list of secrets.
$sel:includePlannedDeletion:ListSecrets', listSecrets_includePlannedDeletion - Undocumented member.
$sel:maxResults:ListSecrets', listSecrets_maxResults - The number of results to include in the response.
If there are more results available, in the response, Secrets Manager
includes NextToken. To get the next results, call ListSecrets again
with the value from NextToken.
ListSecrets, listSecrets_nextToken - A token that indicates where the output should continue from, if a
previous call did not show all results. To get the next results, call
ListSecrets again with this value.
$sel:sortOrder:ListSecrets', listSecrets_sortOrder - Secrets are listed by CreatedDate.
data ListSecretsResponse Source #
See: newListSecretsResponse smart constructor.
Constructors
| ListSecretsResponse' (Maybe Text) (Maybe [SecretListEntry]) Int |
Instances
newListSecretsResponse Source #
Arguments
| :: Int | |
| -> ListSecretsResponse |
Create a value of ListSecretsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListSecrets, listSecretsResponse_nextToken - Secrets Manager includes this value if there's more output available
than what is included in the current response. This can occur even when
the response includes no values at all, such as when you ask for a
filtered view of a long list. To get the next results, call
ListSecrets again with this value.
$sel:secretList:ListSecretsResponse', listSecretsResponse_secretList - A list of the secrets in the account.
$sel:httpStatus:ListSecretsResponse', listSecretsResponse_httpStatus - The response's http status code.
PutResourcePolicy
data PutResourcePolicy Source #
See: newPutResourcePolicy smart constructor.
Constructors
| PutResourcePolicy' (Maybe Bool) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> PutResourcePolicy |
Create a value of PutResourcePolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:blockPublicPolicy:PutResourcePolicy', putResourcePolicy_blockPublicPolicy - Specifies whether to block resource-based policies that allow broad
access to the secret, for example those that use a wildcard for the
principal.
$sel:secretId:PutResourcePolicy', putResourcePolicy_secretId - The ARN or name of the secret to attach the resource-based policy.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
$sel:resourcePolicy:PutResourcePolicy', putResourcePolicy_resourcePolicy - A JSON-formatted string for an Amazon Web Services resource-based
policy. For example policies, see
Permissions policy examples.
data PutResourcePolicyResponse Source #
See: newPutResourcePolicyResponse smart constructor.
Instances
newPutResourcePolicyResponse Source #
Create a value of PutResourcePolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutResourcePolicyResponse, putResourcePolicyResponse_arn - The ARN of the secret.
PutResourcePolicyResponse, putResourcePolicyResponse_name - The name of the secret.
$sel:httpStatus:PutResourcePolicyResponse', putResourcePolicyResponse_httpStatus - The response's http status code.
PutSecretValue
data PutSecretValue Source #
See: newPutSecretValue smart constructor.
Constructors
| PutSecretValue' (Maybe Text) (Maybe (Sensitive Base64)) (Maybe (Sensitive Text)) (Maybe (NonEmpty Text)) Text |
Instances
Arguments
| :: Text | |
| -> PutSecretValue |
Create a value of PutSecretValue with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestToken:PutSecretValue', putSecretValue_clientRequestToken - A unique identifier for the new version of the secret.
If you use the Amazon Web Services CLI or one of the Amazon Web Services
SDKs to call this operation, then you can leave this parameter empty
because they generate a random UUID for you. If you don't use the SDK
and instead generate a raw HTTP request to the Secrets Manager service
endpoint, then you must generate a ClientRequestToken yourself for new
versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
- If the
ClientRequestTokenvalue isn't already associated with a version of the secret then a new version of the secret is created. - If a version with this value already exists and that version's
SecretStringorSecretBinaryvalues are the same as those in the request then the request is ignored. The operation is idempotent. - If a version with this value already exists and the version of the
SecretStringandSecretBinaryvalues are different from those in the request, then the request fails because you can't modify a secret version. You can only create new versions to store new secret values.
This value becomes the VersionId of the new version.
$sel:secretBinary:PutSecretValue', putSecretValue_secretBinary - The binary data to encrypt and store in the new version of the secret.
To use this parameter in the command-line tools, we recommend that you
store your binary data in a file and then pass the contents of the file
as a parameter.
You must include SecretBinary or SecretString, but not both.
You can't access this value from the Secrets Manager console.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
$sel:secretString:PutSecretValue', putSecretValue_secretString - The text to encrypt and store in the new version of the secret.
You must include SecretBinary or SecretString, but not both.
We recommend you create the secret string as JSON key/value pairs, as shown in the example.
PutSecretValue, putSecretValue_versionStages - A list of staging labels to attach to this version of the secret.
Secrets Manager uses staging labels to track versions of a secret
through the rotation process.
If you specify a staging label that's already associated with a
different version of the same secret, then Secrets Manager removes the
label from the other version and attaches it to this version. If you
specify AWSCURRENT, and it is already attached to another version,
then Secrets Manager also moves the staging label AWSPREVIOUS to the
version that AWSCURRENT was removed from.
If you don't include VersionStages, then Secrets Manager
automatically moves the staging label AWSCURRENT to this version.
$sel:secretId:PutSecretValue', putSecretValue_secretId - The ARN or name of the secret to add a new version to.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
If the secret doesn't already exist, use CreateSecret instead.
data PutSecretValueResponse Source #
See: newPutSecretValueResponse smart constructor.
Constructors
| PutSecretValueResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) Int |
Instances
newPutSecretValueResponse Source #
Create a value of PutSecretValueResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutSecretValueResponse, putSecretValueResponse_arn - The ARN of the secret.
PutSecretValueResponse, putSecretValueResponse_name - The name of the secret.
PutSecretValueResponse, putSecretValueResponse_versionId - The unique identifier of the version of the secret.
PutSecretValue, putSecretValueResponse_versionStages - The list of staging labels that are currently attached to this version
of the secret. Secrets Manager uses staging labels to track a version as
it progresses through the secret rotation process.
$sel:httpStatus:PutSecretValueResponse', putSecretValueResponse_httpStatus - The response's http status code.
RemoveRegionsFromReplication
data RemoveRegionsFromReplication Source #
See: newRemoveRegionsFromReplication smart constructor.
Constructors
| RemoveRegionsFromReplication' Text (NonEmpty Text) |
Instances
newRemoveRegionsFromReplication Source #
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> RemoveRegionsFromReplication |
Create a value of RemoveRegionsFromReplication with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:secretId:RemoveRegionsFromReplication', removeRegionsFromReplication_secretId - The ARN or name of the secret.
$sel:removeReplicaRegions:RemoveRegionsFromReplication', removeRegionsFromReplication_removeReplicaRegions - The Regions of the replicas to remove.
data RemoveRegionsFromReplicationResponse Source #
See: newRemoveRegionsFromReplicationResponse smart constructor.
Constructors
| RemoveRegionsFromReplicationResponse' (Maybe Text) (Maybe [ReplicationStatusType]) Int |
Instances
newRemoveRegionsFromReplicationResponse Source #
Arguments
| :: Int | |
| -> RemoveRegionsFromReplicationResponse |
Create a value of RemoveRegionsFromReplicationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RemoveRegionsFromReplicationResponse, removeRegionsFromReplicationResponse_arn - The ARN of the primary secret.
$sel:replicationStatus:RemoveRegionsFromReplicationResponse', removeRegionsFromReplicationResponse_replicationStatus - The status of replicas for this secret after you remove Regions.
$sel:httpStatus:RemoveRegionsFromReplicationResponse', removeRegionsFromReplicationResponse_httpStatus - The response's http status code.
ReplicateSecretToRegions
data ReplicateSecretToRegions Source #
See: newReplicateSecretToRegions smart constructor.
Constructors
| ReplicateSecretToRegions' (Maybe Bool) Text (NonEmpty ReplicaRegionType) |
Instances
newReplicateSecretToRegions Source #
Arguments
| :: Text | |
| -> NonEmpty ReplicaRegionType | |
| -> ReplicateSecretToRegions |
Create a value of ReplicateSecretToRegions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:forceOverwriteReplicaSecret:ReplicateSecretToRegions', replicateSecretToRegions_forceOverwriteReplicaSecret - Specifies whether to overwrite a secret with the same name in the
destination Region.
$sel:secretId:ReplicateSecretToRegions', replicateSecretToRegions_secretId - The ARN or name of the secret to replicate.
$sel:addReplicaRegions:ReplicateSecretToRegions', replicateSecretToRegions_addReplicaRegions - A list of Regions in which to replicate the secret.
data ReplicateSecretToRegionsResponse Source #
See: newReplicateSecretToRegionsResponse smart constructor.
Constructors
| ReplicateSecretToRegionsResponse' (Maybe Text) (Maybe [ReplicationStatusType]) Int |
Instances
newReplicateSecretToRegionsResponse Source #
Create a value of ReplicateSecretToRegionsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ReplicateSecretToRegionsResponse, replicateSecretToRegionsResponse_arn - The ARN of the primary secret.
$sel:replicationStatus:ReplicateSecretToRegionsResponse', replicateSecretToRegionsResponse_replicationStatus - The status of replication.
$sel:httpStatus:ReplicateSecretToRegionsResponse', replicateSecretToRegionsResponse_httpStatus - The response's http status code.
RestoreSecret
data RestoreSecret Source #
See: newRestoreSecret smart constructor.
Constructors
| RestoreSecret' Text |
Instances
Arguments
| :: Text | |
| -> RestoreSecret |
Create a value of RestoreSecret with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:secretId:RestoreSecret', restoreSecret_secretId - The ARN or name of the secret to restore.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
data RestoreSecretResponse Source #
See: newRestoreSecretResponse smart constructor.
Instances
newRestoreSecretResponse Source #
Create a value of RestoreSecretResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RestoreSecretResponse, restoreSecretResponse_arn - The ARN of the secret that was restored.
RestoreSecretResponse, restoreSecretResponse_name - The name of the secret that was restored.
$sel:httpStatus:RestoreSecretResponse', restoreSecretResponse_httpStatus - The response's http status code.
RotateSecret
data RotateSecret Source #
See: newRotateSecret smart constructor.
Constructors
| RotateSecret' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe RotationRulesType) Text |
Instances
Arguments
| :: Text | |
| -> RotateSecret |
Create a value of RotateSecret with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestToken:RotateSecret', rotateSecret_clientRequestToken - A unique identifier for the new version of the secret that helps ensure
idempotency. Secrets Manager uses this value to prevent the accidental
creation of duplicate versions if there are failures and retries during
rotation. This value becomes the VersionId of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services
SDK to call this operation, then you can leave this parameter empty. The
CLI or SDK generates a random UUID for you and includes that in the
request for this parameter. If you don't use the SDK and instead
generate a raw HTTP request to the Secrets Manager service endpoint,
then you must generate a ClientRequestToken yourself for new versions
and include that value in the request.
You only need to specify this value if you implement your own retry logic and you want to ensure that Secrets Manager doesn't attempt to create a secret version twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
$sel:rotateImmediately:RotateSecret', rotateSecret_rotateImmediately - Specifies whether to rotate the secret immediately or wait until the
next scheduled rotation window. The rotation schedule is defined in
RotateSecretRequest$RotationRules.
If you don't immediately rotate the secret, Secrets Manager tests the
rotation configuration by running the
testSecret step
of the Lambda rotation function. The test creates an AWSPENDING
version of the secret and then removes it.
If you don't specify this value, then by default, Secrets Manager rotates the secret immediately.
RotateSecret, rotateSecret_rotationLambdaARN - The ARN of the Lambda rotation function that can rotate the secret.
RotateSecret, rotateSecret_rotationRules - A structure that defines the rotation configuration for this secret.
$sel:secretId:RotateSecret', rotateSecret_secretId - The ARN or name of the secret to rotate.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
data RotateSecretResponse Source #
See: newRotateSecretResponse smart constructor.
Instances
newRotateSecretResponse Source #
Arguments
| :: Int | |
| -> RotateSecretResponse |
Create a value of RotateSecretResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RotateSecretResponse, rotateSecretResponse_arn - The ARN of the secret.
RotateSecretResponse, rotateSecretResponse_name - The name of the secret.
RotateSecretResponse, rotateSecretResponse_versionId - The ID of the new version of the secret.
$sel:httpStatus:RotateSecretResponse', rotateSecretResponse_httpStatus - The response's http status code.
StopReplicationToReplica
data StopReplicationToReplica Source #
See: newStopReplicationToReplica smart constructor.
Constructors
| StopReplicationToReplica' Text |
Instances
newStopReplicationToReplica Source #
Create a value of StopReplicationToReplica with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:secretId:StopReplicationToReplica', stopReplicationToReplica_secretId - The ARN of the primary secret.
data StopReplicationToReplicaResponse Source #
See: newStopReplicationToReplicaResponse smart constructor.
Constructors
| StopReplicationToReplicaResponse' (Maybe Text) Int |
Instances
newStopReplicationToReplicaResponse Source #
Create a value of StopReplicationToReplicaResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StopReplicationToReplicaResponse, stopReplicationToReplicaResponse_arn - The ARN of the promoted secret. The ARN is the same as the original
primary secret except the Region is changed.
$sel:httpStatus:StopReplicationToReplicaResponse', stopReplicationToReplicaResponse_httpStatus - The response's http status code.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text [Tag] |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:secretId:TagResource', tagResource_secretId - The identifier for the secret to attach tags to. You can specify either
the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
TagResource, tagResource_tags - The tags to attach to the secret as a JSON text string argument. Each
element in the list consists of a Key and a Value.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' | |
Instances
newTagResourceResponse :: TagResourceResponse Source #
Create a value of TagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text [Text] |
Instances
Arguments
| :: Text | |
| -> UntagResource |
Create a value of UntagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:secretId:UntagResource', untagResource_secretId - The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
$sel:tagKeys:UntagResource', untagResource_tagKeys - A list of tag key names to remove from the secret. You don't specify
the value. Both the key and its associated value are removed.
This parameter requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' | |
Instances
newUntagResourceResponse :: UntagResourceResponse Source #
Create a value of UntagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateSecret
data UpdateSecret Source #
See: newUpdateSecret smart constructor.
Constructors
| UpdateSecret' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (Sensitive Base64)) (Maybe (Sensitive Text)) Text |
Instances
Arguments
| :: Text | |
| -> UpdateSecret |
Create a value of UpdateSecret with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestToken:UpdateSecret', updateSecret_clientRequestToken - If you include SecretString or SecretBinary, then Secrets Manager
creates a new version for the secret, and this parameter specifies the
unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services
SDKs to call this operation, then you can leave this parameter empty.
The CLI or SDK generates a random UUID for you and includes it as the
value for this parameter in the request. If you don't use the SDK and
instead generate a raw HTTP request to the Secrets Manager service
endpoint, then you must generate a ClientRequestToken yourself for the
new version and include the value in the request.
This value becomes the VersionId of the new version.
UpdateSecret, updateSecret_description - The description of the secret.
UpdateSecret, updateSecret_kmsKeyId - The ARN, key ID, or alias of the KMS key that Secrets Manager uses to
encrypt new secret versions as well as any existing versions with the
staging labels AWSCURRENT, AWSPENDING, or AWSPREVIOUS. For more
information about versions and staging labels, see
Concepts: Version.
A key alias is always prefixed by alias/, for example
alias/aws/secretsmanager. For more information, see
About aliases.
If you set this to an empty string, Secrets Manager uses the Amazon Web
Services managed key aws/secretsmanager. If this key doesn't already
exist in your account, then Secrets Manager creates it for you
automatically. All users and roles in the Amazon Web Services account
automatically have access to use aws/secretsmanager. Creating
aws/secretsmanager can result in a one-time significant delay in
returning the result.
You can only use the Amazon Web Services managed key
aws/secretsmanager if you call this operation using credentials from
the same Amazon Web Services account that owns the secret. If the secret
is in a different account, then you must use a customer managed key and
provide the ARN of that KMS key in this field. The user making the call
must have permissions to both the secret and the KMS key in their
respective accounts.
$sel:secretBinary:UpdateSecret', updateSecret_secretBinary - The binary data to encrypt and store in the new version of the secret.
We recommend that you store your binary data in a file and then pass the
contents of the file as a parameter.
Either SecretBinary or SecretString must have a value, but not both.
You can't access this parameter in the Secrets Manager console.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
$sel:secretString:UpdateSecret', updateSecret_secretString - The text data to encrypt and store in the new version of the secret. We
recommend you use a JSON structure of key/value pairs for your secret
value.
Either SecretBinary or SecretString must have a value, but not both.
$sel:secretId:UpdateSecret', updateSecret_secretId - The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
data UpdateSecretResponse Source #
See: newUpdateSecretResponse smart constructor.
Instances
newUpdateSecretResponse Source #
Arguments
| :: Int | |
| -> UpdateSecretResponse |
Create a value of UpdateSecretResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateSecretResponse, updateSecretResponse_arn - The ARN of the secret that was updated.
UpdateSecretResponse, updateSecretResponse_name - The name of the secret that was updated.
UpdateSecretResponse, updateSecretResponse_versionId - If Secrets Manager created a new version of the secret during this
operation, then VersionId contains the unique identifier of the new
version.
$sel:httpStatus:UpdateSecretResponse', updateSecretResponse_httpStatus - The response's http status code.
UpdateSecretVersionStage
data UpdateSecretVersionStage Source #
See: newUpdateSecretVersionStage smart constructor.
Instances
newUpdateSecretVersionStage Source #
Arguments
| :: Text | |
| -> Text | |
| -> UpdateSecretVersionStage |
Create a value of UpdateSecretVersionStage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:moveToVersionId:UpdateSecretVersionStage', updateSecretVersionStage_moveToVersionId - The ID of the version to add the staging label to. To remove a label
from a version, then do not specify this parameter.
If the staging label is already attached to a different version of the
secret, then you must also specify the RemoveFromVersionId parameter.
$sel:removeFromVersionId:UpdateSecretVersionStage', updateSecretVersionStage_removeFromVersionId - The ID of the version that the staging label is to be removed from. If
the staging label you are trying to attach to one version is already
attached to a different version, then you must include this parameter
and specify the version that the label is to be removed from. If the
label is attached and you either do not specify this parameter, or the
version ID does not match, then the operation fails.
$sel:secretId:UpdateSecretVersionStage', updateSecretVersionStage_secretId - The ARN or the name of the secret with the version and staging labelsto
modify.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
$sel:versionStage:UpdateSecretVersionStage', updateSecretVersionStage_versionStage - The staging label to add to this version.
data UpdateSecretVersionStageResponse Source #
See: newUpdateSecretVersionStageResponse smart constructor.
Instances
newUpdateSecretVersionStageResponse Source #
Create a value of UpdateSecretVersionStageResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateSecretVersionStageResponse, updateSecretVersionStageResponse_arn - The ARN of the secret that was updated.
UpdateSecretVersionStageResponse, updateSecretVersionStageResponse_name - The name of the secret that was updated.
$sel:httpStatus:UpdateSecretVersionStageResponse', updateSecretVersionStageResponse_httpStatus - The response's http status code.
ValidateResourcePolicy
data ValidateResourcePolicy Source #
See: newValidateResourcePolicy smart constructor.
Constructors
| ValidateResourcePolicy' (Maybe Text) Text |
Instances
newValidateResourcePolicy Source #
Create a value of ValidateResourcePolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:secretId:ValidateResourcePolicy', validateResourcePolicy_secretId - This field is reserved for internal use.
$sel:resourcePolicy:ValidateResourcePolicy', validateResourcePolicy_resourcePolicy - A JSON-formatted string that contains an Amazon Web Services
resource-based policy. The policy in the string identifies who can
access or manage this secret and its versions. For example policies, see
Permissions policy examples.
data ValidateResourcePolicyResponse Source #
See: newValidateResourcePolicyResponse smart constructor.
Constructors
| ValidateResourcePolicyResponse' (Maybe Bool) (Maybe [ValidationErrorsEntry]) Int |
Instances
newValidateResourcePolicyResponse Source #
Create a value of ValidateResourcePolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:policyValidationPassed:ValidateResourcePolicyResponse', validateResourcePolicyResponse_policyValidationPassed - True if your policy passes validation, otherwise false.
$sel:validationErrors:ValidateResourcePolicyResponse', validateResourcePolicyResponse_validationErrors - Validation errors if your policy didn't pass validation.
$sel:httpStatus:ValidateResourcePolicyResponse', validateResourcePolicyResponse_httpStatus - The response's http status code.
Types
FilterNameStringType
newtype FilterNameStringType Source #
Constructors
| FilterNameStringType' | |
Fields | |
Bundled Patterns
| pattern FilterNameStringType_All :: FilterNameStringType | |
| pattern FilterNameStringType_Description :: FilterNameStringType | |
| pattern FilterNameStringType_Name :: FilterNameStringType | |
| pattern FilterNameStringType_Owning_service :: FilterNameStringType | |
| pattern FilterNameStringType_Primary_region :: FilterNameStringType | |
| pattern FilterNameStringType_Tag_key :: FilterNameStringType | |
| pattern FilterNameStringType_Tag_value :: FilterNameStringType |
Instances
SortOrderType
newtype SortOrderType Source #
Constructors
| SortOrderType' | |
Fields | |
Bundled Patterns
| pattern SortOrderType_Asc :: SortOrderType | |
| pattern SortOrderType_Desc :: SortOrderType |
Instances
StatusType
newtype StatusType Source #
Constructors
| StatusType' | |
Fields | |
Bundled Patterns
| pattern StatusType_Failed :: StatusType | |
| pattern StatusType_InProgress :: StatusType | |
| pattern StatusType_InSync :: StatusType |
Instances
Filter
Allows you to add filters when you use the search function in Secrets Manager. For more information, see Find secrets in Secrets Manager.
See: newFilter smart constructor.
Instances
| ToJSON Filter Source # | |
Defined in Amazonka.SecretsManager.Types.Filter | |
| Generic Filter Source # | |
| Read Filter Source # | |
| Show Filter Source # | |
| NFData Filter Source # | |
Defined in Amazonka.SecretsManager.Types.Filter | |
| Eq Filter Source # | |
| Hashable Filter Source # | |
Defined in Amazonka.SecretsManager.Types.Filter | |
| type Rep Filter Source # | |
Defined in Amazonka.SecretsManager.Types.Filter type Rep Filter = D1 ('MetaData "Filter" "Amazonka.SecretsManager.Types.Filter" "amazonka-secretsmanager-2.0-8tljeZ4CwL92E7JavkDb0o" 'False) (C1 ('MetaCons "Filter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FilterNameStringType)) :*: S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))))) | |
Create a value of Filter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Filter', filter_key - The following are keys you can use:
- description: Prefix match, not case-sensitive.
- name: Prefix match, case-sensitive.
- tag-key: Prefix match, case-sensitive.
- tag-value: Prefix match, case-sensitive.
- primary-region: Prefix match, case-sensitive.
- all: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.
$sel:values:Filter', filter_values - The keyword to filter for.
You can prefix your search value with an exclamation mark (!) in order
to perform negation filters.
ReplicaRegionType
data ReplicaRegionType Source #
A custom type that specifies a Region and the KmsKeyId for a replica
secret.
See: newReplicaRegionType smart constructor.
Constructors
| ReplicaRegionType' (Maybe Text) (Maybe Text) |
Instances
newReplicaRegionType :: ReplicaRegionType Source #
Create a value of ReplicaRegionType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kmsKeyId:ReplicaRegionType', replicaRegionType_kmsKeyId - The ARN, key ID, or alias of the KMS key to encrypt the secret. If you
don't include this field, Secrets Manager uses aws/secretsmanager.
$sel:region:ReplicaRegionType', replicaRegionType_region - A Region code. For a list of Region codes, see
Name and code of Regions.
ReplicationStatusType
data ReplicationStatusType Source #
A replication object consisting of a RegionReplicationStatus object
and includes a Region, KMSKeyId, status, and status message.
See: newReplicationStatusType smart constructor.
Constructors
| ReplicationStatusType' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe StatusType) (Maybe Text) |
Instances
newReplicationStatusType :: ReplicationStatusType Source #
Create a value of ReplicationStatusType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kmsKeyId:ReplicationStatusType', replicationStatusType_kmsKeyId - Can be an ARN, Key ID, or Alias.
$sel:lastAccessedDate:ReplicationStatusType', replicationStatusType_lastAccessedDate - The date that the secret was last accessed in the Region. This field is
omitted if the secret has never been retrieved in the Region.
$sel:region:ReplicationStatusType', replicationStatusType_region - The Region where replication occurs.
$sel:status:ReplicationStatusType', replicationStatusType_status - The status can be InProgress, Failed, or InSync.
$sel:statusMessage:ReplicationStatusType', replicationStatusType_statusMessage - Status message such as "/Secret with this name already exists in this
region/".
RotationRulesType
data RotationRulesType Source #
A structure that defines the rotation configuration for the secret.
See: newRotationRulesType smart constructor.
Instances
newRotationRulesType :: RotationRulesType Source #
Create a value of RotationRulesType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:automaticallyAfterDays:RotationRulesType', rotationRulesType_automaticallyAfterDays - The number of days between automatic scheduled rotations of the secret.
You can use this value to check that your secret meets your compliance
guidelines for how often secrets must be rotated.
In DescribeSecret and ListSecrets, this value is calculated from the
rotation schedule after every successful rotation. In RotateSecret,
you can set the rotation schedule in RotationRules with
AutomaticallyAfterDays or ScheduleExpression, but not both. To set a
rotation schedule in hours, use ScheduleExpression.
$sel:duration:RotationRulesType', rotationRulesType_duration - The length of the rotation window in hours, for example 3h for a three
hour window. Secrets Manager rotates your secret at any time during this
window. The window must not extend into the next rotation window or the
next UTC day. The window starts according to the ScheduleExpression.
If you don't specify a Duration, for a ScheduleExpression in hours,
the window automatically closes after one hour. For a
ScheduleExpression in days, the window automatically closes at the end
of the UTC day. For more information, including examples, see
Schedule expressions in Secrets Manager rotation
in the Secrets Manager Users Guide.
$sel:scheduleExpression:RotationRulesType', rotationRulesType_scheduleExpression - A cron() or rate() expression that defines the schedule for rotating
your secret. Secrets Manager rotation schedules use UTC time zone.
Secrets Manager rotates your secret any time during a rotation window.
Secrets Manager rate() expressions represent the interval in hours or
days that you want to rotate your secret, for example rate(12 hours)
or rate(10 days). You can rotate a secret as often as every four
hours. If you use a rate() expression, the rotation window starts at
midnight. For a rate in hours, the default rotation window closes after
one hour. For a rate in days, the default rotation window closes at the
end of the day. You can set the Duration to change the rotation
window. The rotation window must not extend into the next UTC day or
into the next rotation window.
You can use a cron() expression to create a rotation schedule that is
more detailed than a rotation interval. For more information, including
examples, see
Schedule expressions in Secrets Manager rotation
in the Secrets Manager Users Guide. For a cron expression that
represents a schedule in hours, the default rotation window closes after
one hour. For a cron expression that represents a schedule in days, the
default rotation window closes at the end of the day. You can set the
Duration to change the rotation window. The rotation window must not
extend into the next UTC day or into the next rotation window.
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
GetSecretValue
.
See: newSecretListEntry smart constructor.
Constructors
| SecretListEntry' (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe RotationRulesType) (Maybe (HashMap Text (NonEmpty Text))) (Maybe [Tag]) |
Instances
newSecretListEntry :: SecretListEntry Source #
Create a value of SecretListEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:SecretListEntry', secretListEntry_arn - The Amazon Resource Name (ARN) of the secret.
$sel:createdDate:SecretListEntry', secretListEntry_createdDate - The date and time when a secret was created.
$sel:deletedDate:SecretListEntry', secretListEntry_deletedDate - The date and time the deletion of the secret occurred. 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.
$sel:description:SecretListEntry', secretListEntry_description - The user-provided description of the secret.
$sel:kmsKeyId:SecretListEntry', secretListEntry_kmsKeyId - The ARN of the KMS key that Secrets Manager uses to encrypt the secret
value. If the secret is encrypted with the Amazon Web Services managed
key aws/secretsmanager, this field is omitted.
$sel:lastAccessedDate:SecretListEntry', secretListEntry_lastAccessedDate - The date that the secret was last accessed in the Region. This field is
omitted if the secret has never been retrieved in the Region.
$sel:lastChangedDate:SecretListEntry', secretListEntry_lastChangedDate - The last date and time that this secret was modified in any way.
$sel:lastRotatedDate:SecretListEntry', secretListEntry_lastRotatedDate - The most recent date and time that the Secrets Manager rotation process
was successfully completed. This value is null if the secret hasn't
ever rotated.
$sel:name:SecretListEntry', secretListEntry_name - The friendly name of the secret. You can use forward slashes in the name
to represent a path hierarchy. For example,
/prod/databases/dbserver1 could represent the secret for a server
named dbserver1 in the folder databases in the folder prod.
$sel:nextRotationDate:SecretListEntry', secretListEntry_nextRotationDate - Undocumented member.
$sel:owningService:SecretListEntry', secretListEntry_owningService - Returns the name of the service that created the secret.
$sel:primaryRegion:SecretListEntry', secretListEntry_primaryRegion - The Region where Secrets Manager originated the secret.
$sel:rotationEnabled:SecretListEntry', secretListEntry_rotationEnabled - Indicates whether automatic, scheduled rotation is enabled for this
secret.
$sel:rotationLambdaARN:SecretListEntry', secretListEntry_rotationLambdaARN - The ARN of an Amazon Web Services Lambda function invoked by Secrets
Manager to rotate and expire the secret either automatically per the
schedule or manually by a call to
RotateSecret
.
$sel:rotationRules:SecretListEntry', secretListEntry_rotationRules - A structure that defines the rotation configuration for the secret.
$sel:secretVersionsToStages:SecretListEntry', secretListEntry_secretVersionsToStages - A list of all of the currently assigned SecretVersionStage staging
labels and the SecretVersionId attached to each one. Staging labels
are used to keep track of the different versions during the rotation
process.
A version that does not have any SecretVersionStage is considered
deprecated and subject to deletion. Such versions are not included in
this list.
$sel:tags:SecretListEntry', secretListEntry_tags - The list of user-defined tags 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: newSecretVersionsListEntry smart constructor.
Constructors
| SecretVersionsListEntry' (Maybe POSIX) (Maybe [Text]) (Maybe POSIX) (Maybe Text) (Maybe (NonEmpty Text)) |
Instances
newSecretVersionsListEntry :: SecretVersionsListEntry Source #
Create a value of SecretVersionsListEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createdDate:SecretVersionsListEntry', secretVersionsListEntry_createdDate - The date and time this version of the secret was created.
$sel:kmsKeyIds:SecretVersionsListEntry', secretVersionsListEntry_kmsKeyIds - The KMS keys used to encrypt the secret version.
$sel:lastAccessedDate:SecretVersionsListEntry', secretVersionsListEntry_lastAccessedDate - 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.
$sel:versionId:SecretVersionsListEntry', secretVersionsListEntry_versionId - The unique version identifier of this version of the secret.
$sel:versionStages:SecretVersionsListEntry', secretVersionsListEntry_versionStages - An array of staging labels that are currently associated with this
version of the secret.
Tag
A structure that contains information about a tag.
See: newTag smart constructor.
Instances
| FromJSON Tag Source # | |
| ToJSON Tag Source # | |
Defined in Amazonka.SecretsManager.Types.Tag | |
| Generic Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.SecretsManager.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.SecretsManager.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.SecretsManager.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.SecretsManager.Types.Tag" "amazonka-secretsmanager-2.0-8tljeZ4CwL92E7JavkDb0o" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
Create a value of Tag with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag', tag_key - The key identifier, or name, of the tag.
$sel:value:Tag', tag_value - The string value associated with the key of the tag.
ValidationErrorsEntry
data ValidationErrorsEntry Source #
Displays errors that occurred during validation of the resource policy.
See: newValidationErrorsEntry smart constructor.
Constructors
| ValidationErrorsEntry' (Maybe Text) (Maybe Text) |
Instances
newValidationErrorsEntry :: ValidationErrorsEntry Source #
Create a value of ValidationErrorsEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:checkName:ValidationErrorsEntry', validationErrorsEntry_checkName - Checks the name of the policy.
$sel:errorMessage:ValidationErrorsEntry', validationErrorsEntry_errorMessage - Displays error messages if validation encounters problems during
validation of the resource policy.